XLAEnvironment¶

class pytorch_lightning.plugins.environments.XLAEnvironment(*args, **kwargs)[source]¶

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.

global_rank()[source]¶

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

local_rank()[source]¶

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

node_rank()[source]¶

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

world_size()[source]¶

The number of processes across all devices and nodes.

property creates_processes_externally: bool¶

Whether the environment creates the subprocesses or not.

property main_address: str¶

The main address through which all processes connect and communicate.

property main_port: int¶

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