<spanid="module-contents"></span><h2>Module contents<aclass="headerlink"href="#module-pyFTS.models.multivariate"title="Permalink to this headline">¶</a></h2>
<spanid="pyfts-models-multivariate-flr-module"></span><h2>pyFTS.models.multivariate.FLR module<aclass="headerlink"href="#module-pyFTS.models.multivariate.FLR"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pyFTS.models.multivariate.FLR.FLR">
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.FLR.</code><codeclass="descname">FLR</code><aclass="reference internal"href="_modules/pyFTS/models/multivariate/FLR.html#FLR"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.FLR.FLR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_lhs</code><spanclass="sig-paren">(</span><em>var</em>, <em>set</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/FLR.html#FLR.set_lhs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.FLR.FLR.set_lhs"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">set_rhs</code><spanclass="sig-paren">(</span><em>set</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/FLR.html#FLR.set_rhs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.FLR.FLR.set_rhs"title="Permalink to this definition">¶</a></dt>
<spanid="pyfts-models-multivariate-common-module"></span><h2>pyFTS.models.multivariate.common module<aclass="headerlink"href="#module-pyFTS.models.multivariate.common"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.common.</code><codeclass="descname">MultivariateFuzzySet</code><spanclass="sig-paren">(</span><em>name</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/common.html#MultivariateFuzzySet"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.common.MultivariateFuzzySet"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">append_set</code><spanclass="sig-paren">(</span><em>variable</em>, <em>set</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/common.html#MultivariateFuzzySet.append_set"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.common.MultivariateFuzzySet.append_set"title="Permalink to this definition">¶</a></dt>
<dd><p>Appends a new fuzzy set from a new variable</p>
<codeclass="descname">membership</code><spanclass="sig-paren">(</span><em>x</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/common.html#MultivariateFuzzySet.membership"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.common.MultivariateFuzzySet.membership"title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate the membership value of a given input</p>
<codeclass="descclassname">pyFTS.models.multivariate.common.</code><codeclass="descname">fuzzyfy_instance</code><spanclass="sig-paren">(</span><em>data_point</em>, <em>var</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/common.html#fuzzyfy_instance"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.common.fuzzyfy_instance"title="Permalink to this definition">¶</a></dt>
<codeclass="descclassname">pyFTS.models.multivariate.common.</code><codeclass="descname">fuzzyfy_instance_clustered</code><spanclass="sig-paren">(</span><em>data_point</em>, <em>cluster</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/common.html#fuzzyfy_instance_clustered"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.common.fuzzyfy_instance_clustered"title="Permalink to this definition">¶</a></dt>
<spanid="pyfts-models-multivariate-variable-module"></span><h2>pyFTS.models.multivariate.variable module<aclass="headerlink"href="#module-pyFTS.models.multivariate.variable"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.variable.</code><codeclass="descname">Variable</code><spanclass="sig-paren">(</span><em>name</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/variable.html#Variable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">alias</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable.alias"title="Permalink to this definition">¶</a></dt>
<dd><p>A string with the alias of the variable</p>
<codeclass="descname">apply_inverse_transformations</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/variable.html#Variable.apply_inverse_transformations"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable.apply_inverse_transformations"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">apply_transformations</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/variable.html#Variable.apply_transformations"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable.apply_transformations"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">build</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/variable.html#Variable.build"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable.build"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">data_label</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable.data_label"title="Permalink to this definition">¶</a></dt>
<dd><p>A string with the column name on DataFrame</p>
<codeclass="descname">name</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.variable.Variable.name"title="Permalink to this definition">¶</a></dt>
<spanid="pyfts-models-multivariate-flrg-module"></span><h2>pyFTS.models.multivariate.flrg module<aclass="headerlink"href="#module-pyFTS.models.multivariate.flrg"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pyFTS.models.multivariate.flrg.FLRG">
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.flrg.</code><codeclass="descname">FLRG</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/flrg.html#FLRG"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.flrg.FLRG"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">append_rhs</code><spanclass="sig-paren">(</span><em>fset</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/flrg.html#FLRG.append_rhs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.flrg.FLRG.append_rhs"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_membership</code><spanclass="sig-paren">(</span><em>data</em>, <em>variables</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/flrg.html#FLRG.get_membership"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.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">set_lhs</code><spanclass="sig-paren">(</span><em>var</em>, <em>fset</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/flrg.html#FLRG.set_lhs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.flrg.FLRG.set_lhs"title="Permalink to this definition">¶</a></dt>
<spanid="pyfts-models-multivariate-mvfts-module"></span><h2>pyFTS.models.multivariate.mvfts module<aclass="headerlink"href="#module-pyFTS.models.multivariate.mvfts"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="pyFTS.models.multivariate.mvfts.MVFTS">
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.mvfts.</code><codeclass="descname">MVFTS</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">append_variable</code><spanclass="sig-paren">(</span><em>var</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.append_variable"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.append_variable"title="Permalink to this definition">¶</a></dt>
<dd><p>Append a new endogenous variable to the model</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/models/multivariate/mvfts.html#MVFTS.apply_transformations"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.apply_transformations"title="Permalink to this definition">¶</a></dt>
<dd><p>Apply the data transformations for data preprocessing</p>
<codeclass="descname">clone_parameters</code><spanclass="sig-paren">(</span><em>model</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.clone_parameters"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.clone_parameters"title="Permalink to this definition">¶</a></dt>
<dd><p>Import the parameters values from other model</p>
<codeclass="descname">forecast</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.forecast"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.forecast"title="Permalink to this definition">¶</a></dt>
<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/models/multivariate/mvfts.html#MVFTS.forecast_ahead"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.forecast_ahead"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">format_data</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.format_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.format_data"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">generate_flrg</code><spanclass="sig-paren">(</span><em>flrs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.generate_flrg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.generate_flrg"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">generate_flrs</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.generate_flrs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.generate_flrs"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">generate_lhs_flrs</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.generate_lhs_flrs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.generate_lhs_flrs"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">train</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/mvfts.html#MVFTS.train"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.mvfts.MVFTS.train"title="Permalink to this definition">¶</a></dt>
<spanid="pyfts-models-multivariate-wmvfts-module"></span><h2>pyFTS.models.multivariate.wmvfts module<aclass="headerlink"href="#module-pyFTS.models.multivariate.wmvfts"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.wmvfts.</code><codeclass="descname">WeightedFLRG</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/wmvfts.html#WeightedFLRG"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.wmvfts.WeightedFLRG"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">append_rhs</code><spanclass="sig-paren">(</span><em>fset</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/wmvfts.html#WeightedFLRG.append_rhs"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.wmvfts.WeightedFLRG.append_rhs"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">get_midpoint</code><spanclass="sig-paren">(</span><em>sets</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/wmvfts.html#WeightedFLRG.get_midpoint"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.wmvfts.WeightedFLRG.get_midpoint"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the midpoint value for the RHS fuzzy sets</p>
<codeclass="descname">weights</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/wmvfts.html#WeightedFLRG.weights"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.wmvfts.WeightedFLRG.weights"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.wmvfts.</code><codeclass="descname">WeightedMVFTS</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/wmvfts.html#WeightedMVFTS"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.wmvfts.WeightedMVFTS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">generate_flrg</code><spanclass="sig-paren">(</span><em>flrs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/wmvfts.html#WeightedMVFTS.generate_flrg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.wmvfts.WeightedMVFTS.generate_flrg"title="Permalink to this definition">¶</a></dt>
<spanid="pyfts-models-multivariate-cmvfts-module"></span><h2>pyFTS.models.multivariate.cmvfts module<aclass="headerlink"href="#module-pyFTS.models.multivariate.cmvfts"title="Permalink to this headline">¶</a></h2>
<emclass="property">class </em><codeclass="descclassname">pyFTS.models.multivariate.cmvfts.</code><codeclass="descname">ClusteredMVFTS</code><spanclass="sig-paren">(</span><em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/cmvfts.html#ClusteredMVFTS"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">check_data</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/cmvfts.html#ClusteredMVFTS.check_data"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.check_data"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">cluster</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.cluster"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">cluster_method</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.cluster_method"title="Permalink to this definition">¶</a></dt>
<dd><p>The cluster method to be called when a new model is build</p>
<codeclass="descname">cluster_params</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.cluster_params"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">forecast</code><spanclass="sig-paren">(</span><em>ndata</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/cmvfts.html#ClusteredMVFTS.forecast"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.forecast"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">forecast_multivariate</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/cmvfts.html#ClusteredMVFTS.forecast_multivariate"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.forecast_multivariate"title="Permalink to this definition">¶</a></dt>
<li><strong>data</strong>– Pandas dataframe with one column for each variable and 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 Pandas Dataframe object representing the forecasted values for each variable</p>
<codeclass="descname">fts_method</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.fts_method"title="Permalink to this definition">¶</a></dt>
<dd><p>The FTS method to be called when a new model is build</p>
<codeclass="descname">fts_params</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.fts_params"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">fuzzyfy</code><spanclass="sig-paren">(</span><em>data</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/cmvfts.html#ClusteredMVFTS.fuzzyfy"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.fuzzyfy"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">model</code><emclass="property"> = None</em><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.model"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">train</code><spanclass="sig-paren">(</span><em>data</em>, <em>**kwargs</em><spanclass="sig-paren">)</span><aclass="reference internal"href="_modules/pyFTS/models/multivariate/cmvfts.html#ClusteredMVFTS.train"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#pyFTS.models.multivariate.cmvfts.ClusteredMVFTS.train"title="Permalink to this definition">¶</a></dt>