Spaces:

03chrisk
/

air-quality-forecasting

Sleeping

App Files Files Community

atodorov284 commited on Oct 27, 2024

Commit

31e91d0

1 Parent(s): 3e9466a

documented all code and update docs

Browse files

Files changed (23) hide show

docs/_build/doctrees/environment.pickle +0 -0
docs/_build/doctrees/streamlit_src.controllers.doctree +0 -0
docs/_build/doctrees/streamlit_src.models.doctree +0 -0
docs/_build/doctrees/streamlit_src.views.doctree +0 -0
docs/_build/html/_modules/streamlit_src/controllers/admin_controller.html +15 -10
docs/_build/html/_modules/streamlit_src/controllers/home_controller.html +36 -12
docs/_build/html/_modules/streamlit_src/controllers/user_controller.html +18 -15
docs/_build/html/_modules/streamlit_src/models/air_quality_model.html +61 -19
docs/_build/html/_modules/streamlit_src/views/admin_view.html +18 -12
docs/_build/html/_modules/streamlit_src/views/home_view.html +61 -14
docs/_build/html/air_quality_forecast.html +22 -22
docs/_build/html/genindex.html +23 -15
docs/_build/html/objects.inv +0 -0
docs/_build/html/searchindex.js +1 -1
docs/_build/html/streamlit_src.controllers.html +37 -24
docs/_build/html/streamlit_src.html +17 -10
docs/_build/html/streamlit_src.models.html +73 -18
docs/_build/html/streamlit_src.views.html +96 -30
streamlit_src/controllers/admin_controller.py +6 -1
streamlit_src/controllers/home_controller.py +28 -3
streamlit_src/models/air_quality_model.py +53 -10
streamlit_src/views/admin_view.py +9 -3
streamlit_src/views/home_view.py +49 -4

docs/_build/doctrees/environment.pickle CHANGED Viewed

Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ

docs/_build/doctrees/streamlit_src.controllers.doctree CHANGED Viewed

Binary files a/docs/_build/doctrees/streamlit_src.controllers.doctree and b/docs/_build/doctrees/streamlit_src.controllers.doctree differ

docs/_build/doctrees/streamlit_src.models.doctree CHANGED Viewed

Binary files a/docs/_build/doctrees/streamlit_src.models.doctree and b/docs/_build/doctrees/streamlit_src.models.doctree differ

docs/_build/doctrees/streamlit_src.views.doctree CHANGED Viewed

Binary files a/docs/_build/doctrees/streamlit_src.views.doctree and b/docs/_build/doctrees/streamlit_src.views.doctree differ

docs/_build/html/_modules/streamlit_src/controllers/admin_controller.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
-    <link rel="search" title="Search" href="../../../search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -67,7 +67,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.controllers.admin_controller</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
@@ -233,7 +233,12 @@
             <span class="s2">&quot;The data must be unnormalized.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;PM25, PM10, O3, NO2 should be in micrograms per cubic meter (µg/m³).&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;Temperature should be in degrees Celcius&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
-            <span class="s2">&quot;Add the others later&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;The dataset must contain a total of 33 columns in the specified order.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;I accept that my data will be used for a prediction using a custom model.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;I understand that my data will not be saved.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
@@ -418,7 +423,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -429,7 +434,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.controllers.admin_controller</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Tuple</span>
             <span class="s2">&quot;The data must be unnormalized.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;PM25, PM10, O3, NO2 should be in micrograms per cubic meter (µg/m³).&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;Temperature should be in degrees Celcius&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+            <span class="s2">&quot;Humidity should be in percentages&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+            <span class="s2">&quot;Visibility should be in kilometers&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+            <span class="s2">&quot;Solar Radiation should be in watts per square meter (W/m²).&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+            <span class="s2">&quot;Precipitation should be in millimeters&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+            <span class="s2">&quot;Wind Speed should be in kilometers per hour (km/h).&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
+            <span class="s2">&quot;Wind Direction should be in degrees&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;The dataset must contain a total of 33 columns in the specified order.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;I accept that my data will be used for a prediction using a custom model.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
             <span class="s2">&quot;I understand that my data will not be saved.&quot;</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/_modules/streamlit_src/controllers/home_controller.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
-    <link rel="search" title="Search" href="../../../search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -67,7 +67,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.controllers.home_controller</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">streamlit</span> <span class="k">as</span> <span class="nn">st</span>
 <span class="kn">import</span> <span class="nn">time</span>
@@ -80,11 +80,24 @@
 <div class="viewcode-block" id="HomeController">
 <a class="viewcode-back" href="../../../streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController">[docs]</a>
 <span class="k">class</span> <span class="nc">HomeController</span><span class="p">:</span>
     <span class="n">__ADMIN_PASSWORD_HASH</span> <span class="o">=</span> <span class="p">(</span>
         <span class="s2">&quot;240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9&quot;</span>
     <span class="p">)</span>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">home_view</span> <span class="o">=</span> <span class="n">HomeView</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">user_controller</span> <span class="o">=</span> <span class="n">UserController</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">admin_controller</span> <span class="o">=</span> <span class="n">AdminController</span><span class="p">()</span>
@@ -92,14 +105,25 @@
 <div class="viewcode-block" id="HomeController._hash_password">
 <a class="viewcode-back" href="../../../streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController._hash_password">[docs]</a>
-    <span class="k">def</span> <span class="nf">_hash_password</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">password</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Hash the input password using SHA-256.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">password</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span></div>
 <div class="viewcode-block" id="HomeController._run">
 <a class="viewcode-back" href="../../../streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController._run">[docs]</a>
-    <span class="k">def</span> <span class="nf">_run</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">if</span> <span class="s2">&quot;is_admin_logged_in&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">st</span><span class="o">.</span><span class="n">session_state</span><span class="p">:</span>
             <span class="n">st</span><span class="o">.</span><span class="n">session_state</span><span class="o">.</span><span class="n">is_admin_logged_in</span> <span class="o">=</span> <span class="kc">False</span>
@@ -139,7 +163,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -150,7 +174,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.controllers.home_controller</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">streamlit</span> <span class="k">as</span> <span class="nn">st</span>
 <span class="kn">import</span> <span class="nn">time</span>
 <div class="viewcode-block" id="HomeController">
 <a class="viewcode-back" href="../../../streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController">[docs]</a>
 <span class="k">class</span> <span class="nc">HomeController</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Handles the logic for the home page, including switching between user and admin views.</span>
+<span class="sd">    The home page is the main entry point for the Streamlit application.</span>
+<span class="sd">    It contains a text input for the admin password, which is hashed and compared to the stored hash.</span>
+<span class="sd">    If the password is correct, the user is logged in as an admin and the admin view is displayed.</span>
+<span class="sd">    Otherwise, the user view is displayed.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="c1"># This needs to be hidden as an env variable but we couldn&#39;t manage with HuggingFace yet, severe security issue</span>
     <span class="n">__ADMIN_PASSWORD_HASH</span> <span class="o">=</span> <span class="p">(</span>
         <span class="s2">&quot;240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9&quot;</span>
     <span class="p">)</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Initializes the HomeController class by setting up the home view, user controller,</span>
+<span class="sd">        and admin controller. Also triggers the _run method to start the application.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">home_view</span> <span class="o">=</span> <span class="n">HomeView</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">user_controller</span> <span class="o">=</span> <span class="n">UserController</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">admin_controller</span> <span class="o">=</span> <span class="n">AdminController</span><span class="p">()</span>
 <div class="viewcode-block" id="HomeController._hash_password">
 <a class="viewcode-back" href="../../../streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController._hash_password">[docs]</a>
+    <span class="k">def</span> <span class="nf">_hash_password</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Hash the input password using SHA-256.&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha256</span><span class="p">(</span><span class="n">password</span><span class="o">.</span><span class="n">encode</span><span class="p">())</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span></div>
 <div class="viewcode-block" id="HomeController._run">
 <a class="viewcode-back" href="../../../streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController._run">[docs]</a>
+    <span class="k">def</span> <span class="nf">_run</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Runs the application logic for the home page.</span>
+<span class="sd">        This method is responsible for rendering the home page and</span>
+<span class="sd">        handling the user&#39;s choice of whether to view the user dashboard</span>
+<span class="sd">        or admin dashboard. If the user chooses to view the admin dashboard,</span>
+<span class="sd">        the user is prompted to enter the admin password. If the password</span>
+<span class="sd">        is valid, the user is logged in as an admin and the admin dashboard</span>
+<span class="sd">        is displayed. If the password is invalid, the user is logged out and</span>
+<span class="sd">        the user dashboard is displayed.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="s2">&quot;is_admin_logged_in&quot;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">st</span><span class="o">.</span><span class="n">session_state</span><span class="p">:</span>
             <span class="n">st</span><span class="o">.</span><span class="n">session_state</span><span class="o">.</span><span class="n">is_admin_logged_in</span> <span class="o">=</span> <span class="kc">False</span>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/_modules/streamlit_src/controllers/user_controller.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
-    <link rel="search" title="Search" href="../../../search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -67,7 +67,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.controllers.user_controller</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Tuple</span>
 <span class="kn">import</span> <span class="nn">streamlit</span> <span class="k">as</span> <span class="nn">st</span>
@@ -95,8 +95,10 @@
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_model</span> <span class="o">=</span> <span class="n">AirQualityModel</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_view</span> <span class="o">=</span> <span class="n">UserView</span><span class="p">()</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">_today_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">get_today_data</span><span class="p">()</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">_next_three_days</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">next_three_day_predictions</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_who_guidelines</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;Pollutant&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;NO2 (µg/m³)&quot;</span><span class="p">,</span> <span class="s2">&quot;O3 (µg/m³)&quot;</span><span class="p">],</span>
@@ -123,7 +125,8 @@
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Shows the main page of the user interface.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">_view</span><span class="o">.</span><span class="n">two_columns_layout</span><span class="p">(</span><span class="mf">0.7</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_raise_awareness</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_quiz</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_current_data_available</span><span class="p">():</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_view</span><span class="o">.</span><span class="n">data_not_available</span><span class="p">()</span>
@@ -143,7 +146,7 @@
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Checks if the current data is available.</span>
-<span class="sd">        The current data is not available from 14:00 to 15:15.</span>
 <span class="sd">        This is because the API is queried every 15 minutes, and the</span>
 <span class="sd">        data is not available for a short period of time before and after</span>
 <span class="sd">        the new data is fetched.</span>
@@ -151,8 +154,8 @@
 <span class="sd">        :return: True if the current data is available, False otherwise.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">current_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
-        <span class="n">start_time</span> <span class="o">=</span> <span class="n">current_time</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">hour</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">minute</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">second</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
-        <span class="n">end_time</span> <span class="o">=</span> <span class="n">current_time</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="n">hour</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">minute</span><span class="o">=</span><span class="mi">15</span><span class="p">,</span> <span class="n">second</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">start_time</span> <span class="o">&lt;=</span> <span class="n">current_time</span> <span class="o">&lt;=</span> <span class="n">end_time</span><span class="p">:</span>
             <span class="k">return</span> <span class="kc">False</span>
         <span class="k">return</span> <span class="kc">True</span></div>
@@ -534,7 +537,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -545,7 +548,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.controllers.user_controller</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Tuple</span>
 <span class="kn">import</span> <span class="nn">streamlit</span> <span class="k">as</span> <span class="nn">st</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_model</span> <span class="o">=</span> <span class="n">AirQualityModel</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_view</span> <span class="o">=</span> <span class="n">UserView</span><span class="p">()</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_current_data_available</span><span class="p">():</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_today_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">get_today_data</span><span class="p">()</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_next_three_days</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_model</span><span class="o">.</span><span class="n">next_three_day_predictions</span><span class="p">()</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_who_guidelines</span> <span class="o">=</span> <span class="p">{</span>
             <span class="s2">&quot;Pollutant&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;NO2 (µg/m³)&quot;</span><span class="p">,</span> <span class="s2">&quot;O3 (µg/m³)&quot;</span><span class="p">],</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Shows the main page of the user interface.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_current_data_available</span><span class="p">():</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_view</span><span class="o">.</span><span class="n">two_columns_layout</span><span class="p">(</span><span class="mf">0.7</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_raise_awareness</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_quiz</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_is_current_data_available</span><span class="p">():</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_view</span><span class="o">.</span><span class="n">data_not_available</span><span class="p">()</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Checks if the current data is available.</span>
+<span class="sd">        The current data is not available from 00:00 to 04:15.</span>
 <span class="sd">        This is because the API is queried every 15 minutes, and the</span>
 <span class="sd">        data is not available for a short period of time before and after</span>
 <span class="sd">        the new data is fetched.</span>
 <span class="sd">        :return: True if the current data is available, False otherwise.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">current_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+        <span class="n">start_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="s2">&quot;00:00&quot;</span><span class="p">,</span> <span class="s2">&quot;%H:%M&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
+        <span class="n">end_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="s2">&quot;04:15&quot;</span><span class="p">,</span> <span class="s2">&quot;%H:%M&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
         <span class="k">if</span> <span class="n">start_time</span> <span class="o">&lt;=</span> <span class="n">current_time</span> <span class="o">&lt;=</span> <span class="n">end_time</span><span class="p">:</span>
             <span class="k">return</span> <span class="kc">False</span>
         <span class="k">return</span> <span class="kc">True</span></div>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/_modules/streamlit_src/models/air_quality_model.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
-    <link rel="search" title="Search" href="../../../search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -67,7 +67,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.models.air_quality_model</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
 <span class="kn">import</span> <span class="nn">os</span>
@@ -92,13 +92,25 @@
 <div class="viewcode-block" id="AirQualityModel">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel">[docs]</a>
 <span class="k">class</span> <span class="nc">AirQualityModel</span><span class="p">:</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">WHO_NO2_LEVEL</span> <span class="o">=</span> <span class="mi">25</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">WHO_O3_LEVEL</span> <span class="o">=</span> <span class="mi">100</span>
 <div class="viewcode-block" id="AirQualityModel.get_today_data">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_today_data">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_today_data</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Returns the air quality data for today from the past 3 days data.</span>
@@ -116,14 +128,14 @@
 <div class="viewcode-block" id="AirQualityModel.next_three_day_predictions">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions">[docs]</a>
-    <span class="k">def</span> <span class="nf">next_three_day_predictions</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-        <span class="c1"># Load data from the specified path (assuming it&#39;s a CSV file)</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PREDICTION_PATH</span><span class="p">)</span>
-        <span class="c1"># correct data is todays data row</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;date&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">pd</span><span class="o">.</span><span class="n">Timestamp</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)]</span>
-        <span class="c1"># Create a DataFrame with the relevant information for the next three days</span>
         <span class="n">next_three_days</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span>
             <span class="p">{</span>
                 <span class="s2">&quot;Day&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;Day 1&quot;</span><span class="p">,</span> <span class="s2">&quot;Day 2&quot;</span><span class="p">,</span> <span class="s2">&quot;Day 3&quot;</span><span class="p">],</span>
@@ -145,14 +157,34 @@
 <div class="viewcode-block" id="AirQualityModel.get_all_data_last_three_days">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_all_data_last_three_days</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PAST_DATA_PATH</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">data</span></div>
 <div class="viewcode-block" id="AirQualityModel.get_last_three_days">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days">[docs]</a>
-    <span class="k">def</span> <span class="nf">get_last_three_days</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="c1"># Extract NO2 and O3 values for the last three days</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PAST_DATA_PATH</span><span class="p">)</span>
         <span class="n">last_three_days</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span>
@@ -175,7 +207,17 @@
 <div class="viewcode-block" id="AirQualityModel.calculate_metrics">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics">[docs]</a>
-    <span class="k">def</span> <span class="nf">calculate_metrics</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">model_predictions</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PREDICTION_PATH</span><span class="p">)</span>
         <span class="n">yesterday</span> <span class="o">=</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span>
@@ -318,7 +360,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -329,7 +371,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.models.air_quality_model</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>
 <span class="kn">import</span> <span class="nn">os</span>
 <div class="viewcode-block" id="AirQualityModel">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel">[docs]</a>
 <span class="k">class</span> <span class="nc">AirQualityModel</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    A class that loads the air quality model and makes predictions.</span>
+<span class="sd">    </span>
+<span class="sd">    The model is loaded from a pickle file located at PREDICTION_PATH.</span>
+<span class="sd">    </span>
+<span class="sd">    Attributes</span>
+<span class="sd">    ----------</span>
+<span class="sd">    _WHO_NO2_LEVEL : int</span>
+<span class="sd">        The WHO air quality level for NO2 in micrograms per cubic meter.</span>
+<span class="sd">    _WHO_O3_LEVEL : int</span>
+<span class="sd">        The WHO air quality level for O3 in micrograms per cubic meter.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_WHO_NO2_LEVEL</span> <span class="o">=</span> <span class="mi">25</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_WHO_O3_LEVEL</span> <span class="o">=</span> <span class="mi">100</span>
 <div class="viewcode-block" id="AirQualityModel.get_today_data">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_today_data">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_today_data</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">Series</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Returns the air quality data for today from the past 3 days data.</span>
 <div class="viewcode-block" id="AirQualityModel.next_three_day_predictions">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions">[docs]</a>
+    <span class="k">def</span> <span class="nf">next_three_day_predictions</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&#39;&#39;&#39;</span>
+<span class="sd">        Returns the predictions for the next three days.</span>
+<span class="sd">        &#39;&#39;&#39;</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PREDICTION_PATH</span><span class="p">)</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="n">data</span><span class="p">[</span><span class="s2">&quot;date&quot;</span><span class="p">]</span> <span class="o">==</span> <span class="n">pd</span><span class="o">.</span><span class="n">Timestamp</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)]</span>
         <span class="n">next_three_days</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span>
             <span class="p">{</span>
                 <span class="s2">&quot;Day&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;Day 1&quot;</span><span class="p">,</span> <span class="s2">&quot;Day 2&quot;</span><span class="p">,</span> <span class="s2">&quot;Day 3&quot;</span><span class="p">],</span>
 <div class="viewcode-block" id="AirQualityModel.get_all_data_last_three_days">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_all_data_last_three_days</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Returns all the air quality data for the last three days from the past 3 days data.</span>
+<span class="sd">        </span>
+<span class="sd">        The data is obtained from a CSV file located at PAST_DATA_PATH.</span>
+<span class="sd">        </span>
+<span class="sd">        Returns</span>
+<span class="sd">        -------</span>
+<span class="sd">        pd.DataFrame</span>
+<span class="sd">            A pandas DataFrame with the air quality data for the last three days.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PAST_DATA_PATH</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">data</span></div>
 <div class="viewcode-block" id="AirQualityModel.get_last_three_days">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_last_three_days</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Returns all the air quality data for the last three days from the past 3 days data.</span>
+<span class="sd">        </span>
+<span class="sd">        The data is obtained from a CSV file located at PAST_DATA_PATH.</span>
+<span class="sd">        </span>
+<span class="sd">        Returns</span>
+<span class="sd">        -------</span>
+<span class="sd">        pd.DataFrame</span>
+<span class="sd">            A pandas DataFrame with the air quality data for the last three days.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># Extract NO2 and O3 values for the last three days</span>
         <span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PAST_DATA_PATH</span><span class="p">)</span>
         <span class="n">last_three_days</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span>
 <div class="viewcode-block" id="AirQualityModel.calculate_metrics">
 <a class="viewcode-back" href="../../../streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics">[docs]</a>
+    <span class="k">def</span> <span class="nf">calculate_metrics</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Calculates the root mean squared error for the predictions of the last three days.</span>
+<span class="sd">        </span>
+<span class="sd">        The data is obtained from a CSV file located at PREDICTION_PATH.</span>
+<span class="sd">        </span>
+<span class="sd">        Returns</span>
+<span class="sd">        -------</span>
+<span class="sd">        pd.DataFrame</span>
+<span class="sd">            A pandas DataFrame with the root mean squared error for the predictions of the last three days.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">model_predictions</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">PREDICTION_PATH</span><span class="p">)</span>
         <span class="n">yesterday</span> <span class="o">=</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y-%m-</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/_modules/streamlit_src/views/admin_view.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
-    <link rel="search" title="Search" href="../../../search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -67,7 +67,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.views.admin_view</h1><div class="highlight"><pre>
 <span></span><span class="c1"># views/user_view.py</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
@@ -93,7 +93,13 @@
 <div class="viewcode-block" id="AdminView.show_admin_pages">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.admin_view.AdminView.show_admin_pages">[docs]</a>
-    <span class="k">def</span> <span class="nf">show_admin_pages</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">page</span> <span class="o">=</span> <span class="n">st</span><span class="o">.</span><span class="n">selectbox</span><span class="p">(</span>
             <span class="s2">&quot;Select a page:&quot;</span><span class="p">,</span>
             <span class="p">[</span>
@@ -160,8 +166,8 @@
         <span class="p">)</span>
         <span class="n">st</span><span class="o">.</span><span class="n">markdown</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;</span>
 <span class="s2">    - **Normalization**: The data must be **unnormalized**.</span>
