From 069a1bdfb22caaf5836f68235f72760d469b1328 Mon Sep 17 00:00:00 2001 From: Zaccharie Ramzi Date: Fri, 14 Jan 2022 14:19:32 +0100 Subject: [PATCH] Update README.md In particular added acronym for JZ, added `--user` for pip install, and added jz docs --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c8958c6..bd3cbb0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 \ No newline at end of file +- submitit: https://github.com/facebookincubator/submitit +- JZ docs: http://www.idris.fr/ or https://jean-zay-doc.readthedocs.io/en/latest/