Added Hydra support as an option in ArgParse UI (#302)

* Introducing Hydra in Code-generator

* Made some bug fixes and CI changes

* Add changes to colab functions for Hydra

* fix bug in colab.js

* fix bugs in utils.py

* Removed unnecessay code in setup_config for hydra

* changed colab function behaviour when argparser = hydra

* fixed colab output

* changed the argparser due to undefined output

* final change, removing debug output

* Fix bugs for Hydra output-dir and overiding the config files

Author: guptaaryan16

.github/workflows/ci.yml

@@ -84,13 +84,17 @@ jobs:
       - run: sh ./scripts/run_tests.sh unzip
       - run: pnpm dist_lint ${{ matrix.template }} argparse
       - run: pnpm dist_lint ${{ matrix.template }} fire
+      - run: pnpm dist_lint ${{ matrix.template }} hydra
 
       - name: 'Run ${{ matrix.template }} ${{ matrix.test }}'
         run: sh ./scripts/run_tests.sh ${{ matrix.test }} ${{ matrix.template }} argparse
 
       - name: 'Run ${{ matrix.template }} ${{ matrix.test }} - Python Fire'
         run: sh ./scripts/run_tests.sh ${{ matrix.test }} ${{ matrix.template }} fire
 
+      - name: 'Run ${{ matrix.template }} ${{ matrix.test }} - Hydra'
+        run: sh ./scripts/run_tests.sh ${{ matrix.test }} ${{ matrix.template }} hydra
+
   lint:
     runs-on: ubuntu-latest
     steps:

__tests__/text-classification.spec.js

@@ -24,7 +24,7 @@ afterEach(async () => {
   await context.close()
 })
 
-const parser = ['argparse', 'fire']
+const parser = ['argparse', 'fire', 'hydra']
 for (const name of parser) {
   test(`text-classification simple ${name}`, async () => {
     await page.selectOption('select', 'template-text-classification')

__tests__/vision-classification.spec.js

@@ -24,7 +24,7 @@ afterEach(async () => {
   await context.close()
 })
 
-const parser = ['argparse', 'fire']
+const parser = ['argparse', 'fire', 'hydra']
 for (const name of parser) {
   test(`vision-classification simple ${name}`, async () => {
     await page.selectOption('select', 'template-vision-classification')

__tests__/vision-dcgan.spec.js

@@ -24,7 +24,7 @@ afterEach(async () => {
   await context.close()
 })
 
-const parser = ['argparse', 'fire']
+const parser = ['argparse', 'fire', 'hydra']
 for (const name of parser) {
   test(`vision-dcgan simple ${name}`, async () => {
     await page.selectOption('select', 'template-vision-dcgan')

__tests__/vision-segmentation.spec.js

@@ -24,7 +24,7 @@ afterEach(async () => {
   await context.close()
 })
 
-const parser = ['argparse', 'fire']
+const parser = ['argparse', 'fire', 'hydra']
 for (const name of parser) {
   test(`vision-segmentation simple ${name}`, async () => {
     await page.selectOption('select', 'template-vision-segmentation')

functions/colab.js

@@ -48,7 +48,14 @@ exports.handler = async function (event, _) {
     '!pip install -r requirements.txt'
   ]
 
-  const execution_nb_commands = ['!python main.py config.yaml']
+  const argparser = data.argparser
+  const execution_nb_commands = [
+    `!python main.py ${
+      argparser === 'hydra'
+        ? '#--config-dir=/content/ --config-name=config.yaml'
+        : 'config.yaml'
+    }`
+  ]
 
   let nb_cells = [
     create_nb_cell(md_cell, 'markdown'),

scripts/requirements.txt

@@ -9,4 +9,5 @@ transformers
 datasets
 tensorboard
 fire 
+hydra-core
 omegaconf

scripts/run_code_style.sh

@@ -17,6 +17,11 @@ if [ $1 == "dist_lint" ]; then
         ls ./dist-tests/$TEMP-all-fire/main.py
     fi
 
+    # for hydra
+    if [ "$ARGPARSE" == "hydra" ]; then 
+        ls ./dist-tests/$TEMP-all-hydra/main.py
+    fi
+
     # Comment dist-tests in .gitignore to make black running on ./dist-tests folder
     sed -i "s/dist-tests/# dist-tests/g" .gitignore
 

scripts/run_tests.sh

@@ -92,6 +92,46 @@ run_spawn_fire() {
   done
 }
 
+# Hydra test functions
+
+run_simple_hydra() {
+  for dir in $(find ./dist-tests/$1-simple-hydra -type d)
+  do
+    cd $dir
+    python main.py --config-dir=../../src/tests/ci-configs --config-name=$1-simple.yaml 
+    cd $CWD
+  done
+}
+
+run_all_hydra() {
+  for dir in $(find ./dist-tests/$1-all-hydra -type d)
+  do
+    cd $dir
+    pytest -vra --color=yes --tb=short test_*.py
+    python main.py --config-dir=../../src/tests/ci-configs --config-name=$1-all.yaml
+    cd $CWD
+  done
+}
+
+run_launch_hydra() {
+  for dir in $(find ./dist-tests/$1-launch-hydra -type d)
+  do
+    cd $dir
+    torchrun --nproc_per_node 2 main.py --config-dir=../../src/tests/ci-configs --config-name=$1-launch.yaml ++backend='gloo'
+    cd $CWD
+  done
+}
+
+run_spawn_hydra() {
+  for dir in $(find ./dist-tests/$1-spawn-hydra -type d)
+  do
+    cd $dir
+    python main.py --config-dir=../../src/tests/ci-configs --config-name=$1-spawn.yaml ++backend='gloo'
+    cd $CWD
+  done
+}
+
+
 
 if [ $1 = "unzip" ]; then
   unzip_all
@@ -100,23 +140,31 @@ elif [ $1 = "simple" ]; then
     run_simple $2
   elif [ $3 = "fire" ]; then 
     run_simple_fire $2
-  fi
+  elif [ $3 = "hydra" ]; then 
+    run_simple_hydra $2
+  fi  
 elif [ $1 = "all" ]; then
   if [ $3 = "argparse" ]; then 
     run_all $2
   elif [ $3 = "fire" ]; then 
     run_all_fire $2
+  elif [ $3 = "hydra" ]; then 
+    run_all_hydra $2
   fi
 elif [ $1 = "launch" ]; then
   if [ $3 = "argparse" ]; then 
     run_launch $2
   elif [ $3 = "fire" ]; then 
     run_launch_fire $2
+  elif [ $3 = "hydra" ]; then 
+    run_launch_hydra $2
   fi
 elif [ $1 = "spawn" ]; then
   if [ $3 = "argparse" ]; then 
     run_spawn $2
   elif [ $3 = "fire" ]; then 
     run_spawn_fire $2
+  elif [ $3 = "hydra" ]; then 
+    run_spawn_hydra $2
   fi
 fi

src/components/NavColab.vue

@@ -93,7 +93,8 @@ export default {
             body: JSON.stringify({
               code: store.code,
               template: store.config.template,
-              config: store.config
+              config: store.config,
+              argparser: store.config.argparser
             })
           })
           // response body is plain text

src/components/TabTraining.vue

@@ -10,17 +10,25 @@
 
     <ul>
       <li>
-        <a href="https://docs.python.org/3/library/argparse.html">Argparse</a> -
-        is a python built-in tool to handle command-line arguments
+        <a href="https://docs.python.org/3/library/argparse.html" id="arg"
+          >Argparse</a
+        >
+        - is a python built-in tool to handle command-line arguments
       </li>
       <li>
         <a
           href="https://github.com/google/python-fire/blob/master/docs/guide.md"
+          id="arg"
           >Python Fire</a
         >
         - transforms Python functions into user-friendly command-line tools,
         ideal for DL experimentation.
       </li>
+      <li>
+        <a href="https://hydra.cc" id="arg">Hydra</a>
+        - Simplifying deep learning experiments through flexible configuration
+        management
+      </li>
     </ul>
     <FormSelect
       :label="argparser.description"
@@ -134,4 +142,8 @@ function saveDistributed(key, value) {
 .training {
   margin-bottom: 0;
 }
+
+#arg {
+  font-weight: bold;
+}
 </style>

src/metadata/metadata.json

@@ -4,7 +4,7 @@
       "name": "argparser",
       "type": "array",
       "description": "Select the argument parser for training",
-      "options": ["argparse", "fire"],
+      "options": ["argparse", "fire", "hydra"],
       "default": "argparse"
     },
     "deterministic": {

src/templates/template-common/README.md

@@ -68,11 +68,16 @@ torchrun \
   --node_rank 0 \
   --master_addr #:::= it.master_addr :::# \
   --master_port #:::= it.master_port :::# \
-  main.py config.yaml --backend #:::= it.backend :::# \
   #::: if ((it.argparser == 'fire')) { :::#
+  main.py config.yaml --backend #:::= it.backend :::# \
   [--override_arg=value]
-
+  #::: } else if ((it.argparser == 'hydra')){ :::#
+  main.py  --config-dir=[dir-path] \
+  --config-name=[config-name] ++backend= #:::= it.backend :::# override_arg=[value]
+  #::: } else { :::#
+  main.py config.yaml --backend #:::= it.backend :::#
   #::: } :::#
+
 ```
 
 - Execute on worker nodes
@@ -84,10 +89,15 @@ torchrun \
   --node_rank <node_rank> \
   --master_addr #:::= it.master_addr :::# \
   --master_port #:::= it.master_port :::# \
-  main.py config.yaml --backend #:::= it.backend :::# \
   #::: if ((it.argparser == 'fire')) { :::#
+  main.py config.yaml --backend #:::= it.backend :::# \
   [--override_arg=value]
-
+  #::: } else if ((it.argparser == 'hydra')){ :::#
+  main.py --config-dir=[dir-path] \
+  --config-name=[config-name] ++backend= #:::= it.backend :::# \
+  override_arg=[value]
+  #::: } else { :::#
+  main.py config.yaml --backend #:::= it.backend :::#
   #::: } :::#
 ```
 
@@ -98,10 +108,15 @@ torchrun \
 ```sh
 torchrun \
   --nproc_per_node #:::= it.nproc_per_node :::# \
-  main.py config.yaml --backend #:::= it.backend :::# \
   #::: if ((it.argparser == 'fire')) { :::#
+  main.py config.yaml --backend #:::= it.backend :::# \
   [--override_arg=value]
-
+  #::: } else if ((it.argparser == 'hydra')){ :::#
+  main.py --config-dir=[dir-path] \
+  --config-name=[config-name] ++backend= #:::= it.backend :::# \
+  override_arg=[value]
+  #::: } else { :::#
+  main.py config.yaml --backend #:::= it.backend :::#
   #::: } :::#
 ```
 
@@ -128,7 +143,9 @@ master_port: #:::= it.master_port :::#
 
 ```sh
 #::: if ((it.argparser == 'fire')) { :::#
-python main.py config.yaml --backend #:::= it.backend :::# [--override_arg=value]
+python main.py config.yaml --backend #:::= it.backend :::# --override_arg=[value]
+#::: } else if ((it.argparser == 'hydra')){ :::#
+python main.py --config-dir=[dir-path] --config-name=[config-name] ++backend= #:::= it.backend :::# override_arg=[value]
 #::: } else { :::#
 python main.py config.yaml --backend #:::= it.backend :::#
 #::: } :::#
@@ -149,6 +166,8 @@ master_port: #:::= it.master_port :::#
 
 #::: if ((it.argparser == 'fire')) { :::#
 python main.py config.yaml --backend #:::= it.backend :::# [--override_arg=value]
+#::: } else if ((it.argparser == 'hydra')){ :::#
+python main.py --config-dir=[dir-path] --config-name=[config-name] ++backend=#:::= it.backend :::# override_arg=[value]
 #::: } else { :::#
 python main.py config.yaml --backend #:::= it.backend :::#
 #::: } :::#
@@ -166,6 +185,10 @@ nproc_per_node: #:::= it.nproc_per_node :::#
 ```sh
 #::: if ((it.argparser == 'fire')) { :::#
 python main.py config.yaml --backend #:::= it.backend :::#  [--override_arg=value]
+
+#::: } else if ((it.argparser == 'hydra')) { :::#
+python main.py --config-dir=[dir-path] --config-name=[config-name] override_arg=[value]
+
 #::: } else { :::#
 python main.py config.yaml --backend #:::= it.backend :::#
 #::: } :::#
@@ -182,8 +205,13 @@ python main.py config.yaml --backend #:::= it.backend :::#
 ```sh
 #::: if ((it.argparser == 'fire')) { :::#
 python main.py config.yaml [--override_arg=value]
+
+#::: } else if ((it.argparser == 'hydra')) { :::#
+python main.py --config-dir=[dir-path] --config-name=[config-name] override_arg=[value]
+
 #::: } else { :::#
 python main.py config.yaml
+
 #::: } :::#
 ```
 
@@ -193,4 +221,8 @@ python main.py config.yaml
 
 Note: We use Python-Fire as the default argument parser here. For more information refer the [docs](https://github.com/google/python-fire/blob/master/docs/guide.md)
 
+#::: } else if ((it.argparser == 'hydra')) { :::#
+
+Note: We use Hydra with [OmegaConfig](https://omegaconf.readthedocs.io/en/2.3_branch/) as the default argument parser here. For more information check the [Hydra docs](https://hydra.cc)
+
 #::: } :::#

src/templates/template-common/main.py

@@ -6,10 +6,17 @@ def main(config_path, backend=None, **kwargs):
     config = setup_config(config_path, backend, **kwargs)
 
 
+#::: } else if ((it.argparser == 'hydra')) { :::#
+@hydra.main(version_base=None, config_path=".", config_name="config")
+def main(cfg: DictConfig):
+    config = setup_config(cfg)
+
+
 #::: } else { :::#
 def main():
     config = setup_config()
     #::: } :::#
+
     #::: if (it.dist === 'spawn') { :::#
     #::: if (it.nproc_per_node && it.nnodes > 1 && it.master_addr && it.master_port) { :::#
     spawn_kwargs = {
@@ -33,6 +40,14 @@ def main():
 if __name__ == "__main__":
     #::: if ((it.argparser == 'fire')) { :::#
     fire.Fire(main)
+
+    #::: } else if ((it.argparser == 'hydra')){ :::#
+    sys.argv.append("hydra.run.dir=.")
+    sys.argv.append("hydra.output_subdir=null")
+    sys.argv.append("hydra/job_logging=stdout")
+    main()
+
     #::: } else { :::#
     main()
+
     #::: } :::#

src/templates/template-common/requirements.txt

@@ -6,6 +6,9 @@ omegaconf
 #::: if ((it.argparser == 'fire')) { :::#
 #:::= it.argparser :::#
 
+#::: } else if ((it.argparser == 'hydra')) { :::#
+#:::= it.argparser + '-core'  :::#
+
 #::: } :::#
 
 #::: if (['neptune', 'polyaxon'].includes(it.logger)) { :::#