From 949d1945d36dbe51d6111dd80a11a1b22bae1cc9 Mon Sep 17 00:00:00 2001 From: andres <andresfp14@gmail.com> Date: Mon, 29 Jan 2024 12:11:55 +0100 Subject: [PATCH] adding execution comments to readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 4f0f104..80015f4 100644 --- a/README.md +++ b/README.md @@ -60,4 +60,23 @@ pip freeze > ./env_setup/requirements2.txt deactivate ``` +## 3) Run code +Now, with the environment setup, we can run the needed code from the base directory. We recommend using the "fire" library to avoid argparsers and maintain cleaner code. + +```bash +############################### +# Getting help with fire +############################### +python 01_train_model.py main --help + +############################### +# Executing with default arguments +############################### +python 01_train_model.py main + +############################### +# Executing and changing an argument +############################### +python 01_train_model.py main --seed=7 +``` \ No newline at end of file -- GitLab