Update How to use authored by Federico Izzo's avatar Federico Izzo
...@@ -7,9 +7,7 @@ Inside [DSIP group repo page](https://gitlab.fbk.eu/dsip) click on: ...@@ -7,9 +7,7 @@ Inside [DSIP group repo page](https://gitlab.fbk.eu/dsip) click on:
4. Use template: DL_setup 4. Use template: DL_setup
#### Step 2 - Pin requirements #### Step 2 - Pin requirements
For replicability is important to pin also the version of Python packages inside `requirements.txt`. For replicability is important to pin the version of Python packages inside `requirements.txt` files.
TODO: specify where requirements files are located and maybe think of a solution to automate this process.
#### Step 3 - Write RFC #### Step 3 - Write RFC
Inside the repo there is a .gitlab/issue_templates directory in which are defined: Inside the repo there is a .gitlab/issue_templates directory in which are defined:
...@@ -35,7 +33,7 @@ Add an optimizer in *train* function inside *run.py* file (you can use [configur ...@@ -35,7 +33,7 @@ Add an optimizer in *train* function inside *run.py* file (you can use [configur
#### Step 8 (Optional) - Add scheduler and early_stopper #### Step 8 (Optional) - Add scheduler and early_stopper
Change the value of the scheduler in *train* function inside *run.py* from None to a scheduler you want. If you are not going to use a scheduler leave scheduler to None. Change the value of the scheduler in *train* function inside *run.py* from None to a scheduler you want. If you are not going to use a scheduler leave scheduler to None.
If you want to use [early stopper](Pytorch) you need to write 3 config inside [configuration file](https://gitlab.fbk.eu/dsip/templates/dl_setup/-/wikis/Configuration-file): If you want to use [early stopper](Pytorch) you need to write 2 configs inside [configuration file](https://gitlab.fbk.eu/dsip/templates/dl_setup/-/wikis/Configuration-file):
* in *environment* section set *use_early_stopper* to true; * in *environment* section set *use_early_stopper* to true;
* in *earlystopping* section set *patience* to a value you want. * in *earlystopping* section set *patience* to a value you want.
\ No newline at end of file