XLAEnvironment¶
- class pytorch_lightning.plugins.environments.XLAEnvironment(*args, **kwargs)[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:
- global_rank()[source]¶
The rank (index) of the currently running process across all nodes and devices.
- Return type:
- local_rank()[source]¶
The rank (index) of the currently running process inside of the current node.
- Return type: