ClusterEnvironment¶
- class pytorch_lightning.plugins.environments.ClusterEnvironment[source]¶
Bases:
abc.ABC
Specification of a cluster environment.
- creates_children()[source]¶
Whether the environment creates the subprocesses or not. :rtype:
bool
Deprecated since version v1.5: This method was deprecated in v1.5 and will be removed in v1.6. Use the property
creates_processes_externally
instead.
- 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 master_address()[source]¶
The master address through which all processes connect and communicate.
- Return type
- abstract master_port()[source]¶
An open and configured port in the master node through which all processes communicate.
- Return type
- abstract node_rank()[source]¶
The rank (index) of the node on which the current process runs.
- Return type
- abstract property creates_processes_externally: bool¶
Whether the environment creates the subprocesses or not.