-<span class="s2">    - **Units**: All measurements should be in **micrograms/m³**.</span>
-<span class="s2">    - **Data Structure**: The dataset must contain a total of **33 columns** with the following order:</span>
 <span class="s2">        - **Optional**: `date`</span>
 <span class="s2">        - `PM25` (today)</span>
 <span class="s2">        - `PM10` (today)</span>
@@ -261,7 +267,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -272,7 +278,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.views.admin_view</h1><div class="highlight"><pre>
 <span></span><span class="c1"># views/user_view.py</span>
 <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Dict</span>
 <div class="viewcode-block" id="AdminView.show_admin_pages">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.admin_view.AdminView.show_admin_pages">[docs]</a>
+    <span class="k">def</span> <span class="nf">show_admin_pages</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Displays a dropdown for selecting different admin pages.</span>
+<span class="sd">        Returns:</span>
+<span class="sd">            str: The selected page from the dropdown.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">page</span> <span class="o">=</span> <span class="n">st</span><span class="o">.</span><span class="n">selectbox</span><span class="p">(</span>
             <span class="s2">&quot;Select a page:&quot;</span><span class="p">,</span>
             <span class="p">[</span>
         <span class="p">)</span>
         <span class="n">st</span><span class="o">.</span><span class="n">markdown</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;</span>
 <span class="s2">    - **Normalization**: The data must be **unnormalized**.</span>
+<span class="s2">    - **Units**: All measurements should as specified below**.</span>
+<span class="s2">    - **Data Structure**: The dataset must contain a total of **33 columns** (34 with date) with the following order:</span>
 <span class="s2">        - **Optional**: `date`</span>
 <span class="s2">        - `PM25` (today)</span>
 <span class="s2">        - `PM10` (today)</span>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/_modules/streamlit_src/views/home_view.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
-    <link rel="search" title="Search" href="../../../search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -67,7 +67,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.views.home_view</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">streamlit</span> <span class="k">as</span> <span class="nn">st</span>
@@ -75,26 +75,73 @@
 <div class="viewcode-block" id="HomeView">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView">[docs]</a>
 <span class="k">class</span> <span class="nc">HomeView</span><span class="p">:</span>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">set_layout</span><span class="p">()</span>
 <div class="viewcode-block" id="HomeView.set_layout">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.set_layout">[docs]</a>
-    <span class="k">def</span> <span class="nf">set_layout</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">st</span><span class="o">.</span><span class="n">set_page_config</span><span class="p">(</span><span class="n">page_title</span><span class="o">=</span><span class="s2">&quot;Air Quality Monitoring Dashboard&quot;</span><span class="p">,</span> <span class="n">layout</span><span class="o">=</span><span class="s2">&quot;wide&quot;</span><span class="p">)</span>
         <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Air Quality Monitoring&quot;</span><span class="p">)</span></div>
 <div class="viewcode-block" id="HomeView.show_dashboard_switch">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.show_dashboard_switch">[docs]</a>
-    <span class="k">def</span> <span class="nf">show_dashboard_switch</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">page</span> <span class="o">=</span> <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">radio</span><span class="p">(</span><span class="s2">&quot;Go to&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;User Dashboard&quot;</span><span class="p">,</span> <span class="s2">&quot;Admin Dashboard&quot;</span><span class="p">])</span>
         <span class="k">return</span> <span class="n">page</span></div>
 <div class="viewcode-block" id="HomeView.prompt_admin_password">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.prompt_admin_password">[docs]</a>
-    <span class="k">def</span> <span class="nf">prompt_admin_password</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">markdown</span><span class="p">(</span><span class="s2">&quot;### Admin Access Required&quot;</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">text_input</span><span class="p">(</span><span class="s2">&quot;Enter Admin Password:&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;password&quot;</span><span class="p">)</span></div>
 </div>
@@ -114,7 +161,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -125,7 +172,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=e59714d7" />
       <script src="../../../_static/jquery.js?v=5d32c60e"></script>
       <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
       <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="../../../index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <h1>Source code for streamlit_src.views.home_view</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">streamlit</span> <span class="k">as</span> <span class="nn">st</span>
 <div class="viewcode-block" id="HomeView">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView">[docs]</a>
 <span class="k">class</span> <span class="nc">HomeView</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    The HomeView class manages the layout and logic for the home page, </span>
+<span class="sd">    including the user and admin dashboard navigation.</span>
+<span class="sd">    Attributes:</span>
+<span class="sd">        None</span>
+<span class="sd">    Methods:</span>
+<span class="sd">        __init__: Initializes the HomeView class by setting up the home layout.</span>
+<span class="sd">        set_layout: Sets the layout of the home page.</span>
+<span class="sd">        show_dashboard_switch: Displays the user and admin dashboard navigation.</span>
+<span class="sd">        prompt_admin_password: Prompts the user for the admin password.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+<div class="viewcode-block" id="HomeView.__init__">
+<a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.__init__">[docs]</a>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Initializes the HomeView class by setting up the home layout.</span>
+<span class="sd">        This method is responsible for setting up the Streamlit page configuration and</span>
+<span class="sd">        creating the sidebar title.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">set_layout</span><span class="p">()</span></div>
 <div class="viewcode-block" id="HomeView.set_layout">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.set_layout">[docs]</a>
+    <span class="k">def</span> <span class="nf">set_layout</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Sets the layout of the home page.</span>
+<span class="sd">        This method is responsible for setting up the Streamlit page configuration</span>
+<span class="sd">        and creating the sidebar title.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">st</span><span class="o">.</span><span class="n">set_page_config</span><span class="p">(</span><span class="n">page_title</span><span class="o">=</span><span class="s2">&quot;Air Quality Monitoring Dashboard&quot;</span><span class="p">,</span> <span class="n">layout</span><span class="o">=</span><span class="s2">&quot;wide&quot;</span><span class="p">)</span>
         <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s2">&quot;Air Quality Monitoring&quot;</span><span class="p">)</span></div>
 <div class="viewcode-block" id="HomeView.show_dashboard_switch">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.show_dashboard_switch">[docs]</a>
+    <span class="k">def</span> <span class="nf">show_dashboard_switch</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Displays the user and admin dashboard navigation.</span>
+<span class="sd">        This method is responsible for displaying the user and admin dashboard navigation</span>
+<span class="sd">        in the sidebar. It returns the page selected by the user.</span>
+<span class="sd">        Returns:</span>
+<span class="sd">            str: The page selected by the user.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">page</span> <span class="o">=</span> <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">radio</span><span class="p">(</span><span class="s2">&quot;Go to&quot;</span><span class="p">,</span> <span class="p">[</span><span class="s2">&quot;User Dashboard&quot;</span><span class="p">,</span> <span class="s2">&quot;Admin Dashboard&quot;</span><span class="p">])</span>
         <span class="k">return</span> <span class="n">page</span></div>
 <div class="viewcode-block" id="HomeView.prompt_admin_password">
 <a class="viewcode-back" href="../../../streamlit_src.views.html#streamlit_src.views.home_view.HomeView.prompt_admin_password">[docs]</a>
+    <span class="k">def</span> <span class="nf">prompt_admin_password</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Prompts the user for the admin password.</span>
+<span class="sd">        This method is responsible for prompting the user for the admin password</span>
+<span class="sd">        when the user navigates to the admin dashboard. It displays a text input</span>
+<span class="sd">        field in the sidebar with a placeholder saying &quot;Enter Admin Password:&quot;.</span>
+<span class="sd">        Returns:</span>
+<span class="sd">            str: The password entered by the user.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">markdown</span><span class="p">(</span><span class="s2">&quot;### Admin Access Required&quot;</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">st</span><span class="o">.</span><span class="n">sidebar</span><span class="o">.</span><span class="n">text_input</span><span class="p">(</span><span class="s2">&quot;Enter Admin Password:&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;password&quot;</span><span class="p">)</span></div>
 </div>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/air_quality_forecast.html CHANGED Viewed

@@ -10,7 +10,7 @@
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
@@ -20,17 +20,17 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src package" href="streamlit_src.html" />
-    <link rel="prev" title="air-quality-forecast" href="modules.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -119,7 +119,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="air-quality-forecast-package">
 <h1>air_quality_forecast package<a class="headerlink" href="#air-quality-forecast-package" title="Link to this heading"></a></h1>
 <section id="submodules">
@@ -204,7 +204,7 @@
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.data_pipeline.DataLoader.save_to_csv">
-<span class="sig-name descname"><span class="pre">save_to_csv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/data_pipeline.html#DataLoader.save_to_csv"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.data_pipeline.DataLoader.save_to_csv" title="Link to this definition"></a></dt>
 <dd><p>Save the data to a CSV file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -336,7 +336,7 @@
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._evaluate_model">
-<span class="sig-name descname"><span class="pre">_evaluate_model</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._evaluate_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._evaluate_model" title="Link to this definition"></a></dt>
 <dd><p>Evaluate the best model on the test data and log metrics.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
@@ -357,7 +357,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._perform_search">
-<span class="sig-name descname"><span class="pre">_perform_search</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._perform_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._perform_search" title="Link to this definition"></a></dt>
 <dd><p>Perform Bayesian optimization for hyperparameters.</p>
 <p>This method initializes and performs a BayesSearchCV search for the best
 hyperparameters of the regressor. The search is performed on the training
@@ -373,7 +373,7 @@ MLflow.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._set_data">
-<span class="sig-name descname"><span class="pre">_set_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._set_data" title="Link to this definition"></a></dt>
 <dd><p>Set the training and test data as class attributes.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -389,7 +389,7 @@ MLflow.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._setup_mlflow">
-<span class="sig-name descname"><span class="pre">_setup_mlflow</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._setup_mlflow"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._setup_mlflow" title="Link to this definition"></a></dt>
 <dd><p>Set up MLflow configuration.</p>
 <p>This method launches the MLflow server, sets the MLflow experiment name and
 tracking URI, enables system metrics logging, and turns on autologging of
@@ -398,7 +398,7 @@ metrics and parameters.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">launch_mlflow_server</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer.launch_mlflow_server"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server" title="Link to this definition"></a></dt>
 <dd><p>Launch MLflow server at <a class="reference external" href="http://127.0.0.1:5000">http://127.0.0.1:5000</a>, if not already running.</p>
 <p>If the port is already in use, it will print a message saying so.
 If there is an error launching the server, it will print the error.</p>
@@ -423,7 +423,7 @@ If there is an error launching the server, it will print the error.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer.run">
-<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer.run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer.run" title="Link to this definition"></a></dt>
 <dd><p>Run the Bayesian optimization workflow.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -468,7 +468,7 @@ of possible values as values.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.run_bayesian_optimization">
-<span class="sig-prename descclassname"><span class="pre">air_quality_forecast.model_development.</span></span><span class="sig-name descname"><span class="pre">run_bayesian_optimization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experiment_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">regressor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BaseEstimator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_iter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#run_bayesian_optimization"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.run_bayesian_optimization" title="Link to this definition"></a></dt>
 <dd><p>Run Bayesian optimization to search for the best hyperparameters for a given regressor.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -499,7 +499,7 @@ using Bayesian optimization.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.train_one_model">
-<span class="sig-prename descclassname"><span class="pre">air_quality_forecast.model_development.</span></span><span class="sig-name descname"><span class="pre">train_one_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experiment_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_iter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#train_one_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.train_one_model" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 </section>
@@ -532,7 +532,7 @@ without having to run all other algorithms.</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="air_quality_forecast.parser_ui.train_model">
-<span class="sig-prename descclassname"><span class="pre">air_quality_forecast.parser_ui.</span></span><span class="sig-name descname"><span class="pre">train_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experiment_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_iter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/parser_ui.html#train_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.parser_ui.train_model" title="Link to this definition"></a></dt>
 <dd><p>Train a model using Bayesian optimization.</p>
 </dd></dl>
@@ -545,7 +545,7 @@ without having to run all other algorithms.</p>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.prediction.PredictorModels._load_models">
-<span class="sig-name descname"><span class="pre">_load_models</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/prediction.html#PredictorModels._load_models"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.prediction.PredictorModels._load_models" title="Link to this definition"></a></dt>
 <dd><p>Loads the pre-trained models from the saved_models directory.</p>
 <p>The models are loaded in the following order:</p>
 <ol class="arabic simple">
@@ -656,7 +656,7 @@ without having to run all other algorithms.</p>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.utils.InputValidator.validate_file_exists">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_file_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/utils.html#InputValidator.validate_file_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.utils.InputValidator.validate_file_exists" title="Link to this definition"></a></dt>
 <dd><p>Validate that the file path exists.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -673,7 +673,7 @@ without having to run all other algorithms.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.utils.InputValidator.validate_type">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expected_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/air_quality_forecast/utils.html#InputValidator.validate_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.utils.InputValidator.validate_type" title="Link to this definition"></a></dt>
 <dd><p>Validate the type of the given variable.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -714,7 +714,7 @@ without having to run all other algorithms.</p>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -725,7 +725,7 @@ without having to run all other algorithms.</p>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src package" href="streamlit_src.html" />
+    <link rel="prev" title="air-quality-forecast" href="modules.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="air-quality-forecast-package">
 <h1>air_quality_forecast package<a class="headerlink" href="#air-quality-forecast-package" title="Link to this heading"></a></h1>
 <section id="submodules">
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.data_pipeline.DataLoader.save_to_csv">
+<span class="sig-name descname"><span class="pre">save_to_csv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/data_pipeline.html#DataLoader.save_to_csv"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.data_pipeline.DataLoader.save_to_csv" title="Link to this definition"></a></dt>
 <dd><p>Save the data to a CSV file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._evaluate_model">
+<span class="sig-name descname"><span class="pre">_evaluate_model</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._evaluate_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._evaluate_model" title="Link to this definition"></a></dt>
 <dd><p>Evaluate the best model on the test data and log metrics.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._perform_search">
+<span class="sig-name descname"><span class="pre">_perform_search</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._perform_search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._perform_search" title="Link to this definition"></a></dt>
 <dd><p>Perform Bayesian optimization for hyperparameters.</p>
 <p>This method initializes and performs a BayesSearchCV search for the best
 hyperparameters of the regressor. The search is performed on the training
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._set_data">
+<span class="sig-name descname"><span class="pre">_set_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._set_data" title="Link to this definition"></a></dt>
 <dd><p>Set the training and test data as class attributes.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer._setup_mlflow">
+<span class="sig-name descname"><span class="pre">_setup_mlflow</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer._setup_mlflow"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer._setup_mlflow" title="Link to this definition"></a></dt>
 <dd><p>Set up MLflow configuration.</p>
 <p>This method launches the MLflow server, sets the MLflow experiment name and
 tracking URI, enables system metrics logging, and turns on autologging of
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">launch_mlflow_server</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer.launch_mlflow_server"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server" title="Link to this definition"></a></dt>
 <dd><p>Launch MLflow server at <a class="reference external" href="http://127.0.0.1:5000">http://127.0.0.1:5000</a>, if not already running.</p>
 <p>If the port is already in use, it will print a message saying so.
 If there is an error launching the server, it will print the error.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.RegressorTrainer.run">
+<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#RegressorTrainer.run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.RegressorTrainer.run" title="Link to this definition"></a></dt>
 <dd><p>Run the Bayesian optimization workflow.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py function">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.run_bayesian_optimization">
+<span class="sig-prename descclassname"><span class="pre">air_quality_forecast.model_development.</span></span><span class="sig-name descname"><span class="pre">run_bayesian_optimization</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experiment_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">regressor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">BaseEstimator</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_iter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#run_bayesian_optimization"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.run_bayesian_optimization" title="Link to this definition"></a></dt>
 <dd><p>Run Bayesian optimization to search for the best hyperparameters for a given regressor.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py function">
 <dt class="sig sig-object py" id="air_quality_forecast.model_development.train_one_model">
+<span class="sig-prename descclassname"><span class="pre">air_quality_forecast.model_development.</span></span><span class="sig-name descname"><span class="pre">train_one_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experiment_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_iter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/model_development.html#train_one_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.model_development.train_one_model" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 </section>
 <dl class="py function">
 <dt class="sig sig-object py" id="air_quality_forecast.parser_ui.train_model">
+<span class="sig-prename descclassname"><span class="pre">air_quality_forecast.parser_ui.</span></span><span class="sig-name descname"><span class="pre">train_model</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_train</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">x_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y_test</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experiment_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">param_space</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_iter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/parser_ui.html#train_model"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.parser_ui.train_model" title="Link to this definition"></a></dt>
 <dd><p>Train a model using Bayesian optimization.</p>
 </dd></dl>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.prediction.PredictorModels._load_models">
+<span class="sig-name descname"><span class="pre">_load_models</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/prediction.html#PredictorModels._load_models"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.prediction.PredictorModels._load_models" title="Link to this definition"></a></dt>
 <dd><p>Loads the pre-trained models from the saved_models directory.</p>
 <p>The models are loaded in the following order:</p>
 <ol class="arabic simple">
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.utils.InputValidator.validate_file_exists">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_file_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/utils.html#InputValidator.validate_file_exists"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.utils.InputValidator.validate_file_exists" title="Link to this definition"></a></dt>
 <dd><p>Validate that the file path exists.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="air_quality_forecast.utils.InputValidator.validate_type">
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expected_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">variable_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/air_quality_forecast/utils.html#InputValidator.validate_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#air_quality_forecast.utils.InputValidator.validate_type" title="Link to this definition"></a></dt>
 <dd><p>Validate the type of the given variable.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/genindex.html CHANGED Viewed

@@ -9,7 +9,7 @@
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
@@ -17,17 +17,17 @@
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="#" />
-    <link rel="search" title="Search" href="search.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -66,7 +66,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 <h1 id="index">Index</h1>
@@ -91,12 +91,14 @@
  | <a href="#U"><strong>U</strong></a>
  | <a href="#V"><strong>V</strong></a>
  | <a href="#X"><strong>X</strong></a>
 </div>
 <h2 id="_">_</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH">__ADMIN_PASSWORD_HASH (streamlit_src.controllers.home_controller.HomeController attribute)</a>
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.admin_controller.AdminController._check_data_out_of_distribution">_check_data_out_of_distribution() (streamlit_src.controllers.admin_controller.AdminController method)</a>
 </li>
@@ -130,10 +132,10 @@
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.user_controller.UserController._is_current_data_available">_is_current_data_available() (streamlit_src.controllers.user_controller.UserController method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels._load_models">_load_models() (air_quality_forecast.prediction.PredictorModels method)</a>
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions">_make_custom_predictions() (streamlit_src.controllers.admin_controller.AdminController method)</a>
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.admin_controller.AdminController._make_prediction">_make_prediction() (streamlit_src.controllers.admin_controller.AdminController method)</a>
@@ -169,6 +171,10 @@
 </li>
       </ul></li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller._two_days_ago">_two_days_ago() (air_quality_forecast.api_caller.APICaller method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -438,6 +444,8 @@
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="air_quality_forecast.html#air_quality_forecast.parser_ui.normalize_data">normalize_data() (in module air_quality_forecast.parser_ui)</a>
 </li>
   </ul></td>
@@ -458,7 +466,7 @@
 </li>
       <li><a href="streamlit_src.views.html#streamlit_src.views.user_view.UserView.print_sources">print_sources() (streamlit_src.views.user_view.UserView method)</a>
 </li>
-      <li><a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.prompt_admin_password">prompt_admin_password() (streamlit_src.views.home_view.HomeView method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -502,7 +510,7 @@
 </li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.select_features">select_features() (air_quality_forecast.data_pipeline.FeatureProcessor method)</a>
 </li>
-      <li><a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.set_layout">set_layout() (streamlit_src.views.home_view.HomeView method)</a>
 </li>
       <li><a href="streamlit_src.views.html#streamlit_src.views.admin_view.AdminView.show_admin_pages">show_admin_pages() (streamlit_src.views.admin_view.AdminView method)</a>
 </li>
@@ -514,7 +522,7 @@
         <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.user_controller.UserController.show_dashboard">(streamlit_src.controllers.user_controller.UserController method)</a>
 </li>
       </ul></li>
-      <li><a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.show_dashboard_switch">show_dashboard_switch() (streamlit_src.views.home_view.HomeView method)</a>
 </li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.sort_data_by_date">sort_data_by_date() (air_quality_forecast.data_pipeline.FeatureProcessor method)</a>
 </li>
@@ -682,7 +690,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -693,7 +701,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="#" />
+    <link rel="search" title="Search" href="search.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 <h1 id="index">Index</h1>
  | <a href="#U"><strong>U</strong></a>
  | <a href="#V"><strong>V</strong></a>
  | <a href="#X"><strong>X</strong></a>
 </div>
 <h2 id="_">_</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH">__ADMIN_PASSWORD_HASH (streamlit_src.controllers.home_controller.HomeController attribute)</a>
