SLURMEnvironment

class pytorch_lightning.plugins.environments.SLURMEnvironment(auto_requeue=True)[source]

Bases: pytorch_lightning.plugins.environments.cluster_environment.ClusterEnvironment

Cluster environment for training on a cluster managed by SLURM.

Parameters

auto_requeue (bool) – Whether automatic job resubmission is enabled or not. How and under which conditions a job gets rescheduled gets determined by the owner of this plugin.

static detect()[source]

Returns True if the current process was launched on a SLURM cluster.

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