deploy: 7a4d0c3

erik-ingwersen-ey · Aug 9, 2024 · 95c0989 · 95c0989
1 parent be07430
commit 95c0989
Show file tree

Hide file tree

Showing 13 changed files with 13,016 additions and 140 deletions.
diff --git a/.doctrees/_api_reference.doctree b/.doctrees/_api_reference.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/_api_reference.html b/_api_reference.html
@@ -1,17 +1,16 @@
 <!doctype html>
-<html class="no-js" lang="en" data-content_root="">
+<html class="no-js">
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
-    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
-<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
+    <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
-    <!-- Generated with Sphinx 7.1.2 and Furo 2024.08.06 -->
+    <meta name="generator" content="sphinx-4.4.0, furo 2022.09.29"/>
         <title>API Reference - Iowa Liquor Sales Forecast 0.0.1 documentation</title>
-      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
-    <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" />
+      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
+    <link rel="stylesheet" type="text/css" href="_static/tabs.css" />
+    <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
+    <link rel="stylesheet" type="text/css" href="_static/custom.css" />
 
 
 
@@ -70,7 +69,7 @@
   <symbol id="svg-sun" viewBox="0 0 24 24">
     <title>Light mode</title>
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
-      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
       <circle cx="12" cy="12" r="5"></circle>
       <line x1="12" y1="1" x2="12" y2="3"></line>
       <line x1="12" y1="21" x2="12" y2="23"></line>
@@ -85,63 +84,22 @@
   <symbol id="svg-moon" viewBox="0 0 24 24">
     <title>Dark mode</title>
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
-      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
       <path stroke="none" d="M0 0h24v24H0z" fill="none" />
       <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
     </svg>
   </symbol>
-  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
-    <title>Auto light/dark, in light mode</title>
+  <symbol id="svg-sun-half" viewBox="0 0 24 24">
+    <title>Auto light/dark mode</title>
     <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
-      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
-      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
-      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
-      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
-      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
-      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
-      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
-      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
-      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
-      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
-      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
-      <circle cx="14.5" cy="9.55" r="3.6"/>
-    </svg>
-  </symbol>
-  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
-    <title>Auto light/dark, in dark mode</title>
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
-      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
-      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
-      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
-      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
-      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
-      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
-      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
-      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
-      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
-      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
-      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
-      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
-    </svg>
-  </symbol>
-  <symbol id="svg-pencil" viewBox="0 0 24 24">
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
-      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
-      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
-      <path d="M13.5 6.5l4 4" />
-      <path d="M20 21l2 -2l-2 -2" />
-      <path d="M17 17l-2 2l2 2" />
-    </svg>
-  </symbol>
-  <symbol id="svg-eye" viewBox="0 0 24 24">
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
-      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
-      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
-      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
-      <path
-        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
-      <path d="M20 21l2 -2l-2 -2" />
-      <path d="M17 17l-2 2l2 2" />
+      stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
+      <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
+      <circle cx="12" cy="12" r="9" />
+      <path d="M13 12h5" />
+      <path d="M13 15h4" />
+      <path d="M13 18h1" />
+      <path d="M13 9h4" />
+      <path d="M13 6h1" />
     </svg>
   </symbol>
 </svg>
@@ -155,8 +113,6 @@
   <div class="visually-hidden">Hide table of contents sidebar</div>
 </label>
 
-<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
-
 
 
 <div class="page">
@@ -174,8 +130,7 @@
       <div class="theme-toggle-container theme-toggle-header">
         <button class="theme-toggle">
           <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
-          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
-          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
+          <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
           <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
           <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
         </button>
@@ -194,7 +149,7 @@
 
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
-  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
+  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
   <input type="hidden" name="check_keywords" value="yes">
   <input type="hidden" name="area" value="default">
 </form>
@@ -204,8 +159,8 @@
 <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-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 child pages in navigation</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 child pages in navigation</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>
@@ -233,17 +188,11 @@
           <span>Back to top</span>
         </a>
         <div class="content-icon-container">
-          <div class="view-this-page">
-  <a class="muted-link" href="_sources/_api_reference.rst.txt" title="View this page">
-    <svg><use href="#svg-eye"></use></svg>
-    <span class="visually-hidden">View this page</span>
-  </a>
-</div>
+
 <div class="theme-toggle-container theme-toggle-content">
             <button class="theme-toggle">
               <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
-              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
-              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
+              <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
               <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
               <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
             </button>
@@ -253,10 +202,10 @@
             <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
           </label>
         </div>
-        <article role="main" id="furo-main-content">
-          <section id="api-reference">
-<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this heading">¶</a></h1>
-<span class="target" id="module-iowa_forecast"></span></section>
+        <article role="main">
+          <div class="section" id="api-reference">
+<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">#</a></h1>
+</div>
 
         </article>
       </div>
@@ -277,7 +226,9 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 
           </div>
           <div class="right-details">
-
+            <div class="icons">
+
+            </div>
           </div>
         </div>
 
@@ -289,10 +240,11 @@ <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to
 
     </aside>
   </div>
