OAR plugin for Submitit
Project description
What is submitit_oar?
submitit_oar is an Oar plugin for Submitit, which is a Python 3.8+ lightweight toolbox for submitting Python functions for computation within a Slurm cluster. It basically wraps submission and provide access to results, logs and more.
How to install submitit_oar?
Quick install, in a virtualenv/conda environment where pip
is installed (check which pip
):
- latest release:
pip install submitit_oar==1.1.0
- from source:
pip install git+https://github.com/ychiat35/submitit_oar@main#egg=submitit_oar
How to use the submitit_oar plugin?
From inside an environment with submitit
and submitit_oar
installed, you can run this addition example:
import submitit
def add(a, b):
return a + b
# logs are dumped in the folder
executor = submitit.AutoExecutor(folder="log_test", cluster="oar")
job_addition = executor.submit(add, 5, 7) # will compute add(5, 7)
output = job_addition.result() # waits for completion and returns output
# if ever the job failed, result() will raise an error with the corresponding trace
print('job_addition output: ', output)
assert output == 12
You can try running this above example with a breakpoint at https://github.com/facebookincubator/submitit/blob/main/submitit/core/plugins.py#L33, to be sure that Submitit correctly finds the submitit_oar plugin.
Releasing submitit_oar
Create a tag matching the version to release in gitlab, it should create a pipeline which will push the package to PyPi.
If you want to do this manually, populate the FLIT_PASSWORD
environment variable with the API token, and run make release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for submitit_oar-1.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a11d89c423ce6d7acf3c04bea46c1e6a739900db7cc56c8464024b2f34234ff4 |
|
MD5 | 77a9e91b3520dbcd4d10b2e82cc89bec |
|
BLAKE2b-256 | 8a849a324fae651261978c983a50bbf47eac945d3b127f1ae1edcc6d9c4ad40e |