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.

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.

Return type: bool

abstract global_rank()[source]¶

The rank (index) of the currently running process across all nodes and devices.

Return type: int

abstract local_rank()[source]¶

The rank (index) of the currently running process inside of the current node.

Return type: int

abstract master_address()[source]¶

The master address through which all processes connect and communicate.

Return type: str

abstract master_port()[source]¶

An open and configured port in the master node through which all processes communicate.

Return type: int

abstract node_rank()[source]¶

The rank (index) of the node on which the current process runs.

Return type: int

teardown()[source]¶

Clean up any state set after execution finishes.

Return type: None

abstract world_size()[source]¶

The number of processes across all devices and nodes.

Return type: int

abstract property creates_processes_externally: bool¶

Whether the environment creates the subprocesses or not.

Return type: bool