(feat): create iowa_forecast/models_configs.pymodule to handle ARIM…

…A and ARIMA_PLUS_XREG. models configuration.

* `iowa_forecast/ml_train.py`: create `include_test_on_model_train` and `include_test_on_arima_model_train` functions to determine whether or not 'test data' is used to train the ARIMA and ARIMA_PLUS_XREG models.

* `.github/workflows/test-code.yml`: fix the workflow.

* `pyproject.toml`: include missing dependencies.

* `requirements.txt`: include missing dependencies.

Unit tests
----------

* `tests/test_models_configs.py`: create unit-tests for `models_configs` module.

* `tests/test_utils.py`: create unit-tests for `utils` module.

Minor Changes
---------------

* `notebooks/Walkthrough.ipynb`: minor fixes to the grammar of some markdown cells.

* `docs/`: remove unused .rst files.

.github/workflows/test-code.yml

@@ -9,21 +9,29 @@ on:
     branches:
       - main
       - dev
+  workflow_dispatch:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.9'
 
+    - name: Cache dependencies
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -32,10 +40,16 @@ jobs:
 
     - name: Run tests
       run: |
-        pytest ./tests
+        pytest --cov=iowa_forecast --cov-report=xml --cov-report=html tests/
 
     - name: Upload coverage report
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: coverage-report
         path: ./htmlcov/
+
+    - name: Upload coverage report XML
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-report-xml
+        path: coverage.xml

.gitignore

@@ -160,3 +160,4 @@ cython_debug/
 #.idea/
 *.json
 /.idea
+*.lock

Dockerfile

@@ -25,7 +25,7 @@ EXPOSE 8080
 # Define environment variables
 
 # Project ID where the tables and models will be saved to inside BigQuery
-ENV PROJECT_ID "iowa-liquor-sales-forecast-v2"
+ENV PROJECT_ID "iowa-liquor-sales-forecast-v4"
 
 # Dataset name where the tables and models will be stored to
 ENV DATASET_NAME "bqmlforecast"
@@ -35,4 +35,4 @@ ENV GOOGLE_APPLICATION_CREDENTIALS="/gcloud/application_default_credentials.json
 
 
 # Run app.py when the container launches
-ENTRYPOINT ["python", "pipelines/execute_load_data.py"]
+ENTRYPOINT ["python", "pipelines/train_model_and_forecast_sales.py"]

docs/api_reference/index.rst

@@ -1,5 +1,5 @@
 API Reference
-==============
+=============
 
 This page gives an overview of all public pandas objects, functions and methods.
 All functions exposed in `iowa_forecast.*` namespace are public.
@@ -12,14 +12,17 @@ The `iowa_forecast` package contains the following modules:
 
 * `iowa_forecast.ml_train`: BigQuery Model Training and Execution Module.
 
+* `iowa_forecast.models_configs`: Classes for managing and validating
+  configuration parameters
+
 * `iowa_forecast.plots`: Time Series Plotting and Date Handling Module.
 
 * `iowa_forecast.utils`: General utility functions Module.
 
 iowa\_forecast
--------------
+--------------
 
 .. toctree::
    :maxdepth: 2
 
-   iowa_forecast/index
+   iowa_forecast/index

docs/api_reference/iowa_forecast/index.rst

@@ -8,5 +8,6 @@ iowa\_forecast
    load_data
    ml_eval
    ml_train
+   models_configs
    plots
    utils

docs/api_reference/iowa_forecast/models_configs.rst

@@ -0,0 +1,7 @@
+models\_configs
+---------------
+
+.. automodule:: iowa_forecast.models_configs
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/docs/html/_modules/index.html

@@ -208,6 +208,7 @@
 <li class="toctree-l3"><a class="reference internal" href="../api_reference/iowa_forecast/load_data.html">load_data</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api_reference/iowa_forecast/ml_eval.html">ml_eval</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api_reference/iowa_forecast/ml_train.html">ml_train</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../api_reference/iowa_forecast/models_configs.html">models_configs</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api_reference/iowa_forecast/plots.html">plots</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../api_reference/iowa_forecast/utils.html">utils</a></li>
 </ul>
@@ -248,11 +249,7 @@
         </div>
         <article role="main" id="furo-main-content">
           <h1>All modules for which code is available</h1>
-<ul><li><a href="iowa_forecast/load_data.html">iowa_forecast.load_data</a></li>
-<li><a href="iowa_forecast/ml_eval.html">iowa_forecast.ml_eval</a></li>
-<li><a href="iowa_forecast/ml_train.html">iowa_forecast.ml_train</a></li>
-<li><a href="iowa_forecast/plots.html">iowa_forecast.plots</a></li>
-<li><a href="iowa_forecast/utils.html">iowa_forecast.utils</a></li>
+<ul><li><a href="iowa_forecast/models_configs.html">iowa_forecast.models_configs</a></li>
 </ul>
         </article>
       </div>

docs/docs/html/_modules/iowa_forecast/load_data.html

@@ -10,6 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=4c969af8" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=302659d7" />
+    <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=44c88a81" />
 
 
 
@@ -199,7 +200,21 @@
 <div id="searchbox"></div><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../iowa_forecast.html">iowa_forecast package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
+</ul>
+<ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="../../api_reference/index.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="../../api_reference/iowa_forecast/index.html">iowa_forecast</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of iowa_forecast</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/load_data.html">load_data</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/ml_eval.html">ml_eval</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/ml_train.html">ml_train</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/models_configs.html">models_configs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/plots.html">plots</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/utils.html">utils</a></li>
+</ul>
+</li>
+</ul>
+</li>
 </ul>
 
 </div>

docs/docs/html/_modules/iowa_forecast/ml_train.html

@@ -10,6 +10,7 @@
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=354aac6f" />
     <link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=4c969af8" />
     <link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=302659d7" />
+    <link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=44c88a81" />
 
 
 
@@ -199,7 +200,21 @@
 <div id="searchbox"></div><div class="sidebar-tree">
   <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../../iowa_forecast.html">iowa_forecast package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
+</ul>
+<ul>
+<li class="toctree-l1 has-children"><a class="reference internal" href="../../api_reference/index.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l2 has-children"><a class="reference internal" href="../../api_reference/iowa_forecast/index.html">iowa_forecast</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of iowa_forecast</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/load_data.html">load_data</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/ml_eval.html">ml_eval</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/ml_train.html">ml_train</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/models_configs.html">models_configs</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/plots.html">plots</a></li>
+<li class="toctree-l3"><a class="reference internal" href="../../api_reference/iowa_forecast/utils.html">utils</a></li>
+</ul>
+</li>
+</ul>
+</li>
 </ul>
 
 </div>