+</li>
+      <li><a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.__init__">__init__() (streamlit_src.views.home_view.HomeView method)</a>
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.admin_controller.AdminController._check_data_out_of_distribution">_check_data_out_of_distribution() (streamlit_src.controllers.admin_controller.AdminController method)</a>
 </li>
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.user_controller.UserController._is_current_data_available">_is_current_data_available() (streamlit_src.controllers.user_controller.UserController method)</a>
 </li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels._load_models">_load_models() (air_quality_forecast.prediction.PredictorModels method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions">_make_custom_predictions() (streamlit_src.controllers.admin_controller.AdminController method)</a>
 </li>
       <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.admin_controller.AdminController._make_prediction">_make_prediction() (streamlit_src.controllers.admin_controller.AdminController method)</a>
 </li>
       </ul></li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller._two_days_ago">_two_days_ago() (air_quality_forecast.api_caller.APICaller method)</a>
+</li>
+      <li><a href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel._WHO_NO2_LEVEL">_WHO_NO2_LEVEL (streamlit_src.models.air_quality_model.AirQualityModel attribute)</a>
+</li>
+      <li><a href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel._WHO_O3_LEVEL">_WHO_O3_LEVEL (streamlit_src.models.air_quality_model.AirQualityModel attribute)</a>
 </li>
   </ul></td>
 </tr></table>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None">None (streamlit_src.views.home_view.HomeView attribute)</a>
+</li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.parser_ui.normalize_data">normalize_data() (in module air_quality_forecast.parser_ui)</a>
 </li>
   </ul></td>
 </li>
       <li><a href="streamlit_src.views.html#streamlit_src.views.user_view.UserView.print_sources">print_sources() (streamlit_src.views.user_view.UserView method)</a>
 </li>
+      <li><a href="streamlit_src.views.html#id0">prompt_admin_password() (streamlit_src.views.home_view.HomeView method)</a>, <a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.prompt_admin_password">[1]</a>
 </li>
   </ul></td>
 </tr></table>
 </li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.select_features">select_features() (air_quality_forecast.data_pipeline.FeatureProcessor method)</a>
 </li>
+      <li><a href="streamlit_src.views.html#id1">set_layout() (streamlit_src.views.home_view.HomeView method)</a>, <a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.set_layout">[1]</a>
 </li>
       <li><a href="streamlit_src.views.html#streamlit_src.views.admin_view.AdminView.show_admin_pages">show_admin_pages() (streamlit_src.views.admin_view.AdminView method)</a>
 </li>
         <li><a href="streamlit_src.controllers.html#streamlit_src.controllers.user_controller.UserController.show_dashboard">(streamlit_src.controllers.user_controller.UserController method)</a>
 </li>
       </ul></li>
+      <li><a href="streamlit_src.views.html#id2">show_dashboard_switch() (streamlit_src.views.home_view.HomeView method)</a>, <a href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.show_dashboard_switch">[1]</a>
 </li>
       <li><a href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.sort_data_by_date">sort_data_by_date() (air_quality_forecast.data_pipeline.FeatureProcessor method)</a>
 </li>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/objects.inv CHANGED Viewed

Binary files a/docs/_build/html/objects.inv and b/docs/_build/html/objects.inv differ

docs/_build/html/searchindex.js CHANGED Viewed

@@ -1 +1 @@

