sam/pyFTS
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation update

Browse Source
This commit is contained in:
Petrônio Cândido 2018-12-12 19:41:52 -02:00
parent 2e186605f7
commit 4d3680ecf6
11 changed files with 47 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
docs/build/doctrees/pyFTS.partitioners.doctree vendored
View File

Binary file not shown.

1
docs/build/html/_modules/index.html vendored
View File

@ -152,6 +152,7 @@
<li><a href="pyFTS/partitioners/FCM.html">pyFTS.partitioners.FCM</a></li>
<li><a href="pyFTS/partitioners/Grid.html">pyFTS.partitioners.Grid</a></li>
<li><a href="pyFTS/partitioners/Huarng.html">pyFTS.partitioners.Huarng</a></li>
<li><a href="pyFTS/partitioners/Simple.html">pyFTS.partitioners.Simple</a></li>
<li><a href="pyFTS/partitioners/Singleton.html">pyFTS.partitioners.Singleton</a></li>
<li><a href="pyFTS/partitioners/Util.html">pyFTS.partitioners.Util</a></li>
<li><a href="pyFTS/partitioners/parallel_util.html">pyFTS.partitioners.parallel_util</a></li>

2
docs/build/html/_sources/pyFTS.partitioners.rst.txt vendored
View File

@ -71,7 +71,7 @@ pyFTS.partitioners.Singleton module
pyFTS.partitioners.Simple module
--------------------------------
.. automodule:: pyFTS.partitioners.Sinple
.. automodule:: pyFTS.partitioners.Simple
:members:
:undoc-members:
:show-inheritance:

6
docs/build/html/genindex.html vendored
View File

@ -131,6 +131,8 @@
<li><a href="pyFTS.common.html#pyFTS.common.Composite.FuzzySet.append">append() (pyFTS.common.Composite.FuzzySet method)</a>
<ul>
<li><a href="pyFTS.partitioners.html#pyFTS.partitioners.Simple.SimplePartitioner.append">(pyFTS.partitioners.Simple.SimplePartitioner method)</a>
</li>
<li><a href="pyFTS.probabilistic.html#pyFTS.probabilistic.ProbabilityDistribution.ProbabilityDistribution.append">(pyFTS.probabilistic.ProbabilityDistribution.ProbabilityDistribution method)</a>
</li>
</ul></li>
@ -1697,6 +1699,8 @@
<li><a href="pyFTS.partitioners.html#module-pyFTS.partitioners.parallel_util">pyFTS.partitioners.parallel_util (module)</a>
</li>
<li><a href="pyFTS.partitioners.html#module-pyFTS.partitioners.partitioner">pyFTS.partitioners.partitioner (module)</a>
</li>
<li><a href="pyFTS.partitioners.html#module-pyFTS.partitioners.Simple">pyFTS.partitioners.Simple (module)</a>
</li>
<li><a href="pyFTS.partitioners.html#module-pyFTS.partitioners.Singleton">pyFTS.partitioners.Singleton (module)</a>
</li>
@ -1851,6 +1855,8 @@
<li><a href="pyFTS.models.nonstationary.html#pyFTS.models.nonstationary.partitioners.simplenonstationary_gridpartitioner_builder">simplenonstationary_gridpartitioner_builder() (in module pyFTS.models.nonstationary.partitioners)</a>
</li>
<li><a href="pyFTS.models.nonstationary.html#pyFTS.models.nonstationary.partitioners.SimpleNonStationaryPartitioner">SimpleNonStationaryPartitioner (class in pyFTS.models.nonstationary.partitioners)</a>
</li>
<li><a href="pyFTS.partitioners.html#pyFTS.partitioners.Simple.SimplePartitioner">SimplePartitioner (class in pyFTS.partitioners.Simple)</a>
</li>
<li><a href="pyFTS.benchmarks.html#pyFTS.benchmarks.benchmarks.simpleSearch_RMSE">simpleSearch_RMSE() (in module pyFTS.benchmarks.benchmarks)</a>
</li>

BIN
docs/build/html/objects.inv vendored
View File

Binary file not shown.

5
docs/build/html/py-modindex.html vendored
View File

@ -565,6 +565,11 @@
<td>&#160;&#160;&#160;
<a href="pyFTS.partitioners.html#module-pyFTS.partitioners.partitioner"><code class="xref">pyFTS.partitioners.partitioner</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="pyFTS.partitioners.html#module-pyFTS.partitioners.Simple"><code class="xref">pyFTS.partitioners.Simple</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;

2
docs/build/html/pyFTS.html vendored
View File

