Skip to content
Snippets Groups Projects
Commit 77e4962e authored by Michael Langguth's avatar Michael Langguth
Browse files

Update README.md

parent 6c1dde5d
No related branches found
No related tags found
No related merge requests found
Pipeline #46445 failed
......@@ -66,17 +66,24 @@ whose order is the following:
### Create additional runscripts ###
In case that you want to perform experiments with varying configuration (e.g. another set of hyperparameters, but still the same input dataset for training), it is convenient to create individual runscripts from the templates.
This can be done with the help of `generate_workflow_runscripts.sh`.
The first argument `<runscript_name>` defines the (relative) path to the template runscript
which should be converted to an executable one. Note that only the suffix of the
template's name must be passed, e.g. `../HPC_scripts/train_era5` in order to create
a runscript for the training substep.
The second argument `<venv_name>` denotes the name of the virtual environment which has to be set up in advanceand which should be used by the runscript.
Additional optional arguments can be passed to control the experimental identifier and to set manually the path to the
Additional optional arguments can be passed to control the experimental identifier and to set manually the realtive path to the
directory where the preprocessed data is stored (used for the training and postprocessing substep). These optional arguments have to follow a naming convention in order to be identified by `generate_workflow_runscripts.sh`.
The experimental identifer can be passed by adding `-exp_id=<id>`while the path to the preprocessed data requires passing of `-exp_dir=<path_to_dir>`. Note, that the default value `exp1` is used as experimental identifier if the `-exp_id=<id>` is omitted.
The experimental identifer can be passed by adding `-exp_id=<id>`while the path to the preprocessed data requires passing of `-exp_dir=<relative_path_to_dir>`. Note, that the default value `exp1` is used as experimental identifier if the `-exp_id=<id>` is omitted.
``` bash
./generate_workflow_runscripts.sh <runscript_name> <venv_name> [-exp_id=<id>] [-exp_dir=<relative_dir_to_path>]
```
*Specific example:*
``` bash
./generate_workflow_runscripts.sh <runscript_name> <venv_name> [-exp_id=<id>] [-exp_dir=<dir_to_path>]
./generate_workflow_runscripts.sh train_era5 venv_juwels -exp_id=exp_test -exp_dir=era5-Y2010toY2222M01to12-160x128-2970N1500W-T2_MSL_gph500
```
### Output folder structure and naming convention
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment