Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
In particular added acronym for JZ, added `--user` for pip install, and added jz docs
  • Loading branch information
zaccharieramzi authored Jan 14, 2022
1 parent 626d282 commit 069a1bd
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

![GitHub Workflow Build Status](https://github.com/zaccharieramzi/jz-hydra-submitit-launcher/workflows/Continuous%20testing/badge.svg)

A Jean Zay tailored Hydra submitit launcher based on [Hydra](https://hydra.cc/docs/intro/) and its [submitit-launcher plugin](https://hydra.cc/docs/plugins/submitit_launcher/).
Basically it extends the submitit-launcher plugin with defaults that make sense for Jean Zay.
A Jean Zay (JZ) tailored Hydra submitit launcher based on [Hydra](https://hydra.cc/docs/intro/) and its [submitit-launcher plugin](https://hydra.cc/docs/plugins/submitit_launcher/).
Basically it extends the submitit-launcher plugin with defaults that make sense for JZ.

## Install

This package can be installed from pypi:
This package can be installed from pypi (using `--user` is required on JZ):
```
pip install jz-hydra-submitit-launcher
pip install --user jz-hydra-submitit-launcher
```

You can also install it from source:
```
git clone https://github.com/zaccharieramzi/jz-hydra-submitit-launcher.git
cd jz-hydra-submitit-launcher
pip install .
pip install --user .
```

## Use
Expand Down Expand Up @@ -49,4 +49,5 @@ hydra-submitit-launch my_app.py dev hydra.launcher.setup=null hydra.launcher.par
## References
- Hydra: https://hydra.cc/docs/intro/
- submitit-launcher: https://hydra.cc/docs/plugins/submitit_launcher/
- submitit: https://github.com/facebookincubator/submitit
- submitit: https://github.com/facebookincubator/submitit
- JZ docs: http://www.idris.fr/ or https://jean-zay-doc.readthedocs.io/en/latest/

0 comments on commit 069a1bd

Please sign in to comment.