<spanid="pyfts-common-composite-module"></span><h2>pyFTS.common.Composite module<aclass="headerlink"href="#module-pyFTS.common.Composite"title="Permalink to this headline">¶</a></h2>
<p>Composite Fuzzy Sets</p>
<dlclass="class">
<dtid="pyFTS.common.Composite.FuzzySet">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.Composite.</code><codeclass="descname">FuzzySet</code><spanclass="sig-paren">(</span><em>name</em>, <em>superset=False</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Composite.html#FuzzySet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Composite.FuzzySet"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">append</code><spanclass="sig-paren">(</span><em>mf</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Composite.html#FuzzySet.append"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Composite.FuzzySet.append"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">append_set</code><spanclass="sig-paren">(</span><em>set</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Composite.html#FuzzySet.append_set"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Composite.FuzzySet.append_set"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">membership</code><spanclass="sig-paren">(</span><em>x</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Composite.html#FuzzySet.membership"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">membership value of x at this fuzzy set</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<divclass="section"id="module-pyFTS.common.FLR">
<spanid="pyfts-common-flr-module"></span><h2>pyFTS.common.FLR module<aclass="headerlink"href="#module-pyFTS.common.FLR"title="Permalink to this headline">¶</a></h2>
<p>This module implements functions for Fuzzy Logical Relationship generation</p>
<dlclass="class">
<dtid="pyFTS.common.FLR.FLR">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.FLR.</code><codeclass="descname">FLR</code><spanclass="sig-paren">(</span><em>LHS</em>, <em>RHS</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FLR.html#FLR"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FLR.FLR"title="Permalink to this definition">¶</a></dt>
<p>Represents a temporal transition of the fuzzy set LHS on time t for the fuzzy set RHS on time t+1.</p>
<dlclass="attribute">
<dtid="pyFTS.common.FLR.FLR.LHS">
<codeclass="descname">LHS</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.common.FLR.FLR.LHS"title="Permalink to this definition">¶</a></dt>
<dd><p>Left Hand Side fuzzy set</p>
</dd></dl>
<dlclass="attribute">
<dtid="pyFTS.common.FLR.FLR.RHS">
<codeclass="descname">RHS</code><emclass="property"> = None</em><aclass="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>
<dlclass="class">
<dtid="pyFTS.common.FLR.IndexedFLR">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.FLR.</code><codeclass="descname">IndexedFLR</code><spanclass="sig-paren">(</span><em>index</em>, <em>LHS</em>, <em>RHS</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FLR.html#IndexedFLR"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FLR.IndexedFLR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">index</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.common.FLR.IndexedFLR.index"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FLR.</code><codeclass="descname">generate_high_order_recurrent_flr</code><spanclass="sig-paren">(</span><em>fuzzyData</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FLR.html#generate_high_order_recurrent_flr"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>fuzzyData</strong>– ordered list of fuzzy sets</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">ordered list of FLR</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.FLR.generate_indexed_flrs">
<codeclass="descclassname">pyFTS.common.FLR.</code><codeclass="descname">generate_indexed_flrs</code><spanclass="sig-paren">(</span><em>sets</em>, <em>indexer</em>, <em>data</em>, <em>transformation=None</em>, <em>alpha_cut=0.0</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FLR.html#generate_indexed_flrs"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descclassname">pyFTS.common.FLR.</code><codeclass="descname">generate_non_recurrent_flrs</code><spanclass="sig-paren">(</span><em>fuzzyData</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FLR.html#generate_non_recurrent_flrs"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>fuzzyData</strong>– ordered list of fuzzy sets</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">ordered list of FLR</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.FLR.generate_recurrent_flrs">
<codeclass="descclassname">pyFTS.common.FLR.</code><codeclass="descname">generate_recurrent_flrs</code><spanclass="sig-paren">(</span><em>fuzzyData</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FLR.html#generate_recurrent_flrs"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<spanid="pyfts-common-fuzzyset-module"></span><h2>pyFTS.common.FuzzySet module<aclass="headerlink"href="#module-pyFTS.common.FuzzySet"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pyFTS.common.FuzzySet.FuzzySet">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">FuzzySet</code><spanclass="sig-paren">(</span><em>name</em>, <em>mf</em>, <em>parameters</em>, <em>centroid</em>, <em>alpha=1.0</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#FuzzySet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.FuzzySet"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">Z</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.FuzzySet.FuzzySet.alpha">
<codeclass="descname">alpha</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.common.FuzzySet.FuzzySet.alpha"title="Permalink to this definition">¶</a></dt>
<dd><p>The alpha cut value</p>
</dd></dl>
<dlclass="attribute">
<dtid="pyFTS.common.FuzzySet.FuzzySet.centroid">
<codeclass="descname">centroid</code><emclass="property"> = None</em><aclass="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>
<codeclass="descname">membership</code><spanclass="sig-paren">(</span><em>x</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.membership"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">membership value of x at this fuzzy set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="attribute">
<dtid="pyFTS.common.FuzzySet.FuzzySet.mf">
<codeclass="descname">mf</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.common.FuzzySet.FuzzySet.mf"title="Permalink to this definition">¶</a></dt>
<dd><p>The membership function</p>
</dd></dl>
<dlclass="attribute">
<dtid="pyFTS.common.FuzzySet.FuzzySet.name">
<codeclass="descname">name</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.common.FuzzySet.FuzzySet.name"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">parameters</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.common.FuzzySet.FuzzySet.parameters"title="Permalink to this definition">¶</a></dt>
<dd><p>The parameters of the membership function</p>
<codeclass="descname">partition_function</code><spanclass="sig-paren">(</span><em>uod=None</em>, <em>nbins=100</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#FuzzySet.partition_function"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">type</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.FuzzySet.FuzzySet.variable">
<codeclass="descname">variable</code><emclass="property"> = None</em><aclass="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>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">check_bounds</code><spanclass="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#check_bounds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.check_bounds"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">check_bounds_index</code><spanclass="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#check_bounds_index"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.check_bounds_index"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">fuzzyfy</code><spanclass="sig-paren">(</span><em>data</em>, <em>partitioner</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.fuzzyfy"title="Permalink to this definition">¶</a></dt>
<li><strong>alpha_cut</strong>– the minimal membership value to be considered on fuzzyfication (only for mode=’sets’)</li>
<li><strong>method</strong>– the fuzzyfication method (fuzzy: all fuzzy memberships, maximum: only the maximum membership)</li>
<li><strong>mode</strong>– the fuzzyfication mode (sets: return the fuzzy sets names, vector: return a vector with the membership values for all fuzzy sets)</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>:returns a list with the fuzzyfied values, depending on the mode</p>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">fuzzyfy_instance</code><spanclass="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_instance"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.fuzzyfy_instance"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">fuzzyfy_instances</code><spanclass="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_instances"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.fuzzyfy_instances"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">fuzzyfy_series</code><spanclass="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>method='maximum'</em>, <em>alpha_cut=0.0</em>, <em>ordered_sets=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_series"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.fuzzyfy_series"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">fuzzyfy_series_old</code><spanclass="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>method='maximum'</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#fuzzyfy_series_old"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.fuzzyfy_series_old"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">get_fuzzysets</code><spanclass="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em>, <em>alpha_cut=0.0</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#get_fuzzysets"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.get_fuzzysets"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">get_maximum_membership_fuzzyset</code><spanclass="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em>, <em>ordered_sets=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#get_maximum_membership_fuzzyset"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">get_maximum_membership_fuzzyset_index</code><spanclass="sig-paren">(</span><em>inst</em>, <em>fuzzy_sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#get_maximum_membership_fuzzyset_index"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.get_maximum_membership_fuzzyset_index"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">grant_bounds</code><spanclass="sig-paren">(</span><em>data</em>, <em>fuzzy_sets</em>, <em>ordered_sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#grant_bounds"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.grant_bounds"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.FuzzySet.</code><codeclass="descname">set_ordered</code><spanclass="sig-paren">(</span><em>fuzzy_sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/FuzzySet.html#set_ordered"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.FuzzySet.set_ordered"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>fuzzy_sets</strong>– a dictionary where the key is the fuzzy set name and the value is the fuzzy set object.</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body">a list with the fuzzy sets names ordered by their centroids.</td>
<spanid="pyfts-common-membership-module"></span><h2>pyFTS.common.Membership module<aclass="headerlink"href="#module-pyFTS.common.Membership"title="Permalink to this headline">¶</a></h2>
<p>Membership functions for Fuzzy Sets</p>
<dlclass="function">
<dtid="pyFTS.common.Membership.bellmf">
<codeclass="descclassname">pyFTS.common.Membership.</code><codeclass="descname">bellmf</code><spanclass="sig-paren">(</span><em>x</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Membership.html#bellmf"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Membership.bellmf"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.Membership.</code><codeclass="descname">gaussmf</code><spanclass="sig-paren">(</span><em>x</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Membership.html#gaussmf"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Membership.gaussmf"title="Permalink to this definition">¶</a></dt>
<li><strong>parameters</strong>– a list with 2 real values (mean and variance)</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the membership value of x given the parameters</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Membership.sigmf">
<codeclass="descclassname">pyFTS.common.Membership.</code><codeclass="descname">sigmf</code><spanclass="sig-paren">(</span><em>x</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Membership.html#sigmf"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Membership.sigmf"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.Membership.</code><codeclass="descname">singleton</code><spanclass="sig-paren">(</span><em>x</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Membership.html#singleton"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Membership.singleton"title="Permalink to this definition">¶</a></dt>
<dd><p>Singleton membership function, a single value fuzzy function</p>
<codeclass="descclassname">pyFTS.common.Membership.</code><codeclass="descname">trapmf</code><spanclass="sig-paren">(</span><em>x</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Membership.html#trapmf"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Membership.trapmf"title="Permalink to this definition">¶</a></dt>
<li><strong>parameters</strong>– a list with 4 real values</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the membership value of x given the parameters</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Membership.trimf">
<codeclass="descclassname">pyFTS.common.Membership.</code><codeclass="descname">trimf</code><spanclass="sig-paren">(</span><em>x</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Membership.html#trimf"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Membership.trimf"title="Permalink to this definition">¶</a></dt>
<li><strong>parameters</strong>– a list with 3 real values</li>
</ul>
</td>
</tr>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">the membership value of x given the parameters</p>
<spanid="pyfts-common-sortedcollection-module"></span><h2>pyFTS.common.SortedCollection module<aclass="headerlink"href="#module-pyFTS.common.SortedCollection"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.SortedCollection.</code><codeclass="descname">SortedCollection</code><spanclass="sig-paren">(</span><em>iterable=()</em>, <em>key=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection"title="Permalink to this definition">¶</a></dt>
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="gp">>>></span><spanclass="n">pprint</span><spanclass="p">(</span><spanclass="nb">list</span><spanclass="p">(</span><spanclass="n">s</span><spanclass="p">))</span><spanclass="c1"># show records sorted by age</span>
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="gp">>>></span><spanclass="n">s</span><spanclass="o">.</span><spanclass="n">find_le</span><spanclass="p">(</span><spanclass="mi">29</span><spanclass="p">)</span><spanclass="c1"># find oldest person aged 29 or younger</span>
<spanclass="gp">>>></span><spanclass="n">s</span><spanclass="o">.</span><spanclass="n">find_lt</span><spanclass="p">(</span><spanclass="mi">28</span><spanclass="p">)</span><spanclass="c1"># find oldest person under 28</span>
<spanclass="gp">>>></span><spanclass="n">s</span><spanclass="o">.</span><spanclass="n">find_gt</span><spanclass="p">(</span><spanclass="mi">28</span><spanclass="p">)</span><spanclass="c1"># find youngest person over 28</span>
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="gp">>>></span><spanclass="n">r</span><spanclass="o">=</span><spanclass="n">s</span><spanclass="o">.</span><spanclass="n">find_ge</span><spanclass="p">(</span><spanclass="mi">32</span><spanclass="p">)</span><spanclass="c1"># find youngest person aged 32 or older</span>
<spanclass="gp">>>></span><spanclass="n">s</span><spanclass="o">.</span><spanclass="n">index</span><spanclass="p">(</span><spanclass="n">r</span><spanclass="p">)</span><spanclass="c1"># get the index of their record</span>
<spanclass="go">3</span>
<spanclass="gp">>>></span><spanclass="n">s</span><spanclass="p">[</span><spanclass="mi">3</span><spanclass="p">]</span><spanclass="c1"># fetch the record at that index</span>
<divclass="highlight-default notranslate"><divclass="highlight"><pre><span></span><spanclass="gp">>>></span><spanclass="n">s</span><spanclass="o">.</span><spanclass="n">key</span><spanclass="o">=</span><spanclass="n">itemgetter</span><spanclass="p">(</span><spanclass="mi">0</span><spanclass="p">)</span><spanclass="c1"># now sort by first name</span>
<codeclass="descname">around</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.around"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.around"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">between</code><spanclass="sig-paren">(</span><em>ge</em>, <em>le</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.between"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.between"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">clear</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.clear"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.clear"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">copy</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.copy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.copy"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">count</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.count"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.count"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">find</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">find_ge</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_ge"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">find_gt</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_gt"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">find_le</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_le"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">find_lt</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.find_lt"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">index</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.index"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">insert</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.insert"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">insert_right</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.insert_right"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">inside</code><spanclass="sig-paren">(</span><em>ge</em>, <em>le</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.inside"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.inside"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">key</code><aclass="headerlink"href="#pyFTS.common.SortedCollection.SortedCollection.key"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">remove</code><spanclass="sig-paren">(</span><em>item</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/SortedCollection.html#SortedCollection.remove"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<spanid="pyfts-common-transformations-module"></span><h2>pyFTS.common.Transformations module<aclass="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>
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">AdaptiveExpectation</code><spanclass="sig-paren">(</span><em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.AdaptiveExpectation"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply</code><spanclass="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation.apply"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.AdaptiveExpectation.apply"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverse</code><spanclass="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#AdaptiveExpectation.inverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.AdaptiveExpectation.inverse"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">parameters</code><aclass="headerlink"href="#pyFTS.common.Transformations.AdaptiveExpectation.parameters"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="pyFTS.common.Transformations.BoxCox">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">BoxCox</code><spanclass="sig-paren">(</span><em>plambda</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#BoxCox"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.BoxCox"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply</code><spanclass="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#BoxCox.apply"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.BoxCox.apply"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverse</code><spanclass="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#BoxCox.inverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.BoxCox.inverse"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">parameters</code><aclass="headerlink"href="#pyFTS.common.Transformations.BoxCox.parameters"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">Differential</code><spanclass="sig-paren">(</span><em>lag</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Differential"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Differential"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply</code><spanclass="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Differential.apply"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Differential.apply"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverse</code><spanclass="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Differential.inverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Differential.inverse"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">parameters</code><aclass="headerlink"href="#pyFTS.common.Transformations.Differential.parameters"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="pyFTS.common.Transformations.Scale">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">Scale</code><spanclass="sig-paren">(</span><em>min=0</em>, <em>max=1</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Scale"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Scale"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply</code><spanclass="sig-paren">(</span><em>data</em>, <em>param=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Scale.apply"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Scale.apply"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverse</code><spanclass="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Scale.inverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Scale.inverse"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">parameters</code><aclass="headerlink"href="#pyFTS.common.Transformations.Scale.parameters"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">Transformation</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Transformation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Transformation"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply</code><spanclass="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Transformation.apply"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Transformation.apply"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">inverse</code><spanclass="sig-paren">(</span><em>data</em>, <em>param</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Transformation.inverse"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Transformation.inverse"title="Permalink to this definition">¶</a></dt>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">numpy array with inverse transformed data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Transformations.Z">
<codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">Z</code><spanclass="sig-paren">(</span><em>original</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#Z"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.Z"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Transformations.aggregate">
<codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">aggregate</code><spanclass="sig-paren">(</span><em>original</em>, <em>operation</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#aggregate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.aggregate"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Transformations.roi">
<codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">roi</code><spanclass="sig-paren">(</span><em>original</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#roi"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.roi"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Transformations.smoothing">
<codeclass="descclassname">pyFTS.common.Transformations.</code><codeclass="descname">smoothing</code><spanclass="sig-paren">(</span><em>original</em>, <em>lags</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Transformations.html#smoothing"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Transformations.smoothing"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<divclass="section"id="module-pyFTS.common.Util">
<spanid="pyfts-common-util-module"></span><h2>pyFTS.common.Util module<aclass="headerlink"href="#module-pyFTS.common.Util"title="Permalink to this headline">¶</a></h2>
<p>Common facilities for pyFTS</p>
<dlclass="function">
<dtid="pyFTS.common.Util.current_milli_time">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">current_milli_time</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#pyFTS.common.Util.current_milli_time"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.distributed_predict">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">distributed_predict</code><spanclass="sig-paren">(</span><em>model</em>, <em>parameters</em>, <em>nodes</em>, <em>data</em>, <em>num_batches</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#distributed_predict"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.distributed_predict"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.distributed_train">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">distributed_train</code><spanclass="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><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#distributed_train"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.distributed_train"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.draw_sets_on_axis">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">draw_sets_on_axis</code><spanclass="sig-paren">(</span><em>axis</em>, <em>model</em>, <em>size</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#draw_sets_on_axis"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.draw_sets_on_axis"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.enumerate2">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">enumerate2</code><spanclass="sig-paren">(</span><em>xs</em>, <em>start=0</em>, <em>step=1</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#enumerate2"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.enumerate2"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.load_env">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">load_env</code><spanclass="sig-paren">(</span><em>file</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#load_env"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.load_env"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.load_obj">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">load_obj</code><spanclass="sig-paren">(</span><em>file</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#load_obj"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>file</strong>– file name where the object is stored</td>
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">persist_env</code><spanclass="sig-paren">(</span><em>file</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#persist_env"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>file</strong>– file name to store the environment</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.persist_obj">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">persist_obj</code><spanclass="sig-paren">(</span><em>obj</em>, <em>file</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#persist_obj"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="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>
<dlclass="function">
<dtid="pyFTS.common.Util.plot_rules">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">plot_rules</code><spanclass="sig-paren">(</span><em>model, size=[5, 5], axis=None, rules_by_axis=None, columns=1</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#plot_rules"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.plot_rules"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.show_and_save_image">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">show_and_save_image</code><spanclass="sig-paren">(</span><em>fig</em>, <em>file</em>, <em>flag</em>, <em>lgd=None</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#show_and_save_image"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.show_and_save_image"title="Permalink to this definition">¶</a></dt>
<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>
<dlclass="function">
<dtid="pyFTS.common.Util.simple_model_predict">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">simple_model_predict</code><spanclass="sig-paren">(</span><em>model</em>, <em>data</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#simple_model_predict"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.simple_model_predict"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.simple_model_train">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">simple_model_train</code><spanclass="sig-paren">(</span><em>model</em>, <em>data</em>, <em>parameters</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#simple_model_train"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.simple_model_train"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.sliding_window">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">sliding_window</code><spanclass="sig-paren">(</span><em>data</em>, <em>windowsize</em>, <em>train=0.8</em>, <em>inc=0.1</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#sliding_window"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">window count, training set, test set</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.start_dispy_cluster">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">start_dispy_cluster</code><spanclass="sig-paren">(</span><em>method</em>, <em>nodes</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#start_dispy_cluster"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.start_dispy_cluster"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.stop_dispy_cluster">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">stop_dispy_cluster</code><spanclass="sig-paren">(</span><em>cluster</em>, <em>http_server</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#stop_dispy_cluster"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.stop_dispy_cluster"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.Util.uniquefilename">
<codeclass="descclassname">pyFTS.common.Util.</code><codeclass="descname">uniquefilename</code><spanclass="sig-paren">(</span><em>name</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/Util.html#uniquefilename"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.Util.uniquefilename"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<divclass="section"id="module-pyFTS.common.flrg">
<spanid="pyfts-common-flrg-module"></span><h2>pyFTS.common.flrg module<aclass="headerlink"href="#module-pyFTS.common.flrg"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pyFTS.common.flrg.FLRG">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.flrg.</code><codeclass="descname">FLRG</code><spanclass="sig-paren">(</span><em>order</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.flrg.FLRG"title="Permalink to this definition">¶</a></dt>
<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>
<dlclass="attribute">
<dtid="pyFTS.common.flrg.FLRG.LHS">
<codeclass="descname">LHS</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.flrg.FLRG.RHS">
<codeclass="descname">RHS</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.flrg.FLRG.append_rhs">
<codeclass="descname">append_rhs</code><spanclass="sig-paren">(</span><em>set</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.append_rhs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.flrg.FLRG.append_rhs"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="pyFTS.common.flrg.FLRG.get_key">
<codeclass="descname">get_key</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.get_key"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.flrg.FLRG.get_lower">
<codeclass="descname">get_lower</code><spanclass="sig-paren">(</span><em>sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.get_lower"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">get_membership</code><spanclass="sig-paren">(</span><em>data</em>, <em>sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.get_membership"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">get_midpoint</code><spanclass="sig-paren">(</span><em>sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.get_midpoint"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">get_midpoints</code><spanclass="sig-paren">(</span><em>sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.get_midpoints"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.flrg.FLRG.get_midpoints"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="pyFTS.common.flrg.FLRG.get_upper">
<codeclass="descname">get_upper</code><spanclass="sig-paren">(</span><em>sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/flrg.html#FLRG.get_upper"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">order</code><emclass="property"> = None</em><aclass="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>
<divclass="section"id="module-pyFTS.common.fts">
<spanid="pyfts-common-fts-module"></span><h2>pyFTS.common.fts module<aclass="headerlink"href="#module-pyFTS.common.fts"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pyFTS.common.fts.FTS">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.fts.</code><codeclass="descname">FTS</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">alpha_cut</code><emclass="property"> = None</em><aclass="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>
<codeclass="descname">append_transformation</code><spanclass="sig-paren">(</span><em>transformation</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.append_transformation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.append_transformation"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply_inverse_transformations</code><spanclass="sig-paren">(</span><em>data</em>, <em>params=None</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.apply_inverse_transformations"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">apply_transformations</code><spanclass="sig-paren">(</span><em>data</em>, <em>params=None</em>, <em>updateUoD=False</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.apply_transformations"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">auto_update</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.benchmark_only">
<codeclass="descname">benchmark_only</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.clone_parameters">
<codeclass="descname">clone_parameters</code><spanclass="sig-paren">(</span><em>model</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.clone_parameters"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<codeclass="descname">detail</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.fit">
<codeclass="descname">fit</code><spanclass="sig-paren">(</span><em>ndata</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.fit"><spanclass="viewcode-link">[source]</span></a><aclass="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>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.flrgs">
<codeclass="descname">flrgs</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.forecast">
<codeclass="descname">forecast</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.forecast"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.forecast"title="Permalink to this definition">¶</a></dt>
<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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">a list with the forecasted values</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.forecast_ahead">
<codeclass="descname">forecast_ahead</code><spanclass="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.forecast_ahead"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">forecast_ahead_distribution</code><spanclass="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_distribution"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.forecast_ahead_distribution"title="Permalink to this definition">¶</a></dt>
<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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">a list with the forecasted Probability Distributions</p>
<codeclass="descname">forecast_ahead_interval</code><spanclass="sig-paren">(</span><em>data</em>, <em>steps</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.forecast_ahead_interval"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.forecast_ahead_interval"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">forecast_distribution</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.forecast_distribution"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.forecast_distribution"title="Permalink to this definition">¶</a></dt>
<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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">a list with the forecasted Probability Distributions</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.forecast_interval">
<codeclass="descname">forecast_interval</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.forecast_interval"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.forecast_interval"title="Permalink to this definition">¶</a></dt>
<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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">a list with the forecasted intervals</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.fuzzy">
<codeclass="descname">fuzzy</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.fuzzy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.fuzzy"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_UoD</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.get_UoD"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.get_UoD"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">has_interval_forecasting</code><emclass="property"> = None</em><aclass="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>
<codeclass="descname">has_point_forecasting</code><emclass="property"> = None</em><aclass="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>
<codeclass="descname">has_probability_forecasting</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.has_seasonality">
<codeclass="descname">has_seasonality</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.indexer">
<codeclass="descname">indexer</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.is_high_order">
<codeclass="descname">is_high_order</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.is_multivariate">
<codeclass="descname">is_multivariate</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.len_total">
<codeclass="descname">len_total</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.len_total"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.len_total"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.max_lag">
<codeclass="descname">max_lag</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.merge">
<codeclass="descname">merge</code><spanclass="sig-paren">(</span><em>model</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.merge"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.merge"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">min_order</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.name">
<codeclass="descname">name</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.order">
<codeclass="descname">order</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.original_max">
<codeclass="descname">original_max</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.original_min">
<codeclass="descname">original_min</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.partitioner">
<codeclass="descname">partitioner</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.predict">
<codeclass="descname">predict</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.predict"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.predict"title="Permalink to this definition">¶</a></dt>
<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>
<trclass="field-even field"><thclass="field-name">Returns:</th><tdclass="field-body"><pclass="first last">a numpy array with the forecasted data</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.sets">
<codeclass="descname">sets</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.shortname">
<codeclass="descname">shortname</code><emclass="property"> = None</em><aclass="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>
<dlclass="method">
<dtid="pyFTS.common.fts.FTS.train">
<codeclass="descname">train</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/fts.html#FTS.train"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.fts.FTS.train"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.transformations">
<codeclass="descname">transformations</code><emclass="property"> = None</em><aclass="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>
<codeclass="descname">transformations_param</code><emclass="property"> = None</em><aclass="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>
<dlclass="attribute">
<dtid="pyFTS.common.fts.FTS.uod_clip">
<codeclass="descname">uod_clip</code><emclass="property"> = None</em><aclass="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>
<divclass="section"id="module-pyFTS.common.tree">
<spanid="pyfts-common-tree-module"></span><h2>pyFTS.common.tree module<aclass="headerlink"href="#module-pyFTS.common.tree"title="Permalink to this headline">¶</a></h2>
<p>Tree data structure</p>
<dlclass="class">
<dtid="pyFTS.common.tree.FLRGTree">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.tree.</code><codeclass="descname">FLRGTree</code><aclass="reference internal"href="_modules/pyFTS/common/tree.html#FLRGTree"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.FLRGTree"title="Permalink to this definition">¶</a></dt>
<p>Represents a FLRG set with a tree structure</p>
</dd></dl>
<dlclass="class">
<dtid="pyFTS.common.tree.FLRGTreeNode">
<emclass="property">class </em><codeclass="descclassname">pyFTS.common.tree.</code><codeclass="descname">FLRGTreeNode</code><spanclass="sig-paren">(</span><em>value</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#FLRGTreeNode"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.FLRGTreeNode"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">appendChild</code><spanclass="sig-paren">(</span><em>child</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#FLRGTreeNode.appendChild"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.FLRGTreeNode.appendChild"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">getChildren</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#FLRGTreeNode.getChildren"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.FLRGTreeNode.getChildren"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="pyFTS.common.tree.FLRGTreeNode.getStr">
<codeclass="descname">getStr</code><spanclass="sig-paren">(</span><em>k</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#FLRGTreeNode.getStr"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.FLRGTreeNode.getStr"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="method">
<dtid="pyFTS.common.tree.FLRGTreeNode.paths">
<codeclass="descname">paths</code><spanclass="sig-paren">(</span><em>acc=[]</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#FLRGTreeNode.paths"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.FLRGTreeNode.paths"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.common.tree.</code><codeclass="descname">build_tree_without_order</code><spanclass="sig-paren">(</span><em>node</em>, <em>lags</em>, <em>level</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#build_tree_without_order"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.build_tree_without_order"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dlclass="function">
<dtid="pyFTS.common.tree.flat">
<codeclass="descclassname">pyFTS.common.tree.</code><codeclass="descname">flat</code><spanclass="sig-paren">(</span><em>dados</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/common/tree.html#flat"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.common.tree.flat"title="Permalink to this definition">¶</a></dt>
