sam/pyFTS
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity
feature/som_fts
pyFTS/docs/build/html/pyFTS.models.seasonal.html
Petrônio Cândido 8bef7b728d Documentation update
2020-08-18 17:06:41 -03:00

748 lines
64 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"><script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-55120145-3']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<title>pyFTS.models.seasonal package &#8212; pyFTS 1.6 documentation</title>
<link rel="stylesheet" href="_static/bizstyle.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/bizstyle.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pyFTS.partitioners package" href="pyFTS.partitioners.html" />
<link rel="prev" title="pyFTS.models.nonstationary package" href="pyFTS.models.nonstationary.html" />
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<!--[if lt IE 9]>
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<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>
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.6 documentation</a> &#187;</li>
<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>
<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>
</ul>
</div>
<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>
<dl class="py class">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.SeasonalIndexer.</code><code class="sig-name descname">DataFrameSeasonalIndexer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">index_fields</span></em>, <em class="sig-param"><span class="n">index_seasons</span></em>, <em class="sig-param"><span class="n">data_field</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DataFrameSeasonalIndexer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data">
<code class="sig-name descname">get_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data_by_season">
<code class="sig-name descname">get_data_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_index_by_season">
<code class="sig-name descname">get_index_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_by_index">
<code class="sig-name descname">get_season_by_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">index</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_of_data">
<code class="sig-name descname">get_season_of_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.set_data">
<code class="sig-name descname">set_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">value</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DataFrameSeasonalIndexer.set_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.SeasonalIndexer.</code><code class="sig-name descname">DateTimeSeasonalIndexer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">date_field</span></em>, <em class="sig-param"><span class="n">index_fields</span></em>, <em class="sig-param"><span class="n">index_seasons</span></em>, <em class="sig-param"><span class="n">data_field</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#DateTimeSeasonalIndexer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data">
<code class="sig-name descname">get_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data_by_season">
<code class="sig-name descname">get_data_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index">
<code class="sig-name descname">get_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index_by_season">
<code class="sig-name descname">get_index_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_by_index">
<code class="sig-name descname">get_season_by_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">index</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_of_data">
<code class="sig-name descname">get_season_of_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.set_data">
<code class="sig-name descname">set_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">value</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.DateTimeSeasonalIndexer.set_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.SeasonalIndexer.</code><code class="sig-name descname">LinearSeasonalIndexer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seasons</span></em>, <em class="sig-param"><span class="n">units</span></em>, <em class="sig-param"><span class="n">ignore</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#LinearSeasonalIndexer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_data">
<code class="sig-name descname">get_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_index_by_season">
<code class="sig-name descname">get_index_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_by_index">
<code class="sig-name descname">get_season_by_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">index</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_of_data">
<code class="sig-name descname">get_season_of_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.LinearSeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.SeasonalIndexer.</code><code class="sig-name descname">SeasonalIndexer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">num_seasons</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/SeasonalIndexer.html#SeasonalIndexer"><span class="viewcode-link">[source]</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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<p>Seasonal Indexer. Responsible to find the seasonal index of a data point inside its data set</p>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data">
<code class="sig-name descname">get_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data_by_season">
<code class="sig-name descname">get_data_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_data_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index">
<code class="sig-name descname">get_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index_by_season">
<code class="sig-name descname">get_index_by_season</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">indexes</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_index_by_season" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_by_index">
<code class="sig-name descname">get_season_by_index</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">inde</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_by_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_of_data">
<code class="sig-name descname">get_season_of_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.SeasonalIndexer.SeasonalIndexer.get_season_of_data" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<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">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.cmsfts.</code><code class="sig-name descname">ContextualMultiSeasonalFTS</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast">
<code class="sig-name descname">forecast</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.forecast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast" title="Permalink to this definition"></a></dt>
<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">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast_ahead">
<code class="sig-name descname">forecast_ahead</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">steps</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.forecast_ahead" title="Permalink to this definition"></a></dt>
<dd><p>Point forecast n steps 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>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">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.generate_flrg">
<code class="sig-name descname">generate_flrg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flrs</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.generate_flrg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.get_midpoints">
<code class="sig-name descname">get_midpoints</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flrg</span></em>, <em class="sig-param"><span class="n">data</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.get_midpoints" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.train">
<code class="sig-name descname">train</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualMultiSeasonalFTS.train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualMultiSeasonalFTS.train" title="Permalink to this definition"></a></dt>
<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>
</dd></dl>
<dl class="py class">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.cmsfts.</code><code class="sig-name descname">ContextualSeasonalFLRG</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seasonality</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/cmsfts.html#ContextualSeasonalFLRG"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG" title="Permalink to this definition"></a></dt>
<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">
<dt id="pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG.append_rhs">
<code class="sig-name descname">append_rhs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flr</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.cmsfts.ContextualSeasonalFLRG.append_rhs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</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>
<dl class="py class">
<dt id="pyFTS.models.seasonal.common.DateTime">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.common.</code><code class="sig-name descname">DateTime</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#DateTime"><span class="viewcode-link">[source]</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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a></p>
<p>Data and Time granularity for time granularity and seasonality identification</p>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.day_of_month">
<code class="sig-name descname">day_of_month</code><em class="property"> = 30</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.day_of_week">
<code class="sig-name descname">day_of_week</code><em class="property"> = 7</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_week" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.day_of_year">
<code class="sig-name descname">day_of_year</code><em class="property"> = 364</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.day_of_year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.half">
<code class="sig-name descname">half</code><em class="property"> = 2</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.half" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.hour">
<code class="sig-name descname">hour</code><em class="property"> = 24</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.hour_of_day">
<code class="sig-name descname">hour_of_day</code><em class="property"> = 24</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_day" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.hour_of_month">
<code class="sig-name descname">hour_of_month</code><em class="property"> = 744</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.hour_of_week">
<code class="sig-name descname">hour_of_week</code><em class="property"> = 168</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_week" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.hour_of_year">
<code class="sig-name descname">hour_of_year</code><em class="property"> = 8736</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.hour_of_year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.minute">
<code class="sig-name descname">minute</code><em class="property"> = 60</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.minute_of_day">
<code class="sig-name descname">minute_of_day</code><em class="property"> = 1440</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_day" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.minute_of_hour">
<code class="sig-name descname">minute_of_hour</code><em class="property"> = 60</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_hour" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.minute_of_month">
<code class="sig-name descname">minute_of_month</code><em class="property"> = 44640</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.minute_of_week">
<code class="sig-name descname">minute_of_week</code><em class="property"> = 10080</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_week" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.minute_of_year">
<code class="sig-name descname">minute_of_year</code><em class="property"> = 524160</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.minute_of_year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.month">
<code class="sig-name descname">month</code><em class="property"> = 12</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.month" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.quarter">
<code class="sig-name descname">quarter</code><em class="property"> = 4</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.quarter" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.second">
<code class="sig-name descname">second</code><em class="property"> = 60</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.second_of_day">
<code class="sig-name descname">second_of_day</code><em class="property"> = 86400</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_day" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.second_of_hour">
<code class="sig-name descname">second_of_hour</code><em class="property"> = 3600</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_hour" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.second_of_minute">
<code class="sig-name descname">second_of_minute</code><em class="property"> = 60.00001</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.second_of_minute" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.sixth">
<code class="sig-name descname">sixth</code><em class="property"> = 6</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.sixth" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.third">
<code class="sig-name descname">third</code><em class="property"> = 3</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.third" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.common.DateTime.year">
<code class="sig-name descname">year</code><em class="property"> = 1</em><a class="headerlink" href="#pyFTS.models.seasonal.common.DateTime.year" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py class">
<dt id="pyFTS.models.seasonal.common.FuzzySet">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.common.</code><code class="sig-name descname">FuzzySet</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">datepart</span></em>, <em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">mf</span></em>, <em class="sig-param"><span class="n">parameters</span></em>, <em class="sig-param"><span class="n">centroid</span></em>, <em class="sig-param"><span class="n">alpha</span><span class="o">=</span><span class="default_value">1.0</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#FuzzySet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.common.FuzzySet.transform">
<code class="sig-name descname">transform</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#FuzzySet.transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.FuzzySet.transform" title="Permalink to this definition"></a></dt>
<dd><p>Preprocess the data point for non native types</p>
<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>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="pyFTS.models.seasonal.common.strip_datepart">
<code class="sig-prename descclassname">pyFTS.models.seasonal.common.</code><code class="sig-name descname">strip_datepart</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">date</span></em>, <em class="sig-param"><span class="n">date_part</span></em>, <em class="sig-param"><span class="n">mask</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/common.html#strip_datepart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.common.strip_datepart" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<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">
<dt id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.msfts.</code><code class="sig-name descname">MultiSeasonalFTS</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span></em>, <em class="sig-param"><span class="n">indexer</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast">
<code class="sig-name descname">forecast</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS.forecast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast" title="Permalink to this definition"></a></dt>
<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">
<dt id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast_ahead">
<code class="sig-name descname">forecast_ahead</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="n">steps</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.forecast_ahead" title="Permalink to this definition"></a></dt>
<dd><p>Point forecast n steps 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>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">
<dt id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.generate_flrg">
<code class="sig-name descname">generate_flrg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flrs</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">[source]</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 method">
<dt id="pyFTS.models.seasonal.msfts.MultiSeasonalFTS.train">
<code class="sig-name descname">train</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/msfts.html#MultiSeasonalFTS.train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.msfts.MultiSeasonalFTS.train" title="Permalink to this definition"></a></dt>
<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>
</dd></dl>
</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>
<dl class="py class">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.partitioner.</code><code class="sig-name descname">TimeGridPartitioner</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build">
<code class="sig-name descname">build</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build" title="Permalink to this definition"></a></dt>
<dd><p>Perform the partitioning of the Universe of Discourse</p>
<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>
</dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build_index">
<code class="sig-name descname">build_index</code><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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.build_index" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.extractor">
<code class="sig-name descname">extractor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.extractor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.extractor" title="Permalink to this definition"></a></dt>
<dd><p>Extract a single primitive type from an structured instance</p>
</dd></dl>
<dl class="py attribute">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.mask">
<code class="sig-name descname">mask</code><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.mask" title="Permalink to this definition"></a></dt>
<dd><p>A string with datetime formating mask</p>
</dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.plot">
<code class="sig-name descname">plot</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">ax</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.plot" title="Permalink to this definition"></a></dt>
<dd><p>Plot the
:param ax:
:return:</p>
</dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.search">
<code class="sig-name descname">search</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/partitioner.html#TimeGridPartitioner.search"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.search" title="Permalink to this definition"></a></dt>
<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>
<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>
</ul>
</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">
<dt id="pyFTS.models.seasonal.partitioner.TimeGridPartitioner.season">
<code class="sig-name descname">season</code><a class="headerlink" href="#pyFTS.models.seasonal.partitioner.TimeGridPartitioner.season" title="Permalink to this definition"></a></dt>
<dd><p>Seasonality, a pyFTS.models.seasonal.common.DateTime object</p>
</dd></dl>
</dd></dl>
</div>
<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">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFLRG">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.sfts.</code><code class="sig-name descname">SeasonalFLRG</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">seasonality</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFLRG"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG" title="Permalink to this definition"></a></dt>
<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">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFLRG.append_rhs">
<code class="sig-name descname">append_rhs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">c</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG.append_rhs" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFLRG.get_key">
<code class="sig-name descname">get_key</code><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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFLRG.get_key" title="Permalink to this definition"></a></dt>
<dd><p>Returns a unique identifier for this FLRG</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFTS">
<em class="property">class </em><code class="sig-prename descclassname">pyFTS.models.seasonal.sfts.</code><code class="sig-name descname">SeasonalFTS</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS" title="Permalink to this definition"></a></dt>
<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>
<dl class="py method">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFTS.forecast">
<code class="sig-name descname">forecast</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS.forecast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.forecast" title="Permalink to this definition"></a></dt>
<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">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFTS.generate_flrg">
<code class="sig-name descname">generate_flrg</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flrs</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.generate_flrg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFTS.get_midpoints">
<code class="sig-name descname">get_midpoints</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">flrg</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">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.get_midpoints" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt id="pyFTS.models.seasonal.sfts.SeasonalFTS.train">
<code class="sig-name descname">train</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">data</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/seasonal/sfts.html#SeasonalFTS.train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.models.seasonal.sfts.SeasonalFTS.train" title="Permalink to this definition"></a></dt>
<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>
</dd></dl>
</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>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<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>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.cmsfts">pyFTS.models.seasonal.cmsfts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.common">pyFTS.models.seasonal.common module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.msfts">pyFTS.models.seasonal.msfts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.partitioner">pyFTS.models.seasonal.partitioner module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal.sfts">pyFTS.models.seasonal.sfts module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.seasonal">Module contents</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="pyFTS.models.nonstationary.html"
title="previous chapter">pyFTS.models.nonstationary package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="pyFTS.partitioners.html"
title="next chapter">pyFTS.partitioners package</a></p>
<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">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<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>
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.6 documentation</a> &#187;</li>
<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>
<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>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2018, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.1.2.
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink