atodorov284
added private attributes to documentation
19d829e
<!DOCTYPE html>
<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>air-quality-forecast &mdash; 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="next" title="air_quality_forecast package" href="air_quality_forecast.html" />
<link rel="prev" title="Air Quality Forecast documentation" href="index.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="current reference internal" href="#">air-quality-forecast</a><ul>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html">air_quality_forecast package</a></li>
<li class="toctree-l2"><a class="reference internal" href="streamlit_src.html">streamlit_src package</a></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 active">air-quality-forecast</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/modules.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="air-quality-forecast">
<h1>air-quality-forecast<a class="headerlink" href="#air-quality-forecast" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="air_quality_forecast.html">air_quality_forecast package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.api_caller">air_quality_forecast.api_caller module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller"><code class="docutils literal notranslate"><span class="pre">APICaller</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller._current_time"><code class="docutils literal notranslate"><span class="pre">APICaller._current_time()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller._get_luchtmeet_data"><code class="docutils literal notranslate"><span class="pre">APICaller._get_luchtmeet_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller._two_days_ago"><code class="docutils literal notranslate"><span class="pre">APICaller._two_days_ago()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller.get_luchtmeet_data"><code class="docutils literal notranslate"><span class="pre">APICaller.get_luchtmeet_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller.get_vc_data"><code class="docutils literal notranslate"><span class="pre">APICaller.get_vc_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.api_caller.APICaller.lag_data"><code class="docutils literal notranslate"><span class="pre">APICaller.lag_data()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.data_pipeline">air_quality_forecast.data_pipeline module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.DataLoader"><code class="docutils literal notranslate"><span class="pre">DataLoader</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.DataLoader.save_to_csv"><code class="docutils literal notranslate"><span class="pre">DataLoader.save_to_csv()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor"><code class="docutils literal notranslate"><span class="pre">FeatureProcessor</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.apply_time_shift"><code class="docutils literal notranslate"><span class="pre">FeatureProcessor.apply_time_shift()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.merge_raw_data"><code class="docutils literal notranslate"><span class="pre">FeatureProcessor.merge_raw_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.preprocess_data"><code class="docutils literal notranslate"><span class="pre">FeatureProcessor.preprocess_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.select_features"><code class="docutils literal notranslate"><span class="pre">FeatureProcessor.select_features()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.FeatureProcessor.sort_data_by_date"><code class="docutils literal notranslate"><span class="pre">FeatureProcessor.sort_data_by_date()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.PreprocessingPipeline"><code class="docutils literal notranslate"><span class="pre">PreprocessingPipeline</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.PreprocessingPipeline.run_pipeline"><code class="docutils literal notranslate"><span class="pre">PreprocessingPipeline.run_pipeline()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.data_pipeline.PreprocessingPipeline.train_test_split"><code class="docutils literal notranslate"><span class="pre">PreprocessingPipeline.train_test_split()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.get_prediction_data">air_quality_forecast.get_prediction_data module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.get_prediction_data.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.main">air_quality_forecast.main module</a></li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.model_development">air_quality_forecast.model_development module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer._evaluate_model"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer._evaluate_model()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer._optimize_and_evaluate"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer._optimize_and_evaluate()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer._perform_search"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer._perform_search()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer._set_data"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer._set_data()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer._setup_mlflow"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer._setup_mlflow()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer.launch_mlflow_server"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer.launch_mlflow_server()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer.port_in_use"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer.port_in_use()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.RegressorTrainer.run"><code class="docutils literal notranslate"><span class="pre">RegressorTrainer.run()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.convert_param_space"><code class="docutils literal notranslate"><span class="pre">convert_param_space()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.run_bayesian_optimization"><code class="docutils literal notranslate"><span class="pre">run_bayesian_optimization()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.train_all_models"><code class="docutils literal notranslate"><span class="pre">train_all_models()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.model_development.train_one_model"><code class="docutils literal notranslate"><span class="pre">train_one_model()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.parser_ui">air_quality_forecast.parser_ui module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.parser_ui.create_parser"><code class="docutils literal notranslate"><span class="pre">create_parser()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.parser_ui.load_data"><code class="docutils literal notranslate"><span class="pre">load_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.parser_ui.main"><code class="docutils literal notranslate"><span class="pre">main()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.parser_ui.normalize_data"><code class="docutils literal notranslate"><span class="pre">normalize_data()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.parser_ui.train_model"><code class="docutils literal notranslate"><span class="pre">train_model()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.prediction">air_quality_forecast.prediction module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels"><code class="docutils literal notranslate"><span class="pre">PredictorModels</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels._load_models"><code class="docutils literal notranslate"><span class="pre">PredictorModels._load_models()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels.decision_tree_predictions"><code class="docutils literal notranslate"><span class="pre">PredictorModels.decision_tree_predictions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels.random_forest_predictions"><code class="docutils literal notranslate"><span class="pre">PredictorModels.random_forest_predictions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.prediction.PredictorModels.xgb_predictions"><code class="docutils literal notranslate"><span class="pre">PredictorModels.xgb_predictions()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast.utils">air_quality_forecast.utils module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.FeatureSelector"><code class="docutils literal notranslate"><span class="pre">FeatureSelector</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.FeatureSelector.change_to_numeric"><code class="docutils literal notranslate"><span class="pre">FeatureSelector.change_to_numeric()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.FeatureSelector.rename_initial_columns"><code class="docutils literal notranslate"><span class="pre">FeatureSelector.rename_initial_columns()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.FeatureSelector.select_cols_by_correlation"><code class="docutils literal notranslate"><span class="pre">FeatureSelector.select_cols_by_correlation()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.FeatureSelector.uninformative_columns"><code class="docutils literal notranslate"><span class="pre">FeatureSelector.uninformative_columns()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.InputValidator"><code class="docutils literal notranslate"><span class="pre">InputValidator</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.InputValidator.validate_file_exists"><code class="docutils literal notranslate"><span class="pre">InputValidator.validate_file_exists()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="air_quality_forecast.html#air_quality_forecast.utils.InputValidator.validate_type"><code class="docutils literal notranslate"><span class="pre">InputValidator.validate_type()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="air_quality_forecast.html#module-air_quality_forecast">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="streamlit_src.html">streamlit_src package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="streamlit_src.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="streamlit_src.controllers.html">streamlit_src.controllers package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.controllers.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.controllers.html#module-streamlit_src.controllers.admin_controller">streamlit_src.controllers.admin_controller module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.controllers.html#module-streamlit_src.controllers.home_controller">streamlit_src.controllers.home_controller module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.controllers.html#module-streamlit_src.controllers.user_controller">streamlit_src.controllers.user_controller module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.controllers.html#module-streamlit_src.controllers">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="streamlit_src.views.html">streamlit_src.views package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#module-streamlit_src.views.admin_view">streamlit_src.views.admin_view module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#module-streamlit_src.views.home_view">streamlit_src.views.home_view module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#module-streamlit_src.views.user_view">streamlit_src.views.user_view module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.views.html#module-streamlit_src.views">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="streamlit_src.models.html">streamlit_src.models package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#module-streamlit_src.models.air_quality_model">streamlit_src.models.air_quality_model module</a></li>
<li class="toctree-l4"><a class="reference internal" href="streamlit_src.models.html#module-streamlit_src.models">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="streamlit_src.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="streamlit_src.html#module-streamlit_src.app">streamlit_src.app module</a></li>
<li class="toctree-l2"><a class="reference internal" href="streamlit_src.html#module-streamlit_src">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="Air Quality Forecast documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="air_quality_forecast.html" class="btn btn-neutral float-right" title="air_quality_forecast package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; 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>