lightning_fabric.plugins.environments.xla.XLAEnvironment

class lightning_fabric.plugins.environments.xla.XLAEnvironment(*args, **kwargs)

Bases: lightning_fabric.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()

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

Return type:

bool

global_rank()

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

Return type:

int

local_rank()

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

Return type:

int

node_rank()

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

Return type:

int

world_size()

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.

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.