- Search.setIndex({"alltitles": {"Air Quality Forecast documentation": [[1, null]], "Codebase": [[1, "codebase"]], "Contents:": [[1, null]], "Deployment": [[1, "deployment"]], "Directory Breakdown": [[1, "directory-breakdown"]], "Module contents": [[0, "module-air_quality_forecast"], [3, "module-streamlit_src"], [4, "module-streamlit_src.controllers"], [5, "module-streamlit_src.models"], [6, "module-streamlit_src.views"]], "Problem Statement": [[1, "problem-statement"]], "Project Structure": [[1, "project-structure"]], "Retraining Protocol": [[1, "retraining-protocol"]], "Submodules": [[0, "submodules"], [3, "submodules"], [4, "submodules"], [5, "submodules"], [6, "submodules"]], "Subpackages": [[3, "subpackages"]], "Workflow": [[1, "workflow"]], "air-quality-forecast": [[2, null]], "air_quality_forecast package": [[0, null]], "air_quality_forecast.api_caller module": [[0, "module-air_quality_forecast.api_caller"]], "air_quality_forecast.data_pipeline module": [[0, "module-air_quality_forecast.data_pipeline"]], "air_quality_forecast.get_prediction_data module": [[0, "module-air_quality_forecast.get_prediction_data"]], "air_quality_forecast.main module": [[0, "module-air_quality_forecast.main"]], "air_quality_forecast.model_development module": [[0, "module-air_quality_forecast.model_development"]], "air_quality_forecast.parser_ui module": [[0, "module-air_quality_forecast.parser_ui"]], "air_quality_forecast.prediction module": [[0, "module-air_quality_forecast.prediction"]], "air_quality_forecast.utils module": [[0, "module-air_quality_forecast.utils"]], "streamlit_src package": [[3, null]], "streamlit_src.app module": [[3, "module-streamlit_src.app"]], "streamlit_src.controllers package": [[4, null]], "streamlit_src.controllers.admin_controller module": [[4, "module-streamlit_src.controllers.admin_controller"]], "streamlit_src.controllers.home_controller module": [[4, "module-streamlit_src.controllers.home_controller"]], "streamlit_src.controllers.user_controller module": [[4, "module-streamlit_src.controllers.user_controller"]], "streamlit_src.models package": [[5, null]], "streamlit_src.models.air_quality_model module": [[5, "module-streamlit_src.models.air_quality_model"]], "streamlit_src.views package": [[6, null]], "streamlit_src.views.admin_view module": [[6, "module-streamlit_src.views.admin_view"]], "streamlit_src.views.home_view module": [[6, "module-streamlit_src.views.home_view"]], "streamlit_src.views.user_view module": [[6, "module-streamlit_src.views.user_view"]]}, "docnames": ["air_quality_forecast", "index", "modules", "streamlit_src", "streamlit_src.controllers", "streamlit_src.models", "streamlit_src.views"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["air_quality_forecast.rst", "index.rst", "modules.rst", "streamlit_src.rst", "streamlit_src.controllers.rst", "streamlit_src.models.rst", "streamlit_src.views.rst"], "indexentries": {"__admin_password_hash (streamlit_src.controllers.home_controller.homecontroller attribute)": [[4, "streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH", false]], "_check_data_out_of_distribution() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._check_data_out_of_distribution", false]], "_compare_to_who() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._compare_to_who", false]], "_compute_distribution_statistics() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._compute_distribution_statistics", false]], "_create_gauge_plot() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._create_gauge_plot", false]], "_current_time() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller._current_time", false]], "_data_is_valid() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._data_is_valid", false]], "_display_compare_who() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._display_compare_who", false]], "_display_plots() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._display_plots", false]], "_display_sources() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._display_sources", false]], "_evaluate_model() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._evaluate_model", false]], "_feature_importance() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._feature_importance", false]], "_get_color() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._get_color", false]], "_get_luchtmeet_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller._get_luchtmeet_data", false]], "_get_next_three_days_dates() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._get_next_three_days_dates", false]], "_hash_password() (streamlit_src.controllers.home_controller.homecontroller method)": [[4, "streamlit_src.controllers.home_controller.HomeController._hash_password", false]], "_is_current_data_available() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._is_current_data_available", false]], "_load_models() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels._load_models", false]], "_make_custom_predictions() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions", false]], "_make_prediction() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._make_prediction", false]], "_model_metrics() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._model_metrics", false]], "_optimize_and_evaluate() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._optimize_and_evaluate", false]], "_perform_search() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._perform_search", false]], "_prepare_awareness_content() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_awareness_content", false]], "_prepare_data_for_view() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_data_for_view", false]], "_prepare_gauge_plots() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_gauge_plots", false]], "_prepare_line_plot() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_line_plot", false]], "_quiz() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._quiz", false]], "_raise_awareness() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._raise_awareness", false]], "_run() (streamlit_src.controllers.home_controller.homecontroller method)": [[4, "streamlit_src.controllers.home_controller.HomeController._run", false]], "_set_data() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._set_data", false]], "_setup_mlflow() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._setup_mlflow", false]], "_show_current_data() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._show_current_data", false]], "_show_current_data() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._show_current_data", false]], "_two_days_ago() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller._two_days_ago", false]], "admincontroller (class in streamlit_src.controllers.admin_controller)": [[4, "streamlit_src.controllers.admin_controller.AdminController", false]], "adminview (class in streamlit_src.views.admin_view)": [[6, "streamlit_src.views.admin_view.AdminView", false]], "air_quality_forecast": [[0, "module-air_quality_forecast", false]], "air_quality_forecast.api_caller": [[0, "module-air_quality_forecast.api_caller", false]], "air_quality_forecast.data_pipeline": [[0, "module-air_quality_forecast.data_pipeline", false]], "air_quality_forecast.get_prediction_data": [[0, "module-air_quality_forecast.get_prediction_data", false]], "air_quality_forecast.main": [[0, "module-air_quality_forecast.main", false]], "air_quality_forecast.model_development": [[0, "module-air_quality_forecast.model_development", false]], "air_quality_forecast.parser_ui": [[0, "module-air_quality_forecast.parser_ui", false]], "air_quality_forecast.prediction": [[0, "module-air_quality_forecast.prediction", false]], "air_quality_forecast.utils": [[0, "module-air_quality_forecast.utils", false]], "airqualitymodel (class in streamlit_src.models.air_quality_model)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel", false]], "apicaller (class in air_quality_forecast.api_caller)": [[0, "air_quality_forecast.api_caller.APICaller", false]], "apply_time_shift() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.apply_time_shift", false]], "calculate_metrics() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics", false]], "change_to_numeric() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.change_to_numeric", false]], "compare_to_who() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.compare_to_who", false]], "confirm_checks() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.confirm_checks", false]], "convert_param_space() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.convert_param_space", false]], "create_parser() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.create_parser", false]], "data_not_available() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.data_not_available", false]], "dataloader (class in air_quality_forecast.data_pipeline)": [[0, "air_quality_forecast.data_pipeline.DataLoader", false]], "decision_tree_predictions() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels.decision_tree_predictions", false]], "display_datatable() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.display_datatable", false]], "display_feature_importance() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.display_feature_importance", false]], "display_predictions_gaugeplot() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.display_predictions_gaugeplot", false]], "display_predictions_lineplot() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.display_predictions_lineplot", false]], "download_button() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.download_button", false]], "error() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.error", false]], "featureprocessor (class in air_quality_forecast.data_pipeline)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor", false]], "featureselector (class in air_quality_forecast.utils)": [[0, "air_quality_forecast.utils.FeatureSelector", false]], "get_all_data_last_three_days() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days", false]], "get_last_three_days() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days", false]], "get_luchtmeet_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller.get_luchtmeet_data", false]], "get_today_data() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.get_today_data", false]], "get_vc_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller.get_vc_data", false]], "homecontroller (class in streamlit_src.controllers.home_controller)": [[4, "streamlit_src.controllers.home_controller.HomeController", false]], "homeview (class in streamlit_src.views.home_view)": [[6, "streamlit_src.views.home_view.HomeView", false]], "inputvalidator (class in air_quality_forecast.utils)": [[0, "air_quality_forecast.utils.InputValidator", false]], "lag_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller.lag_data", false]], "launch_mlflow_server() (air_quality_forecast.model_development.regressortrainer static method)": [[0, "air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server", false]], "load_data() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.load_data", false]], "main() (in module air_quality_forecast.get_prediction_data)": [[0, "air_quality_forecast.get_prediction_data.main", false]], "main() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.main", false]], "merge_raw_data() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.merge_raw_data", false]], "module": [[0, "module-air_quality_forecast", false], [0, "module-air_quality_forecast.api_caller", false], [0, "module-air_quality_forecast.data_pipeline", false], [0, "module-air_quality_forecast.get_prediction_data", false], [0, "module-air_quality_forecast.main", false], [0, "module-air_quality_forecast.model_development", false], [0, "module-air_quality_forecast.parser_ui", false], [0, "module-air_quality_forecast.prediction", false], [0, "module-air_quality_forecast.utils", false], [3, "module-streamlit_src", false], [3, "module-streamlit_src.app", false], [4, "module-streamlit_src.controllers", false], [4, "module-streamlit_src.controllers.admin_controller", false], [4, "module-streamlit_src.controllers.home_controller", false], [4, "module-streamlit_src.controllers.user_controller", false], [5, "module-streamlit_src.models", false], [5, "module-streamlit_src.models.air_quality_model", false], [6, "module-streamlit_src.views", false], [6, "module-streamlit_src.views.admin_view", false], [6, "module-streamlit_src.views.home_view", false], [6, "module-streamlit_src.views.user_view", false]], "next_three_day_predictions() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions", false]], "normalize_data() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.normalize_data", false]], "port_in_use() (air_quality_forecast.model_development.regressortrainer static method)": [[0, "air_quality_forecast.model_development.RegressorTrainer.port_in_use", false]], "predictormodels (class in air_quality_forecast.prediction)": [[0, "air_quality_forecast.prediction.PredictorModels", false]], "preprocess_data() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.preprocess_data", false]], "preprocessingpipeline (class in air_quality_forecast.data_pipeline)": [[0, "air_quality_forecast.data_pipeline.PreprocessingPipeline", false]], "print_sources() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.print_sources", false]], "prompt_admin_password() (streamlit_src.views.home_view.homeview method)": [[6, "streamlit_src.views.home_view.HomeView.prompt_admin_password", false]], "quiz() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.quiz", false]], "raise_awareness() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.raise_awareness", false]], "random_forest_predictions() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels.random_forest_predictions", false]], "regressortrainer (class in air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.RegressorTrainer", false]], "rename_initial_columns() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.rename_initial_columns", false]], "run() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer.run", false]], "run_bayesian_optimization() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.run_bayesian_optimization", false]], "run_pipeline() (air_quality_forecast.data_pipeline.preprocessingpipeline method)": [[0, "air_quality_forecast.data_pipeline.PreprocessingPipeline.run_pipeline", false]], "save_to_csv() (air_quality_forecast.data_pipeline.dataloader method)": [[0, "air_quality_forecast.data_pipeline.DataLoader.save_to_csv", false]], "select_cols_by_correlation() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.select_cols_by_correlation", false]], "select_features() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.select_features", false]], "set_layout() (streamlit_src.views.home_view.homeview method)": [[6, "streamlit_src.views.home_view.HomeView.set_layout", false]], "show_admin_pages() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.show_admin_pages", false]], "show_current_data() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.show_current_data", false]], "show_dashboard() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController.show_dashboard", false]], "show_dashboard() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController.show_dashboard", false]], "show_dashboard_switch() (streamlit_src.views.home_view.homeview method)": [[6, "streamlit_src.views.home_view.HomeView.show_dashboard_switch", false]], "sort_data_by_date() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.sort_data_by_date", false]], "streamlit_src": [[3, "module-streamlit_src", false]], "streamlit_src.app": [[3, "module-streamlit_src.app", false]], "streamlit_src.controllers": [[4, "module-streamlit_src.controllers", false]], "streamlit_src.controllers.admin_controller": [[4, "module-streamlit_src.controllers.admin_controller", false]], "streamlit_src.controllers.home_controller": [[4, "module-streamlit_src.controllers.home_controller", false]], "streamlit_src.controllers.user_controller": [[4, "module-streamlit_src.controllers.user_controller", false]], "streamlit_src.models": [[5, "module-streamlit_src.models", false]], "streamlit_src.models.air_quality_model": [[5, "module-streamlit_src.models.air_quality_model", false]], "streamlit_src.views": [[6, "module-streamlit_src.views", false]], "streamlit_src.views.admin_view": [[6, "module-streamlit_src.views.admin_view", false]], "streamlit_src.views.home_view": [[6, "module-streamlit_src.views.home_view", false]], "streamlit_src.views.user_view": [[6, "module-streamlit_src.views.user_view", false]], "success() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.success", false]], "train_all_models() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.train_all_models", false]], "train_model() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.train_model", false]], "train_one_model() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.train_one_model", false]], "train_test_split() (air_quality_forecast.data_pipeline.preprocessingpipeline method)": [[0, "air_quality_forecast.data_pipeline.PreprocessingPipeline.train_test_split", false]], "two_columns_layout() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.two_columns_layout", false]], "uninformative_columns() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.uninformative_columns", false]], "upload_dataset() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.upload_dataset", false]], "upload_instructions() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.upload_instructions", false]], "usercontroller (class in streamlit_src.controllers.user_controller)": [[4, "streamlit_src.controllers.user_controller.UserController", false]], "userview (class in streamlit_src.views.user_view)": [[6, "streamlit_src.views.user_view.UserView", false]], "validate_file_exists() (air_quality_forecast.utils.inputvalidator static method)": [[0, "air_quality_forecast.utils.InputValidator.validate_file_exists", false]], "validate_type() (air_quality_forecast.utils.inputvalidator static method)": [[0, "air_quality_forecast.utils.InputValidator.validate_type", false]], "view_option_selection() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.view_option_selection", false]], "xgb_predictions() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels.xgb_predictions", false]]}, "objects": {"": [[0, 0, 0, "-", "air_quality_forecast"], [3, 0, 0, "-", "streamlit_src"]], "air_quality_forecast": [[0, 0, 0, "-", "api_caller"], [0, 0, 0, "-", "data_pipeline"], [0, 0, 0, "-", "get_prediction_data"], [0, 0, 0, "-", "main"], [0, 0, 0, "-", "model_development"], [0, 0, 0, "-", "parser_ui"], [0, 0, 0, "-", "prediction"], [0, 0, 0, "-", "utils"]], "air_quality_forecast.api_caller": [[0, 1, 1, "", "APICaller"]], "air_quality_forecast.api_caller.APICaller": [[0, 2, 1, "", "_current_time"], [0, 2, 1, "", "_get_luchtmeet_data"], [0, 2, 1, "", "_two_days_ago"], [0, 2, 1, "", "get_luchtmeet_data"], [0, 2, 1, "", "get_vc_data"], [0, 2, 1, "", "lag_data"]], "air_quality_forecast.data_pipeline": [[0, 1, 1, "", "DataLoader"], [0, 1, 1, "", "FeatureProcessor"], [0, 1, 1, "", "PreprocessingPipeline"]], "air_quality_forecast.data_pipeline.DataLoader": [[0, 2, 1, "", "save_to_csv"]], "air_quality_forecast.data_pipeline.FeatureProcessor": [[0, 2, 1, "", "apply_time_shift"], [0, 2, 1, "", "merge_raw_data"], [0, 2, 1, "", "preprocess_data"], [0, 2, 1, "", "select_features"], [0, 2, 1, "", "sort_data_by_date"]], "air_quality_forecast.data_pipeline.PreprocessingPipeline": [[0, 2, 1, "", "run_pipeline"], [0, 2, 1, "", "train_test_split"]], "air_quality_forecast.get_prediction_data": [[0, 3, 1, "", "main"]], "air_quality_forecast.model_development": [[0, 1, 1, "", "RegressorTrainer"], [0, 3, 1, "", "convert_param_space"], [0, 3, 1, "", "run_bayesian_optimization"], [0, 3, 1, "", "train_all_models"], [0, 3, 1, "", "train_one_model"]], "air_quality_forecast.model_development.RegressorTrainer": [[0, 2, 1, "", "_evaluate_model"], [0, 2, 1, "", "_optimize_and_evaluate"], [0, 2, 1, "", "_perform_search"], [0, 2, 1, "", "_set_data"], [0, 2, 1, "", "_setup_mlflow"], [0, 2, 1, "", "launch_mlflow_server"], [0, 2, 1, "", "port_in_use"], [0, 2, 1, "", "run"]], "air_quality_forecast.parser_ui": [[0, 3, 1, "", "create_parser"], [0, 3, 1, "", "load_data"], [0, 3, 1, "", "main"], [0, 3, 1, "", "normalize_data"], [0, 3, 1, "", "train_model"]], "air_quality_forecast.prediction": [[0, 1, 1, "", "PredictorModels"]], "air_quality_forecast.prediction.PredictorModels": [[0, 2, 1, "", "_load_models"], [0, 2, 1, "", "decision_tree_predictions"], [0, 2, 1, "", "random_forest_predictions"], [0, 2, 1, "", "xgb_predictions"]], "air_quality_forecast.utils": [[0, 1, 1, "", "FeatureSelector"], [0, 1, 1, "", "InputValidator"]], "air_quality_forecast.utils.FeatureSelector": [[0, 2, 1, "", "change_to_numeric"], [0, 2, 1, "", "rename_initial_columns"], [0, 2, 1, "", "select_cols_by_correlation"], [0, 2, 1, "", "uninformative_columns"]], "air_quality_forecast.utils.InputValidator": [[0, 2, 1, "", "validate_file_exists"], [0, 2, 1, "", "validate_type"]], "streamlit_src": [[3, 0, 0, "-", "app"], [4, 0, 0, "-", "controllers"], [5, 0, 0, "-", "models"], [6, 0, 0, "-", "views"]], "streamlit_src.controllers": [[4, 0, 0, "-", "admin_controller"], [4, 0, 0, "-", "home_controller"], [4, 0, 0, "-", "user_controller"]], "streamlit_src.controllers.admin_controller": [[4, 1, 1, "", "AdminController"]], "streamlit_src.controllers.admin_controller.AdminController": [[4, 2, 1, "", "_check_data_out_of_distribution"], [4, 2, 1, "", "_compute_distribution_statistics"], [4, 2, 1, "", "_data_is_valid"], [4, 2, 1, "", "_feature_importance"], [4, 2, 1, "", "_make_custom_predictions"], [4, 2, 1, "", "_make_prediction"], [4, 2, 1, "", "_model_metrics"], [4, 2, 1, "", "_show_current_data"], [4, 2, 1, "", "show_dashboard"]], "streamlit_src.controllers.home_controller": [[4, 1, 1, "", "HomeController"]], "streamlit_src.controllers.home_controller.HomeController": [[4, 4, 1, "", "__ADMIN_PASSWORD_HASH"], [4, 2, 1, "", "_hash_password"], [4, 2, 1, "", "_run"]], "streamlit_src.controllers.user_controller": [[4, 1, 1, "", "UserController"]], "streamlit_src.controllers.user_controller.UserController": [[4, 2, 1, "", "_compare_to_who"], [4, 2, 1, "", "_create_gauge_plot"], [4, 2, 1, "", "_display_compare_who"], [4, 2, 1, "", "_display_plots"], [4, 2, 1, "", "_display_sources"], [4, 2, 1, "", "_get_color"], [4, 2, 1, "", "_get_next_three_days_dates"], [4, 2, 1, "", "_is_current_data_available"], [4, 2, 1, "", "_prepare_awareness_content"], [4, 2, 1, "", "_prepare_data_for_view"], [4, 2, 1, "", "_prepare_gauge_plots"], [4, 2, 1, "", "_prepare_line_plot"], [4, 2, 1, "", "_quiz"], [4, 2, 1, "", "_raise_awareness"], [4, 2, 1, "", "_show_current_data"], [4, 2, 1, "", "show_dashboard"]], "streamlit_src.models": [[5, 0, 0, "-", "air_quality_model"]], "streamlit_src.models.air_quality_model": [[5, 1, 1, "", "AirQualityModel"]], "streamlit_src.models.air_quality_model.AirQualityModel": [[5, 2, 1, "", "calculate_metrics"], [5, 2, 1, "", "get_all_data_last_three_days"], [5, 2, 1, "", "get_last_three_days"], [5, 2, 1, "", "get_today_data"], [5, 2, 1, "", "next_three_day_predictions"]], "streamlit_src.views": [[6, 0, 0, "-", "admin_view"], [6, 0, 0, "-", "home_view"], [6, 0, 0, "-", "user_view"]], "streamlit_src.views.admin_view": [[6, 1, 1, "", "AdminView"]], "streamlit_src.views.admin_view.AdminView": [[6, 2, 1, "", "confirm_checks"], [6, 2, 1, "", "display_datatable"], [6, 2, 1, "", "display_feature_importance"], [6, 2, 1, "", "download_button"], [6, 2, 1, "", "show_admin_pages"], [6, 2, 1, "", "upload_dataset"], [6, 2, 1, "", "upload_instructions"]], "streamlit_src.views.home_view": [[6, 1, 1, "", "HomeView"]], "streamlit_src.views.home_view.HomeView": [[6, 2, 1, "", "prompt_admin_password"], [6, 2, 1, "", "set_layout"], [6, 2, 1, "", "show_dashboard_switch"]], "streamlit_src.views.user_view": [[6, 1, 1, "", "UserView"]], "streamlit_src.views.user_view.UserView": [[6, 2, 1, "", "compare_to_who"], [6, 2, 1, "", "data_not_available"], [6, 2, 1, "", "display_predictions_gaugeplot"], [6, 2, 1, "", "display_predictions_lineplot"], [6, 2, 1, "", "error"], [6, 2, 1, "", "print_sources"], [6, 2, 1, "", "quiz"], [6, 2, 1, "", "raise_awareness"], [6, 2, 1, "", "show_current_data"], [6, 2, 1, "", "success"], [6, 2, 1, "", "two_columns_layout"], [6, 2, 1, "", "view_option_selection"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute"}, "terms": {"0": 0, "00": [4, 6], "04": 6, "1": 0, "127": 0, "14": 4, "15": [4, 6], "2": 0, "240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9": 4, "256": 4, "3": [0, 4, 5], "5": 0, "50": 0, "5000": 0, "A": [0, 4, 5, 6], "By": 1, "If": 0, "In": 1, "It": [0, 1], "The": [0, 1, 4, 5, 6], "To": 1, "__admin_password_hash": [3, 4], "_check_data_out_of_distribut": [3, 4], "_compare_to_who": [3, 4], "_compute_distribution_statist": [3, 4], "_create_gauge_plot": [3, 4], "_current_tim": [0, 2], "_data_is_valid": [3, 4], "_display_compare_who": [3, 4], "_display_plot": [3, 4], "_display_sourc": [3, 4], "_evaluate_model": [0, 2], "_feature_import": [3, 4], "_get_color": [3, 4], "_get_luchtmeet_data": [0, 2], "_get_next_three_days_d": [3, 4], "_hash_password": [3, 4], "_is_current_data_avail": [3, 4], "_load_model": [0, 2], "_make_custom_predict": [3, 4], "_make_predict": [3, 4], "_model_metr": [3, 4], "_optimize_and_evalu": [0, 2], "_perform_search": [0, 2], "_prepare_awareness_cont": [3, 4], "_prepare_data_for_view": [3, 4], "_prepare_gauge_plot": [3, 4], "_prepare_line_plot": [3, 4], "_quiz": [3, 4], "_raise_awar": [3, 4], "_run": [3, 4], "_set_data": [0, 2], "_setup_mlflow": [0, 2], "_show_current_data": [3, 4], "_two_days_ago": [0, 2], "about": 6, "abov": 6, "access": 1, "accur": [1, 6], "across": 1, "admin": [1, 4, 6], "admin_control": [2, 3], "admin_view": [1, 2, 3], "admincontrol": [3, 4], "adminview": [3, 6], "aesthet": 6, "after": [1, 4], "air": [0, 4, 5, 6], "air_quality_forecast": [1, 2], "air_quality_model": [2, 3], "airqualitymodel": [3, 5], "algorithm": [0, 1], "all": [0, 1, 6], "along": 6, "alreadi": 0, "altern": 1, "an": [0, 1, 4, 6], "ani": [0, 1], "answer": [4, 6], "api": [0, 1, 4], "api_cal": [1, 2], "apical": [0, 2], "app": [1, 2], "appli": 0, "applic": [1, 6], "apply_time_shift": [0, 2], "appropri": 1, "ar": [0, 1, 6], "aren": 6, "argument": 0, "argumentpars": 0, "ask": 6, "attribut": 0, "autolog": 0, "automat": 6, "avail": [4, 6], "averag": 0, "awar": [4, 6], "awareness_expand": 6, "backend": 1, "base": [0, 1, 4, 5, 6], "baseestim": 0, "bayesian": 0, "bayessearchcv": 0, "becaus": 4, "been": 0, "befor": [0, 4], "best": 0, "better": 6, "between": 6, "bool": [0, 4, 6], "boolean": [4, 6], "both": 1, "bring": 1, "built": 1, "button": 6, "calcul": 4, "calculate_metr": [3, 5], "call": [0, 6], "callabl": 6, "can": [0, 1], "cd": 1, "certain": 1, "chang": [0, 1], "change_to_numer": [0, 2], "check": [0, 4, 6], "checkbox": 6, "choos": 1, "ci": 1, "class": [0, 4, 5, 6], "code": [1, 4], "collect": 1, "color": 4, "column": [0, 6], "command": [0, 1], "compar": [4, 6], "compare_to_who": [3, 6], "comparison": 4, "compon": 0, "comput": 4, "concentr": [4, 6], "config": [0, 1], "configur": 0, "confirm": 6, "confirm_check": [3, 6], "consist": 1, "contain": [1, 4, 6], "content": 2, "control": [1, 2, 3], "convert": 0, "convert_param_spac": [0, 2], "core": 1, "correct": [4, 6], "correl": 0, "correspond": [0, 4, 6], "creat": [4, 6], "create_pars": [0, 2], "criteria": 0, "cross": 0, "csv": [0, 5], "current": [0, 4, 6], "custom": [1, 4], "cv_split": 0, "dai": [0, 4, 5, 6], "daili": 0, "dashboard": 1, "data": [0, 1, 4, 5, 6], "data_not_avail": [3, 6], "data_pipelin": [1, 2], "datafram": [0, 4, 6], "dataload": [0, 2], "dataset": [0, 1, 4, 6], "date": [0, 4, 6], "dd": 0, "decis": [0, 1], "decision_tre": 0, "decision_tree_predict": [0, 2], "decisiontreeregressor": 0, "defin": 1, "deploi": 1, "design": 1, "determin": 4, "develop": 1, "deviat": 4, "dict": [0, 4, 6], "dictionari": [0, 6], "differ": 1, "directori": 0, "displai": [1, 4, 6], "display_datat": [3, 6], "display_feature_import": [3, 6], "display_predictions_gaugeplot": [3, 6], "display_predictions_lineplot": [3, 6], "distribut": 4, "divid": 6, "doe": 0, "download": 6, "download_button": [3, 6], "dure": 1, "e": 0, "each": 0, "easier": 1, "element": 6, "enabl": 0, "engin": 1, "enough": 6, "entir": 0, "entri": [0, 1], "environment": 1, "error": [0, 3, 6], "evalu": 0, "everi": 4, "exce": 4, "execut": 1, "exist": 0, "expand": [4, 6], "expect": 0, "expected_typ": 0, "experi": 0, "experiment_nam": 0, "extern": 1, "fact": [4, 6], "fals": [0, 4, 6], "featur": [0, 4, 6], "feature_import": 6, "featureprocessor": [0, 2], "featureselector": [0, 2], "fetch": [0, 1, 4], "fig": 6, "figur": [4, 6], "file": [0, 1, 5, 6], "file_nam": 6, "filenotfounderror": 0, "final": 0, "first": [0, 4], "float": [0, 4, 6], "follow": [0, 1], "forest": [0, 1], "format": [0, 1, 4, 6], "formula": 0, "friendli": 1, "from": [0, 1, 4, 5], "frontend": 1, "function": [0, 1, 6], "futur": [0, 1], "g": 0, "gaug": [4, 6], "gauge_plot": 6, "gener": 1, "get": 4, "get_all_data_last_three_dai": [3, 5], "get_last_three_dai": [3, 5], "get_luchtmeet_data": [0, 2], "get_prediction_data": [1, 2], "get_today_data": [3, 5], "get_vc_data": [0, 2], "given": [0, 4], "go": [4, 6], "graph": 6, "griftpark_data": 0, "guidelin": [4, 6], "ha": [0, 1], "handl": [1, 4, 6], "hash": 4, "have": 0, "health": [4, 6], "health_messag": 6, "hex": 4, "hh": 0, "histor": 1, "home_control": [2, 3], "home_view": [1, 2, 3], "homecontrol": [3, 4], "homepag": 1, "homeview": [3, 6], "http": 0, "hyperparamet": [0, 1], "hyperparameter_search_spac": [0, 1], "i": [0, 1, 4, 5, 6], "import": [4, 6], "importance_valu": 6, "includ": 4, "incom": 1, "index": [1, 4], "indic": [4, 6], "infer": 1, "inform": [0, 1], "inherit": 4, "initi": 0, "input": [0, 1, 4], "input_data": 4, "inputvalid": [0, 2], "instruct": 6, "int": 0, "integr": 1, "interact": 1, "interfac": [1, 4, 6], "issu": 6, "iter": 0, "json": [0, 1], "just": 0, "kei": 0, "label": [0, 6], "lag": 0, "lag_data": [0, 2], "last": 0, "launch": [0, 1], "launch_mlflow_serv": [0, 2], "learn": 1, "left": 6, "left_funct": 6, "level": [1, 4, 6], "line": [0, 4, 6], "list": [0, 4, 6], "load": [0, 1], "load_data": [0, 2], "local": 1, "locat": 5, "log": 0, "logic": 1, "luchtmeet": 0, "machin": 1, "made": 1, "main": [1, 2, 4], "make": [0, 1, 4], "manag": 1, "maximum": 0, "mean": [0, 4], "measur": 6, "merg": 0, "merge_raw_data": [0, 2], "merged_data_df": 6, "messag": [0, 4, 6], "method": 0, "metric": [0, 4], "minut": 4, "miss": 0, "mlflow": 0, "mm": 0, "model": [0, 1, 2, 3, 4], "model_develop": [1, 2], "modul": [1, 2], "most": 0, "mvc": 1, "n_iter": [0, 1], "name": [0, 4, 6], "ndarrai": 0, "new": [0, 4], "next": [4, 6], "next_three_day_predict": [3, 5], "nice": 0, "no2": [0, 4, 6], "none": [0, 4, 6], "normal": 0, "normalize_data": [0, 2], "normalizer_typ": 0, "note": 1, "now": 0, "np": 0, "number": 0, "numer": 0, "o3": [0, 4, 6], "obei": 1, "object": [0, 1, 4, 5, 6], "obtain": 5, "offer": 1, "oldest": 0, "one": 1, "onli": 1, "oper": 1, "optim": 0, "option": 6, "order": 0, "organ": 1, "other": [0, 1], "otherwis": [0, 4, 6], "out": [0, 4], "output": 1, "over": 0, "packag": [1, 2], "page": [1, 4, 6], "panda": [0, 4, 5, 6], "param_spac": 0, "paramet": [0, 4, 6], "pars": [0, 1], "parser": 1, "parser_ui": [1, 2], "password": 4, "past": [0, 5], "past_data_path": 5, "path": [0, 1], "pattern": 1, "pd": [0, 4, 5, 6], "per": 1, "perform": [0, 1, 4], "period": 4, "pipelin": [0, 1], "pkl": 0, "placehold": 1, "plot": [0, 4, 6], "plot_typ": 6, "plotli": [4, 6], "pm25": 0, "point": [0, 1], "pollut": [4, 6], "port": 0, "port_in_us": [0, 2], "possibl": 0, "pre": 0, "predict": [1, 2, 4, 6], "prediction_path": 1, "predictormodel": [0, 2], "prepar": 4, "preprocess": [0, 1], "preprocess_data": [0, 2], "preprocessingpipelin": [0, 2], "print": [0, 6], "print_sourc": [3, 6], "process": [0, 1], "processed_data_path": 0, "produc": 6, "prompt_admin_password": [3, 6], "provid": [0, 1, 6], "py": 1, "python": 1, "qualiti": [0, 4, 5, 6], "queri": [0, 4], "question": [4, 6], "quit": 0, "quiz": [3, 6], "rais": [0, 6], "raise_awar": [3, 6], "random": [0, 1, 4, 6], "random_fact": 6, "random_forest": 0, "random_forest_predict": [0, 2], "randomforestregressor": 0, "rang": 0, "ratio": 6, "raw": 0, "raw_data_path": 0, "real": 1, "recent": 0, "recommend": 6, "regressor": 0, "regressortrain": [0, 2], "regular": 1, "relat": 1, "relev": 0, "remov": 0, "renam": 0, "rename_initial_column": [0, 2], "repres": [0, 4], "requir": [0, 1, 6], "respons": 0, "result": [1, 6], "retriev": [1, 4], "return": [0, 4, 5, 6], "right": 6, "right_funct": 6, "row": 0, "run": [0, 1, 2], "run_bayesian_optim": [0, 2], "run_pipelin": [0, 2], "sai": 0, "same": 0, "save": 0, "save_to_csv": [0, 2], "saved_model": 0, "scheme": 0, "score": 4, "script": 1, "search": [0, 1], "second": 4, "select": [0, 6], "select_cols_by_correl": [0, 2], "select_featur": [0, 2], "separ": 1, "seri": 5, "server": 0, "set": 0, "set_layout": [3, 6], "sha": 4, "shift": 0, "short": 4, "show": [4, 6], "show_admin_pag": [3, 6], "show_current_data": [3, 6], "show_dashboard": [3, 4], "show_dashboard_switch": [3, 6], "shown": 6, "singl": 0, "sklearn": 0, "skopt": 0, "so": 0, "solut": 1, "sort": 0, "sort_data_by_d": [0, 2], "sourc": [0, 1, 4, 5, 6], "space": [0, 1], "specif": [0, 1], "specifi": 1, "split": 0, "squar": 0, "ss": 0, "stage": 1, "standard": 4, "start": 0, "static": 0, "station": 0, "station_numb": 0, "step": 1, "str": [0, 4, 6], "streamlit": 1, "streamlit_src": [1, 2], "string": 6, "submodul": [1, 2], "subpackag": [1, 2], "success": [3, 6], "suitabl": 1, "system": [0, 1], "t": 6, "t_max": 0, "tabl": 6, "take": 0, "techniqu": 1, "test": 0, "test_siz": 0, "text": 6, "them": 6, "thi": [0, 1, 4, 6], "those": 0, "three": [0, 4, 6], "threshold": 4, "through": 1, "time": [0, 1, 4, 6], "timeseriessplit": 0, "titl": [4, 6], "todai": 5, "togeth": 1, "track": 0, "train": [0, 1, 4], "train_all_model": [0, 2], "train_model": [0, 2], "train_one_model": [0, 2], "train_test_split": [0, 2], "transform": 1, "tree": [0, 1], "true": [0, 4, 6], "tupl": [0, 4, 6], "turn": 0, "two": [0, 1, 4, 6], "two_columns_layout": [3, 6], "type": [0, 4, 5, 6], "typeerror": 0, "ui": 1, "uninformative_column": [0, 2], "up": 0, "updat": 6, "upload": [4, 6], "upload_dataset": [3, 6], "upload_instruct": [3, 6], "uri": 0, "url": 6, "us": [0, 1, 4, 6], "usabl": 0, "user": [1, 4, 6], "user_control": [2, 3], "user_view": [1, 2, 3], "usercontrol": [3, 4], "userview": [3, 6], "util": [1, 2], "utrecht": 0, "utrecht_data": 0, "valid": [0, 1, 4], "validate_file_exist": [0, 2], "validate_typ": [0, 2], "valu": [0, 4, 6], "valueerror": 0, "variabl": 0, "variable_nam": 0, "variou": 1, "via": 1, "view": [1, 2, 3, 4], "view_option_select": [3, 6], "visual": 0, "wa": [4, 6], "want": 0, "warn": 6, "weather": 0, "web": 1, "when": 6, "where": 0, "whether": [0, 4, 6], "which": [1, 4], "whitespac": 0, "who": [4, 6], "who_limit": 4, "within": [1, 6], "without": 0, "workflow": 0, "wrap": 0, "x": 0, "x_test": 0, "x_test_path": [0, 1], "x_train": 0, "x_train_path": [0, 1], "xgb": 0, "xgb_predict": [0, 2], "xgboost": [0, 4], "xgbregressor": 0, "y": 0, "y_pred": 0, "y_test": 0, "y_test_path": [0, 1], "y_train": 0, "y_train_path": [0, 1], "yaml": [0, 1], "you": [0, 1], "yyyi": 0, "z": 4}, "titles": ["air_quality_forecast package", "Air Quality Forecast documentation", "air-quality-forecast", "streamlit_src package", "streamlit_src.controllers package", "streamlit_src.models package", "streamlit_src.views package"], "titleterms": {"admin_control": 4, "admin_view": 6, "air": [1, 2], "air_quality_forecast": 0, "air_quality_model": 5, "api_cal": 0, "app": 3, "breakdown": 1, "codebas": 1, "content": [0, 1, 3, 4, 5, 6], "control": 4, "data_pipelin": 0, "deploy": 1, "directori": 1, "document": 1, "forecast": [1, 2], "get_prediction_data": 0, "home_control": 4, "home_view": 6, "main": 0, "model": 5, "model_develop": 0, "modul": [0, 3, 4, 5, 6], "packag": [0, 3, 4, 5, 6], "parser_ui": 0, "predict": 0, "problem": 1, "project": 1, "protocol": 1, "qualiti": [1, 2], "retrain": 1, "statement": 1, "streamlit_src": [3, 4, 5, 6], "structur": 1, "submodul": [0, 3, 4, 5, 6], "subpackag": 3, "user_control": 4, "user_view": 6, "util": 0, "view": 6, "workflow": 1}})

+ Search.setIndex({"alltitles": {"Air Quality Forecast documentation": [[1, null]], "Codebase": [[1, "codebase"]], "Contents:": [[1, null]], "Deployment": [[1, "deployment"]], "Directory Breakdown": [[1, "directory-breakdown"]], "Module contents": [[0, "module-air_quality_forecast"], [3, "module-streamlit_src"], [4, "module-streamlit_src.controllers"], [5, "module-streamlit_src.models"], [6, "module-streamlit_src.views"]], "Problem Statement": [[1, "problem-statement"]], "Project Structure": [[1, "project-structure"]], "Retraining Protocol": [[1, "retraining-protocol"]], "Submodules": [[0, "submodules"], [3, "submodules"], [4, "submodules"], [5, "submodules"], [6, "submodules"]], "Subpackages": [[3, "subpackages"]], "Workflow": [[1, "workflow"]], "air-quality-forecast": [[2, null]], "air_quality_forecast package": [[0, null]], "air_quality_forecast.api_caller module": [[0, "module-air_quality_forecast.api_caller"]], "air_quality_forecast.data_pipeline module": [[0, "module-air_quality_forecast.data_pipeline"]], "air_quality_forecast.get_prediction_data module": [[0, "module-air_quality_forecast.get_prediction_data"]], "air_quality_forecast.main module": [[0, "module-air_quality_forecast.main"]], "air_quality_forecast.model_development module": [[0, "module-air_quality_forecast.model_development"]], "air_quality_forecast.parser_ui module": [[0, "module-air_quality_forecast.parser_ui"]], "air_quality_forecast.prediction module": [[0, "module-air_quality_forecast.prediction"]], "air_quality_forecast.utils module": [[0, "module-air_quality_forecast.utils"]], "streamlit_src package": [[3, null]], "streamlit_src.app module": [[3, "module-streamlit_src.app"]], "streamlit_src.controllers package": [[4, null]], "streamlit_src.controllers.admin_controller module": [[4, "module-streamlit_src.controllers.admin_controller"]], "streamlit_src.controllers.home_controller module": [[4, "module-streamlit_src.controllers.home_controller"]], "streamlit_src.controllers.user_controller module": [[4, "module-streamlit_src.controllers.user_controller"]], "streamlit_src.models package": [[5, null]], "streamlit_src.models.air_quality_model module": [[5, "module-streamlit_src.models.air_quality_model"]], "streamlit_src.views package": [[6, null]], "streamlit_src.views.admin_view module": [[6, "module-streamlit_src.views.admin_view"]], "streamlit_src.views.home_view module": [[6, "module-streamlit_src.views.home_view"]], "streamlit_src.views.user_view module": [[6, "module-streamlit_src.views.user_view"]]}, "docnames": ["air_quality_forecast", "index", "modules", "streamlit_src", "streamlit_src.controllers", "streamlit_src.models", "streamlit_src.views"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["air_quality_forecast.rst", "index.rst", "modules.rst", "streamlit_src.rst", "streamlit_src.controllers.rst", "streamlit_src.models.rst", "streamlit_src.views.rst"], "indexentries": {"__admin_password_hash (streamlit_src.controllers.home_controller.homecontroller attribute)": [[4, "streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH", false]], "__init__() (streamlit_src.views.home_view.homeview method)": [[6, "streamlit_src.views.home_view.HomeView.__init__", false]], "_check_data_out_of_distribution() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._check_data_out_of_distribution", false]], "_compare_to_who() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._compare_to_who", false]], "_compute_distribution_statistics() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._compute_distribution_statistics", false]], "_create_gauge_plot() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._create_gauge_plot", false]], "_current_time() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller._current_time", false]], "_data_is_valid() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._data_is_valid", false]], "_display_compare_who() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._display_compare_who", false]], "_display_plots() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._display_plots", false]], "_display_sources() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._display_sources", false]], "_evaluate_model() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._evaluate_model", false]], "_feature_importance() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._feature_importance", false]], "_get_color() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._get_color", false]], "_get_luchtmeet_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller._get_luchtmeet_data", false]], "_get_next_three_days_dates() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._get_next_three_days_dates", false]], "_hash_password() (streamlit_src.controllers.home_controller.homecontroller method)": [[4, "streamlit_src.controllers.home_controller.HomeController._hash_password", false]], "_is_current_data_available() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._is_current_data_available", false]], "_load_models() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels._load_models", false]], "_make_custom_predictions() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions", false]], "_make_prediction() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._make_prediction", false]], "_model_metrics() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._model_metrics", false]], "_optimize_and_evaluate() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._optimize_and_evaluate", false]], "_perform_search() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._perform_search", false]], "_prepare_awareness_content() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_awareness_content", false]], "_prepare_data_for_view() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_data_for_view", false]], "_prepare_gauge_plots() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_gauge_plots", false]], "_prepare_line_plot() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._prepare_line_plot", false]], "_quiz() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._quiz", false]], "_raise_awareness() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._raise_awareness", false]], "_run() (streamlit_src.controllers.home_controller.homecontroller method)": [[4, "streamlit_src.controllers.home_controller.HomeController._run", false]], "_set_data() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._set_data", false]], "_setup_mlflow() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer._setup_mlflow", false]], "_show_current_data() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController._show_current_data", false]], "_show_current_data() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController._show_current_data", false]], "_two_days_ago() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller._two_days_ago", false]], "_who_no2_level (streamlit_src.models.air_quality_model.airqualitymodel attribute)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel._WHO_NO2_LEVEL", false]], "_who_o3_level (streamlit_src.models.air_quality_model.airqualitymodel attribute)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel._WHO_O3_LEVEL", false]], "admincontroller (class in streamlit_src.controllers.admin_controller)": [[4, "streamlit_src.controllers.admin_controller.AdminController", false]], "adminview (class in streamlit_src.views.admin_view)": [[6, "streamlit_src.views.admin_view.AdminView", false]], "air_quality_forecast": [[0, "module-air_quality_forecast", false]], "air_quality_forecast.api_caller": [[0, "module-air_quality_forecast.api_caller", false]], "air_quality_forecast.data_pipeline": [[0, "module-air_quality_forecast.data_pipeline", false]], "air_quality_forecast.get_prediction_data": [[0, "module-air_quality_forecast.get_prediction_data", false]], "air_quality_forecast.main": [[0, "module-air_quality_forecast.main", false]], "air_quality_forecast.model_development": [[0, "module-air_quality_forecast.model_development", false]], "air_quality_forecast.parser_ui": [[0, "module-air_quality_forecast.parser_ui", false]], "air_quality_forecast.prediction": [[0, "module-air_quality_forecast.prediction", false]], "air_quality_forecast.utils": [[0, "module-air_quality_forecast.utils", false]], "airqualitymodel (class in streamlit_src.models.air_quality_model)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel", false]], "apicaller (class in air_quality_forecast.api_caller)": [[0, "air_quality_forecast.api_caller.APICaller", false]], "apply_time_shift() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.apply_time_shift", false]], "calculate_metrics() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics", false]], "change_to_numeric() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.change_to_numeric", false]], "compare_to_who() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.compare_to_who", false]], "confirm_checks() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.confirm_checks", false]], "convert_param_space() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.convert_param_space", false]], "create_parser() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.create_parser", false]], "data_not_available() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.data_not_available", false]], "dataloader (class in air_quality_forecast.data_pipeline)": [[0, "air_quality_forecast.data_pipeline.DataLoader", false]], "decision_tree_predictions() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels.decision_tree_predictions", false]], "display_datatable() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.display_datatable", false]], "display_feature_importance() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.display_feature_importance", false]], "display_predictions_gaugeplot() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.display_predictions_gaugeplot", false]], "display_predictions_lineplot() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.display_predictions_lineplot", false]], "download_button() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.download_button", false]], "error() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.error", false]], "featureprocessor (class in air_quality_forecast.data_pipeline)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor", false]], "featureselector (class in air_quality_forecast.utils)": [[0, "air_quality_forecast.utils.FeatureSelector", false]], "get_all_data_last_three_days() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days", false]], "get_last_three_days() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days", false]], "get_luchtmeet_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller.get_luchtmeet_data", false]], "get_today_data() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.get_today_data", false]], "get_vc_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller.get_vc_data", false]], "homecontroller (class in streamlit_src.controllers.home_controller)": [[4, "streamlit_src.controllers.home_controller.HomeController", false]], "homeview (class in streamlit_src.views.home_view)": [[6, "streamlit_src.views.home_view.HomeView", false]], "inputvalidator (class in air_quality_forecast.utils)": [[0, "air_quality_forecast.utils.InputValidator", false]], "lag_data() (air_quality_forecast.api_caller.apicaller method)": [[0, "air_quality_forecast.api_caller.APICaller.lag_data", false]], "launch_mlflow_server() (air_quality_forecast.model_development.regressortrainer static method)": [[0, "air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server", false]], "load_data() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.load_data", false]], "main() (in module air_quality_forecast.get_prediction_data)": [[0, "air_quality_forecast.get_prediction_data.main", false]], "main() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.main", false]], "merge_raw_data() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.merge_raw_data", false]], "module": [[0, "module-air_quality_forecast", false], [0, "module-air_quality_forecast.api_caller", false], [0, "module-air_quality_forecast.data_pipeline", false], [0, "module-air_quality_forecast.get_prediction_data", false], [0, "module-air_quality_forecast.main", false], [0, "module-air_quality_forecast.model_development", false], [0, "module-air_quality_forecast.parser_ui", false], [0, "module-air_quality_forecast.prediction", false], [0, "module-air_quality_forecast.utils", false], [3, "module-streamlit_src", false], [3, "module-streamlit_src.app", false], [4, "module-streamlit_src.controllers", false], [4, "module-streamlit_src.controllers.admin_controller", false], [4, "module-streamlit_src.controllers.home_controller", false], [4, "module-streamlit_src.controllers.user_controller", false], [5, "module-streamlit_src.models", false], [5, "module-streamlit_src.models.air_quality_model", false], [6, "module-streamlit_src.views", false], [6, "module-streamlit_src.views.admin_view", false], [6, "module-streamlit_src.views.home_view", false], [6, "module-streamlit_src.views.user_view", false]], "next_three_day_predictions() (streamlit_src.models.air_quality_model.airqualitymodel method)": [[5, "streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions", false]], "none (streamlit_src.views.home_view.homeview attribute)": [[6, "streamlit_src.views.home_view.HomeView.None", false]], "normalize_data() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.normalize_data", false]], "port_in_use() (air_quality_forecast.model_development.regressortrainer static method)": [[0, "air_quality_forecast.model_development.RegressorTrainer.port_in_use", false]], "predictormodels (class in air_quality_forecast.prediction)": [[0, "air_quality_forecast.prediction.PredictorModels", false]], "preprocess_data() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.preprocess_data", false]], "preprocessingpipeline (class in air_quality_forecast.data_pipeline)": [[0, "air_quality_forecast.data_pipeline.PreprocessingPipeline", false]], "print_sources() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.print_sources", false]], "prompt_admin_password() (streamlit_src.views.home_view.homeview method)": [[6, "id0", false], [6, "streamlit_src.views.home_view.HomeView.prompt_admin_password", false]], "quiz() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.quiz", false]], "raise_awareness() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.raise_awareness", false]], "random_forest_predictions() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels.random_forest_predictions", false]], "regressortrainer (class in air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.RegressorTrainer", false]], "rename_initial_columns() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.rename_initial_columns", false]], "run() (air_quality_forecast.model_development.regressortrainer method)": [[0, "air_quality_forecast.model_development.RegressorTrainer.run", false]], "run_bayesian_optimization() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.run_bayesian_optimization", false]], "run_pipeline() (air_quality_forecast.data_pipeline.preprocessingpipeline method)": [[0, "air_quality_forecast.data_pipeline.PreprocessingPipeline.run_pipeline", false]], "save_to_csv() (air_quality_forecast.data_pipeline.dataloader method)": [[0, "air_quality_forecast.data_pipeline.DataLoader.save_to_csv", false]], "select_cols_by_correlation() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.select_cols_by_correlation", false]], "select_features() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.select_features", false]], "set_layout() (streamlit_src.views.home_view.homeview method)": [[6, "id1", false], [6, "streamlit_src.views.home_view.HomeView.set_layout", false]], "show_admin_pages() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.show_admin_pages", false]], "show_current_data() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.show_current_data", false]], "show_dashboard() (streamlit_src.controllers.admin_controller.admincontroller method)": [[4, "streamlit_src.controllers.admin_controller.AdminController.show_dashboard", false]], "show_dashboard() (streamlit_src.controllers.user_controller.usercontroller method)": [[4, "streamlit_src.controllers.user_controller.UserController.show_dashboard", false]], "show_dashboard_switch() (streamlit_src.views.home_view.homeview method)": [[6, "id2", false], [6, "streamlit_src.views.home_view.HomeView.show_dashboard_switch", false]], "sort_data_by_date() (air_quality_forecast.data_pipeline.featureprocessor method)": [[0, "air_quality_forecast.data_pipeline.FeatureProcessor.sort_data_by_date", false]], "streamlit_src": [[3, "module-streamlit_src", false]], "streamlit_src.app": [[3, "module-streamlit_src.app", false]], "streamlit_src.controllers": [[4, "module-streamlit_src.controllers", false]], "streamlit_src.controllers.admin_controller": [[4, "module-streamlit_src.controllers.admin_controller", false]], "streamlit_src.controllers.home_controller": [[4, "module-streamlit_src.controllers.home_controller", false]], "streamlit_src.controllers.user_controller": [[4, "module-streamlit_src.controllers.user_controller", false]], "streamlit_src.models": [[5, "module-streamlit_src.models", false]], "streamlit_src.models.air_quality_model": [[5, "module-streamlit_src.models.air_quality_model", false]], "streamlit_src.views": [[6, "module-streamlit_src.views", false]], "streamlit_src.views.admin_view": [[6, "module-streamlit_src.views.admin_view", false]], "streamlit_src.views.home_view": [[6, "module-streamlit_src.views.home_view", false]], "streamlit_src.views.user_view": [[6, "module-streamlit_src.views.user_view", false]], "success() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.success", false]], "train_all_models() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.train_all_models", false]], "train_model() (in module air_quality_forecast.parser_ui)": [[0, "air_quality_forecast.parser_ui.train_model", false]], "train_one_model() (in module air_quality_forecast.model_development)": [[0, "air_quality_forecast.model_development.train_one_model", false]], "train_test_split() (air_quality_forecast.data_pipeline.preprocessingpipeline method)": [[0, "air_quality_forecast.data_pipeline.PreprocessingPipeline.train_test_split", false]], "two_columns_layout() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.two_columns_layout", false]], "uninformative_columns() (air_quality_forecast.utils.featureselector method)": [[0, "air_quality_forecast.utils.FeatureSelector.uninformative_columns", false]], "upload_dataset() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.upload_dataset", false]], "upload_instructions() (streamlit_src.views.admin_view.adminview method)": [[6, "streamlit_src.views.admin_view.AdminView.upload_instructions", false]], "usercontroller (class in streamlit_src.controllers.user_controller)": [[4, "streamlit_src.controllers.user_controller.UserController", false]], "userview (class in streamlit_src.views.user_view)": [[6, "streamlit_src.views.user_view.UserView", false]], "validate_file_exists() (air_quality_forecast.utils.inputvalidator static method)": [[0, "air_quality_forecast.utils.InputValidator.validate_file_exists", false]], "validate_type() (air_quality_forecast.utils.inputvalidator static method)": [[0, "air_quality_forecast.utils.InputValidator.validate_type", false]], "view_option_selection() (streamlit_src.views.user_view.userview method)": [[6, "streamlit_src.views.user_view.UserView.view_option_selection", false]], "xgb_predictions() (air_quality_forecast.prediction.predictormodels method)": [[0, "air_quality_forecast.prediction.PredictorModels.xgb_predictions", false]]}, "objects": {"": [[0, 0, 0, "-", "air_quality_forecast"], [3, 0, 0, "-", "streamlit_src"]], "air_quality_forecast": [[0, 0, 0, "-", "api_caller"], [0, 0, 0, "-", "data_pipeline"], [0, 0, 0, "-", "get_prediction_data"], [0, 0, 0, "-", "main"], [0, 0, 0, "-", "model_development"], [0, 0, 0, "-", "parser_ui"], [0, 0, 0, "-", "prediction"], [0, 0, 0, "-", "utils"]], "air_quality_forecast.api_caller": [[0, 1, 1, "", "APICaller"]], "air_quality_forecast.api_caller.APICaller": [[0, 2, 1, "", "_current_time"], [0, 2, 1, "", "_get_luchtmeet_data"], [0, 2, 1, "", "_two_days_ago"], [0, 2, 1, "", "get_luchtmeet_data"], [0, 2, 1, "", "get_vc_data"], [0, 2, 1, "", "lag_data"]], "air_quality_forecast.data_pipeline": [[0, 1, 1, "", "DataLoader"], [0, 1, 1, "", "FeatureProcessor"], [0, 1, 1, "", "PreprocessingPipeline"]], "air_quality_forecast.data_pipeline.DataLoader": [[0, 2, 1, "", "save_to_csv"]], "air_quality_forecast.data_pipeline.FeatureProcessor": [[0, 2, 1, "", "apply_time_shift"], [0, 2, 1, "", "merge_raw_data"], [0, 2, 1, "", "preprocess_data"], [0, 2, 1, "", "select_features"], [0, 2, 1, "", "sort_data_by_date"]], "air_quality_forecast.data_pipeline.PreprocessingPipeline": [[0, 2, 1, "", "run_pipeline"], [0, 2, 1, "", "train_test_split"]], "air_quality_forecast.get_prediction_data": [[0, 3, 1, "", "main"]], "air_quality_forecast.model_development": [[0, 1, 1, "", "RegressorTrainer"], [0, 3, 1, "", "convert_param_space"], [0, 3, 1, "", "run_bayesian_optimization"], [0, 3, 1, "", "train_all_models"], [0, 3, 1, "", "train_one_model"]], "air_quality_forecast.model_development.RegressorTrainer": [[0, 2, 1, "", "_evaluate_model"], [0, 2, 1, "", "_optimize_and_evaluate"], [0, 2, 1, "", "_perform_search"], [0, 2, 1, "", "_set_data"], [0, 2, 1, "", "_setup_mlflow"], [0, 2, 1, "", "launch_mlflow_server"], [0, 2, 1, "", "port_in_use"], [0, 2, 1, "", "run"]], "air_quality_forecast.parser_ui": [[0, 3, 1, "", "create_parser"], [0, 3, 1, "", "load_data"], [0, 3, 1, "", "main"], [0, 3, 1, "", "normalize_data"], [0, 3, 1, "", "train_model"]], "air_quality_forecast.prediction": [[0, 1, 1, "", "PredictorModels"]], "air_quality_forecast.prediction.PredictorModels": [[0, 2, 1, "", "_load_models"], [0, 2, 1, "", "decision_tree_predictions"], [0, 2, 1, "", "random_forest_predictions"], [0, 2, 1, "", "xgb_predictions"]], "air_quality_forecast.utils": [[0, 1, 1, "", "FeatureSelector"], [0, 1, 1, "", "InputValidator"]], "air_quality_forecast.utils.FeatureSelector": [[0, 2, 1, "", "change_to_numeric"], [0, 2, 1, "", "rename_initial_columns"], [0, 2, 1, "", "select_cols_by_correlation"], [0, 2, 1, "", "uninformative_columns"]], "air_quality_forecast.utils.InputValidator": [[0, 2, 1, "", "validate_file_exists"], [0, 2, 1, "", "validate_type"]], "streamlit_src": [[3, 0, 0, "-", "app"], [4, 0, 0, "-", "controllers"], [5, 0, 0, "-", "models"], [6, 0, 0, "-", "views"]], "streamlit_src.controllers": [[4, 0, 0, "-", "admin_controller"], [4, 0, 0, "-", "home_controller"], [4, 0, 0, "-", "user_controller"]], "streamlit_src.controllers.admin_controller": [[4, 1, 1, "", "AdminController"]], "streamlit_src.controllers.admin_controller.AdminController": [[4, 2, 1, "", "_check_data_out_of_distribution"], [4, 2, 1, "", "_compute_distribution_statistics"], [4, 2, 1, "", "_data_is_valid"], [4, 2, 1, "", "_feature_importance"], [4, 2, 1, "", "_make_custom_predictions"], [4, 2, 1, "", "_make_prediction"], [4, 2, 1, "", "_model_metrics"], [4, 2, 1, "", "_show_current_data"], [4, 2, 1, "", "show_dashboard"]], "streamlit_src.controllers.home_controller": [[4, 1, 1, "", "HomeController"]], "streamlit_src.controllers.home_controller.HomeController": [[4, 4, 1, "", "__ADMIN_PASSWORD_HASH"], [4, 2, 1, "", "_hash_password"], [4, 2, 1, "", "_run"]], "streamlit_src.controllers.user_controller": [[4, 1, 1, "", "UserController"]], "streamlit_src.controllers.user_controller.UserController": [[4, 2, 1, "", "_compare_to_who"], [4, 2, 1, "", "_create_gauge_plot"], [4, 2, 1, "", "_display_compare_who"], [4, 2, 1, "", "_display_plots"], [4, 2, 1, "", "_display_sources"], [4, 2, 1, "", "_get_color"], [4, 2, 1, "", "_get_next_three_days_dates"], [4, 2, 1, "", "_is_current_data_available"], [4, 2, 1, "", "_prepare_awareness_content"], [4, 2, 1, "", "_prepare_data_for_view"], [4, 2, 1, "", "_prepare_gauge_plots"], [4, 2, 1, "", "_prepare_line_plot"], [4, 2, 1, "", "_quiz"], [4, 2, 1, "", "_raise_awareness"], [4, 2, 1, "", "_show_current_data"], [4, 2, 1, "", "show_dashboard"]], "streamlit_src.models": [[5, 0, 0, "-", "air_quality_model"]], "streamlit_src.models.air_quality_model": [[5, 1, 1, "", "AirQualityModel"]], "streamlit_src.models.air_quality_model.AirQualityModel": [[5, 4, 1, "", "_WHO_NO2_LEVEL"], [5, 4, 1, "", "_WHO_O3_LEVEL"], [5, 2, 1, "", "calculate_metrics"], [5, 2, 1, "", "get_all_data_last_three_days"], [5, 2, 1, "", "get_last_three_days"], [5, 2, 1, "", "get_today_data"], [5, 2, 1, "", "next_three_day_predictions"]], "streamlit_src.views": [[6, 0, 0, "-", "admin_view"], [6, 0, 0, "-", "home_view"], [6, 0, 0, "-", "user_view"]], "streamlit_src.views.admin_view": [[6, 1, 1, "", "AdminView"]], "streamlit_src.views.admin_view.AdminView": [[6, 2, 1, "", "confirm_checks"], [6, 2, 1, "", "display_datatable"], [6, 2, 1, "", "display_feature_importance"], [6, 2, 1, "", "download_button"], [6, 2, 1, "", "show_admin_pages"], [6, 2, 1, "", "upload_dataset"], [6, 2, 1, "", "upload_instructions"]], "streamlit_src.views.home_view": [[6, 1, 1, "", "HomeView"]], "streamlit_src.views.home_view.HomeView": [[6, 4, 1, "", "None"], [6, 2, 1, "", "__init__"], [6, 2, 1, "id0", "prompt_admin_password"], [6, 2, 1, "id1", "set_layout"], [6, 2, 1, "id2", "show_dashboard_switch"]], "streamlit_src.views.user_view": [[6, 1, 1, "", "UserView"]], "streamlit_src.views.user_view.UserView": [[6, 2, 1, "", "compare_to_who"], [6, 2, 1, "", "data_not_available"], [6, 2, 1, "", "display_predictions_gaugeplot"], [6, 2, 1, "", "display_predictions_lineplot"], [6, 2, 1, "", "error"], [6, 2, 1, "", "print_sources"], [6, 2, 1, "", "quiz"], [6, 2, 1, "", "raise_awareness"], [6, 2, 1, "", "show_current_data"], [6, 2, 1, "", "success"], [6, 2, 1, "", "two_columns_layout"], [6, 2, 1, "", "view_option_selection"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "function", "Python function"], "4": ["py", "attribute", "Python attribute"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:function", "4": "py:attribute"}, "terms": {"": 4, "0": 0, "00": [4, 6], "04": [4, 6], "1": 0, "127": 0, "15": [4, 6], "2": 0, "240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9": 4, "256": 4, "3": [0, 4, 5], "5": 0, "50": 0, "5000": 0, "A": [0, 4, 5, 6], "By": 1, "If": [0, 4], "In": 1, "It": [0, 1, 4, 6], "The": [0, 1, 4, 5, 6], "To": 1, "__admin_password_hash": [3, 4], "__init__": [3, 6], "_check_data_out_of_distribut": [3, 4], "_compare_to_who": [3, 4], "_compute_distribution_statist": [3, 4], "_create_gauge_plot": [3, 4], "_current_tim": [0, 2], "_data_is_valid": [3, 4], "_display_compare_who": [3, 4], "_display_plot": [3, 4], "_display_sourc": [3, 4], "_evaluate_model": [0, 2], "_feature_import": [3, 4], "_get_color": [3, 4], "_get_luchtmeet_data": [0, 2], "_get_next_three_days_d": [3, 4], "_hash_password": [3, 4], "_is_current_data_avail": [3, 4], "_load_model": [0, 2], "_make_custom_predict": [3, 4], "_make_predict": [3, 4], "_model_metr": [3, 4], "_optimize_and_evalu": [0, 2], "_perform_search": [0, 2], "_prepare_awareness_cont": [3, 4], "_prepare_data_for_view": [3, 4], "_prepare_gauge_plot": [3, 4], "_prepare_line_plot": [3, 4], "_quiz": [3, 4], "_raise_awar": [3, 4], "_run": [3, 4], "_set_data": [0, 2], "_setup_mlflow": [0, 2], "_show_current_data": [3, 4], "_two_days_ago": [0, 2], "_who_no2_level": [3, 5], "_who_o3_level": [3, 5], "about": 6, "abov": 6, "access": 1, "accur": [1, 6], "across": 1, "admin": [1, 4, 6], "admin_control": [2, 3], "admin_view": [1, 2, 3], "admincontrol": [3, 4], "adminview": [3, 6], "aesthet": 6, "after": [1, 4], "air": [0, 4, 5, 6], "air_quality_forecast": [1, 2], "air_quality_model": [2, 3], "airqualitymodel": [3, 5], "algorithm": [0, 1], "all": [0, 1, 5, 6], "along": 6, "alreadi": 0, "altern": 1, "an": [0, 1, 4, 6], "ani": [0, 1], "answer": [4, 6], "api": [0, 1, 4], "api_cal": [1, 2], "apical": [0, 2], "app": [1, 2], "appli": 0, "applic": [1, 4, 6], "apply_time_shift": [0, 2], "appropri": 1, "ar": [0, 1, 6], "aren": 6, "argument": 0, "argumentpars": 0, "ask": 6, "attribut": 0, "autolog": 0, "automat": 6, "avail": [4, 6], "averag": 0, "awar": [4, 6], "awareness_expand": 6, "backend": 1, "base": [0, 1, 4, 5, 6], "baseestim": 0, "bayesian": 0, "bayessearchcv": 0, "becaus": 4, "been": 0, "befor": [0, 4], "best": 0, "better": 6, "between": [4, 6], "bool": [0, 4, 6], "boolean": [4, 6], "both": 1, "bring": 1, "built": 1, "button": 6, "calcul": [4, 5], "calculate_metr": [3, 5], "call": [0, 6], "callabl": 6, "can": [0, 1], "cd": 1, "certain": 1, "chang": [0, 1], "change_to_numer": [0, 2], "check": [0, 4, 6], "checkbox": 6, "choic": 4, "choos": [1, 4], "ci": 1, "class": [0, 4, 5, 6], "code": [1, 4], "collect": 1, "color": 4, "column": [0, 6], "command": [0, 1], "compar": [4, 6], "compare_to_who": [3, 6], "comparison": 4, "compon": 0, "comput": 4, "concentr": [4, 6], "config": [0, 1], "configur": [0, 6], "confirm": 6, "confirm_check": [3, 6], "consist": 1, "contain": [1, 4, 6], "content": 2, "control": [1, 2, 3], "convert": 0, "convert_param_spac": [0, 2], "core": 1, "correct": [4, 6], "correl": 0, "correspond": [0, 4, 6], "creat": [4, 6], "create_pars": [0, 2], "criteria": 0, "cross": 0, "csv": [0, 5], "cubic": 5, "current": [0, 4, 6], "custom": [1, 4], "cv_split": 0, "dai": [0, 4, 5, 6], "daili": 0, "dashboard": [1, 4, 6], "data": [0, 1, 4, 5, 6], "data_not_avail": [3, 6], "data_pipelin": [1, 2], "datafram": [0, 4, 5, 6], "dataload": [0, 2], "dataset": [0, 1, 4, 6], "date": [0, 4, 6], "dd": 0, "decis": [0, 1], "decision_tre": 0, "decision_tree_predict": [0, 2], "decisiontreeregressor": 0, "defin": 1, "deploi": 1, "design": 1, "determin": 4, "develop": 1, "deviat": 4, "dict": [0, 4, 6], "dictionari": [0, 6], "differ": [1, 6], "directori": 0, "displai": [1, 4, 6], "display_datat": [3, 6], "display_feature_import": [3, 6], "display_predictions_gaugeplot": [3, 6], "display_predictions_lineplot": [3, 6], "distribut": 4, "divid": 6, "doe": 0, "download": 6, "download_button": [3, 6], "dropdown": 6, "dure": 1, "e": 0, "each": 0, "easier": 1, "element": 6, "enabl": 0, "engin": 1, "enough": 6, "enter": [4, 6], "entir": 0, "entri": [0, 1, 4], "environment": 1, "error": [0, 3, 5, 6], "evalu": 0, "everi": 4, "exce": 4, "execut": 1, "exist": 0, "expand": [4, 6], "expect": 0, "expected_typ": 0, "experi": 0, "experiment_nam": 0, "extern": 1, "fact": [4, 6], "fals": [0, 4, 6], "featur": [0, 4, 6], "feature_import": 6, "featureprocessor": [0, 2], "featureselector": [0, 2], "fetch": [0, 1, 4], "field": 6, "fig": 6, "figur": [4, 6], "file": [0, 1, 5, 6], "file_nam": 6, "filenotfounderror": 0, "final": 0, "first": [0, 4], "float": [0, 4, 6], "follow": [0, 1], "forest": [0, 1], "format": [0, 1, 4, 6], "formula": 0, "friendli": 1, "from": [0, 1, 4, 5, 6], "frontend": 1, "function": [0, 1, 6], "futur": [0, 1], "g": 0, "gaug": [4, 6], "gauge_plot": 6, "gener": 1, "get": 4, "get_all_data_last_three_dai": [3, 5], "get_last_three_dai": [3, 5], "get_luchtmeet_data": [0, 2], "get_prediction_data": [1, 2], "get_today_data": [3, 5], "get_vc_data": [0, 2], "given": [0, 4], "go": [4, 6], "graph": 6, "griftpark_data": 0, "guidelin": [4, 6], "ha": [0, 1], "handl": [1, 4, 6], "hash": 4, "have": 0, "health": [4, 6], "health_messag": 6, "hex": 4, "hh": 0, "histor": 1, "home": [4, 6], "home_control": [2, 3], "home_view": [1, 2, 3], "homecontrol": [3, 4], "homepag": 1, "homeview": [3, 6], "http": 0, "hyperparamet": [0, 1], "hyperparameter_search_spac": [0, 1], "i": [0, 1, 4, 5, 6], "import": [4, 6], "importance_valu": 6, "includ": [4, 6], "incom": 1, "index": [1, 4], "indic": [4, 6], "infer": 1, "inform": [0, 1], "inherit": 4, "initi": [0, 6], "input": [0, 1, 4, 6], "input_data": 4, "inputvalid": [0, 2], "instruct": 6, "int": [0, 5], "integr": 1, "interact": 1, "interfac": [1, 4, 6], "invalid": 4, "issu": 6, "iter": 0, "json": [0, 1], "just": 0, "kei": 0, "label": [0, 6], "lag": 0, "lag_data": [0, 2], "last": [0, 5], "launch": [0, 1], "launch_mlflow_serv": [0, 2], "layout": 6, "learn": 1, "left": 6, "left_funct": 6, "level": [1, 4, 5, 6], "line": [0, 4, 6], "list": [0, 4, 6], "load": [0, 1, 5], "load_data": [0, 2], "local": 1, "locat": 5, "log": [0, 4], "logic": [1, 4, 6], "luchtmeet": 0, "machin": 1, "made": 1, "main": [1, 2, 4], "make": [0, 1, 4, 5], "manag": [1, 6], "maximum": 0, "mean": [0, 4, 5], "measur": 6, "merg": 0, "merge_raw_data": [0, 2], "merged_data_df": 6, "messag": [0, 4, 6], "meter": 5, "method": [0, 4, 6], "metric": [0, 4], "microgram": 5, "minut": 4, "miss": 0, "mlflow": 0, "mm": 0, "model": [0, 1, 2, 3, 4], "model_develop": [1, 2], "modul": [1, 2], "most": 0, "mvc": 1, "n_iter": [0, 1], "name": [0, 4, 6], "navig": 6, "ndarrai": 0, "new": [0, 4], "next": [4, 5, 6], "next_three_day_predict": [3, 5], "nice": 0, "no2": [0, 4, 5, 6], "none": [0, 3, 4, 6], "normal": 0, "normalize_data": [0, 2], "normalizer_typ": 0, "note": 1, "now": 0, "np": 0, "number": 0, "numer": 0, "o3": [0, 4, 5, 6], "obei": 1, "object": [0, 1, 4, 5, 6], "obtain": 5, "offer": 1, "oldest": 0, "one": 1, "onli": 1, "oper": 1, "optim": 0, "option": 6, "order": 0, "organ": 1, "other": [0, 1], "otherwis": [0, 4, 6], "out": [0, 4], "output": 1, "over": 0, "packag": [1, 2], "page": [1, 4, 6], "panda": [0, 4, 5, 6], "param_spac": 0, "paramet": [0, 4, 6], "pars": [0, 1], "parser": 1, "parser_ui": [1, 2], "password": [4, 6], "past": [0, 5], "past_data_path": 5, "path": [0, 1], "pattern": 1, "pd": [0, 4, 5, 6], "per": [1, 5], "perform": [0, 1, 4], "period": 4, "pickl": 5, "pipelin": [0, 1], "pkl": 0, "placehold": [1, 6], "plot": [0, 4, 6], "plot_typ": 6, "plotli": [4, 6], "pm25": 0, "point": [0, 1, 4], "pollut": [4, 6], "port": 0, "port_in_us": [0, 2], "possibl": 0, "pre": 0, "predict": [1, 2, 4, 5, 6], "prediction_path": [1, 5], "predictormodel": [0, 2], "prepar": 4, "preprocess": [0, 1], "preprocess_data": [0, 2], "preprocessingpipelin": [0, 2], "print": [0, 6], "print_sourc": [3, 6], "process": [0, 1], "processed_data_path": 0, "produc": 6, "prompt": [4, 6], "prompt_admin_password": [3, 6], "provid": [0, 1, 6], "py": 1, "python": 1, "qualiti": [0, 4, 5, 6], "queri": [0, 4], "question": [4, 6], "quit": 0, "quiz": [3, 6], "rais": [0, 6], "raise_awar": [3, 6], "random": [0, 1, 4, 6], "random_fact": 6, "random_forest": 0, "random_forest_predict": [0, 2], "randomforestregressor": 0, "rang": 0, "ratio": 6, "raw": 0, "raw_data_path": 0, "real": 1, "recent": 0, "recommend": 6, "regressor": 0, "regressortrain": [0, 2], "regular": 1, "relat": 1, "relev": 0, "remov": 0, "renam": 0, "rename_initial_column": [0, 2], "render": 4, "repres": [0, 4], "requir": [0, 1, 6], "respons": [0, 4, 6], "result": [1, 6], "retriev": [1, 4], "return": [0, 4, 5, 6], "right": 6, "right_funct": 6, "root": 5, "row": 0, "run": [0, 1, 2, 4], "run_bayesian_optim": [0, 2], "run_pipelin": [0, 2], "sai": [0, 6], "same": 0, "save": 0, "save_to_csv": [0, 2], "saved_model": 0, "scheme": 0, "score": 4, "script": 1, "search": [0, 1], "second": 4, "select": [0, 6], "select_cols_by_correl": [0, 2], "select_featur": [0, 2], "separ": 1, "seri": 5, "server": 0, "set": [0, 6], "set_layout": [3, 6], "sha": 4, "shift": 0, "short": 4, "show": [4, 6], "show_admin_pag": [3, 6], "show_current_data": [3, 6], "show_dashboard": [3, 4], "show_dashboard_switch": [3, 6], "shown": 6, "sidebar": 6, "singl": 0, "sklearn": 0, "skopt": 0, "so": 0, "solut": 1, "sort": 0, "sort_data_by_d": [0, 2], "sourc": [0, 1, 4, 5, 6], "space": [0, 1], "specif": [0, 1], "specifi": 1, "split": 0, "squar": [0, 5], "ss": 0, "stage": 1, "standard": 4, "start": 0, "static": 0, "station": 0, "station_numb": 0, "step": 1, "store": 4, "str": [0, 4, 6], "streamlit": [1, 4, 6], "streamlit_src": [1, 2], "string": 6, "submodul": [1, 2], "subpackag": [1, 2], "success": [3, 6], "suitabl": 1, "switch": 4, "system": [0, 1], "t": 6, "t_max": 0, "tabl": 6, "take": 0, "techniqu": 1, "test": 0, "test_siz": 0, "text": [4, 6], "them": 6, "thi": [0, 1, 4, 6], "those": 0, "three": [0, 4, 5, 6], "threshold": 4, "through": 1, "time": [0, 1, 4, 6], "timeseriessplit": 0, "titl": [4, 6], "todai": 5, "togeth": 1, "track": 0, "train": [0, 1, 4], "train_all_model": [0, 2], "train_model": [0, 2], "train_one_model": [0, 2], "train_test_split": [0, 2], "transform": 1, "tree": [0, 1], "true": [0, 4, 6], "tupl": [0, 4, 6], "turn": 0, "two": [0, 1, 4, 6], "two_columns_layout": [3, 6], "type": [0, 4, 5, 6], "typeerror": 0, "ui": 1, "uninformative_column": [0, 2], "up": [0, 6], "updat": 6, "upload": [4, 6], "upload_dataset": [3, 6], "upload_instruct": [3, 6], "uri": 0, "url": 6, "us": [0, 1, 4, 6], "usabl": 0, "user": [1, 4, 6], "user_control": [2, 3], "user_view": [1, 2, 3], "usercontrol": [3, 4], "userview": [3, 6], "util": [1, 2], "utrecht": 0, "utrecht_data": 0, "valid": [0, 1, 4], "validate_file_exist": [0, 2], "validate_typ": [0, 2], "valu": [0, 4, 6], "valueerror": 0, "variabl": 0, "variable_nam": 0, "variou": 1, "via": 1, "view": [1, 2, 3, 4], "view_option_select": [3, 6], "visual": 0, "wa": [4, 6], "want": 0, "warn": 6, "weather": 0, "web": 1, "when": 6, "where": 0, "whether": [0, 4, 6], "which": [1, 4], "whitespac": 0, "who": [4, 5, 6], "who_limit": 4, "within": [1, 6], "without": 0, "workflow": 0, "wrap": 0, "x": 0, "x_test": 0, "x_test_path": [0, 1], "x_train": 0, "x_train_path": [0, 1], "xgb": 0, "xgb_predict": [0, 2], "xgboost": [0, 4], "xgbregressor": 0, "y": 0, "y_pred": 0, "y_test": 0, "y_test_path": [0, 1], "y_train": 0, "y_train_path": [0, 1], "yaml": [0, 1], "you": [0, 1], "yyyi": 0, "z": 4}, "titles": ["air_quality_forecast package", "Air Quality Forecast documentation", "air-quality-forecast", "streamlit_src package", "streamlit_src.controllers package", "streamlit_src.models package", "streamlit_src.views package"], "titleterms": {"admin_control": 4, "admin_view": 6, "air": [1, 2], "air_quality_forecast": 0, "air_quality_model": 5, "api_cal": 0, "app": 3, "breakdown": 1, "codebas": 1, "content": [0, 1, 3, 4, 5, 6], "control": 4, "data_pipelin": 0, "deploy": 1, "directori": 1, "document": 1, "forecast": [1, 2], "get_prediction_data": 0, "home_control": 4, "home_view": 6, "main": 0, "model": 5, "model_develop": 0, "modul": [0, 3, 4, 5, 6], "packag": [0, 3, 4, 5, 6], "parser_ui": 0, "predict": 0, "problem": 1, "project": 1, "protocol": 1, "qualiti": [1, 2], "retrain": 1, "statement": 1, "streamlit_src": [3, 4, 5, 6], "structur": 1, "submodul": [0, 3, 4, 5, 6], "subpackag": 3, "user_control": 4, "user_view": 6, "util": 0, "view": 6, "workflow": 1}})

docs/_build/html/streamlit_src.controllers.html CHANGED Viewed

@@ -10,7 +10,7 @@
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
@@ -20,17 +20,17 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src.views package" href="streamlit_src.views.html" />
-    <link rel="prev" title="streamlit_src package" href="streamlit_src.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -87,7 +87,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-controllers-package">
 <h1>streamlit_src.controllers package<a class="headerlink" href="#streamlit-src-controllers-package" title="Link to this heading"></a></h1>
 <section id="submodules">
@@ -169,7 +169,7 @@ Displays which features exceed the threshold.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions">
-<span class="sig-name descname"><span class="pre">_make_custom_predictions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._make_custom_predictions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions" title="Link to this definition"></a></dt>
 <dd><p>Makes a custom prediction for the admin interface.</p>
 </dd></dl>
@@ -192,19 +192,19 @@ Displays which features exceed the threshold.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._model_metrics">
-<span class="sig-name descname"><span class="pre">_model_metrics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._model_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._model_metrics" title="Link to this definition"></a></dt>
 <dd><p>Computes the metrics for the admin interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._show_current_data">
-<span class="sig-name descname"><span class="pre">_show_current_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._show_current_data" title="Link to this definition"></a></dt>
 <dd><p>Shows the current data on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController.show_dashboard">
-<span class="sig-name descname"><span class="pre">show_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController.show_dashboard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController.show_dashboard" title="Link to this definition"></a></dt>
 <dd><p>Shows the main page of the admin interface.</p>
 </dd></dl>
@@ -217,6 +217,11 @@ Displays which features exceed the threshold.</p>
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.controllers.home_controller.</span></span><span class="sig-name descname"><span class="pre">HomeController</span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH">
 <span class="sig-name descname"><span class="pre">__ADMIN_PASSWORD_HASH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9'</span></em><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH" title="Link to this definition"></a></dt>
@@ -224,14 +229,22 @@ Displays which features exceed the threshold.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController._hash_password">
-<span class="sig-name descname"><span class="pre">_hash_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">password</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController._hash_password"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController._hash_password" title="Link to this definition"></a></dt>
 <dd><p>Hash the input password using SHA-256.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController._run">
-<span class="sig-name descname"><span class="pre">_run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController._run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController._run" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 </dd></dl>
@@ -280,19 +293,19 @@ Displays which features exceed the threshold.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_compare_who">
-<span class="sig-name descname"><span class="pre">_display_compare_who</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_compare_who"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_compare_who" title="Link to this definition"></a></dt>
 <dd><p>Displays the WHO comparison on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_plots">
-<span class="sig-name descname"><span class="pre">_display_plots</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_plots"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_plots" title="Link to this definition"></a></dt>
 <dd><p>Displays the plots on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_sources">
-<span class="sig-name descname"><span class="pre">_display_sources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_sources" title="Link to this definition"></a></dt>
 <dd><p>Displays the sources on the main page of the user interface.</p>
 </dd></dl>
@@ -334,7 +347,7 @@ Displays which features exceed the threshold.</p>
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._is_current_data_available">
 <span class="sig-name descname"><span class="pre">_is_current_data_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._is_current_data_available"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._is_current_data_available" title="Link to this definition"></a></dt>
 <dd><p>Checks if the current data is available.</p>
-<p>The current data is not available from 14:00 to 15:15.
 This is because the API is queried every 15 minutes, and the
 data is not available for a short period of time before and after
 the new data is fetched.</p>
@@ -403,7 +416,7 @@ the new data is fetched.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._quiz">
-<span class="sig-name descname"><span class="pre">_quiz</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._quiz"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._quiz" title="Link to this definition"></a></dt>
 <dd><p>Show a _quiz question and return the answer and whether the answer was correct.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
@@ -417,19 +430,19 @@ the new data is fetched.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._raise_awareness">
-<span class="sig-name descname"><span class="pre">_raise_awareness</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._raise_awareness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._raise_awareness" title="Link to this definition"></a></dt>
 <dd><p>Shows the awareness content on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._show_current_data">
-<span class="sig-name descname"><span class="pre">_show_current_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._show_current_data" title="Link to this definition"></a></dt>
 <dd><p>Shows the current data on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController.show_dashboard">
-<span class="sig-name descname"><span class="pre">show_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController.show_dashboard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController.show_dashboard" title="Link to this definition"></a></dt>
 <dd><p>Shows the main page of the user interface.</p>
 </dd></dl>
@@ -458,7 +471,7 @@ the new data is fetched.</p>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -469,7 +482,7 @@ the new data is fetched.</p>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src.views package" href="streamlit_src.views.html" />
+    <link rel="prev" title="streamlit_src package" href="streamlit_src.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-controllers-package">
 <h1>streamlit_src.controllers package<a class="headerlink" href="#streamlit-src-controllers-package" title="Link to this heading"></a></h1>
 <section id="submodules">
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions">
+<span class="sig-name descname"><span class="pre">_make_custom_predictions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._make_custom_predictions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._make_custom_predictions" title="Link to this definition"></a></dt>
 <dd><p>Makes a custom prediction for the admin interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._model_metrics">
+<span class="sig-name descname"><span class="pre">_model_metrics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._model_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._model_metrics" title="Link to this definition"></a></dt>
 <dd><p>Computes the metrics for the admin interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController._show_current_data">
+<span class="sig-name descname"><span class="pre">_show_current_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController._show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController._show_current_data" title="Link to this definition"></a></dt>
 <dd><p>Shows the current data on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.admin_controller.AdminController.show_dashboard">
+<span class="sig-name descname"><span class="pre">show_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/admin_controller.html#AdminController.show_dashboard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.admin_controller.AdminController.show_dashboard" title="Link to this definition"></a></dt>
 <dd><p>Shows the main page of the admin interface.</p>
 </dd></dl>
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.controllers.home_controller.</span></span><span class="sig-name descname"><span class="pre">HomeController</span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>Handles the logic for the home page, including switching between user and admin views.</p>
+<p>The home page is the main entry point for the Streamlit application.
+It contains a text input for the admin password, which is hashed and compared to the stored hash.
+If the password is correct, the user is logged in as an admin and the admin view is displayed.
+Otherwise, the user view is displayed.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH">
 <span class="sig-name descname"><span class="pre">__ADMIN_PASSWORD_HASH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9'</span></em><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController.__ADMIN_PASSWORD_HASH" title="Link to this definition"></a></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController._hash_password">
+<span class="sig-name descname"><span class="pre">_hash_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">password</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController._hash_password"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController._hash_password" title="Link to this definition"></a></dt>
 <dd><p>Hash the input password using SHA-256.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.home_controller.HomeController._run">
+<span class="sig-name descname"><span class="pre">_run</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/home_controller.html#HomeController._run"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.home_controller.HomeController._run" title="Link to this definition"></a></dt>
+<dd><p>Runs the application logic for the home page.</p>
+<p>This method is responsible for rendering the home page and
+handling the user’s choice of whether to view the user dashboard
+or admin dashboard. If the user chooses to view the admin dashboard,
+the user is prompted to enter the admin password. If the password
+is valid, the user is logged in as an admin and the admin dashboard
+is displayed. If the password is invalid, the user is logged out and
+the user dashboard is displayed.</p>
+</dd></dl>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_compare_who">
+<span class="sig-name descname"><span class="pre">_display_compare_who</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_compare_who"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_compare_who" title="Link to this definition"></a></dt>
 <dd><p>Displays the WHO comparison on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_plots">
+<span class="sig-name descname"><span class="pre">_display_plots</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_plots"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_plots" title="Link to this definition"></a></dt>
 <dd><p>Displays the plots on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._display_sources">
+<span class="sig-name descname"><span class="pre">_display_sources</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._display_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._display_sources" title="Link to this definition"></a></dt>
 <dd><p>Displays the sources on the main page of the user interface.</p>
 </dd></dl>
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._is_current_data_available">
 <span class="sig-name descname"><span class="pre">_is_current_data_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._is_current_data_available"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._is_current_data_available" title="Link to this definition"></a></dt>
 <dd><p>Checks if the current data is available.</p>
+<p>The current data is not available from 00:00 to 04:15.
 This is because the API is queried every 15 minutes, and the
 data is not available for a short period of time before and after
 the new data is fetched.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._quiz">
+<span class="sig-name descname"><span class="pre">_quiz</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._quiz"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._quiz" title="Link to this definition"></a></dt>
 <dd><p>Show a _quiz question and return the answer and whether the answer was correct.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._raise_awareness">
+<span class="sig-name descname"><span class="pre">_raise_awareness</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._raise_awareness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._raise_awareness" title="Link to this definition"></a></dt>
 <dd><p>Shows the awareness content on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController._show_current_data">
+<span class="sig-name descname"><span class="pre">_show_current_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController._show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController._show_current_data" title="Link to this definition"></a></dt>
 <dd><p>Shows the current data on the main page of the user interface.</p>
 </dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.controllers.user_controller.UserController.show_dashboard">
+<span class="sig-name descname"><span class="pre">show_dashboard</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/controllers/user_controller.html#UserController.show_dashboard"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.controllers.user_controller.UserController.show_dashboard" title="Link to this definition"></a></dt>
 <dd><p>Shows the main page of the user interface.</p>
 </dd></dl>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/streamlit_src.html CHANGED Viewed

@@ -10,7 +10,7 @@
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
@@ -20,17 +20,17 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src.controllers package" href="streamlit_src.controllers.html" />
-    <link rel="prev" title="air_quality_forecast package" href="air_quality_forecast.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -86,7 +86,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-package">
 <h1>streamlit_src package<a class="headerlink" href="#streamlit-src-package" title="Link to this heading"></a></h1>
 <section id="subpackages">
@@ -161,9 +161,14 @@
 </li>
 <li class="toctree-l2"><a class="reference internal" href="streamlit_src.views.html#module-streamlit_src.views.home_view">streamlit_src.views.home_view module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView"><code class="docutils literal notranslate"><span class="pre">HomeView</span></code></a><ul>
-<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.prompt_admin_password"><code class="docutils literal notranslate"><span class="pre">HomeView.prompt_admin_password()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.set_layout"><code class="docutils literal notranslate"><span class="pre">HomeView.set_layout()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.show_dashboard_switch"><code class="docutils literal notranslate"><span class="pre">HomeView.show_dashboard_switch()</span></code></a></li>
 </ul>
 </li>
 </ul>
@@ -193,6 +198,8 @@
 <li class="toctree-l2"><a class="reference internal" href="streamlit_src.models.html#submodules">Submodules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="streamlit_src.models.html#module-streamlit_src.models.air_quality_model">streamlit_src.models.air_quality_model module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel"><code class="docutils literal notranslate"><span class="pre">AirQualityModel</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics"><code class="docutils literal notranslate"><span class="pre">AirQualityModel.calculate_metrics()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days"><code class="docutils literal notranslate"><span class="pre">AirQualityModel.get_all_data_last_three_days()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days"><code class="docutils literal notranslate"><span class="pre">AirQualityModel.get_last_three_days()</span></code></a></li>
@@ -236,7 +243,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -247,7 +254,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src.controllers package" href="streamlit_src.controllers.html" />
+    <link rel="prev" title="air_quality_forecast package" href="air_quality_forecast.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-package">
 <h1>streamlit_src package<a class="headerlink" href="#streamlit-src-package" title="Link to this heading"></a></h1>
 <section id="subpackages">
 </li>
 <li class="toctree-l2"><a class="reference internal" href="streamlit_src.views.html#module-streamlit_src.views.home_view">streamlit_src.views.home_view module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView"><code class="docutils literal notranslate"><span class="pre">HomeView</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.None"><code class="docutils literal notranslate"><span class="pre">HomeView.None</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.__init__"><code class="docutils literal notranslate"><span class="pre">HomeView.__init__()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.set_layout"><code class="docutils literal notranslate"><span class="pre">HomeView.set_layout()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.show_dashboard_switch"><code class="docutils literal notranslate"><span class="pre">HomeView.show_dashboard_switch()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#streamlit_src.views.home_view.HomeView.prompt_admin_password"><code class="docutils literal notranslate"><span class="pre">HomeView.prompt_admin_password()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#id0"><code class="docutils literal notranslate"><span class="pre">HomeView.prompt_admin_password()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#id1"><code class="docutils literal notranslate"><span class="pre">HomeView.set_layout()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#id2"><code class="docutils literal notranslate"><span class="pre">HomeView.show_dashboard_switch()</span></code></a></li>
 </ul>
 </li>
 </ul>
 <li class="toctree-l2"><a class="reference internal" href="streamlit_src.models.html#submodules">Submodules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="streamlit_src.models.html#module-streamlit_src.models.air_quality_model">streamlit_src.models.air_quality_model module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel"><code class="docutils literal notranslate"><span class="pre">AirQualityModel</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel._WHO_NO2_LEVEL"><code class="docutils literal notranslate"><span class="pre">AirQualityModel._WHO_NO2_LEVEL</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel._WHO_O3_LEVEL"><code class="docutils literal notranslate"><span class="pre">AirQualityModel._WHO_O3_LEVEL</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics"><code class="docutils literal notranslate"><span class="pre">AirQualityModel.calculate_metrics()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days"><code class="docutils literal notranslate"><span class="pre">AirQualityModel.get_all_data_last_three_days()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days"><code class="docutils literal notranslate"><span class="pre">AirQualityModel.get_last_three_days()</span></code></a></li>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/streamlit_src.models.html CHANGED Viewed

@@ -10,7 +10,7 @@
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
@@ -19,17 +19,17 @@
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="streamlit_src.views package" href="streamlit_src.views.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -86,7 +86,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-models-package">
 <h1>streamlit_src.models package<a class="headerlink" href="#streamlit-src-models-package" title="Link to this heading"></a></h1>
 <section id="submodules">
@@ -98,24 +98,78 @@
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.models.air_quality_model.</span></span><span class="sig-name descname"><span class="pre">AirQualityModel</span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics">
-<span class="sig-name descname"><span class="pre">calculate_metrics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.calculate_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days">
-<span class="sig-name descname"><span class="pre">get_all_data_last_three_days</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.get_all_data_last_three_days"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days">
-<span class="sig-name descname"><span class="pre">get_last_three_days</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.get_last_three_days"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.get_today_data">
-<span class="sig-name descname"><span class="pre">get_today_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.get_today_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.get_today_data" title="Link to this definition"></a></dt>
 <dd><p>Returns the air quality data for today from the past 3 days data.</p>
 <p>The data is obtained from a CSV file located at PAST_DATA_PATH.</p>
 <dl class="field-list simple">
@@ -130,8 +184,9 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions">
-<span class="sig-name descname"><span class="pre">next_three_day_predictions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.next_three_day_predictions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 </dd></dl>
@@ -157,7 +212,7 @@
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -168,7 +223,7 @@
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="streamlit_src.views package" href="streamlit_src.views.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-models-package">
 <h1>streamlit_src.models package<a class="headerlink" href="#streamlit-src-models-package" title="Link to this heading"></a></h1>
 <section id="submodules">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.models.air_quality_model.</span></span><span class="sig-name descname"><span class="pre">AirQualityModel</span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>A class that loads the air quality model and makes predictions.</p>
+<p>The model is loaded from a pickle file located at PREDICTION_PATH.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel._WHO_NO2_LEVEL">
+<span class="sig-name descname"><span class="pre">_WHO_NO2_LEVEL</span></span><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel._WHO_NO2_LEVEL" title="Link to this definition"></a></dt>
+<dd><p>The WHO air quality level for NO2 in micrograms per cubic meter.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>int</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel._WHO_O3_LEVEL">
+<span class="sig-name descname"><span class="pre">_WHO_O3_LEVEL</span></span><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel._WHO_O3_LEVEL" title="Link to this definition"></a></dt>
+<dd><p>The WHO air quality level for O3 in micrograms per cubic meter.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>int</p>
+</dd>
+</dl>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics">
+<span class="sig-name descname"><span class="pre">calculate_metrics</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.calculate_metrics"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.calculate_metrics" title="Link to this definition"></a></dt>
+<dd><p>Calculates the root mean squared error for the predictions of the last three days.</p>
+<p>The data is obtained from a CSV file located at PREDICTION_PATH.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A pandas DataFrame with the root mean squared error for the predictions of the last three days.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days">
+<span class="sig-name descname"><span class="pre">get_all_data_last_three_days</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.get_all_data_last_three_days"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.get_all_data_last_three_days" title="Link to this definition"></a></dt>
+<dd><p>Returns all the air quality data for the last three days from the past 3 days data.</p>
+<p>The data is obtained from a CSV file located at PAST_DATA_PATH.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A pandas DataFrame with the air quality data for the last three days.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days">
+<span class="sig-name descname"><span class="pre">get_last_three_days</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.get_last_three_days"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.get_last_three_days" title="Link to this definition"></a></dt>
+<dd><p>Returns all the air quality data for the last three days from the past 3 days data.</p>
+<p>The data is obtained from a CSV file located at PAST_DATA_PATH.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>A pandas DataFrame with the air quality data for the last three days.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>pd.DataFrame</p>
+</dd>
+</dl>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.get_today_data">
+<span class="sig-name descname"><span class="pre">get_today_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.get_today_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.get_today_data" title="Link to this definition"></a></dt>
 <dd><p>Returns the air quality data for today from the past 3 days data.</p>
 <p>The data is obtained from a CSV file located at PAST_DATA_PATH.</p>
 <dl class="field-list simple">
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions">
+<span class="sig-name descname"><span class="pre">next_three_day_predictions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="reference internal" href="_modules/streamlit_src/models/air_quality_model.html#AirQualityModel.next_three_day_predictions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.models.air_quality_model.AirQualityModel.next_three_day_predictions" title="Link to this definition"></a></dt>
+<dd><p>Returns the predictions for the next three days.</p>
+</dd></dl>
 </dd></dl>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

docs/_build/html/streamlit_src.views.html CHANGED Viewed

@@ -10,7 +10,7 @@
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
@@ -20,17 +20,17 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src.models package" href="streamlit_src.models.html" />
-    <link rel="prev" title="streamlit_src.controllers package" href="streamlit_src.controllers.html" />
 </head>
-<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
@@ -87,7 +87,7 @@
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-views-package">
 <h1>streamlit_src.views package<a class="headerlink" href="#streamlit-src-views-package" title="Link to this heading"></a></h1>
 <section id="submodules">
@@ -116,7 +116,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.display_datatable">
-<span class="sig-name descname"><span class="pre">display_datatable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.display_datatable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.display_datatable" title="Link to this definition"></a></dt>
 <dd><p>Displays a table of the data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -130,7 +130,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.display_feature_importance">
-<span class="sig-name descname"><span class="pre">display_feature_importance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_importances</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.display_feature_importance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.display_feature_importance" title="Link to this definition"></a></dt>
 <dd><p>Displays the feature importance graph using Plotly for better aesthetics.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -144,7 +144,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.download_button">
-<span class="sig-name descname"><span class="pre">download_button</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.download_button"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.download_button" title="Link to this definition"></a></dt>
 <dd><p>Creates a download button for the user to download the data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -159,8 +159,17 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.show_admin_pages">
-<span class="sig-name descname"><span class="pre">show_admin_pages</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.show_admin_pages"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.show_admin_pages" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.upload_dataset">
@@ -175,7 +184,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.upload_instructions">
-<span class="sig-name descname"><span class="pre">upload_instructions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.upload_instructions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.upload_instructions" title="Link to this definition"></a></dt>
 <dd><p>Displays instructions for uploading a dataset.</p>
 </dd></dl>
@@ -188,20 +197,77 @@
 <dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.views.home_view.</span></span><span class="sig-name descname"><span class="pre">HomeView</span></span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
-<dl class="py method">
-<dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.prompt_admin_password">
-<span class="sig-name descname"><span class="pre">prompt_admin_password</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.prompt_admin_password"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.prompt_admin_password" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.set_layout">
 <span class="sig-name descname"><span class="pre">set_layout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.set_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.set_layout" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.show_dashboard_switch">
 <span class="sig-name descname"><span class="pre">show_dashboard_switch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.show_dashboard_switch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.show_dashboard_switch" title="Link to this definition"></a></dt>
-<dd></dd></dl>
 </dd></dl>
@@ -215,7 +281,7 @@
 <p>A class to handle all user interface elements.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.compare_to_who">
-<span class="sig-name descname"><span class="pre">compare_to_who</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.compare_to_who"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.compare_to_who" title="Link to this definition"></a></dt>
 <dd><p>Compare the current pollutant concentrations with WHO guidelines and display the results.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -226,7 +292,7 @@
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.data_not_available">
-<span class="sig-name descname"><span class="pre">data_not_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.data_not_available"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.data_not_available" title="Link to this definition"></a></dt>
 <dd><p>Show an error message indicating that data is not available.</p>
 <p>This is shown when the current time is between 00:00 and 04:15, when the measurements aren’t accurate enough to produce a prediction.
 The data will be automatically updated at 04:15 with the prediction for the next three days.</p>
@@ -234,7 +300,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.display_predictions_gaugeplot">
-<span class="sig-name descname"><span class="pre">display_predictions_gaugeplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gauge_plots</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.display_predictions_gaugeplot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.display_predictions_gaugeplot" title="Link to this definition"></a></dt>
 <dd><p>Show a gauge plot of the predictions.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -245,7 +311,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.display_predictions_lineplot">
-<span class="sig-name descname"><span class="pre">display_predictions_lineplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Figure</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.display_predictions_lineplot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.display_predictions_lineplot" title="Link to this definition"></a></dt>
 <dd><p>Show a line plot of the predictions.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -256,7 +322,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.error">
-<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.error" title="Link to this definition"></a></dt>
 <dd><p>Show an error message.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -267,7 +333,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.print_sources">
-<span class="sig-name descname"><span class="pre">print_sources</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sources</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.print_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.print_sources" title="Link to this definition"></a></dt>
 <dd><p>Print the sources used in the application.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -298,7 +364,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.raise_awareness">
-<span class="sig-name descname"><span class="pre">raise_awareness</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">random_fact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">awareness_expanders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.raise_awareness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.raise_awareness" title="Link to this definition"></a></dt>
 <dd><p>Raise awareness about air quality issues and provide health recommendations.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -313,7 +379,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.show_current_data">
-<span class="sig-name descname"><span class="pre">show_current_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">merged_data_df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.show_current_data" title="Link to this definition"></a></dt>
 <dd><p>Show the current pollutant concentrations along with WHO guidelines.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -324,7 +390,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.success">
-<span class="sig-name descname"><span class="pre">success</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.success"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.success" title="Link to this definition"></a></dt>
 <dd><p>Show a success message.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -335,7 +401,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.two_columns_layout">
-<span class="sig-name descname"><span class="pre">two_columns_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">left_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.two_columns_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.two_columns_layout" title="Link to this definition"></a></dt>
 <dd><p>Divide the page into two columns and call the left and right functions within them.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -390,7 +456,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
@@ -401,7 +467,7 @@ The data will be automatically updated at 04:15 with the prediction for the next
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
-  </script>
 </body>
-</html>

       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=5929fcd5"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="streamlit_src.models package" href="streamlit_src.models.html" />
+    <link rel="prev" title="streamlit_src.controllers package" href="streamlit_src.controllers.html" />
 </head>
+<body class="wy-body-for-nav">
   <div class="wy-grid-for-nav">
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
           <a href="index.html" class="icon icon-home">
             Air Quality Forecast
           </a>
 </div>
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
   <section id="streamlit-src-views-package">
 <h1>streamlit_src.views package<a class="headerlink" href="#streamlit-src-views-package" title="Link to this heading"></a></h1>
 <section id="submodules">
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.display_datatable">
+<span class="sig-name descname"><span class="pre">display_datatable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.display_datatable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.display_datatable" title="Link to this definition"></a></dt>
 <dd><p>Displays a table of the data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.display_feature_importance">
+<span class="sig-name descname"><span class="pre">display_feature_importance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feature_importances</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.display_feature_importance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.display_feature_importance" title="Link to this definition"></a></dt>
 <dd><p>Displays the feature importance graph using Plotly for better aesthetics.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.download_button">
+<span class="sig-name descname"><span class="pre">download_button</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.download_button"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.download_button" title="Link to this definition"></a></dt>
 <dd><p>Creates a download button for the user to download the data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.show_admin_pages">
+<span class="sig-name descname"><span class="pre">show_admin_pages</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.show_admin_pages"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.show_admin_pages" title="Link to this definition"></a></dt>
+<dd><p>Displays a dropdown for selecting different admin pages.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The selected page from the dropdown.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.upload_dataset">
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.admin_view.AdminView.upload_instructions">
+<span class="sig-name descname"><span class="pre">upload_instructions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/admin_view.html#AdminView.upload_instructions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.admin_view.AdminView.upload_instructions" title="Link to this definition"></a></dt>
 <dd><p>Displays instructions for uploading a dataset.</p>
 </dd></dl>
 <dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">streamlit_src.views.home_view.</span></span><span class="sig-name descname"><span class="pre">HomeView</span></span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView" title="Link to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+<p>The HomeView class manages the layout and logic for the home page,
+including the user and admin dashboard navigation.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.None">
+<span class="sig-name descname"><span class="pre">None</span></span><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.None" title="Link to this definition"></a></dt>
 <dd></dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.__init__">
+<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.__init__" title="Link to this definition"></a></dt>
+<dd><p>Initializes the HomeView class by setting up the home layout.</p>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.set_layout">
 <span class="sig-name descname"><span class="pre">set_layout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.set_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.set_layout" title="Link to this definition"></a></dt>
+<dd><p>Sets the layout of the home page.</p>
+</dd></dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.show_dashboard_switch">
 <span class="sig-name descname"><span class="pre">show_dashboard_switch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.show_dashboard_switch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.show_dashboard_switch" title="Link to this definition"></a></dt>
+<dd><p>Displays the user and admin dashboard navigation.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="streamlit_src.views.home_view.HomeView.prompt_admin_password">
+<span class="sig-name descname"><span class="pre">prompt_admin_password</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.prompt_admin_password"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.home_view.HomeView.prompt_admin_password" title="Link to this definition"></a></dt>
+<dd><p>Prompts the user for the admin password.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="id0">
+<span class="sig-name descname"><span class="pre">prompt_admin_password</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.prompt_admin_password"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Link to this definition"></a></dt>
+<dd><p>Prompts the user for the admin password.</p>
+<p>This method is responsible for prompting the user for the admin password
+when the user navigates to the admin dashboard. It displays a text input
+field in the sidebar with a placeholder saying “Enter Admin Password:”.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The password entered by the user.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="id1">
+<span class="sig-name descname"><span class="pre">set_layout</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.set_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id1" title="Link to this definition"></a></dt>
+<dd><p>Sets the layout of the home page.</p>
+<p>This method is responsible for setting up the Streamlit page configuration
+and creating the sidebar title.</p>
+</dd></dl>
+<dl class="py method">
+<dt class="sig sig-object py" id="id2">
+<span class="sig-name descname"><span class="pre">show_dashboard_switch</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/streamlit_src/views/home_view.html#HomeView.show_dashboard_switch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id2" title="Link to this definition"></a></dt>
+<dd><p>Displays the user and admin dashboard navigation.</p>
+<p>This method is responsible for displaying the user and admin dashboard navigation
+in the sidebar. It returns the page selected by the user.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Returns<span class="colon">:</span></dt>
+<dd class="field-odd"><p>The page selected by the user.</p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
 </dd></dl>
 <p>A class to handle all user interface elements.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.compare_to_who">
+<span class="sig-name descname"><span class="pre">compare_to_who</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">warnings</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.compare_to_who"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.compare_to_who" title="Link to this definition"></a></dt>
 <dd><p>Compare the current pollutant concentrations with WHO guidelines and display the results.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.data_not_available">
+<span class="sig-name descname"><span class="pre">data_not_available</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.data_not_available"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.data_not_available" title="Link to this definition"></a></dt>
 <dd><p>Show an error message indicating that data is not available.</p>
 <p>This is shown when the current time is between 00:00 and 04:15, when the measurements aren’t accurate enough to produce a prediction.
 The data will be automatically updated at 04:15 with the prediction for the next three days.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.display_predictions_gaugeplot">
+<span class="sig-name descname"><span class="pre">display_predictions_gaugeplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gauge_plots</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.display_predictions_gaugeplot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.display_predictions_gaugeplot" title="Link to this definition"></a></dt>
 <dd><p>Show a gauge plot of the predictions.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.display_predictions_lineplot">
+<span class="sig-name descname"><span class="pre">display_predictions_lineplot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fig</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Figure</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.display_predictions_lineplot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.display_predictions_lineplot" title="Link to this definition"></a></dt>
 <dd><p>Show a line plot of the predictions.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.error">
+<span class="sig-name descname"><span class="pre">error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.error" title="Link to this definition"></a></dt>
 <dd><p>Show an error message.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.print_sources">
+<span class="sig-name descname"><span class="pre">print_sources</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sources</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.print_sources"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.print_sources" title="Link to this definition"></a></dt>
 <dd><p>Print the sources used in the application.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.raise_awareness">
+<span class="sig-name descname"><span class="pre">raise_awareness</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">random_fact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">awareness_expanders</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">health_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.raise_awareness"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.raise_awareness" title="Link to this definition"></a></dt>
 <dd><p>Raise awareness about air quality issues and provide health recommendations.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.show_current_data">
+<span class="sig-name descname"><span class="pre">show_current_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">merged_data_df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.show_current_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.show_current_data" title="Link to this definition"></a></dt>
 <dd><p>Show the current pollutant concentrations along with WHO guidelines.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.success">
+<span class="sig-name descname"><span class="pre">success</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.success"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.success" title="Link to this definition"></a></dt>
 <dd><p>Show a success message.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dl class="py method">
 <dt class="sig sig-object py" id="streamlit_src.views.user_view.UserView.two_columns_layout">
+<span class="sig-name descname"><span class="pre">two_columns_layout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ratio</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">left_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">right_function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#streamlit_src.views.home_view.HomeView.None" title="streamlit_src.views.home_view.HomeView.None"><span class="pre">None</span></a></span></span><a class="reference internal" href="_modules/streamlit_src/views/user_view.html#UserView.two_columns_layout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#streamlit_src.views.user_view.UserView.two_columns_layout" title="Link to this definition"></a></dt>
 <dd><p>Divide the page into two columns and call the left and right functions within them.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.
 </footer>
         </div>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
+  </script>
 </body>
+</html>

streamlit_src/controllers/admin_controller.py CHANGED Viewed

@@ -143,7 +143,12 @@ class AdminController(UserController):
             "The data must be unnormalized.": False,
             "PM25, PM10, O3, NO2 should be in micrograms per cubic meter (µg/m³).": False,
             "Temperature should be in degrees Celcius": False,
-            "Add the others later": False,
             "The dataset must contain a total of 33 columns in the specified order.": False,
             "I accept that my data will be used for a prediction using a custom model.": False,
             "I understand that my data will not be saved.": False,

             "The data must be unnormalized.": False,
             "PM25, PM10, O3, NO2 should be in micrograms per cubic meter (µg/m³).": False,
             "Temperature should be in degrees Celcius": False,
+            "Humidity should be in percentages": False,
+            "Visibility should be in kilometers": False,
+            "Solar Radiation should be in watts per square meter (W/m²).": False,
+            "Precipitation should be in millimeters": False,
+            "Wind Speed should be in kilometers per hour (km/h).": False,
+            "Wind Direction should be in degrees": False,
             "The dataset must contain a total of 33 columns in the specified order.": False,
             "I accept that my data will be used for a prediction using a custom model.": False,
             "I understand that my data will not be saved.": False,

streamlit_src/controllers/home_controller.py CHANGED Viewed

@@ -7,21 +7,46 @@ import hashlib
 class HomeController:
     __ADMIN_PASSWORD_HASH = (
         "240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9"
     )
-    def __init__(self):
         self.home_view = HomeView()
         self.user_controller = UserController()
         self.admin_controller = AdminController()
         self._run()
-    def _hash_password(self, password):
         """Hash the input password using SHA-256."""
         return hashlib.sha256(password.encode()).hexdigest()
-    def _run(self):
         if "is_admin_logged_in" not in st.session_state:
             st.session_state.is_admin_logged_in = False

 class HomeController:
+    """
+    Handles the logic for the home page, including switching between user and admin views.
+    The home page is the main entry point for the Streamlit application.
+    It contains a text input for the admin password, which is hashed and compared to the stored hash.
+    If the password is correct, the user is logged in as an admin and the admin view is displayed.
+    Otherwise, the user view is displayed.
+    """
+    # This needs to be hidden as an env variable but we couldn't manage with HuggingFace yet, severe security issue
     __ADMIN_PASSWORD_HASH = (
         "240be518fabd2724ddb6f04eeb1da5967448d7e831c08c8fa822809f74c720a9"
     )
+    def __init__(self) -> None:
+        """
+        Initializes the HomeController class by setting up the home view, user controller,
+        and admin controller. Also triggers the _run method to start the application.
+        """
         self.home_view = HomeView()
         self.user_controller = UserController()
         self.admin_controller = AdminController()
         self._run()
+    def _hash_password(self, password: str) -> str:
         """Hash the input password using SHA-256."""
         return hashlib.sha256(password.encode()).hexdigest()
+    def _run(self) -> None:
+        """
+        Runs the application logic for the home page.
+        This method is responsible for rendering the home page and
+        handling the user's choice of whether to view the user dashboard
+        or admin dashboard. If the user chooses to view the admin dashboard,
+        the user is prompted to enter the admin password. If the password
+        is valid, the user is logged in as an admin and the admin dashboard
+        is displayed. If the password is invalid, the user is logged out and
+        the user dashboard is displayed.
+        """
         if "is_admin_logged_in" not in st.session_state:
             st.session_state.is_admin_logged_in = False

streamlit_src/models/air_quality_model.py CHANGED Viewed

@@ -19,11 +19,24 @@ PAST_DATA_PATH = os.path.join(
 class AirQualityModel:
     def __init__(self) -> None:
-        self.WHO_NO2_LEVEL = 25
-        self.WHO_O3_LEVEL = 100
-    def get_today_data(self):
         """
         Returns the air quality data for today from the past 3 days data.
@@ -38,14 +51,14 @@ class AirQualityModel:
         today = last_three_days.iloc[0]
         return today
-    def next_three_day_predictions(self):
-        # Load data from the specified path (assuming it's a CSV file)
         data = pd.read_csv(PREDICTION_PATH)
-        # correct data is todays data row
         data = data[data["date"] == pd.Timestamp.now().strftime("%Y-%m-%d")]
-        # Create a DataFrame with the relevant information for the next three days
         next_three_days = pd.DataFrame(
             {
                 "Day": ["Day 1", "Day 2", "Day 3"],
@@ -64,11 +77,31 @@ class AirQualityModel:
         return next_three_days
-    def get_all_data_last_three_days(self):
         data = pd.read_csv(PAST_DATA_PATH)
         return data
-    def get_last_three_days(self):
         # Extract NO2 and O3 values for the last three days
         data = pd.read_csv(PAST_DATA_PATH)
         last_three_days = pd.DataFrame(
@@ -88,7 +121,17 @@ class AirQualityModel:
         )
         return last_three_days
-    def calculate_metrics(self):
         model_predictions = pd.read_csv(PREDICTION_PATH)
         yesterday = (datetime.now() - timedelta(days=1)).strftime("%Y-%m-%d")

 class AirQualityModel:
+    """
+    A class that loads the air quality model and makes predictions.
+    The model is loaded from a pickle file located at PREDICTION_PATH.
+    Attributes
+    ----------
+    _WHO_NO2_LEVEL : int
+        The WHO air quality level for NO2 in micrograms per cubic meter.
+    _WHO_O3_LEVEL : int
+        The WHO air quality level for O3 in micrograms per cubic meter.
+    """
     def __init__(self) -> None:
+        self._WHO_NO2_LEVEL = 25
+        self._WHO_O3_LEVEL = 100
+    def get_today_data(self) -> pd.Series:
         """
         Returns the air quality data for today from the past 3 days data.
         today = last_three_days.iloc[0]
         return today
+    def next_three_day_predictions(self) -> pd.DataFrame:
+        """
+        Returns the predictions for the next three days.
+        """
         data = pd.read_csv(PREDICTION_PATH)
         data = data[data["date"] == pd.Timestamp.now().strftime("%Y-%m-%d")]
         next_three_days = pd.DataFrame(
             {
                 "Day": ["Day 1", "Day 2", "Day 3"],
         return next_three_days
+    def get_all_data_last_three_days(self) -> pd.DataFrame:
+        """
+        Returns all the air quality data for the last three days from the past 3 days data.
+        The data is obtained from a CSV file located at PAST_DATA_PATH.
+        Returns
+        -------
+        pd.DataFrame
+            A pandas DataFrame with the air quality data for the last three days.
+        """
         data = pd.read_csv(PAST_DATA_PATH)
         return data
+    def get_last_three_days(self) -> pd.DataFrame:
+        """
+        Returns all the air quality data for the last three days from the past 3 days data.
+        The data is obtained from a CSV file located at PAST_DATA_PATH.
+        Returns
+        -------
+        pd.DataFrame
+            A pandas DataFrame with the air quality data for the last three days.
+        """
         # Extract NO2 and O3 values for the last three days
         data = pd.read_csv(PAST_DATA_PATH)
         last_three_days = pd.DataFrame(
         )
         return last_three_days
+    def calculate_metrics(self) -> pd.DataFrame:
+        """
+        Calculates the root mean squared error for the predictions of the last three days.
+        The data is obtained from a CSV file located at PREDICTION_PATH.
+        Returns
+        -------
+        pd.DataFrame
+            A pandas DataFrame with the root mean squared error for the predictions of the last three days.
+        """
         model_predictions = pd.read_csv(PREDICTION_PATH)
         yesterday = (datetime.now() - timedelta(days=1)).strftime("%Y-%m-%d")

streamlit_src/views/admin_view.py CHANGED Viewed

@@ -18,7 +18,13 @@ class AdminView(UserView):
         """
         super().__init__()
-    def show_admin_pages(self):
         page = st.selectbox(
             "Select a page:",
             [
@@ -76,8 +82,8 @@ class AdminView(UserView):
         )
         st.markdown("""
     - **Normalization**: The data must be **unnormalized**.
-    - **Units**: All measurements should be in **micrograms/m³**.
-    - **Data Structure**: The dataset must contain a total of **33 columns** with the following order:
         - **Optional**: `date`
         - `PM25` (today)
         - `PM10` (today)

         """
         super().__init__()
+    def show_admin_pages(self) -> str:
+        """
+        Displays a dropdown for selecting different admin pages.
+        Returns:
+            str: The selected page from the dropdown.
+        """
         page = st.selectbox(
             "Select a page:",
             [
         )
         st.markdown("""
     - **Normalization**: The data must be **unnormalized**.
+    - **Units**: All measurements should as specified below**.
+    - **Data Structure**: The dataset must contain a total of **33 columns** (34 with date) with the following order:
         - **Optional**: `date`
         - `PM25` (today)
         - `PM10` (today)

streamlit_src/views/home_view.py CHANGED Viewed

@@ -2,17 +2,62 @@ import streamlit as st
 class HomeView:
-    def __init__(self):
         self.set_layout()
-    def set_layout(self):
         st.set_page_config(page_title="Air Quality Monitoring Dashboard", layout="wide")
         st.sidebar.title("Air Quality Monitoring")
-    def show_dashboard_switch(self):
         page = st.sidebar.radio("Go to", ["User Dashboard", "Admin Dashboard"])
         return page
-    def prompt_admin_password(self):
         st.sidebar.markdown("### Admin Access Required")
         return st.sidebar.text_input("Enter Admin Password:", type="password")

 class HomeView:
+    """
+    The HomeView class manages the layout and logic for the home page,
+    including the user and admin dashboard navigation.
+    Attributes:
+        None
+    Methods:
+        __init__: Initializes the HomeView class by setting up the home layout.
+        set_layout: Sets the layout of the home page.
+        show_dashboard_switch: Displays the user and admin dashboard navigation.
+        prompt_admin_password: Prompts the user for the admin password.
+    """
+    def __init__(self) -> None:
+        """
+        Initializes the HomeView class by setting up the home layout.
+        This method is responsible for setting up the Streamlit page configuration and
+        creating the sidebar title.
+        """
         self.set_layout()
+    def set_layout(self) -> None:
+        """
+        Sets the layout of the home page.
+        This method is responsible for setting up the Streamlit page configuration
+        and creating the sidebar title.
+        """
         st.set_page_config(page_title="Air Quality Monitoring Dashboard", layout="wide")
         st.sidebar.title("Air Quality Monitoring")
+    def show_dashboard_switch(self) -> str:
+        """
+        Displays the user and admin dashboard navigation.
+        This method is responsible for displaying the user and admin dashboard navigation
+        in the sidebar. It returns the page selected by the user.
+        Returns:
+            str: The page selected by the user.
+        """
         page = st.sidebar.radio("Go to", ["User Dashboard", "Admin Dashboard"])
         return page
+    def prompt_admin_password(self) -> str:
+        """
+        Prompts the user for the admin password.
+        This method is responsible for prompting the user for the admin password
+        when the user navigates to the admin dashboard. It displays a text input
+        field in the sidebar with a placeholder saying "Enter Admin Password:".
+        Returns:
+            str: The password entered by the user.
+        """
         st.sidebar.markdown("### Admin Access Required")
         return st.sidebar.text_input("Enter Admin Password:", type="password")