-</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=8df938ec"></script>
-    <script src="_static/doctools.js?v=888ff710"></script>
-    <script src="_static/sphinx_highlight.js?v=4825356b"></script>
-    <script src="_static/scripts/furo.js?v=5fa4622c"></script>
-    <script src="_static/tabs.js?v=3ee01567"></script>
+</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
+    <script src="_static/jquery.js"></script>
+    <script src="_static/underscore.js"></script>
+    <script src="_static/doctools.js"></script>
+    <script src="_static/scripts/furo.js"></script>
+    <script src="_static/tabs.js"></script>
     </body>
 </html>
diff --git a/_sources/installation.rst.txt b/_sources/installation.rst.txt
@@ -10,10 +10,10 @@ Requirements
 
 Before you begin, ensure you have the following installed:
 
-- [Python 3.9](https://www.python.org/downloads/release/python-390/) or higher
-- [Google Cloud SDK (gcloud)](https://cloud.google.com/sdk/docs/install) installed and configured
-- [Docker](https://www.docker.com/) (for containerized environments)
-- [Git](https://git-scm.com/) (for cloning the repository)
+- `Python 3.9 <https://www.python.org/downloads/release/python-390/>`_ or higher
+- `Google Cloud SDK (gcloud) <https://cloud.google.com/sdk/docs/install)>`_ installed and configured
+- `Docker <https://www.docker.com/>`_ (for containerized environments)
+- `Git <https://git-scm.com/>`_ (for cloning the repository)
 
 Python Dependencies
 --------------------
@@ -34,14 +34,14 @@ This project utilizes Google Cloud BigQuery for data storage and retrieval.
 Follow these steps to set up your Google Cloud environment:
 
 1. **Create a Google Cloud Project**:
-    - Go to the [Google Cloud Console](https://console.cloud.google.com/).
+    - Go to the `Google Cloud Console <https://console.cloud.google.com/>`_.
     - Create a new project or select an existing one.
 
 2. **Enable the BigQuery API**:
-    - Navigate to [BigQuery API](https://console.cloud.google.com/bigquery) and enable it for your project.
+    - Navigate to `BigQuery API <https://console.cloud.google.com/bigquery>`_ and enable it for your project.
 
 3. **Set up Authentication**:
-    - Navigate to [IAM Service Accounts](https://console.cloud.google.com/iam-admin/serviceaccounts)
+    - Navigate to `IAM Service Accounts <https://console.cloud.google.com/iam-admin/serviceaccounts>`_
       and create a service account in your project.
     - In the projects service accounts page, click on the service account
       you've created and then navigate to the "Keys" tab.
@@ -51,9 +51,9 @@ Follow these steps to set up your Google Cloud environment:
     - Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to the
       path of this file:
 
-    ```bash
-    export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json"
-    ```
+    .. code-block:: bash
+
+        export GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json"
 
 4. **Create a BigQuery Dataset**:
     - In the BigQuery console, create a new dataset where the data and models will be stored.
@@ -67,18 +67,19 @@ If you prefer to run the project in a Docker container to ensure a consistent en
 
     In the root directory of the project, run:
 
-    ```bash
-    docker build -t iowa-liquor-sales-forecast .
-    ```
+    .. code-block:: bash
+
+        docker build -t iowa-liquor-sales-forecast .
+
 
 2. **Run the Docker Container**:
 
     Start the container with:
 
-    ```bash
-    docker run -it --rm -e GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json" \
-    -v $(pwd):/app iowa-liquor-sales-forecast
-    ```
+    .. code-block:: bash
+
+        docker run -it --rm -e GOOGLE_APPLICATION_CREDENTIALS="/path/to/your/service-account-file.json" \
+        -v $(pwd):/app iowa-liquor-sales-forecast
 
     Replace `/path/to/your/service-account-file.json` with the actual path to your credentials file.
     The `-v $(pwd):/app` option mounts the current directory inside the container.
@@ -93,19 +94,20 @@ you can start using the project. Here’s how:
 
     If you haven't already, clone the project repository:
 
-    ```bash
-    git clone https://github.com/yourusername/iowa-liquor-sales-forecast.git
-    cd iowa-liquor-sales-forecast
-    ```
+    .. code-block:: bash
+
+        git clone https://github.com/erik-ingwersen-ey/iowa-liquor-sales-forecast.git
+        cd iowa-liquor-sales-forecast
+
 
 2. **Run the Pipeline Script**:
 
     Execute the `train_model_and_forecast_sales.py` script to train the
     models and start generating forecasts:
 
-    ```bash
-    python pipelines/train_model_and_forecast_sales.py
-    ```
+    .. code-block:: bash
+
+        python pipelines/train_model_and_forecast_sales.py
 
     .. attention::
 
@@ -125,4 +127,4 @@ If you encounter any issues during installation or setup, here are some common s
 - **Docker Issues**:
     - Ensure Docker is running and your system has enough resources allocated to Docker.
 
-For further assistance, refer to the project’s [documentation](index.html).
+For further assistance, refer to the project’s `documentation <index.html>`_.