Spaces:
Sleeping
Sleeping
| <html class="writer-html5" lang="en" data-content_root="./"> | |
| <head> | |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | |
| <title>streamlit_src.models package — Air Quality Forecast documentation</title> | |
| <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/doctools.js?v=9bcbadda"></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" /> | |
| <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 role="search"> | |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> | |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> | |
| <input type="hidden" name="check_keywords" value="yes" /> | |
| <input type="hidden" name="area" value="default" /> | |
| </form> | |
| </div> | |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | |
| <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> | |
| <ul class="current"> | |
| <li class="toctree-l1 current"><a class="reference internal" href="modules.html">air-quality-forecast</a><ul class="current"> | |
| <li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html">air_quality_forecast package</a></li> | |
| <li class="toctree-l2 current"><a class="reference internal" href="streamlit_src.html">streamlit_src package</a><ul class="current"> | |
| <li class="toctree-l3 current"><a class="reference internal" href="streamlit_src.html#subpackages">Subpackages</a><ul class="current"> | |
| <li class="toctree-l4"><a class="reference internal" href="streamlit_src.controllers.html">streamlit_src.controllers package</a></li> | |
| <li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html">streamlit_src.views package</a></li> | |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">streamlit_src.models package</a></li> | |
| </ul> | |
| </li> | |
| <li class="toctree-l3"><a class="reference internal" href="streamlit_src.html#submodules">Submodules</a></li> | |
| <li class="toctree-l3"><a class="reference internal" href="streamlit_src.html#module-streamlit_src.app">streamlit_src.app module</a></li> | |
| <li class="toctree-l3"><a class="reference internal" href="streamlit_src.html#module-streamlit_src">Module contents</a></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| </nav> | |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > | |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | |
| <a href="index.html">Air Quality Forecast</a> | |
| </nav> | |
| <div class="wy-nav-content"> | |
| <div class="rst-content"> | |
| <div role="navigation" aria-label="Page navigation"> | |
| <ul class="wy-breadcrumbs"> | |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> | |
| <li class="breadcrumb-item"><a href="modules.html">air-quality-forecast</a></li> | |
| <li class="breadcrumb-item"><a href="streamlit_src.html">streamlit_src package</a></li> | |
| <li class="breadcrumb-item active">streamlit_src.models package</li> | |
| <li class="wy-breadcrumbs-aside"> | |
| <a href="_sources/streamlit_src.models.rst.txt" rel="nofollow"> View page source</a> | |
| </li> | |
| </ul> | |
| <hr/> | |
| </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"> | |
| <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2> | |
| </section> | |
| <section id="module-streamlit_src.models.air_quality_model"> | |
| <span id="streamlit-src-models-air-quality-model-module"></span><h2>streamlit_src.models.air_quality_model module<a class="headerlink" href="#module-streamlit_src.models.air_quality_model" title="Link to this heading"></a></h2> | |
| <dl class="py class"> | |
| <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">→</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">→</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">→</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">→</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"> | |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> | |
| <dd class="field-odd"><p>A pandas Series with the air quality data for today.</p> | |
| </dd> | |
| <dt class="field-even">Return type<span class="colon">:</span></dt> | |
| <dd class="field-even"><p>pd.Series</p> | |
| </dd> | |
| </dl> | |
| </dd></dl> | |
| <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">→</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> | |
| </section> | |
| <section id="module-streamlit_src.models"> | |
| <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-streamlit_src.models" title="Link to this heading"></a></h2> | |
| </section> | |
| </section> | |
| </div> | |
| </div> | |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | |
| <a href="streamlit_src.views.html" class="btn btn-neutral float-left" title="streamlit_src.views package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | |
| </div> | |
| <hr/> | |
| <div role="contentinfo"> | |
| <p>© Copyright 2024, Aleksandar Todorov, Christian Kobriger, Lukasz Sawala, Csenge Szoke.</p> | |
| </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> | |
| </div> | |
| </section> | |
| </div> | |
| <script> | |
| jQuery(function () { | |
| SphinxRtdTheme.Navigation.enable(true); | |
| }); | |
| </script> | |
| </body> | |
| </html> | |