adding catalogs to README.md

.github/workflows/update_catalogs.yml

@@ -0,0 +1,42 @@
+name: Update Model Catalogs
+on:
+  push:
+    branches:
+      - create_pgm_catalog_01 # for testing on this branch
+      - main
+      - development
+    paths:
+      - models/*/configs/config_*.py
+      - ensembles/*/configs/config_*.py
+  workflow_dispatch: # for triggering manually
+
+jobs:
+  check-new-folder:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Generate catalog if models directory has changed
+        run: |
+          python create_catalogs.py  
+          if [ $? -ne 0 ]; then
+            echo "Generating catalogs failed."
+            exit 1
+          fi
+          echo "Model catalog is updated."           
+          git status
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "GitHub Actions"
+          git config --global user.email "[email protected]"
+
+      - name: Commit and Push Changes
+        run: |
+          git add README.md
+          git commit -m "Automated changes by GitHub Actions" || echo "Nothing to commit"
+          git push https://${{ secrets.GITHUB_TOKEN }}@github.com/views-platform/views-models.git
+

README.md

@@ -1 +1,57 @@
-# views-models
+# VIEWS Models
+
+## CM Model Catalog
+<!-- CM_TABLE_START -->
+| Model Name | Algorithm | Target | Input Features | Non-default Hyperparameters | Forecasting Type | Implementation Status | Implementation Date | Author |
+| ---------- | --------- | ------ | -------------- | --------------------------- | ---------------- | --------------------- | ------------------- | ------ |
+| bad_blood | LightGBMModel | ln_ged_sb_dep | - [fatalities003_pgm_natsoc](https://github.com/prio-data/views_pipeline/blob/main/models/bad_blood/configs/config_queryset.py) | - [hyperparameters bad_blood](https://github.com/prio-data/views_pipeline/blob/main/models/bad_blood/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| blank_space | HurdleModel | ln_ged_sb_dep | - [fatalities003_pgm_natsoc](https://github.com/prio-data/views_pipeline/blob/main/models/blank_space/configs/config_queryset.py) | - [hyperparameters blank_space](https://github.com/prio-data/views_pipeline/blob/main/models/blank_space/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| caring_fish | XGBModel | ln_ged_sb_dep | - [fatalities003_pgm_conflict_history](https://github.com/prio-data/views_pipeline/blob/main/models/caring_fish/configs/config_queryset.py) | - [hyperparameters caring_fish](https://github.com/prio-data/views_pipeline/blob/main/models/caring_fish/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| chunky_cat | LightGBMModel | ln_ged_sb_dep | - [fatalities003_pgm_conflictlong](https://github.com/prio-data/views_pipeline/blob/main/models/chunky_cat/configs/config_queryset.py) | - [hyperparameters chunky_cat](https://github.com/prio-data/views_pipeline/blob/main/models/chunky_cat/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| dark_paradise | HurdleModel | ln_ged_sb_dep | - [fatalities003_pgm_conflictlong](https://github.com/prio-data/views_pipeline/blob/main/models/dark_paradise/configs/config_queryset.py) | - [hyperparameters dark_paradise](https://github.com/prio-data/views_pipeline/blob/main/models/dark_paradise/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| invisible_string | LightGBMModel | ln_ged_sb_dep | - [fatalities003_pgm_broad](https://github.com/prio-data/views_pipeline/blob/main/models/invisible_string/configs/config_queryset.py) | - [hyperparameters invisible_string](https://github.com/prio-data/views_pipeline/blob/main/models/invisible_string/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| lavender_haze | HurdleModel | ln_ged_sb_dep | - [fatalities003_pgm_broad](https://github.com/prio-data/views_pipeline/blob/main/models/lavender_haze/configs/config_queryset.py) | - [hyperparameters lavender_haze](https://github.com/prio-data/views_pipeline/blob/main/models/lavender_haze/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| midnight_rain | LightGBMModel | ln_ged_sb_dep | - [fatalities003_pgm_escwa_drought](https://github.com/prio-data/views_pipeline/blob/main/models/midnight_rain/configs/config_queryset.py) | - [hyperparameters midnight_rain](https://github.com/prio-data/views_pipeline/blob/main/models/midnight_rain/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| old_money | HurdleModel | ln_ged_sb_dep | - [fatalities003_pgm_escwa_drought](https://github.com/prio-data/views_pipeline/blob/main/models/old_money/configs/config_queryset.py) | - [hyperparameters old_money](https://github.com/prio-data/views_pipeline/blob/main/models/old_money/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| orange_pasta | LightGBMModel | ln_ged_sb_dep | - [fatalities003_pgm_baseline](https://github.com/prio-data/views_pipeline/blob/main/models/orange_pasta/configs/config_queryset.py) | - [hyperparameters orange_pasta](https://github.com/prio-data/views_pipeline/blob/main/models/orange_pasta/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| purple_alien | HydraNet | ln_sb_best, ln_ns_best, ln_os_best, ln_sb_best_binarized, ln_ns_best_binarized, ln_os_best_binarized | - [escwa001_cflong](https://github.com/prio-data/views_pipeline/blob/main/models/purple_alien/configs/config_queryset.py) | - [hyperparameters purple_alien](https://github.com/prio-data/views_pipeline/blob/main/models/purple_alien/configs/config_hyperparameters.py) | None | shadow | NA | Simon |
+| wildest_dream | HurdleModel | ln_ged_sb_dep | - [fatalities003_pgm_conflict_sptime_dist](https://github.com/prio-data/views_pipeline/blob/main/models/wildest_dream/configs/config_queryset.py) | - [hyperparameters wildest_dream](https://github.com/prio-data/views_pipeline/blob/main/models/wildest_dream/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| yellow_pikachu | HurdleModel | ln_ged_sb_dep | - [fatalities003_pgm_conflict_treelag](https://github.com/prio-data/views_pipeline/blob/main/models/yellow_pikachu/configs/config_queryset.py) | - [hyperparameters yellow_pikachu](https://github.com/prio-data/views_pipeline/blob/main/models/yellow_pikachu/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+
+<!-- CM_TABLE_END -->
+
+## PGM Model Catalog
+<!-- PGM_TABLE_START -->
+| Model Name | Algorithm | Target | Input Features | Non-default Hyperparameters | Forecasting Type | Implementation Status | Implementation Date | Author |
+| ---------- | --------- | ------ | -------------- | --------------------------- | ---------------- | --------------------- | ------------------- | ------ |
+| bittersweet_symphony | XGBModel | ln_ged_sb_dep | - [ fatalities003_all_features](https://github.com/prio-data/views_pipeline/blob/main/models/bittersweet_symphony/configs/config_queryset.py) | - [hyperparameters bittersweet_symphony](https://github.com/prio-data/views_pipeline/blob/main/models/bittersweet_symphony/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| brown_cheese | RandomForestModel | ln_ged_sb_dep | - [fatalities003_baseline](https://github.com/prio-data/views_pipeline/blob/main/models/brown_cheese/configs/config_queryset.py) | - [hyperparameters brown_cheese](https://github.com/prio-data/views_pipeline/blob/main/models/brown_cheese/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| car_radio | XGBModel | ln_ged_sb_dep | - [fatalities003_topics](https://github.com/prio-data/views_pipeline/blob/main/models/car_radio/configs/config_queryset.py) | - [hyperparameters car_radio](https://github.com/prio-data/views_pipeline/blob/main/models/car_radio/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| counting_stars | XGBModel | ln_ged_sb_dep | - [fatalities003_conflict_history_long](https://github.com/prio-data/views_pipeline/blob/main/models/counting_stars/configs/config_queryset.py) | - [hyperparameters counting_stars](https://github.com/prio-data/views_pipeline/blob/main/models/counting_stars/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| demon_days | RandomForestModel | ln_ged_sb_dep | - [fatalities003_faostat](https://github.com/prio-data/views_pipeline/blob/main/models/demon_days/configs/config_queryset.py) | - [hyperparameters demon_days](https://github.com/prio-data/views_pipeline/blob/main/models/demon_days/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| electric_relaxation | RandomForestModel | ged_sb_dep | - [escwa001_cflong](https://github.com/prio-data/views_pipeline/blob/main/models/electric_relaxation/configs/config_queryset.py) | - [hyperparameters electric_relaxation](https://github.com/prio-data/views_pipeline/blob/main/models/electric_relaxation/configs/config_hyperparameters.py) | None | shadow | NA | Sara |
+| fast_car | HurdleModel | ln_ged_sb_dep | - [fatalities003_vdem_short](https://github.com/prio-data/views_pipeline/blob/main/models/fast_car/configs/config_queryset.py) | - [hyperparameters fast_car](https://github.com/prio-data/views_pipeline/blob/main/models/fast_car/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| fluorescent_adolescent | HurdleModel | ln_ged_sb_dep | - [fatalities003_joint_narrow](https://github.com/prio-data/views_pipeline/blob/main/models/fluorescent_adolescent/configs/config_queryset.py) | - [hyperparameters fluorescent_adolescent](https://github.com/prio-data/views_pipeline/blob/main/models/fluorescent_adolescent/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| good_riddance | RandomForestModel | ln_ged_sb_dep | - [fatalities003_joint_narrow](https://github.com/prio-data/views_pipeline/blob/main/models/good_riddance/configs/config_queryset.py) | - [hyperparameters good_riddance](https://github.com/prio-data/views_pipeline/blob/main/models/good_riddance/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| green_squirrel | HurdleModel | ln_ged_sb_dep | - [fatalities003_joint_broad](https://github.com/prio-data/views_pipeline/blob/main/models/green_squirrel/configs/config_queryset.py) | - [hyperparameters green_squirrel](https://github.com/prio-data/views_pipeline/blob/main/models/green_squirrel/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| heavy_rotation | RandomForestModel | ln_ged_sb_dep | - [fatalities003_joint_broad](https://github.com/prio-data/views_pipeline/blob/main/models/heavy_rotation/configs/config_queryset.py) | - [hyperparameters heavy_rotation](https://github.com/prio-data/views_pipeline/blob/main/models/heavy_rotation/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| high_hopes | HurdleModel | ln_ged_sb_dep | - [fatalities003_conflict_history](https://github.com/prio-data/views_pipeline/blob/main/models/high_hopes/configs/config_queryset.py) | - [hyperparameters high_hopes](https://github.com/prio-data/views_pipeline/blob/main/models/high_hopes/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| little_lies | HurdleModel | ln_ged_sb_dep | - [fatalities003_joint_narrow](https://github.com/prio-data/views_pipeline/blob/main/models/little_lies/configs/config_queryset.py) | - [hyperparameters little_lies](https://github.com/prio-data/views_pipeline/blob/main/models/little_lies/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| national_anthem | RandomForestModel | ln_ged_sb_dep | - [fatalities003_wdi_short](https://github.com/prio-data/views_pipeline/blob/main/models/national_anthem/configs/config_queryset.py) | - [hyperparameters national_anthem](https://github.com/prio-data/views_pipeline/blob/main/models/national_anthem/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| ominous_ox | RandomForestModel | ln_ged_sb_dep | - [fatalities003_conflict_history](https://github.com/prio-data/views_pipeline/blob/main/models/ominous_ox/configs/config_queryset.py) | - [hyperparameters ominous_ox](https://github.com/prio-data/views_pipeline/blob/main/models/ominous_ox/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| plastic_beach | RandomForestModel | ln_ged_sb_dep | - [fatalities003_aquastat](https://github.com/prio-data/views_pipeline/blob/main/models/plastic_beach/configs/config_queryset.py) | - [hyperparameters plastic_beach](https://github.com/prio-data/views_pipeline/blob/main/models/plastic_beach/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| popular_monster | RandomForestModel | ln_ged_sb_dep | - [fatalities003_topics](https://github.com/prio-data/views_pipeline/blob/main/models/popular_monster/configs/config_queryset.py) | - [hyperparameters popular_monster](https://github.com/prio-data/views_pipeline/blob/main/models/popular_monster/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| teen_spirit | RandomForestModel | ln_ged_sb_dep | - [fatalities003_faoprices](https://github.com/prio-data/views_pipeline/blob/main/models/teen_spirit/configs/config_queryset.py) | - [hyperparameters teen_spirit](https://github.com/prio-data/views_pipeline/blob/main/models/teen_spirit/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+| twin_flame | HurdleModel | ln_ged_sb_dep | - [fatalities003_topics](https://github.com/prio-data/views_pipeline/blob/main/models/twin_flame/configs/config_queryset.py) | - [hyperparameters twin_flame](https://github.com/prio-data/views_pipeline/blob/main/models/twin_flame/configs/config_hyperparameters.py) | None | shadow | NA | Borbála |
+| yellow_submarine | RandomForestModel | ln_ged_sb_dep | - [fatalities003_imfweo](https://github.com/prio-data/views_pipeline/blob/main/models/yellow_submarine/configs/config_queryset.py) | - [hyperparameters yellow_submarine](https://github.com/prio-data/views_pipeline/blob/main/models/yellow_submarine/configs/config_hyperparameters.py) | None | shadow | NA | Marina |
+
+<!-- PGM_TABLE_END -->
+
+## Ensemble Catalog
+<!-- ENSEMBLE_TABLE_START -->
+| Model Name | Algorithm | Target | Input Features | Non-default Hyperparameters | Forecasting Type | Implementation Status | Implementation Date | Author |
+| ---------- | --------- | ------ | -------------- | --------------------------- | ---------------- | --------------------- | ------------------- | ------ |
+| cruel_summer |  | ln_ged_sb_dep | None | - [hyperparameters cruel_summer](https://github.com/prio-data/views_pipeline/blob/main/ensembles/cruel_summer/configs/config_hyperparameters.py) | None | shadow | NA | Xiaolong |
+| white_mustang |  | ln_ged_sb_dep | None | - [hyperparameters white_mustang](https://github.com/prio-data/views_pipeline/blob/main/ensembles/white_mustang/configs/config_hyperparameters.py) | None | deployed | NA | Xiaolong |
+
+<!-- ENSEMBLE_TABLE_END -->