@ -249,7 +249,7 @@
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#module-pyFTS.partitioners.Grid">pyFTS.partitioners.Grid module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#module-pyFTS.partitioners.Huarng">pyFTS.partitioners.Huarng module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#module-pyFTS.partitioners.Singleton">pyFTS.partitioners.Singleton module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#pyfts-partitioners-simple-module">pyFTS.partitioners.Simple module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#module-pyFTS.partitioners.Simple">pyFTS.partitioners.Simple module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#module-pyFTS.partitioners.Util">pyFTS.partitioners.Util module</a></li>
<li class="toctree-l2"><a class="reference internal" href="pyFTS.partitioners.html#module-pyFTS.partitioners.parallel_util">pyFTS.partitioners.parallel_util module</a></li>
</ul>

34
docs/build/html/pyFTS.partitioners.html vendored
View File

@ -72,7 +72,7 @@
<li><a class="reference internal" href="#module-pyFTS.partitioners.Grid">pyFTS.partitioners.Grid module</a></li>
<li><a class="reference internal" href="#module-pyFTS.partitioners.Huarng">pyFTS.partitioners.Huarng module</a></li>
<li><a class="reference internal" href="#module-pyFTS.partitioners.Singleton">pyFTS.partitioners.Singleton module</a></li>
<li><a class="reference internal" href="#pyfts-partitioners-simple-module">pyFTS.partitioners.Simple module</a></li>
<li><a class="reference internal" href="#module-pyFTS.partitioners.Simple">pyFTS.partitioners.Simple module</a></li>
<li><a class="reference internal" href="#module-pyFTS.partitioners.Util">pyFTS.partitioners.Util module</a></li>
<li><a class="reference internal" href="#module-pyFTS.partitioners.parallel_util">pyFTS.partitioners.parallel_util module</a></li>
</ul>
@ -505,8 +505,36 @@ Fuzzy Sets Syst., vol. 123, no. 3, pp. 387–394, Nov. 2001.</p>
</dd></dl>
</div>
<div class="section" id="pyfts-partitioners-simple-module">
<h2>pyFTS.partitioners.Simple module<a class="headerlink" href="#pyfts-partitioners-simple-module" title="Permalink to this headline"></a></h2>
<div class="section" id="module-pyFTS.partitioners.Simple">
<span id="pyfts-partitioners-simple-module"></span><h2>pyFTS.partitioners.Simple module<a class="headerlink" href="#module-pyFTS.partitioners.Simple" title="Permalink to this headline"></a></h2>
<p>Simple Partitioner for manually informed fuzzy sets</p>
<dl class="class">
<dt id="pyFTS.partitioners.Simple.SimplePartitioner">
<em class="property">class </em><code class="descclassname">pyFTS.partitioners.Simple.</code><code class="descname">SimplePartitioner</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/partitioners/Simple.html#SimplePartitioner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.partitioners.Simple.SimplePartitioner" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pyFTS.partitioners.partitioner.Partitioner" title="pyFTS.partitioners.partitioner.Partitioner"><code class="xref py py-class docutils literal notranslate"><span class="pre">pyFTS.partitioners.partitioner.Partitioner</span></code></a></p>
<p>Simple Partitioner for manually informed fuzzy sets</p>
<dl class="method">
<dt id="pyFTS.partitioners.Simple.SimplePartitioner.append">
<code class="descname">append</code><span class="sig-paren">(</span><em>name</em>, <em>mf</em>, <em>parameters</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pyFTS/partitioners/Simple.html#SimplePartitioner.append"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyFTS.partitioners.Simple.SimplePartitioner.append" title="Permalink to this definition"></a></dt>
<dd><p>Append a new partition (fuzzy set) to the partitioner</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Fuzzy set name</li>
<li><strong>mf</strong> – One of the pyFTS.common.Membership functions</li>
<li><strong>parameters</strong> – A list with the parameters for the membership function</li>
<li><strong>kwargs</strong> – Optional arguments for the fuzzy set</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-pyFTS.partitioners.Util">
<span id="pyfts-partitioners-util-module"></span><h2>pyFTS.partitioners.Util module<a class="headerlink" href="#module-pyFTS.partitioners.Util" title="Permalink to this headline"></a></h2>

2
docs/build/html/searchindex.js vendored
View File

File diff suppressed because one or more lines are too long

2
docs/pyFTS.partitioners.rst
View File

@ -71,7 +71,7 @@ pyFTS.partitioners.Singleton module
pyFTS.partitioners.Simple module
--------------------------------
.. automodule:: pyFTS.partitioners.Sinple
.. automodule:: pyFTS.partitioners.Simple
:members:
:undoc-members:
:show-inheritance: