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

725 lines
66 KiB
HTML
Raw Normal View History

Incremental module
2018-11-01 18:11:20 +04:00
<!doctype html>
Documentation update
2020-08-19 00:06:41 +04:00
<html>
Incremental module
2018-11-01 18:11:20 +04:00
<head>
Documentation update
2020-08-19 00:06:41 +04:00
<meta charset="utf-8" />
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pyFTS.models.incremental package &#8212; pyFTS 1.7 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/bizstyle.css" />
Documentation update
2020-08-19 00:06:41 +04:00
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Documentation update
2020-08-19 00:06:41 +04:00
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/bizstyle.js"></script>
Incremental module
2018-11-01 18:11:20 +04:00
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pyFTS.models.multivariate package" href="pyFTS.models.multivariate.html" />
<link rel="prev" title="pyFTS.models.ensemble package" href="pyFTS.models.ensemble.html" />
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<meta name="viewport" content="width=device-width,initial-scale=1.0" />
Incremental module
2018-11-01 18:11:20 +04:00
<!--[if lt IE 9]>
Documentation update
2020-08-19 00:06:41 +04:00
<script src="_static/css3-mediaqueries.js"></script>
Incremental module
2018-11-01 18:11:20 +04:00
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.models.multivariate.html" title="pyFTS.models.multivariate package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyFTS.models.ensemble.html" title="pyFTS.models.ensemble package"
accesskey="P">previous</a> |</li>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.7 documentation</a> &#187;</li>
Incremental module
2018-11-01 18:11:20 +04:00
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
Documentation update
2020-08-19 00:06:41 +04:00
<li class="nav-item nav-item-3"><a href="pyFTS.models.html" accesskey="U">pyFTS.models package</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyFTS.models.incremental package</a></li>
Incremental module
2018-11-01 18:11:20 +04:00
</ul>
Documentation update
2020-08-19 00:06:41 +04:00
</div>
Incremental module
2018-11-01 18:11:20 +04:00
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="pyfts-models-incremental-package">
<h1>pyFTS.models.incremental package<a class="headerlink" href="#pyfts-models-incremental-package" title="Permalink to this headline"></a></h1>
<div class="section" id="module-pyFTS.models.incremental">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-pyFTS.models.incremental" title="Permalink to this headline"></a></h2>
<p>FTS methods with incremental/online learning</p>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
Documentation update
2021-01-13 01:04:42 +04:00
<div class="section" id="module-pyFTS.models.incremental.TimeVariant">
<span id="pyfts-models-incremental-timevariant-module"></span><h2>pyFTS.models.incremental.TimeVariant module<a class="headerlink" href="#module-pyFTS.models.incremental.TimeVariant" title="Permalink to this headline"></a></h2>
<p>Meta model that wraps another FTS method and continously retrain it using a data window with
the most recent data</p>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.incremental.TimeVariant.</span></span><span class="sig-name descname"><span class="pre">Retrainer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/TimeVariant.html#Retrainer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="pyFTS.common.html#pyFTS.common.fts.FTS" title="pyFTS.common.fts.FTS"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.common.fts.FTS</span></code></a></p>
<p>Meta model for incremental/online learning that retrain its internal model after
data windows controlled by the parameter ‘batch_size’, using as the training data a
window of recent lags, whose size is controlled by the parameter ‘window_length’.</p>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.alpha_cut">
<span class="sig-name descname"><span class="pre">alpha_cut</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.alpha_cut" title="Permalink to this definition"></a></dt>
<dd><p>A float with the minimal membership to be considered on fuzzyfication process</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.auto_update">
<span class="sig-name descname"><span class="pre">auto_update</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.auto_update" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>If true the model is updated at each time and not recreated</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.batch_size">
<span class="sig-name descname"><span class="pre">batch_size</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.batch_size" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The batch interval between each retraining</p>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.benchmark_only">
<span class="sig-name descname"><span class="pre">benchmark_only</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.benchmark_only" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating a façade for external (non-FTS) model used on benchmarks or ensembles.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.detail">
<span class="sig-name descname"><span class="pre">detail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.detail" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model detailed information</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.dump">
<span class="sig-name descname"><span class="pre">dump</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.dump" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.flrgs">
<span class="sig-name descname"><span class="pre">flrgs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><span class="pre">dict</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.flrgs" title="Permalink to this definition"></a></dt>
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.forecast">
<span class="sig-name descname"><span class="pre">forecast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/TimeVariant.html#Retrainer.forecast"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.forecast" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast one step ahead</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.forecast_ahead">
<span class="sig-name descname"><span class="pre">forecast_ahead</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/TimeVariant.html#Retrainer.forecast_ahead"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.forecast_ahead" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast from 1 to H steps ahead, where H is given by the steps parameter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast (default: 1)</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.fts_method">
<span class="sig-name descname"><span class="pre">fts_method</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.fts_method" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The FTS method to be called when a new model is build</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.fts_params">
<span class="sig-name descname"><span class="pre">fts_params</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.fts_params" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The FTS method specific parameters</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.has_interval_forecasting">
<span class="sig-name descname"><span class="pre">has_interval_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.has_interval_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports interval forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.has_point_forecasting">
<span class="sig-name descname"><span class="pre">has_point_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.has_point_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports point forecasting, default: True</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.has_probability_forecasting">
<span class="sig-name descname"><span class="pre">has_probability_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.has_probability_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support probabilistic forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.has_seasonality">
<span class="sig-name descname"><span class="pre">has_seasonality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.has_seasonality" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports seasonal indexers, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.is_clustered">
<span class="sig-name descname"><span class="pre">is_clustered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.is_clustered" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), but works like
a monovariate method, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.is_high_order">
<span class="sig-name descname"><span class="pre">is_high_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.is_high_order" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support orders greater than 1, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.is_multivariate">
<span class="sig-name descname"><span class="pre">is_multivariate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.is_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.is_time_variant">
<span class="sig-name descname"><span class="pre">is_time_variant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.is_time_variant" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if this model is time variant</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.is_wrapper">
<span class="sig-name descname"><span class="pre">is_wrapper</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.is_wrapper" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that this model is a wrapper for other(s) method(s)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.lags">
<span class="sig-name descname"><span class="pre">lags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.lags" title="Permalink to this definition"></a></dt>
<dd><p>The list of lag indexes for high order models</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.log">
<span class="sig-name descname"><span class="pre">log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">pd.DataFrame</span></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.log" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.max_lag">
<span class="sig-name descname"><span class="pre">max_lag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.max_lag" title="Permalink to this definition"></a></dt>
<dd><p>A integer indicating the largest lag used by the model. This value also indicates the minimum number of past lags
needed to forecast a single step ahead</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.min_order">
<span class="sig-name descname"><span class="pre">min_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.min_order" title="Permalink to this definition"></a></dt>
<dd><p>In high order models, this integer value indicates the minimal order supported for the model, default: 1</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.model">
<span class="sig-name descname"><span class="pre">model</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.model" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The most recent trained model</p>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.name" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model name</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.offset">
<span class="sig-name descname"><span class="pre">offset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/TimeVariant.html#Retrainer.offset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.offset" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Returns the number of lags to skip in the input test data in order to synchronize it with
the forecasted values given by the predict function. This is necessary due to the order of the
model, among other parameters.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>An integer with the number of lags to skip</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.order">
<span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.order" title="Permalink to this definition"></a></dt>
<dd><p>A integer with the model order (number of past lags are used on forecasting)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.original_max">
<span class="sig-name descname"><span class="pre">original_max</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.original_max" title="Permalink to this definition"></a></dt>
<dd><p>A float with the upper limit of the Universe of Discourse, the maximal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.original_min">
<span class="sig-name descname"><span class="pre">original_min</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.original_min" title="Permalink to this definition"></a></dt>
<dd><p>A float with the lower limit of the Universe of Discourse, the minimal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.partitioner">
<span class="sig-name descname"><span class="pre">partitioner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><span class="pre">partitioner.Partitioner</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.partitioner" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The most recent trained partitioner</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.partitioner_method">
<span class="sig-name descname"><span class="pre">partitioner_method</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.partitioner_method" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The partitioner method to be called when a new model is build</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.partitioner_params">
<span class="sig-name descname"><span class="pre">partitioner_params</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.partitioner_params" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The partitioner method parameters</p>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.shortname">
<span class="sig-name descname"><span class="pre">shortname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.shortname" title="Permalink to this definition"></a></dt>
<dd><p>A string with a short name or alias for the model</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.standard_horizon">
<span class="sig-name descname"><span class="pre">standard_horizon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.standard_horizon" title="Permalink to this definition"></a></dt>
<dd><p>Standard forecasting horizon (Default: 1)</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.train">
<span class="sig-name descname"><span class="pre">train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/TimeVariant.html#Retrainer.train"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.train" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Method specific parameter fitting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – Method specific parameters</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.transformations">
<span class="sig-name descname"><span class="pre">transformations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyFTS.common.transformations.html#pyFTS.common.transformations.transformation.Transformation" title="pyFTS.common.transformations.transformation.Transformation"><span class="pre">transformation.Transformation</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.transformations" title="Permalink to this definition"></a></dt>
<dd><p>A list with the data transformations (common.Transformations) applied on model pre and post processing, default: []</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.transformations_param">
<span class="sig-name descname"><span class="pre">transformations_param</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.transformations_param" title="Permalink to this definition"></a></dt>
<dd><p>A list with the specific parameters for each data transformation</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.uod_clip">
<span class="sig-name descname"><span class="pre">uod_clip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.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>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.TimeVariant.Retrainer.window_length">
<span class="sig-name descname"><span class="pre">window_length</span></span><a class="headerlink" href="#pyFTS.models.incremental.TimeVariant.Retrainer.window_length" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The memory window length</p>
</dd></dl>
</dd></dl>
Updating the documentation
2019-02-21 19:00:09 +04:00
</div>
Documentation update
2021-01-13 01:04:42 +04:00
<div class="section" id="module-pyFTS.models.incremental.IncrementalEnsemble">
<span id="pyfts-models-incremental-incrementalensemble-module"></span><h2>pyFTS.models.incremental.IncrementalEnsemble module<a class="headerlink" href="#module-pyFTS.models.incremental.IncrementalEnsemble" title="Permalink to this headline"></a></h2>
<p>Time Variant/Incremental Ensemble of FTS methods</p>
<dl class="py class">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyFTS.models.incremental.IncrementalEnsemble.</span></span><span class="sig-name descname"><span class="pre">IncrementalEnsembleFTS</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/IncrementalEnsemble.html#IncrementalEnsembleFTS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Bases: <a class="reference internal" href="pyFTS.models.ensemble.html#pyFTS.models.ensemble.ensemble.EnsembleFTS" title="pyFTS.models.ensemble.ensemble.EnsembleFTS"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.models.ensemble.ensemble.EnsembleFTS</span></code></a></p>
<p>Time Variant/Incremental Ensemble of FTS methods</p>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.alpha_cut">
<span class="sig-name descname"><span class="pre">alpha_cut</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.alpha_cut" title="Permalink to this definition"></a></dt>
<dd><p>A float with the minimal membership to be considered on fuzzyfication process</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.auto_update">
<span class="sig-name descname"><span class="pre">auto_update</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.auto_update" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating that model is incremental</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.batch_size">
<span class="sig-name descname"><span class="pre">batch_size</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.batch_size" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The batch interval between each retraining</p>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.benchmark_only">
<span class="sig-name descname"><span class="pre">benchmark_only</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.benchmark_only" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating a façade for external (non-FTS) model used on benchmarks or ensembles.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.detail">
<span class="sig-name descname"><span class="pre">detail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.detail" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model detailed information</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.dump">
<span class="sig-name descname"><span class="pre">dump</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.dump" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.flrgs">
<span class="sig-name descname"><span class="pre">flrgs</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.10)"><span class="pre">dict</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.flrgs" title="Permalink to this definition"></a></dt>
<dd><p>The list of Fuzzy Logical Relationship Groups - FLRG</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.forecast">
<span class="sig-name descname"><span class="pre">forecast</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/IncrementalEnsemble.html#IncrementalEnsembleFTS.forecast"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.forecast" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast one step ahead</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>kwargs</strong> – model specific parameters</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.forecast_ahead">
<span class="sig-name descname"><span class="pre">forecast_ahead</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/IncrementalEnsemble.html#IncrementalEnsembleFTS.forecast_ahead"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.forecast_ahead" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Point forecast from 1 to H steps ahead, where H is given by the steps parameter</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – time series data with the minimal length equal to the max_lag of the model</p></li>
<li><p><strong>steps</strong> – the number of steps ahead to forecast (default: 1)</p></li>
<li><p><strong>start_at</strong> – in the multi step forecasting, the index of the data where to start forecasting (default: 0)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a list with the forecasted values</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.fts_method">
<span class="sig-name descname"><span class="pre">fts_method</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.fts_method" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The FTS method to be called when a new model is build</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.fts_params">
<span class="sig-name descname"><span class="pre">fts_params</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.fts_params" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The FTS method specific parameters</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_interval_forecasting">
<span class="sig-name descname"><span class="pre">has_interval_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_interval_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports interval forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_point_forecasting">
<span class="sig-name descname"><span class="pre">has_point_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_point_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports point forecasting, default: True</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_probability_forecasting">
<span class="sig-name descname"><span class="pre">has_probability_forecasting</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_probability_forecasting" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support probabilistic forecasting, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_seasonality">
<span class="sig-name descname"><span class="pre">has_seasonality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.has_seasonality" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model supports seasonal indexers, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_clustered">
<span class="sig-name descname"><span class="pre">is_clustered</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_clustered" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), but works like
a monovariate method, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_high_order">
<span class="sig-name descname"><span class="pre">is_high_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_high_order" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support orders greater than 1, default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_multivariate">
<span class="sig-name descname"><span class="pre">is_multivariate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_multivariate" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if the model support multivariate time series (Pandas DataFrame), default: False</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_time_variant">
<span class="sig-name descname"><span class="pre">is_time_variant</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_time_variant" title="Permalink to this definition"></a></dt>
<dd><p>A boolean value indicating if this model is time variant</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_wrapper">
<span class="sig-name descname"><span class="pre">is_wrapper</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.is_wrapper" title="Permalink to this definition"></a></dt>
<dd><p>Indicates that this model is a wrapper for other(s) method(s)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.lags">
<span class="sig-name descname"><span class="pre">lags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.lags" title="Permalink to this definition"></a></dt>
<dd><p>The list of lag indexes for high order models</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.log">
<span class="sig-name descname"><span class="pre">log</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">pd.DataFrame</span></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.log" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.max_lag">
<span class="sig-name descname"><span class="pre">max_lag</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.max_lag" title="Permalink to this definition"></a></dt>
<dd><p>A integer indicating the largest lag used by the model. This value also indicates the minimum number of past lags
needed to forecast a single step ahead</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.min_order">
<span class="sig-name descname"><span class="pre">min_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.min_order" title="Permalink to this definition"></a></dt>
<dd><p>In high order models, this integer value indicates the minimal order supported for the model, default: 1</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.name">
<span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.name" title="Permalink to this definition"></a></dt>
<dd><p>A string with the model name</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.num_models">
<span class="sig-name descname"><span class="pre">num_models</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.num_models" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The number of models to hold in the ensemble</p>
</dd></dl>
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.offset">
<span class="sig-name descname"><span class="pre">offset</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/IncrementalEnsemble.html#IncrementalEnsembleFTS.offset"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.offset" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Returns the number of lags to skip in the input test data in order to synchronize it with
the forecasted values given by the predict function. This is necessary due to the order of the
model, among other parameters.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>An integer with the number of lags to skip</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.order">
<span class="sig-name descname"><span class="pre">order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.order" title="Permalink to this definition"></a></dt>
<dd><p>A integer with the model order (number of past lags are used on forecasting)</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.original_max">
<span class="sig-name descname"><span class="pre">original_max</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.original_max" title="Permalink to this definition"></a></dt>
<dd><p>A float with the upper limit of the Universe of Discourse, the maximal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.original_min">
<span class="sig-name descname"><span class="pre">original_min</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.10)"><span class="pre">float</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.original_min" title="Permalink to this definition"></a></dt>
<dd><p>A float with the lower limit of the Universe of Discourse, the minimal value found on training data</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.partitioner">
<span class="sig-name descname"><span class="pre">partitioner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="pyFTS.partitioners.html#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><span class="pre">partitioner.Partitioner</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.partitioner" title="Permalink to this definition"></a></dt>
<dd><p>A pyFTS.partitioners.Partitioner object with the Universe of Discourse partitioner used on the model. This is a mandatory dependecy.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.partitioner_method">
<span class="sig-name descname"><span class="pre">partitioner_method</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.partitioner_method" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The partitioner method to be called when a new model is build</p>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.partitioner_params">
<span class="sig-name descname"><span class="pre">partitioner_params</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.partitioner_params" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The partitioner method parameters</p>
</dd></dl>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.shortname">
<span class="sig-name descname"><span class="pre">shortname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><span class="pre">str</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.shortname" title="Permalink to this definition"></a></dt>
<dd><p>A string with a short name or alias for the model</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.standard_horizon">
<span class="sig-name descname"><span class="pre">standard_horizon</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><span class="pre">int</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.standard_horizon" title="Permalink to this definition"></a></dt>
<dd><p>Standard forecasting horizon (Default: 1)</p>
</dd></dl>
Documentation update
2021-01-13 01:04:42 +04:00
<dl class="py method">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.train">
<span class="sig-name descname"><span class="pre">train</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/models/incremental/IncrementalEnsemble.html#IncrementalEnsembleFTS.train"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.train" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>Method specific parameter fitting</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>data</strong> – training time series data</p></li>
<li><p><strong>kwargs</strong> – Method specific parameters</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.transformations">
<span class="sig-name descname"><span class="pre">transformations</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="pyFTS.common.transformations.html#pyFTS.common.transformations.transformation.Transformation" title="pyFTS.common.transformations.transformation.Transformation"><span class="pre">transformation.Transformation</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.transformations" title="Permalink to this definition"></a></dt>
<dd><p>A list with the data transformations (common.Transformations) applied on model pre and post processing, default: []</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.transformations_param">
<span class="sig-name descname"><span class="pre">transformations_param</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.10)"><span class="pre">list</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.transformations_param" title="Permalink to this definition"></a></dt>
<dd><p>A list with the specific parameters for each data transformation</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.uod_clip">
<span class="sig-name descname"><span class="pre">uod_clip</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.10)"><span class="pre">bool</span></a></em><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.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>
<dl class="py attribute">
<dt class="sig sig-object py" id="pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.window_length">
<span class="sig-name descname"><span class="pre">window_length</span></span><a class="headerlink" href="#pyFTS.models.incremental.IncrementalEnsemble.IncrementalEnsembleFTS.window_length" title="Permalink to this definition"></a></dt>
Documentation update
2021-01-13 01:04:42 +04:00
<dd><p>The memory window length</p>
</dd></dl>
</dd></dl>
Incremental module
2018-11-01 18:11:20 +04:00
</div>
</div>
Documentation update
2020-08-19 00:06:41 +04:00
<div class="clearer"></div>
Incremental module
2018-11-01 18:11:20 +04:00
</div>
</div>
</div>
Documentation update
2020-08-19 00:06:41 +04:00
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<div>
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
Documentation update
2020-08-19 00:06:41 +04:00
<li><a class="reference internal" href="#">pyFTS.models.incremental package</a><ul>
<li><a class="reference internal" href="#module-pyFTS.models.incremental">Module contents</a></li>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
Documentation update
2021-01-13 01:04:42 +04:00
<li><a class="reference internal" href="#module-pyFTS.models.incremental.TimeVariant">pyFTS.models.incremental.TimeVariant module</a></li>
<li><a class="reference internal" href="#module-pyFTS.models.incremental.IncrementalEnsemble">pyFTS.models.incremental.IncrementalEnsemble module</a></li>
Documentation update
2020-08-19 00:06:41 +04:00
</ul>
</li>
</ul>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="pyFTS.models.ensemble.html"
title="previous chapter">pyFTS.models.ensemble package</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="pyFTS.models.multivariate.html"
title="next chapter">pyFTS.models.multivariate package</a></p>
</div>
Documentation update
2020-08-19 00:06:41 +04:00
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/pyFTS.models.incremental.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
Documentation update
2020-08-19 00:06:41 +04:00
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
Incremental module
2018-11-01 18:11:20 +04:00
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="pyFTS.models.multivariate.html" title="pyFTS.models.multivariate package"
>next</a> |</li>
<li class="right" >
<a href="pyFTS.models.ensemble.html" title="pyFTS.models.ensemble package"
>previous</a> |</li>
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
<li class="nav-item nav-item-0"><a href="index.html">pyFTS 1.7 documentation</a> &#187;</li>
Incremental module
2018-11-01 18:11:20 +04:00
<li class="nav-item nav-item-1"><a href="modules.html" >pyFTS</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="pyFTS.html" >pyFTS package</a> &#187;</li>
Documentation update
2020-08-19 00:06:41 +04:00
<li class="nav-item nav-item-3"><a href="pyFTS.models.html" >pyFTS.models package</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyFTS.models.incremental package</a></li>
Incremental module
2018-11-01 18:11:20 +04:00
</ul>
</div>
<div class="footer" role="contentinfo">
Fixing documentation and type hints
2022-04-10 21:32:24 +04:00
&#169; Copyright 2022, Machine Intelligence and Data Science Laboratory - UFMG - Brazil.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
Incremental module
2018-11-01 18:11:20 +04:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink