| Name | submitit_oar JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | OAR plugin for Submitit |
| upload_time | 2024-03-04 16:21:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
submitit
oar
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# What is submitit_oar?
submitit_oar is an [Oar](https://oar.imag.fr/) plugin for [Submitit](https://github.com/facebookincubator/submitit), which is a Python 3.8+ lightweight toolbox for submitting Python functions for computation within a [Slurm](https://slurm.schedmd.com/quickstart.html) 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:
```python
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`
Raw data
{
"_id": null,
"home_page": null,
"name": "submitit_oar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "submitit,oar",
"author": null,
"author_email": "Yao Chi <yao.chi@inria.fr>",
"download_url": "https://files.pythonhosted.org/packages/92/35/ccfcd732aa2153f3aa207a0a7e3386a3bb631d0547192413e4f301bddf7f/submitit_oar-1.1.1.tar.gz",
"platform": null,
"description": "# What is submitit_oar?\nsubmitit_oar is an [Oar](https://oar.imag.fr/) plugin for [Submitit](https://github.com/facebookincubator/submitit), which is a Python 3.8+ lightweight toolbox for submitting Python functions for computation within a [Slurm](https://slurm.schedmd.com/quickstart.html) cluster. It basically wraps submission and provide access to results, logs and more.\n\n# How to install submitit_oar?\nQuick install, in a virtualenv/conda environment where `pip` is installed (check `which pip`):\n- latest release:\n```\npip install submitit_oar==1.1.0\n```\n- from source:\n```\npip install git+https://github.com/ychiat35/submitit_oar@main#egg=submitit_oar\n```\n\n# How to use the submitit_oar plugin?\nFrom inside an environment with `submitit` and `submitit_oar` installed, you can run this addition example:\n\n```python\nimport submitit\n\ndef add(a, b):\n return a + b\n\n# logs are dumped in the folder\nexecutor = submitit.AutoExecutor(folder=\"log_test\", cluster=\"oar\")\n\njob_addition = executor.submit(add, 5, 7) # will compute add(5, 7)\noutput = job_addition.result() # waits for completion and returns output\n# if ever the job failed, result() will raise an error with the corresponding trace\nprint('job_addition output: ', output)\nassert output == 12\n```\n\nYou 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.\n\n# Releasing submitit_oar\n\nCreate a tag matching the version to release in gitlab, it should create a pipeline which will push the package to PyPi.\nIf you want to do this manually, populate the `FLIT_PASSWORD` environment variable with the API token, and run `make release`\n",
"bugtrack_url": null,
"license": null,
"summary": "OAR plugin for Submitit",
"version": "1.1.1",
"project_urls": {
"Source": "https://github.com/ychiat35/submitit_oar.git",
"Tracker": "https://github.com/ychiat35/submitit_oar.git/issues"
},
"split_keywords": [
"submitit",
"oar"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8a849a324fae651261978c983a50bbf47eac945d3b127f1ae1edcc6d9c4ad40e",
"md5": "77a9e91b3520dbcd4d10b2e82cc89bec",
"sha256": "a11d89c423ce6d7acf3c04bea46c1e6a739900db7cc56c8464024b2f34234ff4"
},
"downloads": -1,
"filename": "submitit_oar-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "77a9e91b3520dbcd4d10b2e82cc89bec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18108,
"upload_time": "2024-03-04T16:21:51",
"upload_time_iso_8601": "2024-03-04T16:21:51.159859Z",
"url": "https://files.pythonhosted.org/packages/8a/84/9a324fae651261978c983a50bbf47eac945d3b127f1ae1edcc6d9c4ad40e/submitit_oar-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9235ccfcd732aa2153f3aa207a0a7e3386a3bb631d0547192413e4f301bddf7f",
"md5": "7b31074e9a43fca31afcc585a34eb25f",
"sha256": "480194e583b94329e5c184a3e7e0e5c19343562b58b23c0bf991f0679ca5847e"
},
"downloads": -1,
"filename": "submitit_oar-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "7b31074e9a43fca31afcc585a34eb25f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21114,
"upload_time": "2024-03-04T16:21:53",
"upload_time_iso_8601": "2024-03-04T16:21:53.156658Z",
"url": "https://files.pythonhosted.org/packages/92/35/ccfcd732aa2153f3aa207a0a7e3386a3bb631d0547192413e4f301bddf7f/submitit_oar-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-04 16:21:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ychiat35",
"github_project": "submitit_oar",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "submitit_oar"
}
