1864 lines
121 KiB
HTML
1864 lines
121 KiB
HTML
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
<title>pyFTS.common package — pyFTS 1.2.3 documentation</title>
|
||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<script type="text/javascript" src="_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="pyfts-common-package">
|
||
<h1>pyFTS.common package<a class="headerlink" href="#pyfts-common-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.common.Composite">
|
||
<span id="pyfts-common-composite-module"></span><h2>pyFTS.common.Composite module<a class="headerlink" href="#module-pyFTS.common.Composite" title="Permalink to this headline">¶</a></h2>
|
||
<p>Composite Fuzzy Sets</p>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.Composite.FuzzySet">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.Composite.</code><code class="descname">FuzzySet</code><span class="sig-paren">(</span><em>name</em>, <em>superset=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#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>Composite Fuzzy Set</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Composite.FuzzySet.append">
|
||
<code class="descname">append</code><span class="sig-paren">(</span><em>mf</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.append" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Adds a new function to composition</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>mf</strong> – </li>
|
||
<li><strong>parameters</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Composite.FuzzySet.append_set">
|
||
<code class="descname">append_set</code><span class="sig-paren">(</span><em>set</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.append_set"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.append_set" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Adds a new function to composition</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>mf</strong> – </li>
|
||
<li><strong>parameters</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Composite.FuzzySet.membership">
|
||
<code class="descname">membership</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Composite.html#FuzzySet.membership"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Composite.FuzzySet.membership" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calculate the membership value of a given input</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input value</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">membership value of x at this fuzzy set</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.FLR">
|
||
<span id="pyfts-common-flr-module"></span><h2>pyFTS.common.FLR module<a class="headerlink" href="#module-pyFTS.common.FLR" title="Permalink to this headline">¶</a></h2>
|
||
<p>This module implements functions for Fuzzy Logical Relationship generation</p>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.FLR.FLR">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.FLR.</code><code class="descname">FLR</code><span class="sig-paren">(</span><em>LHS</em>, <em>RHS</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#FLR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FLR.FLR" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Fuzzy Logical Relationship</p>
|
||
<p>Represents a temporal transition of the fuzzy set LHS on time t for the fuzzy set RHS on time t+1.</p>
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FLR.FLR.LHS">
|
||
<code class="descname">LHS</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FLR.FLR.LHS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Left Hand Side fuzzy set</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FLR.FLR.RHS">
|
||
<code class="descname">RHS</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FLR.FLR.RHS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Right Hand Side fuzzy set</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.FLR.IndexedFLR">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.FLR.</code><code class="descname">IndexedFLR</code><span class="sig-paren">(</span><em>index</em>, <em>LHS</em>, <em>RHS</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#IndexedFLR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FLR.IndexedFLR" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.FLR.FLR" title="pyFTS.common.FLR.FLR"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.FLR.FLR</span></code></a></p>
|
||
<p>Season Indexed Fuzzy Logical Relationship</p>
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FLR.IndexedFLR.index">
|
||
<code class="descname">index</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FLR.IndexedFLR.index" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>seasonal index</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FLR.generate_high_order_recurrent_flr">
|
||
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_high_order_recurrent_flr</code><span class="sig-paren">(</span><em>fuzzyData</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_high_order_recurrent_flr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FLR.generate_high_order_recurrent_flr" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a ordered FLR set from a list of fuzzy sets with recurrence</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzyData</strong> – ordered list of fuzzy sets</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ordered list of FLR</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FLR.generate_indexed_flrs">
|
||
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_indexed_flrs</code><span class="sig-paren">(</span><em>sets</em>, <em>indexer</em>, <em>data</em>, <em>transformation=None</em>, <em>alpha_cut=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_indexed_flrs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FLR.generate_indexed_flrs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a season-indexed ordered FLR set from a list of fuzzy sets with recurrence</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>sets</strong> – fuzzy sets</li>
|
||
<li><strong>indexer</strong> – seasonality indexer</li>
|
||
<li><strong>data</strong> – original data</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">ordered list of FLR</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FLR.generate_non_recurrent_flrs">
|
||
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_non_recurrent_flrs</code><span class="sig-paren">(</span><em>fuzzyData</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_non_recurrent_flrs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FLR.generate_non_recurrent_flrs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a ordered FLR set from a list of fuzzy sets without recurrence</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzyData</strong> – ordered list of fuzzy sets</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ordered list of FLR</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FLR.generate_recurrent_flrs">
|
||
<code class="descclassname">pyFTS.common.FLR.</code><code class="descname">generate_recurrent_flrs</code><span class="sig-paren">(</span><em>fuzzyData</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FLR.html#generate_recurrent_flrs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FLR.generate_recurrent_flrs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Create a ordered FLR set from a list of fuzzy sets with recurrence</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fuzzyData</strong> – ordered list of fuzzy sets</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">ordered list of FLR</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.FuzzySet">
|
||
<span id="pyfts-common-fuzzyset-module"></span><h2>pyFTS.common.FuzzySet module<a class="headerlink" href="#module-pyFTS.common.FuzzySet" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">FuzzySet</code><span class="sig-paren">(</span><em>name</em>, <em>mf</em>, <em>parameters</em>, <em>centroid</em>, <em>alpha=1.0</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Fuzzy Set</p>
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.Z">
|
||
<code class="descname">Z</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.Z" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Partition function in respect to the membership function</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.alpha">
|
||
<code class="descname">alpha</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.alpha" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The alpha cut value</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.centroid">
|
||
<code class="descname">centroid</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.centroid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The fuzzy set center of mass (or midpoint)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.membership">
|
||
<code class="descname">membership</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.membership"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.membership" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calculate the membership value of a given input</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input value</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">membership value of x at this fuzzy set</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.mf">
|
||
<code class="descname">mf</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.mf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The membership function</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.name">
|
||
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The fuzzy set name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.parameters">
|
||
<code class="descname">parameters</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.parameters" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The parameters of the membership function</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.partition_function">
|
||
<code class="descname">partition_function</code><span class="sig-paren">(</span><em>uod=None</em>, <em>nbins=100</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.partition_function"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.partition_function" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calculate the partition function over the membership function.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>uod</strong> – </li>
|
||
<li><strong>nbins</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.type">
|
||
<code class="descname">type</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The fuzzy set type (common, composite, nonstationary, etc)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.FuzzySet.FuzzySet.variable">
|
||
<code class="descname">variable</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.FuzzySet.FuzzySet.variable" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>In multivariate time series, indicate for which variable this fuzzy set belogs</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.check_bounds">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">check_bounds</code><span class="sig-paren">(</span><em>data</em>, <em>sets</em>, <em>ordered_sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#check_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.check_bounds" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.check_bounds_index">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">check_bounds_index</code><span class="sig-paren">(</span><em>data</em>, <em>sets</em>, <em>ordered_sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#check_bounds_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.check_bounds_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.fuzzyfy_instance">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_instance</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzySets</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_instance"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_instance" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calculate the membership values for a data point given fuzzy sets</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>inst</strong> – data point</li>
|
||
<li><strong>fuzzySets</strong> – dict of fuzzy sets</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">array of membership values</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.fuzzyfy_instances">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_instances</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzySets</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_instances"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_instances" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Calculate the membership values for a data point given fuzzy sets</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>inst</strong> – data point</li>
|
||
<li><strong>fuzzySets</strong> – dict of fuzzy sets</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">array of membership values</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.fuzzyfy_series">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_series</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzySets</em>, <em>method='maximum'</em>, <em>alpha_cut=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_series"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_series" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.fuzzyfy_series_old">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">fuzzyfy_series_old</code><span class="sig-paren">(</span><em>data</em>, <em>fuzzySets</em>, <em>method='maximum'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_series_old"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.fuzzyfy_series_old" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.get_fuzzysets">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">get_fuzzysets</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzySets</em>, <em>ordered_sets=None</em>, <em>alpha_cut=0.0</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#get_fuzzysets"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.get_fuzzysets" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return the fuzzy sets which membership value for a inst is greater than the alpha_cut</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>inst</strong> – data point</li>
|
||
<li><strong>fuzzySets</strong> – dict of fuzzy sets</li>
|
||
<li><strong>alpha_cut</strong> – Minimal membership to be considered on fuzzyfication process</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">array of membership values</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">get_maximum_membership_fuzzyset</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzySets</em>, <em>ordered_sets=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#get_maximum_membership_fuzzyset"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fuzzify a data point, returning the fuzzy set with maximum membership value</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>inst</strong> – data point</li>
|
||
<li><strong>fuzzySets</strong> – dict of fuzzy sets</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">fuzzy set with maximum membership</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">get_maximum_membership_fuzzyset_index</code><span class="sig-paren">(</span><em>inst</em>, <em>fuzzySets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#get_maximum_membership_fuzzyset_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fuzzify a data point, returning the fuzzy set with maximum membership value</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>inst</strong> – data point</li>
|
||
<li><strong>fuzzySets</strong> – dict of fuzzy sets</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">fuzzy set with maximum membership</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.grant_bounds">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">grant_bounds</code><span class="sig-paren">(</span><em>data</em>, <em>sets</em>, <em>ordered_sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#grant_bounds"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.grant_bounds" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.FuzzySet.set_ordered">
|
||
<code class="descclassname">pyFTS.common.FuzzySet.</code><code class="descname">set_ordered</code><span class="sig-paren">(</span><em>fuzzySets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/FuzzySet.html#set_ordered"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.FuzzySet.set_ordered" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Order a fuzzy set list by their centroids</p>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.Membership">
|
||
<span id="pyfts-common-membership-module"></span><h2>pyFTS.common.Membership module<a class="headerlink" href="#module-pyFTS.common.Membership" title="Permalink to this headline">¶</a></h2>
|
||
<p>Membership functions for Fuzzy Sets</p>
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Membership.bellmf">
|
||
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">bellmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#bellmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.bellmf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bell shaped membership function</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>x</strong> – </li>
|
||
<li><strong>parameters</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Membership.gaussmf">
|
||
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">gaussmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#gaussmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.gaussmf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gaussian fuzzy membership function</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>x</strong> – data point</li>
|
||
<li><strong>parameters</strong> – a list with 2 real values (mean and variance)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value of x given the parameters</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Membership.sigmf">
|
||
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">sigmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#sigmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.sigmf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sigmoid / Logistic membership function</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>x</strong> – </li>
|
||
<li><strong>parameters</strong> – an list with 2 real values (smoothness and midpoint)</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Membership.trapmf">
|
||
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">trapmf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#trapmf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.trapmf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Trapezoidal fuzzy membership function</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>x</strong> – data point</li>
|
||
<li><strong>parameters</strong> – a list with 4 real values</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value of x given the parameters</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Membership.trimf">
|
||
<code class="descclassname">pyFTS.common.Membership.</code><code class="descname">trimf</code><span class="sig-paren">(</span><em>x</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Membership.html#trimf"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Membership.trimf" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Triangular fuzzy membership function</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>x</strong> – data point</li>
|
||
<li><strong>parameters</strong> – a list with 3 real values</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value of x given the parameters</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.SortedCollection">
|
||
<span id="pyfts-common-sortedcollection-module"></span><h2>pyFTS.common.SortedCollection module<a class="headerlink" href="#module-pyFTS.common.SortedCollection" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.SortedCollection.</code><code class="descname">SortedCollection</code><span class="sig-paren">(</span><em>iterable=()</em>, <em>key=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Sequence sorted by a key function.</p>
|
||
<p>SortedCollection() is much easier to work with than using bisect() directly.
|
||
It supports key functions like those use in sorted(), min(), and max().
|
||
The result of the key function call is saved so that keys can be searched
|
||
efficiently.</p>
|
||
<p>Instead of returning an insertion-point which can be hard to interpret, the
|
||
five find-methods return a specific item in the sequence. They can scan for
|
||
exact matches, the last item less-than-or-equal to a key, or the first item
|
||
greater-than-or-equal to a key.</p>
|
||
<p>Once found, an item’s ordinal position can be located with the index() method.
|
||
New items can be added with the insert() and insert_right() methods.
|
||
Old items can be deleted with the remove() method.</p>
|
||
<p>The usual sequence methods are provided to support indexing, slicing,
|
||
length lookup, clearing, copying, forward and reverse iteration, contains
|
||
checking, item counts, item removal, and a nice looking repr.</p>
|
||
<p>Finding and indexing are O(log n) operations while iteration and insertion
|
||
are O(n). The initial sort is O(n log n).</p>
|
||
<p>The key function is stored in the ‘key’ attibute for easy introspection or
|
||
so that you can assign a new key function (triggering an automatic re-sort).</p>
|
||
<p>In short, the class was designed to handle all of the common use cases for
|
||
bisect but with a simpler API and support for key functions.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pprint</span> <span class="k">import</span> <span class="n">pprint</span>
|
||
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">operator</span> <span class="k">import</span> <span class="n">itemgetter</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span> <span class="o">=</span> <span class="n">SortedCollection</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">itemgetter</span><span class="p">(</span><span class="mi">2</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="k">for</span> <span class="n">record</span> <span class="ow">in</span> <span class="p">[</span>
|
||
<span class="gp">... </span> <span class="p">(</span><span class="s1">'roger'</span><span class="p">,</span> <span class="s1">'young'</span><span class="p">,</span> <span class="mi">30</span><span class="p">),</span>
|
||
<span class="gp">... </span> <span class="p">(</span><span class="s1">'angela'</span><span class="p">,</span> <span class="s1">'jones'</span><span class="p">,</span> <span class="mi">28</span><span class="p">),</span>
|
||
<span class="gp">... </span> <span class="p">(</span><span class="s1">'bill'</span><span class="p">,</span> <span class="s1">'smith'</span><span class="p">,</span> <span class="mi">22</span><span class="p">),</span>
|
||
<span class="gp">... </span> <span class="p">(</span><span class="s1">'david'</span><span class="p">,</span> <span class="s1">'thomas'</span><span class="p">,</span> <span class="mi">32</span><span class="p">)]:</span>
|
||
<span class="gp">... </span> <span class="n">s</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">pprint</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">s</span><span class="p">))</span> <span class="c1"># show records sorted by age</span>
|
||
<span class="go">[('bill', 'smith', 22),</span>
|
||
<span class="go"> ('angela', 'jones', 28),</span>
|
||
<span class="go"> ('roger', 'young', 30),</span>
|
||
<span class="go"> ('david', 'thomas', 32)]</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">find_le</span><span class="p">(</span><span class="mi">29</span><span class="p">)</span> <span class="c1"># find oldest person aged 29 or younger</span>
|
||
<span class="go">('angela', 'jones', 28)</span>
|
||
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">find_lt</span><span class="p">(</span><span class="mi">28</span><span class="p">)</span> <span class="c1"># find oldest person under 28</span>
|
||
<span class="go">('bill', 'smith', 22)</span>
|
||
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">find_gt</span><span class="p">(</span><span class="mi">28</span><span class="p">)</span> <span class="c1"># find youngest person over 28</span>
|
||
<span class="go">('roger', 'young', 30)</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">r</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">find_ge</span><span class="p">(</span><span class="mi">32</span><span class="p">)</span> <span class="c1"># find youngest person aged 32 or older</span>
|
||
<span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">r</span><span class="p">)</span> <span class="c1"># get the index of their record</span>
|
||
<span class="go">3</span>
|
||
<span class="gp">>>> </span><span class="n">s</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="c1"># fetch the record at that index</span>
|
||
<span class="go">('david', 'thomas', 32)</span>
|
||
</pre></div>
|
||
</div>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">s</span><span class="o">.</span><span class="n">key</span> <span class="o">=</span> <span class="n">itemgetter</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c1"># now sort by first name</span>
|
||
<span class="gp">>>> </span><span class="n">pprint</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">s</span><span class="p">))</span>
|
||
<span class="go">[('angela', 'jones', 28),</span>
|
||
<span class="go"> ('bill', 'smith', 22),</span>
|
||
<span class="go"> ('david', 'thomas', 32),</span>
|
||
<span class="go"> ('roger', 'young', 30)]</span>
|
||
</pre></div>
|
||
</div>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.around">
|
||
<code class="descname">around</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.around"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.around" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.between">
|
||
<code class="descname">between</code><span class="sig-paren">(</span><em>ge</em>, <em>le</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.between"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.between" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.clear">
|
||
<code class="descname">clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.clear"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.clear" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.copy">
|
||
<code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.copy" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.count">
|
||
<code class="descname">count</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.count"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.count" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return number of occurrences of item</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.find">
|
||
<code class="descname">find</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return first item with a key == k. Raise ValueError if not found.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_ge">
|
||
<code class="descname">find_ge</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_ge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_ge" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return first item with a key >= equal to k. Raise ValueError if not found</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_gt">
|
||
<code class="descname">find_gt</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_gt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_gt" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return first item with a key > k. Raise ValueError if not found</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_le">
|
||
<code class="descname">find_le</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_le"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_le" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return last item with a key <= k. Raise ValueError if not found.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.find_lt">
|
||
<code class="descname">find_lt</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_lt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.find_lt" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return last item with a key < k. Raise ValueError if not found.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.index">
|
||
<code class="descname">index</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.index" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Find the position of an item. Raise ValueError if not found.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.insert">
|
||
<code class="descname">insert</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.insert"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.insert" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Insert a new item. If equal keys are found, add to the left</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.insert_right">
|
||
<code class="descname">insert_right</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.insert_right"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.insert_right" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Insert a new item. If equal keys are found, add to the right</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.inside">
|
||
<code class="descname">inside</code><span class="sig-paren">(</span><em>ge</em>, <em>le</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.inside"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.inside" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.key">
|
||
<code class="descname">key</code><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>key function</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.SortedCollection.SortedCollection.remove">
|
||
<code class="descname">remove</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.SortedCollection.SortedCollection.remove" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Remove first occurence of item. Raise ValueError if not found</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.Transformations">
|
||
<span id="pyfts-common-transformations-module"></span><h2>pyFTS.common.Transformations module<a class="headerlink" href="#module-pyFTS.common.Transformations" title="Permalink to this headline">¶</a></h2>
|
||
<p>Common data transformation used on pre and post processing of the FTS</p>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.Transformations.AdaptiveExpectation">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">AdaptiveExpectation</code><span class="sig-paren">(</span><em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
|
||
<p>Adaptive Expectation post processing</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.apply">
|
||
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.apply" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the transformation on input data</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.inverse">
|
||
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.inverse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – transformed data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.Transformations.AdaptiveExpectation.parameters">
|
||
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.AdaptiveExpectation.parameters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.Transformations.BoxCox">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">BoxCox</code><span class="sig-paren">(</span><em>plambda</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#BoxCox"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
|
||
<p>Box-Cox power transformation</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.BoxCox.apply">
|
||
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#BoxCox.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.apply" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the transformation on input data</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.BoxCox.inverse">
|
||
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#BoxCox.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.inverse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – transformed data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.Transformations.BoxCox.parameters">
|
||
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.BoxCox.parameters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.Transformations.Differential">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Differential</code><span class="sig-paren">(</span><em>lag</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Differential"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Differential" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
|
||
<p>Differentiation data transform</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.Differential.apply">
|
||
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Differential.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Differential.apply" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the transformation on input data</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.Differential.inverse">
|
||
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Differential.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Differential.inverse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – transformed data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.Transformations.Differential.parameters">
|
||
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.Differential.parameters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.Transformations.Scale">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Scale</code><span class="sig-paren">(</span><em>min=0</em>, <em>max=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Scale"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Scale" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyFTS.common.Transformations.Transformation" title="pyFTS.common.Transformations.Transformation"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.Transformations.Transformation</span></code></a></p>
|
||
<p>Scale data inside a interval [min, max]</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.Scale.apply">
|
||
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Scale.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Scale.apply" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the transformation on input data</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.Scale.inverse">
|
||
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Scale.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Scale.inverse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – transformed data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.Transformations.Scale.parameters">
|
||
<code class="descname">parameters</code><a class="headerlink" href="#pyFTS.common.Transformations.Scale.parameters" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.Transformations.Transformation">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Transformation</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Transformation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Transformation" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Data transformation used on pre and post processing of the FTS</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.Transformation.apply">
|
||
<code class="descname">apply</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Transformation.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Transformation.apply" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the transformation on input data</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.Transformations.Transformation.inverse">
|
||
<code class="descname">inverse</code><span class="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Transformation.inverse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Transformation.inverse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – transformed data</li>
|
||
<li><strong>param</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">numpy array with inverse transformed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Transformations.Z">
|
||
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">Z</code><span class="sig-paren">(</span><em>original</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#Z"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.Z" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Transformations.aggregate">
|
||
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">aggregate</code><span class="sig-paren">(</span><em>original</em>, <em>operation</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#aggregate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.aggregate" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Transformations.roi">
|
||
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">roi</code><span class="sig-paren">(</span><em>original</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#roi"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.roi" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Transformations.smoothing">
|
||
<code class="descclassname">pyFTS.common.Transformations.</code><code class="descname">smoothing</code><span class="sig-paren">(</span><em>original</em>, <em>lags</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Transformations.html#smoothing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Transformations.smoothing" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.Util">
|
||
<span id="pyfts-common-util-module"></span><h2>pyFTS.common.Util module<a class="headerlink" href="#module-pyFTS.common.Util" title="Permalink to this headline">¶</a></h2>
|
||
<p>Common facilities for pyFTS</p>
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.current_milli_time">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">current_milli_time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyFTS.common.Util.current_milli_time" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.distributed_predict">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">distributed_predict</code><span class="sig-paren">(</span><em>model</em>, <em>parameters</em>, <em>nodes</em>, <em>data</em>, <em>num_batches</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#distributed_predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.distributed_predict" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.distributed_train">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">distributed_train</code><span class="sig-paren">(</span><em>model</em>, <em>train_method</em>, <em>nodes</em>, <em>fts_method</em>, <em>data</em>, <em>num_batches=10</em>, <em>train_parameters={}</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#distributed_train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.distributed_train" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.draw_sets_on_axis">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">draw_sets_on_axis</code><span class="sig-paren">(</span><em>axis</em>, <em>model</em>, <em>size</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#draw_sets_on_axis"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.draw_sets_on_axis" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.enumerate2">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">enumerate2</code><span class="sig-paren">(</span><em>xs</em>, <em>start=0</em>, <em>step=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#enumerate2"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.enumerate2" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.load_env">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">load_env</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#load_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.load_env" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.load_obj">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">load_obj</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#load_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.load_obj" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Load to memory an object stored filesystem. This function depends on Dill package</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> – file name where the object is stored</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">object</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.persist_env">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">persist_env</code><span class="sig-paren">(</span><em>file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#persist_env"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.persist_env" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Persist an entire environment on file. This function depends on Dill package</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>file</strong> – file name to store the environment</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.persist_obj">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">persist_obj</code><span class="sig-paren">(</span><em>obj</em>, <em>file</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#persist_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.persist_obj" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Persist an object on filesystem. This function depends on Dill package</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>obj</strong> – object on memory</li>
|
||
<li><strong>file</strong> – file name to store the object</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.plot_rules">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">plot_rules</code><span class="sig-paren">(</span><em>model, size=[5, 5], axis=None, rules_by_axis=None, columns=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#plot_rules"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.plot_rules" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.show_and_save_image">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">show_and_save_image</code><span class="sig-paren">(</span><em>fig</em>, <em>file</em>, <em>flag</em>, <em>lgd=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#show_and_save_image"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.show_and_save_image" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Show and image and save on file</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>fig</strong> – Matplotlib Figure object</li>
|
||
<li><strong>file</strong> – filename to save the picture</li>
|
||
<li><strong>flag</strong> – if True the image will be saved</li>
|
||
<li><strong>lgd</strong> – legend</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.simple_model_predict">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">simple_model_predict</code><span class="sig-paren">(</span><em>model</em>, <em>data</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#simple_model_predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.simple_model_predict" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.simple_model_train">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">simple_model_train</code><span class="sig-paren">(</span><em>model</em>, <em>data</em>, <em>parameters</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#simple_model_train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.simple_model_train" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.sliding_window">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">sliding_window</code><span class="sig-paren">(</span><em>data</em>, <em>windowsize</em>, <em>train=0.8</em>, <em>inc=0.1</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#sliding_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.sliding_window" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sliding window method of cross validation for time series</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – the entire dataset</li>
|
||
<li><strong>windowsize</strong> – window size</li>
|
||
<li><strong>train</strong> – percentual of the window size will be used for training the models</li>
|
||
<li><strong>inc</strong> – percentual of data used for slide the window</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">window count, training set, test set</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.start_dispy_cluster">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">start_dispy_cluster</code><span class="sig-paren">(</span><em>method</em>, <em>nodes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#start_dispy_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.start_dispy_cluster" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.stop_dispy_cluster">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">stop_dispy_cluster</code><span class="sig-paren">(</span><em>cluster</em>, <em>http_server</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#stop_dispy_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.stop_dispy_cluster" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.Util.uniquefilename">
|
||
<code class="descclassname">pyFTS.common.Util.</code><code class="descname">uniquefilename</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/Util.html#uniquefilename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.Util.uniquefilename" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.flrg">
|
||
<span id="pyfts-common-flrg-module"></span><h2>pyFTS.common.flrg module<a class="headerlink" href="#module-pyFTS.common.flrg" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.flrg.FLRG">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.flrg.</code><code class="descname">FLRG</code><span class="sig-paren">(</span><em>order</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Fuzzy Logical Relationship Group</p>
|
||
<p>Group a set of FLR’s with the same LHS. Represents the temporal patterns for time t+1 (the RHS fuzzy sets)
|
||
when the LHS pattern is identified on time t.</p>
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.flrg.FLRG.LHS">
|
||
<code class="descname">LHS</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.flrg.FLRG.LHS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Left Hand Side of the rule</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.flrg.FLRG.RHS">
|
||
<code class="descname">RHS</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.flrg.FLRG.RHS" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Right Hand Side of the rule</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.append_rhs">
|
||
<code class="descname">append_rhs</code><span class="sig-paren">(</span><em>set</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.append_rhs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.append_rhs" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.get_key">
|
||
<code class="descname">get_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a unique identifier for this FLRG</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.get_lower">
|
||
<code class="descname">get_lower</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_lower"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_lower" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the lower bound value for the RHS fuzzy sets</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sets</strong> – fuzzy sets</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">lower bound value</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.get_membership">
|
||
<code class="descname">get_membership</code><span class="sig-paren">(</span><em>data</em>, <em>sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_membership"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_membership" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the membership value of the FLRG for the input data</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>sets</strong> – fuzzy sets</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the membership value</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.get_midpoint">
|
||
<code class="descname">get_midpoint</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_midpoint"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_midpoint" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the midpoint value for the RHS fuzzy sets</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sets</strong> – fuzzy sets</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the midpoint value</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.get_midpoints">
|
||
<code class="descname">get_midpoints</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_midpoints"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_midpoints" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.flrg.FLRG.get_upper">
|
||
<code class="descname">get_upper</code><span class="sig-paren">(</span><em>sets</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/flrg.html#FLRG.get_upper"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.flrg.FLRG.get_upper" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns the upper bound value for the RHS fuzzy sets</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sets</strong> – fuzzy sets</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">upper bound value</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.flrg.FLRG.order">
|
||
<code class="descname">order</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.flrg.FLRG.order" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Number of lags on LHS</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.fts">
|
||
<span id="pyfts-common-fts-module"></span><h2>pyFTS.common.fts module<a class="headerlink" href="#module-pyFTS.common.fts" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.fts.FTS">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.fts.</code><code class="descname">FTS</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Fuzzy Time Series object model</p>
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.alpha_cut">
|
||
<code class="descname">alpha_cut</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="method">
|
||
<dt id="pyFTS.common.fts.FTS.append_transformation">
|
||
<code class="descname">append_transformation</code><span class="sig-paren">(</span><em>transformation</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.append_transformation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.append_transformation" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.apply_inverse_transformations">
|
||
<code class="descname">apply_inverse_transformations</code><span class="sig-paren">(</span><em>data</em>, <em>params=None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.apply_inverse_transformations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.apply_inverse_transformations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the data transformations for data postprocessing</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>params</strong> – transformation parameters</li>
|
||
<li><strong>updateUoD</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">postprocessed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.apply_transformations">
|
||
<code class="descname">apply_transformations</code><span class="sig-paren">(</span><em>data</em>, <em>params=None</em>, <em>updateUoD=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.apply_transformations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.apply_transformations" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Apply the data transformations for data preprocessing</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – input data</li>
|
||
<li><strong>params</strong> – transformation parameters</li>
|
||
<li><strong>updateUoD</strong> – </li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">preprocessed data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.auto_update">
|
||
<code class="descname">auto_update</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.auto_update" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A boolean value indicating that model is incremental</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.benchmark_only">
|
||
<code class="descname">benchmark_only</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="method">
|
||
<dt id="pyFTS.common.fts.FTS.clone_parameters">
|
||
<code class="descname">clone_parameters</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.clone_parameters"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.clone_parameters" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Import the parameters values from other model</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.detail">
|
||
<code class="descname">detail</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.detail" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A string with the model detailed information</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.fit">
|
||
<code class="descname">fit</code><span class="sig-paren">(</span><em>ndata</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.fit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.fit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fit the model’s parameters based on the training data.</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>ndata</strong> – training time series data</li>
|
||
<li><strong>kwargs</strong> – </li>
|
||
<li><strong>num_batches</strong> – split the training data in num_batches to save memory during the training process</li>
|
||
<li><strong>save_model</strong> – save final model on disk</li>
|
||
<li><strong>batch_save</strong> – save the model between each batch</li>
|
||
<li><strong>file_path</strong> – path to save the model</li>
|
||
<li><strong>distributed</strong> – boolean, indicate if the training procedure will be distributed in a dispy cluster</li>
|
||
<li><strong>nodes</strong> – a list with the dispy cluster nodes addresses</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.flrgs">
|
||
<code class="descname">flrgs</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.flrgs" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.forecast">
|
||
<code class="descname">forecast</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Point forecast one step ahead</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
|
||
<li><strong>kwargs</strong> – model specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted values</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.forecast_ahead">
|
||
<code class="descname">forecast_ahead</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Point forecast n steps ahead</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
|
||
<li><strong>steps</strong> – the number of steps ahead to forecast</li>
|
||
<li><strong>kwargs</strong> – model specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted values</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.forecast_ahead_distribution">
|
||
<code class="descname">forecast_ahead_distribution</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_distribution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead_distribution" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Probabilistic forecast n steps ahead</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
|
||
<li><strong>steps</strong> – the number of steps ahead to forecast</li>
|
||
<li><strong>kwargs</strong> – model specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted Probability Distributions</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.forecast_ahead_interval">
|
||
<code class="descname">forecast_ahead_interval</code><span class="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_ahead_interval" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Interval forecast n steps ahead</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
|
||
<li><strong>steps</strong> – the number of steps ahead to forecast</li>
|
||
<li><strong>kwargs</strong> – model specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted intervals</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.forecast_distribution">
|
||
<code class="descname">forecast_distribution</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_distribution"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_distribution" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Probabilistic forecast one step ahead</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
|
||
<li><strong>kwargs</strong> – model specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted Probability Distributions</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.forecast_interval">
|
||
<code class="descname">forecast_interval</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.forecast_interval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.forecast_interval" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Interval forecast one step ahead</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</li>
|
||
<li><strong>kwargs</strong> – model specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a list with the forecasted intervals</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.fuzzy">
|
||
<code class="descname">fuzzy</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.fuzzy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.fuzzy" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Fuzzify a data point</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – data point</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">maximum membership fuzzy set</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.fts.FTS.get_UoD">
|
||
<code class="descname">get_UoD</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.get_UoD"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.get_UoD" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.has_interval_forecasting">
|
||
<code class="descname">has_interval_forecasting</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.has_point_forecasting">
|
||
<code class="descname">has_point_forecasting</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.has_probability_forecasting">
|
||
<code class="descname">has_probability_forecasting</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.has_seasonality">
|
||
<code class="descname">has_seasonality</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.indexer">
|
||
<code class="descname">indexer</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.indexer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>An pyFTS.models.seasonal.Indexer object for indexing the time series data</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.is_high_order">
|
||
<code class="descname">is_high_order</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.is_multivariate">
|
||
<code class="descname">is_multivariate</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="method">
|
||
<dt id="pyFTS.common.fts.FTS.len_total">
|
||
<code class="descname">len_total</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.len_total"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.len_total" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.max_lag">
|
||
<code class="descname">max_lag</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="method">
|
||
<dt id="pyFTS.common.fts.FTS.merge">
|
||
<code class="descname">merge</code><span class="sig-paren">(</span><em>model</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.merge"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.merge" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Merge the FLRG rules from other model</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – source model</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.min_order">
|
||
<code class="descname">min_order</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.name">
|
||
<code class="descname">name</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.name" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>A string with the model name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.order">
|
||
<code class="descname">order</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.original_max">
|
||
<code class="descname">original_max</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.original_min">
|
||
<code class="descname">original_min</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.partitioner">
|
||
<code class="descname">partitioner</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="method">
|
||
<dt id="pyFTS.common.fts.FTS.predict">
|
||
<code class="descname">predict</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.predict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.predict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Forecast using trained model</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||
<li><strong>data</strong> – time series with minimal length to the order of the model</li>
|
||
<li><strong>type</strong> – the forecasting type, one of these values: point(default), interval or distribution.</li>
|
||
<li><strong>steps_ahead</strong> – The forecasting horizon, i. e., the number of steps ahead to forecast</li>
|
||
<li><strong>start</strong> – in the multi step forecasting, the index of the data where to start forecasting</li>
|
||
<li><strong>distributed</strong> – boolean, indicate if the forecasting procedure will be distributed in a dispy cluster</li>
|
||
<li><strong>nodes</strong> – a list with the dispy cluster nodes addresses</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a numpy array with the forecasted data</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.sets">
|
||
<code class="descname">sets</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.sets" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>The list of fuzzy sets used on this model</p>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.shortname">
|
||
<code class="descname">shortname</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="method">
|
||
<dt id="pyFTS.common.fts.FTS.train">
|
||
<code class="descname">train</code><span class="sig-paren">(</span><em>data</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/fts.html#FTS.train"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.fts.FTS.train" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Method specific parameter fitting</p>
|
||
<table class="docutils field-list" frame="void" rules="none">
|
||
<col class="field-name" />
|
||
<col class="field-body" />
|
||
<tbody valign="top">
|
||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
|
||
<li><strong>data</strong> – training time series data</li>
|
||
<li><strong>kwargs</strong> – Method specific parameters</li>
|
||
</ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</dd></dl>
|
||
|
||
<dl class="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.transformations">
|
||
<code class="descname">transformations</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.transformations_param">
|
||
<code class="descname">transformations_param</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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="attribute">
|
||
<dt id="pyFTS.common.fts.FTS.uod_clip">
|
||
<code class="descname">uod_clip</code><em class="property"> = None</em><a class="headerlink" href="#pyFTS.common.fts.FTS.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>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common.tree">
|
||
<span id="pyfts-common-tree-module"></span><h2>pyFTS.common.tree module<a class="headerlink" href="#module-pyFTS.common.tree" title="Permalink to this headline">¶</a></h2>
|
||
<p>Tree data structure</p>
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.tree.FLRGTree">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.tree.</code><code class="descname">FLRGTree</code><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTree" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Represents a FLRG set with a tree structure</p>
|
||
</dd></dl>
|
||
|
||
<dl class="class">
|
||
<dt id="pyFTS.common.tree.FLRGTreeNode">
|
||
<em class="property">class </em><code class="descclassname">pyFTS.common.tree.</code><code class="descname">FLRGTreeNode</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode" 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.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
|
||
<p>Tree node for</p>
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.tree.FLRGTreeNode.appendChild">
|
||
<code class="descname">appendChild</code><span class="sig-paren">(</span><em>child</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.appendChild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.appendChild" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.tree.FLRGTreeNode.getChildren">
|
||
<code class="descname">getChildren</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.getChildren"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.getChildren" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.tree.FLRGTreeNode.getStr">
|
||
<code class="descname">getStr</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.getStr"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.getStr" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="method">
|
||
<dt id="pyFTS.common.tree.FLRGTreeNode.paths">
|
||
<code class="descname">paths</code><span class="sig-paren">(</span><em>acc=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#FLRGTreeNode.paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.FLRGTreeNode.paths" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.tree.build_tree_without_order">
|
||
<code class="descclassname">pyFTS.common.tree.</code><code class="descname">build_tree_without_order</code><span class="sig-paren">(</span><em>node</em>, <em>lags</em>, <em>level</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#build_tree_without_order"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.build_tree_without_order" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="function">
|
||
<dt id="pyFTS.common.tree.flat">
|
||
<code class="descclassname">pyFTS.common.tree.</code><code class="descname">flat</code><span class="sig-paren">(</span><em>dados</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/common/tree.html#flat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.common.tree.flat" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</div>
|
||
<div class="section" id="module-pyFTS.common">
|
||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyFTS.common" title="Permalink to this headline">¶</a></h2>
|
||
</div>
|
||
</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.common package</a><ul>
|
||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.Composite">pyFTS.common.Composite module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.FLR">pyFTS.common.FLR module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.FuzzySet">pyFTS.common.FuzzySet module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.Membership">pyFTS.common.Membership module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.SortedCollection">pyFTS.common.SortedCollection module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.Transformations">pyFTS.common.Transformations module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.Util">pyFTS.common.Util module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.flrg">pyFTS.common.flrg module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.fts">pyFTS.common.fts module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common.tree">pyFTS.common.tree module</a></li>
|
||
<li><a class="reference internal" href="#module-pyFTS.common">Module contents</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/pyFTS.common.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3>Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" />
|
||
<input type="submit" value="Go" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2018, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.2</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
|
||
|
||
|
|
||
<a href="_sources/pyFTS.common.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |