espnet2.train.distributed_utils.is_in_slurm_job

source

espnet2.train.distributed_utils.is_in_slurm_job() → bool

Check if the current process is running within a SLURM job.

This function determines if the environment variables indicative of a SLURM job are set. It checks for the presence of the “SLURM_PROCID” and “SLURM_NTASKS” environment variables, which are typically set when a job is launched using SLURM.

• Returns: True if the process is running in a SLURM job, False otherwise.
• Return type: bool

Examples

>>> os.environ["SLURM_PROCID"] = "0"
>>> os.environ["SLURM_NTASKS"] = "4"
>>> is_in_slurm_job()
True

>>> os.environ.pop("SLURM_PROCID")
>>> is_in_slurm_job()
False