sam/pyFTS
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity
0546544890
pyFTS/docs/build/html/pyFTS.models.seasonal.html

1294 lines
138 KiB
HTML
Raw Normal View History

Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
Updating the documentation
2018-08-30 23:04:52 +04:00
<!doctype html>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
Documentation update
2020-08-19 00:06:41 +04:00
<html>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<head>
Documentation update
2020-08-19 00:06:41 +04:00
<meta charset="utf-8" />
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyFTS.models.seasonal package &#8212; pyFTS 1.7 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
Documentation update
2020-08-19 00:06:41 +04:00
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Documentation update
2020-08-19 00:06:41 +04:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/bizstyle.js"></script>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Updating the documentation
2018-08-30 23:04:52 +04:00
<link rel="next" title="pyFTS.partitioners package" href="pyFTS.partitioners.html" />
<link rel="prev" title="pyFTS.models.nonstationary package" href="pyFTS.models.nonstationary.html" />
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
Updating the documentation
2018-08-30 23:04:52 +04:00
<!--[if lt IE 9]>
Documentation update
2020-08-19 00:06:41 +04:00
<script src="_static/css3-mediaqueries.js"></script>
Updating the documentation
2018-08-30 23:04:52 +04:00
<![endif]-->
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</head><body>
Updating the documentation
2018-08-30 23:04:52 +04:00
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.partitioners.html" title="pyFTS.partitioners package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyFTS.models.nonstationary.html" title="pyFTS.models.nonstationary package"
accesskey="P">previous</a> |</li>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.7 documentation</a> &#187;</li>
Updating the documentation
2018-08-30 23:04:52 +04:00
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
Documentation update
2020-08-19 00:06:41 +04:00
<li class="nav-item nav-item-3"><a href="pyFTS.models.html" accesskey="U">pyFTS.models package</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyFTS.models.seasonal package</a></li>
Updating the documentation
2018-08-30 23:04:52 +04:00
</ul>
Documentation update
2020-08-19 00:06:41 +04:00
</div>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pyfts-models-seasonal-package">
<h1>pyFTS.models.seasonal package<a class="headerlink" href="#pyfts-models-seasonal-package" title="Permalink to this headline"></a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-pyFTS.models.seasonal.SeasonalIndexer">
<span id="pyfts-models-seasonal-seasonalindexer-module"></span><h2>pyFTS.models.seasonal.SeasonalIndexer module<a class="headerlink" href="#module-pyFTS.models.seasonal.SeasonalIndexer" title="Permalink to this headline"></a></h2>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">DataFrameSeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index_fields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_seasons</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_field</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer</span></code></a></p>
<p>Use the Pandas.DataFrame index position to index the seasonality</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data_by_season">
<span class="sig-name descname"><span class="pre">get_data_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_data_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.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">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer.set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.set_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">DateTimeSeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_fields</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index_seasons</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_field</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer</span></code></a></p>
<p>Use a Pandas.DataFrame date field to index the seasonality</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data_by_season">
<span class="sig-name descname"><span class="pre">get_data_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_data_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index">
<span class="sig-name descname"><span class="pre">get_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.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">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer.set_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.set_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">LinearSeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seasons</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer</span></code></a></p>
<p>Use the data array/list position to index the seasonality</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.SeasonalIndexer.</span></span><span class="sig-name descname"><span class="pre">SeasonalIndexer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">num_seasons</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<p>Seasonal Indexer. Responsible to find the seasonal index of a data point inside its data set</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data">
<span class="sig-name descname"><span class="pre">get_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data_by_season">
<span class="sig-name descname"><span class="pre">get_data_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_data_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index">
<span class="sig-name descname"><span class="pre">get_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index_by_season">
<span class="sig-name descname"><span class="pre">get_index_by_season</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indexes</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_index_by_season"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_by_index">
<span class="sig-name descname"><span class="pre">get_season_by_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">inde</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_season_by_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_of_data">
<span class="sig-name descname"><span class="pre">get_season_of_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer.get_season_of_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
</dd></dl>
</div>
Documentation update
2021-01-13 01:04:42 +04:00
<div class="section" id="module-pyFTS.models.seasonal.cmsfts">
<span id="pyfts-models-seasonal-cmsfts-module"></span><h2>pyFTS.models.seasonal.cmsfts module<a class="headerlink" href="#module-pyFTS.models.seasonal.cmsfts" title="Permalink to this headline"></a></h2>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.cmsfts.</span></span><span class="sig-name descname"><span class="pre">ContextualMultiSeasonalFTS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.sfts.SeasonalFTS" title="pyFTS.models.seasonal.sfts.SeasonalFTS"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.sfts.SeasonalFTS</span></code></a></p>
<p>Contextual Multi-Seasonal Fuzzy Time Series</p>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.alpha_cut">
<span class="sig-name descname"><span class="pre">alpha_cut</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.alpha_cut" title="Permalink to this definition"></a></dt>
<dd><p>A float with the minimal membership to be considered on fuzzyfication process</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.auto_update">
<span class="sig-name descname"><span class="pre">auto_update</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.auto_update" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating that model is incremental</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.benchmark_only">
<span class="sig-name descname"><span class="pre">benchmark_only</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.benchmark_only" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating a façade for external (non-FTS) model used on benchmarks or ensembles.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.detail">
<span class="sig-name descname"><span class="pre">detail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.detail" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model detailed information</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.dump">
<span class="sig-name descname"><span class="pre">dump</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.dump" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.flrgs">
<span class="sig-name descname"><span class="pre">flrgs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><span class="pre">dict</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.flrgs" title="Permalink to this definition"></a></dt>
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast">
<span class="sig-name descname"><span class="pre">forecast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.forecast"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast one step ahead</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast_ahead">
<span class="sig-name descname"><span class="pre">forecast_ahead</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.forecast_ahead"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast_ahead" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast from 1 to H steps ahead, where H is given by the steps parameter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast (default: 1)</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.generate_flrg">
<span class="sig-name descname"><span class="pre">generate_flrg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flrs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.generate_flrg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.generate_flrg" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.get_midpoints">
<span class="sig-name descname"><span class="pre">get_midpoints</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flrg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.get_midpoints"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.get_midpoints" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_interval_forecasting">
<span class="sig-name descname"><span class="pre">has_interval_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_interval_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports interval forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_point_forecasting">
<span class="sig-name descname"><span class="pre">has_point_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_point_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports point forecasting, default: True</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_probability_forecasting">
<span class="sig-name descname"><span class="pre">has_probability_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_probability_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support probabilistic forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_seasonality">
<span class="sig-name descname"><span class="pre">has_seasonality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.has_seasonality" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports seasonal indexers, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_clustered">
<span class="sig-name descname"><span class="pre">is_clustered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_clustered" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), but works like
a monovariate method, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_high_order">
<span class="sig-name descname"><span class="pre">is_high_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_high_order" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support orders greater than 1, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_multivariate">
<span class="sig-name descname"><span class="pre">is_multivariate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_time_variant">
<span class="sig-name descname"><span class="pre">is_time_variant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_time_variant" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if this model is time variant</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_wrapper">
<span class="sig-name descname"><span class="pre">is_wrapper</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.is_wrapper" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that this model is a wrapper for other(s) method(s)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.lags">
<span class="sig-name descname"><span class="pre">lags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.lags" title="Permalink to this definition"></a></dt>
<dd><p>The list of lag indexes for high order models</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.log">
<span class="sig-name descname"><span class="pre">log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">pd.DataFrame</span></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.log" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.max_lag">
<span class="sig-name descname"><span class="pre">max_lag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.max_lag" title="Permalink to this definition"></a></dt>
<dd><p>A integer indicating the largest lag used by the model. This value also indicates the minimum number of past lags
needed to forecast a single step ahead</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.min_order">
<span class="sig-name descname"><span class="pre">min_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.min_order" title="Permalink to this definition"></a></dt>
<dd><p>In high order models, this integer value indicates the minimal order supported for the model, default: 1</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.name" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.order">
<span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.order" title="Permalink to this definition"></a></dt>
<dd><p>A integer with the model order (number of past lags are used on forecasting)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.original_max">
<span class="sig-name descname"><span class="pre">original_max</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.original_max" title="Permalink to this definition"></a></dt>
<dd><p>A float with the upper limit of the Universe of Discourse, the maximal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.original_min">
<span class="sig-name descname"><span class="pre">original_min</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.original_min" title="Permalink to this definition"></a></dt>
<dd><p>A float with the lower limit of the Universe of Discourse, the minimal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.partitioner">
<span class="sig-name descname"><span class="pre">partitioner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><span class="pre">partitioner.Partitioner</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.partitioner" title="Permalink to this definition"></a></dt>
<dd><p>A pyFTS.partitioners.Partitioner object with the Universe of Discourse partitioner used on the model. This is a mandatory dependecy.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.shortname">
<span class="sig-name descname"><span class="pre">shortname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.shortname" title="Permalink to this definition"></a></dt>
<dd><p>A string with a short name or alias for the model</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.standard_horizon">
<span class="sig-name descname"><span class="pre">standard_horizon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.standard_horizon" title="Permalink to this definition"></a></dt>
<dd><p>Standard forecasting horizon (Default: 1)</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.train">
<span class="sig-name descname"><span class="pre">train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.train"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.train" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Method specific parameter fitting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – Method specific parameters</p></li>
</ul>
</dd>
</dl>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.transformations">
<span class="sig-name descname"><span class="pre">transformations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyFTS.common.transformations.html#pyFTS.common.transformations.transformation.Transformation" title="pyFTS.common.transformations.transformation.Transformation"><span class="pre">transformation.Transformation</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.transformations" title="Permalink to this definition"></a></dt>
<dd><p>A list with the data transformations (common.Transformations) applied on model pre and post processing, default: []</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.transformations_param">
<span class="sig-name descname"><span class="pre">transformations_param</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.transformations_param" title="Permalink to this definition"></a></dt>
<dd><p>A list with the specific parameters for each data transformation</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.uod_clip">
<span class="sig-name descname"><span class="pre">uod_clip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.uod_clip" title="Permalink to this definition"></a></dt>
<dd><p>Flag indicating if the test data will be clipped inside the training Universe of Discourse</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
</dd></dl>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.cmsfts.</span></span><span class="sig-name descname"><span class="pre">ContextualSeasonalFLRG</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seasonality</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualSeasonalFLRG"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG" title="pyFTS.models.seasonal.sfts.SeasonalFLRG"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.sfts.SeasonalFLRG</span></code></a></p>
<p>Contextual Seasonal Fuzzy Logical Relationship Group</p>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG.append_rhs">
<span class="sig-name descname"><span class="pre">append_rhs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flr</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualSeasonalFLRG.append_rhs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG.append_rhs" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
</dd></dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</div>
<div class="section" id="module-pyFTS.models.seasonal.common">
<span id="pyfts-models-seasonal-common-module"></span><h2>pyFTS.models.seasonal.common module<a class="headerlink" href="#module-pyFTS.models.seasonal.common" title="Permalink to this headline"></a></h2>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.common.</span></span><span class="sig-name descname"><span class="pre">DateTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#DateTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a></p>
Updating the documentation
2019-02-21 19:00:09 +04:00
<p>Data and Time granularity for time granularity and seasonality identification</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.day_of_month">
<span class="sig-name descname"><span class="pre">day_of_month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">30</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_month" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.day_of_week">
<span class="sig-name descname"><span class="pre">day_of_week</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_week" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.day_of_year">
<span class="sig-name descname"><span class="pre">day_of_year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">364</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_year" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.half">
<span class="sig-name descname"><span class="pre">half</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.half" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour">
<span class="sig-name descname"><span class="pre">hour</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">24</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_day">
<span class="sig-name descname"><span class="pre">hour_of_day</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">24</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_day" title="Permalink to this definition"></a></dt>
Documentation update
2020-08-19 00:06:41 +04:00
<dd></dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_month">
<span class="sig-name descname"><span class="pre">hour_of_month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">744</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_month" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_week">
<span class="sig-name descname"><span class="pre">hour_of_week</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">168</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_week" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.hour_of_year">
<span class="sig-name descname"><span class="pre">hour_of_year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8736</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_year" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute">
<span class="sig-name descname"><span class="pre">minute</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_day">
<span class="sig-name descname"><span class="pre">minute_of_day</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1440</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_day" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_hour">
<span class="sig-name descname"><span class="pre">minute_of_hour</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_hour" title="Permalink to this definition"></a></dt>
Documentation update
2020-08-19 00:06:41 +04:00
<dd></dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_month">
<span class="sig-name descname"><span class="pre">minute_of_month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">44640</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_month" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_week">
<span class="sig-name descname"><span class="pre">minute_of_week</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10080</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_week" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.minute_of_year">
<span class="sig-name descname"><span class="pre">minute_of_year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">524160</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_year" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.month">
<span class="sig-name descname"><span class="pre">month</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">12</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.month" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.quarter">
<span class="sig-name descname"><span class="pre">quarter</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.quarter" title="Permalink to this definition"></a></dt>
Updating the documentation
2019-02-21 19:00:09 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second">
<span class="sig-name descname"><span class="pre">second</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second" title="Permalink to this definition"></a></dt>
Documentation update
2020-08-19 00:06:41 +04:00
<dd></dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second_of_day">
<span class="sig-name descname"><span class="pre">second_of_day</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">86400</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_day" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second_of_hour">
<span class="sig-name descname"><span class="pre">second_of_hour</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3600</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_hour" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.second_of_minute">
<span class="sig-name descname"><span class="pre">second_of_minute</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">60.00001</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_minute" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.sixth">
<span class="sig-name descname"><span class="pre">sixth</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.sixth" title="Permalink to this definition"></a></dt>
Updating the documentation
2019-02-21 19:00:09 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.third">
<span class="sig-name descname"><span class="pre">third</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.third" title="Permalink to this definition"></a></dt>
Updating the documentation
2019-02-21 19:00:09 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.DateTime.year">
<span class="sig-name descname"><span class="pre">year</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.year" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.common.</span></span><span class="sig-name descname"><span class="pre">FuzzySet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datepart</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">centroid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alpha</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#FuzzySet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Bases: <a class="reference internal" href="pyFTS.common.html#pyFTS.common.FuzzySet.FuzzySet" title="pyFTS.common.FuzzySet.FuzzySet"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.FuzzySet.FuzzySet</span></code></a></p>
<p>Temporal/Seasonal Fuzzy Set</p>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.alpha">
<span class="sig-name descname"><span class="pre">alpha</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.alpha" title="Permalink to this definition"></a></dt>
<dd><p>The alpha cut value</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.centroid">
<span class="sig-name descname"><span class="pre">centroid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.centroid" title="Permalink to this definition"></a></dt>
<dd><p>The fuzzy set center of mass (or midpoint)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.name" title="Permalink to this definition"></a></dt>
<dd><p>The fuzzy set name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.parameters">
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.parameters" title="Permalink to this definition"></a></dt>
<dd><p>The parameters of the membership function</p>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.transform">
<span class="sig-name descname"><span class="pre">transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#FuzzySet.transform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.transform" title="Permalink to this definition"></a></dt>
Updating the documentation
2018-11-07 17:31:46 +04:00
<dd><p>Preprocess the data point for non native types</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>x</strong> – </p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>return a native type value for the structured type</p>
</dd>
</dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.FuzzySet.type">
<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.type" title="Permalink to this definition"></a></dt>
<dd><p>The fuzzy set type (common, composite, nonstationary, etc)</p>
</dd></dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py function">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.common.strip_datepart">
<span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.common.</span></span><span class="sig-name descname"><span class="pre">strip_datepart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_part</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mask</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#strip_datepart"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.strip_datepart" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd></dd></dl>
</div>
Documentation update
2021-01-13 01:04:42 +04:00
<div class="section" id="module-pyFTS.models.seasonal.msfts">
<span id="pyfts-models-seasonal-msfts-module"></span><h2>pyFTS.models.seasonal.msfts module<a class="headerlink" href="#module-pyFTS.models.seasonal.msfts" title="Permalink to this headline"></a></h2>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.msfts.</span></span><span class="sig-name descname"><span class="pre">MultiSeasonalFTS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indexer</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="#pyFTS.models.seasonal.sfts.SeasonalFTS" title="pyFTS.models.seasonal.sfts.SeasonalFTS"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.seasonal.sfts.SeasonalFTS</span></code></a></p>
<p>Multi-Seasonal Fuzzy Time Series</p>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.alpha_cut">
<span class="sig-name descname"><span class="pre">alpha_cut</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.alpha_cut" title="Permalink to this definition"></a></dt>
<dd><p>A float with the minimal membership to be considered on fuzzyfication process</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.auto_update">
<span class="sig-name descname"><span class="pre">auto_update</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.auto_update" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating that model is incremental</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.benchmark_only">
<span class="sig-name descname"><span class="pre">benchmark_only</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.benchmark_only" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating a façade for external (non-FTS) model used on benchmarks or ensembles.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.detail">
<span class="sig-name descname"><span class="pre">detail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.detail" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model detailed information</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.dump">
<span class="sig-name descname"><span class="pre">dump</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.dump" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.flrgs">
<span class="sig-name descname"><span class="pre">flrgs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><span class="pre">dict</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.flrgs" title="Permalink to this definition"></a></dt>
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast">
<span class="sig-name descname"><span class="pre">forecast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS.forecast"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast one step ahead</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast_ahead">
<span class="sig-name descname"><span class="pre">forecast_ahead</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS.forecast_ahead"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast_ahead" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast from 1 to H steps ahead, where H is given by the steps parameter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast (default: 1)</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.generate_flrg">
<span class="sig-name descname"><span class="pre">generate_flrg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flrs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS.generate_flrg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.generate_flrg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_interval_forecasting">
<span class="sig-name descname"><span class="pre">has_interval_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_interval_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports interval forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_point_forecasting">
<span class="sig-name descname"><span class="pre">has_point_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_point_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports point forecasting, default: True</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_probability_forecasting">
<span class="sig-name descname"><span class="pre">has_probability_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_probability_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support probabilistic forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_seasonality">
<span class="sig-name descname"><span class="pre">has_seasonality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.has_seasonality" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports seasonal indexers, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_clustered">
<span class="sig-name descname"><span class="pre">is_clustered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_clustered" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), but works like
a monovariate method, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_high_order">
<span class="sig-name descname"><span class="pre">is_high_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_high_order" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support orders greater than 1, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_multivariate">
<span class="sig-name descname"><span class="pre">is_multivariate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_time_variant">
<span class="sig-name descname"><span class="pre">is_time_variant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_time_variant" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if this model is time variant</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_wrapper">
<span class="sig-name descname"><span class="pre">is_wrapper</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.is_wrapper" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that this model is a wrapper for other(s) method(s)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.lags">
<span class="sig-name descname"><span class="pre">lags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.lags" title="Permalink to this definition"></a></dt>
<dd><p>The list of lag indexes for high order models</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.log">
<span class="sig-name descname"><span class="pre">log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">pd.DataFrame</span></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.log" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.max_lag">
<span class="sig-name descname"><span class="pre">max_lag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.max_lag" title="Permalink to this definition"></a></dt>
<dd><p>A integer indicating the largest lag used by the model. This value also indicates the minimum number of past lags
needed to forecast a single step ahead</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.min_order">
<span class="sig-name descname"><span class="pre">min_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.min_order" title="Permalink to this definition"></a></dt>
<dd><p>In high order models, this integer value indicates the minimal order supported for the model, default: 1</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.name" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.order">
<span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.order" title="Permalink to this definition"></a></dt>
<dd><p>A integer with the model order (number of past lags are used on forecasting)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.original_max">
<span class="sig-name descname"><span class="pre">original_max</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.original_max" title="Permalink to this definition"></a></dt>
<dd><p>A float with the upper limit of the Universe of Discourse, the maximal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.original_min">
<span class="sig-name descname"><span class="pre">original_min</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.original_min" title="Permalink to this definition"></a></dt>
<dd><p>A float with the lower limit of the Universe of Discourse, the minimal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.partitioner">
<span class="sig-name descname"><span class="pre">partitioner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><span class="pre">partitioner.Partitioner</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.partitioner" title="Permalink to this definition"></a></dt>
<dd><p>A pyFTS.partitioners.Partitioner object with the Universe of Discourse partitioner used on the model. This is a mandatory dependecy.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.shortname">
<span class="sig-name descname"><span class="pre">shortname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.shortname" title="Permalink to this definition"></a></dt>
<dd><p>A string with a short name or alias for the model</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.standard_horizon">
<span class="sig-name descname"><span class="pre">standard_horizon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.standard_horizon" title="Permalink to this definition"></a></dt>
<dd><p>Standard forecasting horizon (Default: 1)</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.train">
<span class="sig-name descname"><span class="pre">train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS.train"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.train" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Method specific parameter fitting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – Method specific parameters</p></li>
</ul>
</dd>
</dl>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.transformations">
<span class="sig-name descname"><span class="pre">transformations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyFTS.common.transformations.html#pyFTS.common.transformations.transformation.Transformation" title="pyFTS.common.transformations.transformation.Transformation"><span class="pre">transformation.Transformation</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.transformations" title="Permalink to this definition"></a></dt>
<dd><p>A list with the data transformations (common.Transformations) applied on model pre and post processing, default: []</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.transformations_param">
<span class="sig-name descname"><span class="pre">transformations_param</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.transformations_param" title="Permalink to this definition"></a></dt>
<dd><p>A list with the specific parameters for each data transformation</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.uod_clip">
<span class="sig-name descname"><span class="pre">uod_clip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.uod_clip" title="Permalink to this definition"></a></dt>
<dd><p>Flag indicating if the test data will be clipped inside the training Universe of Discourse</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
</dd></dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</div>
<div class="section" id="module-pyFTS.models.seasonal.partitioner">
<span id="pyfts-models-seasonal-partitioner-module"></span><h2>pyFTS.models.seasonal.partitioner module<a class="headerlink" href="#module-pyFTS.models.seasonal.partitioner" title="Permalink to this headline"></a></h2>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.partitioner.</span></span><span class="sig-name descname"><span class="pre">TimeGridPartitioner</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Bases: <a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.partitioners.partitioner.Partitioner</span></code></a></p>
<p>Even Length DateTime Grid Partitioner</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build">
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Perform the partitioning of the Universe of Discourse</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>data</strong> – training data</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p></p>
</dd>
</dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build_index">
<span class="sig-name descname"><span class="pre">build_index</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.build_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build_index" title="Permalink to this definition"></a></dt>
Documentation update
2019-04-22 17:01:58 +04:00
<dd></dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.extractor">
<span class="sig-name descname"><span class="pre">extractor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.extractor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.extractor" title="Permalink to this definition"></a></dt>
Documentation update
2019-06-21 18:34:49 +04:00
<dd><p>Extract a single primitive type from an structured instance</p>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.mask">
<span class="sig-name descname"><span class="pre">mask</span></span><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.mask" title="Permalink to this definition"></a></dt>
Documentation update
2020-08-19 00:06:41 +04:00
<dd><p>A string with datetime formating mask</p>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.plot">
<span class="sig-name descname"><span class="pre">plot</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ax</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.plot"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.plot" title="Permalink to this definition"></a></dt>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<dd><p>Plot the
:param ax:
:return:</p>
</dd></dl>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.search">
<span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.search"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.search" title="Permalink to this definition"></a></dt>
Documentation update
2019-04-22 17:01:58 +04:00
<dd><p>Perform a search for the nearest fuzzy sets of the point ‘data’. This function were designed to work with several
overlapped fuzzy sets.</p>
Documentation update
2020-08-19 00:06:41 +04:00
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – the value to search for the nearest fuzzy sets</p></li>
<li><p><strong>type</strong> – the return type: ‘index’ for the fuzzy set indexes or ‘name’ for fuzzy set names.</p></li>
<li><p><strong>results</strong> – the number of nearest fuzzy sets to return</p></li>
Documentation update
2019-04-22 17:01:58 +04:00
</ul>
Documentation update
2020-08-19 00:06:41 +04:00
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the nearest fuzzy sets</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.season">
<span class="sig-name descname"><span class="pre">season</span></span><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.season" title="Permalink to this definition"></a></dt>
Documentation update
2020-08-19 00:06:41 +04:00
<dd><p>Seasonality, a pyFTS.models.seasonal.common.DateTime object</p>
Documentation update
2019-04-22 17:01:58 +04:00
</dd></dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</dd></dl>
</div>
Documentation update
2021-01-13 01:04:42 +04:00
<div class="section" id="module-pyFTS.models.seasonal.sfts">
<span id="pyfts-models-seasonal-sfts-module"></span><h2>pyFTS.models.seasonal.sfts module<a class="headerlink" href="#module-pyFTS.models.seasonal.sfts" title="Permalink to this headline"></a></h2>
<p>Simple First Order Seasonal Fuzzy Time Series implementation of Song (1999) based of Conventional FTS by Chen (1996)</p>
<ol class="upperalpha simple" start="17">
<li><p>Song, “Seasonal forecasting in fuzzy time series,” Fuzzy sets Syst., vol. 107, pp. 235–236, 1999.</p></li>
</ol>
<p>S.-M. Chen, “Forecasting enrollments based on fuzzy time series,” Fuzzy Sets Syst., vol. 81, no. 3, pp. 311–319, 1996.</p>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFLRG">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.sfts.</span></span><span class="sig-name descname"><span class="pre">SeasonalFLRG</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seasonality</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFLRG"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="pyFTS.common.html#pyFTS.common.flrg.FLRG" title="pyFTS.common.flrg.FLRG"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.flrg.FLRG</span></code></a></p>
<p>First Order Seasonal Fuzzy Logical Relationship Group</p>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFLRG.append_rhs">
<span class="sig-name descname"><span class="pre">append_rhs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">c</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFLRG.append_rhs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG.append_rhs" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFLRG.get_key">
<span class="sig-name descname"><span class="pre">get_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFLRG.get_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG.get_key" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Returns a unique identifier for this FLRG</p>
</dd></dl>
</dd></dl>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.seasonal.sfts.</span></span><span class="sig-name descname"><span class="pre">SeasonalFTS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="pyFTS.common.html#pyFTS.common.fts.FTS" title="pyFTS.common.fts.FTS"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.fts.FTS</span></code></a></p>
<p>First Order Seasonal Fuzzy Time Series</p>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.alpha_cut">
<span class="sig-name descname"><span class="pre">alpha_cut</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.alpha_cut" title="Permalink to this definition"></a></dt>
<dd><p>A float with the minimal membership to be considered on fuzzyfication process</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.auto_update">
<span class="sig-name descname"><span class="pre">auto_update</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.auto_update" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating that model is incremental</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.benchmark_only">
<span class="sig-name descname"><span class="pre">benchmark_only</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.benchmark_only" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating a façade for external (non-FTS) model used on benchmarks or ensembles.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.detail">
<span class="sig-name descname"><span class="pre">detail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.detail" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model detailed information</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.dump">
<span class="sig-name descname"><span class="pre">dump</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.dump" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.flrgs">
<span class="sig-name descname"><span class="pre">flrgs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><span class="pre">dict</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.flrgs" title="Permalink to this definition"></a></dt>
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.forecast">
<span class="sig-name descname"><span class="pre">forecast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS.forecast"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.forecast" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast one step ahead</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.generate_flrg">
<span class="sig-name descname"><span class="pre">generate_flrg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flrs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS.generate_flrg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.generate_flrg" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.get_midpoints">
<span class="sig-name descname"><span class="pre">get_midpoints</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flrg</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS.get_midpoints"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.get_midpoints" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd></dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.has_interval_forecasting">
<span class="sig-name descname"><span class="pre">has_interval_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.has_interval_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports interval forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.has_point_forecasting">
<span class="sig-name descname"><span class="pre">has_point_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.has_point_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports point forecasting, default: True</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.has_probability_forecasting">
<span class="sig-name descname"><span class="pre">has_probability_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.has_probability_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support probabilistic forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.has_seasonality">
<span class="sig-name descname"><span class="pre">has_seasonality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.has_seasonality" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports seasonal indexers, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.is_clustered">
<span class="sig-name descname"><span class="pre">is_clustered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.is_clustered" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), but works like
a monovariate method, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.is_high_order">
<span class="sig-name descname"><span class="pre">is_high_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.is_high_order" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support orders greater than 1, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.is_multivariate">
<span class="sig-name descname"><span class="pre">is_multivariate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.is_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.is_time_variant">
<span class="sig-name descname"><span class="pre">is_time_variant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.is_time_variant" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if this model is time variant</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.is_wrapper">
<span class="sig-name descname"><span class="pre">is_wrapper</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.is_wrapper" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that this model is a wrapper for other(s) method(s)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.lags">
<span class="sig-name descname"><span class="pre">lags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.lags" title="Permalink to this definition"></a></dt>
<dd><p>The list of lag indexes for high order models</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.log">
<span class="sig-name descname"><span class="pre">log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">pd.DataFrame</span></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.log" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.max_lag">
<span class="sig-name descname"><span class="pre">max_lag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.max_lag" title="Permalink to this definition"></a></dt>
<dd><p>A integer indicating the largest lag used by the model. This value also indicates the minimum number of past lags
needed to forecast a single step ahead</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.min_order">
<span class="sig-name descname"><span class="pre">min_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.min_order" title="Permalink to this definition"></a></dt>
<dd><p>In high order models, this integer value indicates the minimal order supported for the model, default: 1</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.name" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.order">
<span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.order" title="Permalink to this definition"></a></dt>
<dd><p>A integer with the model order (number of past lags are used on forecasting)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.original_max">
<span class="sig-name descname"><span class="pre">original_max</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.original_max" title="Permalink to this definition"></a></dt>
<dd><p>A float with the upper limit of the Universe of Discourse, the maximal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.original_min">
<span class="sig-name descname"><span class="pre">original_min</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.original_min" title="Permalink to this definition"></a></dt>
<dd><p>A float with the lower limit of the Universe of Discourse, the minimal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.partitioner">
<span class="sig-name descname"><span class="pre">partitioner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><span class="pre">partitioner.Partitioner</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.partitioner" title="Permalink to this definition"></a></dt>
<dd><p>A pyFTS.partitioners.Partitioner object with the Universe of Discourse partitioner used on the model. This is a mandatory dependecy.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.shortname">
<span class="sig-name descname"><span class="pre">shortname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.shortname" title="Permalink to this definition"></a></dt>
<dd><p>A string with a short name or alias for the model</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.standard_horizon">
<span class="sig-name descname"><span class="pre">standard_horizon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.standard_horizon" title="Permalink to this definition"></a></dt>
<dd><p>Standard forecasting horizon (Default: 1)</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.train">
<span class="sig-name descname"><span class="pre">train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS.train"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.train" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Method specific parameter fitting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – Method specific parameters</p></li>
</ul>
</dd>
</dl>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.transformations">
<span class="sig-name descname"><span class="pre">transformations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyFTS.common.transformations.html#pyFTS.common.transformations.transformation.Transformation" title="pyFTS.common.transformations.transformation.Transformation"><span class="pre">transformation.Transformation</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.transformations" title="Permalink to this definition"></a></dt>
<dd><p>A list with the data transformations (common.Transformations) applied on model pre and post processing, default: []</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.transformations_param">
<span class="sig-name descname"><span class="pre">transformations_param</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.transformations_param" title="Permalink to this definition"></a></dt>
<dd><p>A list with the specific parameters for each data transformation</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.seasonal.sfts.SeasonalFTS.uod_clip">
<span class="sig-name descname"><span class="pre">uod_clip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.uod_clip" title="Permalink to this definition"></a></dt>
<dd><p>Flag indicating if the test data will be clipped inside the training Universe of Discourse</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
</dd></dl>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</div>
<div class="section" id="module-pyFTS.models.seasonal">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyFTS.models.seasonal" title="Permalink to this headline"></a></h2>
</div>
</div>
Documentation update
2020-08-19 00:06:41 +04:00
<div class="clearer"></div>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</div>
</div>
</div>
Documentation update
2020-08-19 00:06:41 +04:00
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
Documentation update
2020-08-19 00:06:41 +04:00
<li><a class="reference internal" href="#">pyFTS.models.seasonal package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.SeasonalIndexer">pyFTS.models.seasonal.SeasonalIndexer module</a></li>
Documentation update
2021-01-13 01:04:42 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.cmsfts">pyFTS.models.seasonal.cmsfts module</a></li>
Documentation update
2020-08-19 00:06:41 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.common">pyFTS.models.seasonal.common module</a></li>
Documentation update
2021-01-13 01:04:42 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.msfts">pyFTS.models.seasonal.msfts module</a></li>
Documentation update
2020-08-19 00:06:41 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.partitioner">pyFTS.models.seasonal.partitioner module</a></li>
Documentation update
2021-01-13 01:04:42 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.sfts">pyFTS.models.seasonal.sfts module</a></li>
Documentation update
2020-08-19 00:06:41 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.seasonal">Module contents</a></li>
</ul>
</li>
</ul>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="pyFTS.models.nonstationary.html"
title="previous chapter">pyFTS.models.nonstationary package</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="pyFTS.partitioners.html"
title="next chapter">pyFTS.partitioners package</a></p>
</div>
Documentation update
2020-08-19 00:06:41 +04:00
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pyFTS.models.seasonal.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
Documentation update
2020-08-19 00:06:41 +04:00
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
<div class="clearer"></div>
</div>
Updating the documentation
2018-08-30 23:04:52 +04:00
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.partitioners.html" title="pyFTS.partitioners package"
>next</a> |</li>
<li class="right" >
<a href="pyFTS.models.nonstationary.html" title="pyFTS.models.nonstationary package"
>previous</a> |</li>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.7 documentation</a> &#187;</li>
Updating the documentation
2018-08-30 23:04:52 +04:00
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
Documentation update
2020-08-19 00:06:41 +04:00
<li class="nav-item nav-item-3"><a href="pyFTS.models.html" >pyFTS.models package</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyFTS.models.seasonal package</a></li>
Updating the documentation
2018-08-30 23:04:52 +04:00
</ul>
</div>
<div class="footer" role="contentinfo">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
&#169; Copyright 2022, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
Sphinx documentation for ReadTheDocs site
2018-08-30 09:05:29 +04:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink