Shortcuts

XLAEnvironment

class pytorch_lightning.plugins.environments.XLAEnvironment[source]

Bases: lightning_lite.plugins.environments.cluster_environment.ClusterEnvironment

Cluster environment for training on a TPU Pod with the PyTorch/XLA library.

A list of environment variables set by XLA can be found here.

static detect()[source]

Detects the environment settings corresponding to this cluster and returns True if they match.

Return type

bool

global_rank()[source]

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

Return type

int

local_rank()[source]

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

Return type

int

node_rank()[source]

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

Return type

int

world_size()[source]

The number of processes across all devices and nodes.

Return type

int

property creates_processes_externally: bool

Whether the environment creates the subprocesses or not.

Return type

bool

property main_address: str

The main address through which all processes connect and communicate.

Return type

str

property main_port: int

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

Return type

int

Read the Docs v: latest
Versions
latest
stable
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
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
future-structure
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.