SLURMEnvironment¶

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

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.

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.