ClusterEnvironment¶
-
class
pytorch_lightning.plugins.environments.
ClusterEnvironment
[source]¶ Bases:
abc.ABC
Specification of a cluster environment.
-
abstract
creates_children
()[source]¶ Whether the environment creates the subprocesses or not.
- 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
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