XLAEnvironment¶
- class lightning.pytorch.plugins.environments.XLAEnvironment(*args, **kwargs)[source]¶
Bases:
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:
- global_rank()[source]¶
The rank (index) of the currently running process across all host and devices.
The output is cached for performance.
- Return type:
- local_rank()[source]¶
The rank (index) of the currently running process inside of the current host.
The output is cached for performance.
- Return type:
- node_rank()[source]¶
The rank (index) of the host on which the current process runs.
The output is cached for performance.
- Return type:
- world_size()[source]¶
The number of processes across all devices and hosts.
The output is cached for performance.
- Return type: