ClusterEnvironment¶
- class lightning.pytorch.plugins.environments.ClusterEnvironment[source]¶
Bases:
ABC
Specification of a cluster environment.
- abstract static detect()[source]¶
Detects the environment settings corresponding to this cluster and returns
True
if they match.- Return type:
- abstract global_rank()[source]¶
The rank (index) of the currently running process across all nodes and devices.
- Return type:
- abstract local_rank()[source]¶
The rank (index) of the currently running process inside of the current node.
- Return type:
- abstract node_rank()[source]¶
The rank (index) of the node on which the current process runs.
- Return type:
- validate_settings(num_devices, num_nodes)[source]¶
Validates settings configured in the script against the environment, and raises an exception if there is an inconsistency.
- Return type:
- abstract property creates_processes_externally: bool¶
Whether the environment creates the subprocesses or not.