Submit it!
What is submitit?
Submitit is a lightweight tool for submitting Python functions for computation within a Slurm cluster. It basically wraps submission and provide access to results, logs and more. Slurm is an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters. Submitit allows to switch seamlessly between executing on Slurm or locally.
An example is worth a thousand words: performing an addition
From inside an environment with submitit installed:
import submitit
def add(a, b):
return a + b
# executor is the submission interface (logs are dumped in the folder)
executor = submitit.AutoExecutor(folder="log_test")
# set timeout in min, and partition for running the job
executor.update_parameters(timeout_min=1, slurm_partition="dev")
job = executor.submit(add, 5, 7) # will compute add(5, 7)
print(job.job_id) # ID of your job
output = job.result() # waits for completion and returns output
assert output == 12 # 5 + 7 = 12... your addition was computed in the cluster
The Job class also provides tools for reading the log files (job.stdout() and job.stderr()).
If what you want to run is a command, turn it into a Python function using submitit.helpers.CommandFunction, then submit it. By default stdout is silenced in CommandFunction, but it can be unsilenced with verbose=True.
Find more examples here!!!
Submitit is a Python 3.6+ toolbox for submitting jobs to Slurm. It aims at running python function from python code.
Install
Quick install, in a virtualenv/conda environment where pip is installed (check which pip):
- stable release:
pip install submitit - stable release using conda:
conda install -c conda-forge submitit - master branch:
pip install git+https://github.com/facebookincubator/[email protected]#egg=submitit
You can try running the MNIST example to check that everything is working as expected (requires sklearn).
Documentation
See the following pages for more detailled information:
- Examples: for a bunch of examples dealing with errors, concurrency, multi-tasking etc...
- Structure and main objects: to get a better understanding of how
submititworks, which files are created for each job, and the main objects you will interact with. - Checkpointing: to understand how you can configure your job to get checkpointed when preempted and/or timed-out.
- Tips and caveats: for a bunch of information that can be handy when working with
submitit. - Hyperparameter search with nevergrad: basic example of
nevergradusage and how it interfaces withsubmitit.
Goals
The aim of this Python3 package is to be able to launch jobs on Slurm painlessly from inside Python, using the same submission and job patterns than the standard library package concurrent.futures:
Here are a few benefits of using this lightweight package:
- submit any function, even lambda and script-defined functions.
- raises an error with stack trace if the job failed.
- requeue preempted jobs (Slurm only)
- swap between
submititexecutor and one ofconcurrent.futuresexecutors in a line, so that it is easy to run your code either on slurm, or locally with multithreading for instance. - checkpoints stateful callables when preempted or timed-out and requeue from current state (advanced feature).
- easy access to task local/global rank for multi-nodes/tasks jobs.
- same code can work for different clusters thanks to a plugin system.
Submitit is used by FAIR researchers on the FAIR cluster. The defaults are chosen to make their life easier, and might not be ideal for every cluster.
Non-goals
- a commandline tool for running slurm jobs. Here, everything happens inside Python. To this end, you can however use Hydra's submitit plugin (version >= 1.0.0).
- a task queue, this only implements the ability to launch tasks, but does not schedule them in any way.
- being used in Python2! This is a Python3.6+ only package :)
Comparison with dask.distributed
dask is a nice framework for distributed computing. dask.distributed provides the same concurrent.futures executor API as submitit:
from distributed import Client
from dask_jobqueue import SLURMCluster
cluster = SLURMCluster(processes=1, cores=2, memory="2GB")
cluster.scale(2) # this may take a few seconds to launch
executor = Client(cluster)
executor.submit(...)
The key difference with submitit is that dask.distributed distributes the jobs to a pool of workers (see the cluster variable above) while submitit jobs are directly jobs on the cluster. In that sense submitit is a lower level interface than dask.distributed and you get more direct control over your jobs, including individual stdout and stderr, and possibly checkpointing in case of preemption and timeout. On the other hand, you should avoid submitting multiple small tasks with submitit, which would create many independent jobs and possibly overload the cluster, while you can do it without any problem through dask.distributed.
Contributors
By chronological order: Jérémy Rapin, Louis Martin, Lowik Chanussot, Lucas Hosseini, Fabio Petroni, Francisco Massa, Guillaume Wenzek, Thibaut Lavril, Vinayak Tantia, Andrea Vedaldi, Max Nickel, Quentin Duval (feel free to contribute and add your name ;) )
License
Submitit is released under the MIT License.
![[To be discussed] Add option to submit within a batch context](https://avatars.githubusercontent.com/u/11429864?v=4)
![[BUG] `Scontrol` Error when checkpointing / preemption on slurm](https://avatars.githubusercontent.com/u/24327668?v=4)
2.8k Jan 06, 2023
366 Jan 03, 2023
1 Dec 17, 2021
1.1k Jan 01, 2023
177 Sep 02, 2022
18 Jan 04, 2022
7.1k Jan 01, 2023
175 Jan 08, 2023
2 Sep 13, 2022
1.6k Jan 01, 2023
858 Dec 25, 2022
1 Jan 16, 2022
924 Jan 03, 2023
7 Nov 09, 2022
1 Jan 06, 2022
2 Aug 25, 2022
604 Dec 29, 2022
16 Jul 20, 2022
1 Jul 09, 2022
12 Aug 23, 2022