Shortcuts

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

Read the Docs v: latest
Versions
latest
stable
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.10
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.10.0
0.9.0
0.8.5
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.6
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.0
0.5.3
0.4.9
ipynb-update
docs-search
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.