| Name | submitit-oar JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | OAR plugin for Submitit |
| upload_time | 2023-10-27 15:49:57 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | |
| 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`):
```
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "submitit-oar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "submitit,oar",
"author": "",
"author_email": "Yao Chi <yao.chi@inria.fr>",
"download_url": "https://files.pythonhosted.org/packages/19/8b/2c64ddb81c0aa39f979248f09869db138cec460981c2c668d1e4be57d851/submitit_oar-1.0.0.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```\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",
"bugtrack_url": null,
"license": "",
"summary": "OAR plugin for Submitit",
"version": "1.0.0",
"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": "",
"digests": {
"blake2b_256": "f1e854120604507855039d723b79a727d3ad4d53dd2e482c4c1a5482212b1350",
"md5": "a08255f5b63527abb4a1b61680965d11",
"sha256": "31cb1ba2835891a1e6608b3173676cd55d672cfe58ad5ffd884d3faa882b804d"
},
"downloads": -1,
"filename": "submitit_oar-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a08255f5b63527abb4a1b61680965d11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16209,
"upload_time": "2023-10-27T15:49:56",
"upload_time_iso_8601": "2023-10-27T15:49:56.351890Z",
"url": "https://files.pythonhosted.org/packages/f1/e8/54120604507855039d723b79a727d3ad4d53dd2e482c4c1a5482212b1350/submitit_oar-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "198b2c64ddb81c0aa39f979248f09869db138cec460981c2c668d1e4be57d851",
"md5": "e790e100dde493fc443f12dbb764d697",
"sha256": "12dde0bed35732e1eb45292ed6634b3d9d8735f112581ee55b927e6242e83e31"
},
"downloads": -1,
"filename": "submitit_oar-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e790e100dde493fc443f12dbb764d697",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 16017,
"upload_time": "2023-10-27T15:49:57",
"upload_time_iso_8601": "2023-10-27T15:49:57.856898Z",
"url": "https://files.pythonhosted.org/packages/19/8b/2c64ddb81c0aa39f979248f09869db138cec460981c2c668d1e4be57d851/submitit_oar-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 15:49:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ychiat35",
"github_project": "submitit_oar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "submitit-oar"
}
