update the documentation with the correct changelog link

wilsonrljr · Mar 5, 2022 · 7926460 · 7926460
1 parent 1df03c0
commit 7926460
Show file tree

Hide file tree

Showing 116 changed files with 1,073 additions and 1,031 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,6 +2,50 @@
 File for tracking changes in SysIdentPy
 --------------------------------------------------------------------------------------------------------------
 
+Changes in SysIdentPy
+=====================
+
+v0.1.9
+------
+
+CONTRIBUTORS
+~~~~~~~~~~~~
+
+- wilsonrljr
+- samirmartins
+
+CHANGES
+~~~~~~~
+- The update **v0.1.9**  has been released with additional feature, minor API changes and fixes of the new features added in v0.1.7. 
+
+- MAJOR: Entropic Regression Algorithm
+    - Added the new class ER to build NARX models using the Entropic Regression algorithm.
+    - Only the Mutual Information KNN is implemented in this version and it may take too long to run on a high number of regressor, so the user should be careful regarding the number of candidates to put in the model.
+
+- API: save_load
+    - Added a function to save and load models from file.
+
+- API: Added tests for python 3.9
+
+- Fix : Change condition for n_info_values in FROLS. Now the value defined by the user is compared against X matrix shape instead of regressor space shape. This fix the Fourier basis function usage with more the 15 regressors in FROLS.
+
+- DOC: Save and Load models
+    - Added a notebook showing how to use the save_load method.
+
+- DOC: Entropic Regression example 
+    - Added notebook with a simple example of how to use AOLS
+
+- DOC: Fourier Basis Function Example 
+    - Added notebook with a simple example of how to use Fourier Basis Function
+
+- DOC: PV forecasting benchmark
+    - FIX AOLS prediction. The example was using the meta_mss model in prediction, so the results for AOLS were wrong.
+
+- DOC: Fixed minor grammatical and spelling mistakes.
+
+- DOC: Fix issues related to html on Jupyter notebooks examples on documentation.
+
+
 v0.1.8
 ------
 

diff --git a/docs/_images/aols_4_0.png b/docs/_images/aols_4_0.png
diff --git a/docs/_images/basic_steps_17_0.png b/docs/_images/basic_steps_17_0.png
diff --git a/docs/_images/basic_steps_19_1.png b/docs/_images/basic_steps_19_1.png
diff --git a/docs/_images/basic_steps_23_1.png b/docs/_images/basic_steps_23_1.png
diff --git a/docs/_images/extended_least_squares_12_1.png b/docs/_images/extended_least_squares_12_1.png
diff --git a/docs/_images/extended_least_squares_14_1.png b/docs/_images/extended_least_squares_14_1.png
diff --git a/docs/_images/general_estimators_10_1.png b/docs/_images/general_estimators_10_1.png
diff --git a/docs/_images/general_estimators_10_11.png b/docs/_images/general_estimators_10_11.png
diff --git a/docs/_images/general_estimators_13_5.png b/docs/_images/general_estimators_13_5.png
diff --git a/docs/_images/general_estimators_13_51.png b/docs/_images/general_estimators_13_51.png
diff --git a/docs/_images/general_estimators_15_6.png b/docs/_images/general_estimators_15_6.png
diff --git a/docs/_images/general_estimators_15_61.png b/docs/_images/general_estimators_15_61.png
diff --git a/docs/_images/general_estimators_17_6.png b/docs/_images/general_estimators_17_6.png
diff --git a/docs/_images/general_estimators_17_61.png b/docs/_images/general_estimators_17_61.png
diff --git a/docs/_images/general_estimators_19_6.png b/docs/_images/general_estimators_19_6.png
diff --git a/docs/_images/general_estimators_19_61.png b/docs/_images/general_estimators_19_61.png
diff --git a/docs/_images/general_estimators_9_0.png b/docs/_images/general_estimators_9_0.png
diff --git a/docs/_images/general_estimators_9_01.png b/docs/_images/general_estimators_9_01.png
diff --git a/docs/_images/multiple_inputs_example_10_1.png b/docs/_images/multiple_inputs_example_10_1.png
diff --git a/docs/_images/multiple_inputs_example_11_1.png b/docs/_images/multiple_inputs_example_11_1.png
diff --git a/docs/_images/narx_neural_network_20_1.png b/docs/_images/narx_neural_network_20_1.png
diff --git a/docs/_images/narx_neural_network_20_2.png b/docs/_images/narx_neural_network_20_2.png
diff --git a/docs/_images/narx_neural_network_22_200.png b/docs/_images/narx_neural_network_22_200.png
diff --git a/docs/_images/narx_neural_network_22_2001.png b/docs/_images/narx_neural_network_22_2001.png
diff --git a/docs/_images/simulating_a_predefined_model_14_0.png b/docs/_images/simulating_a_predefined_model_14_0.png
diff --git a/docs/_images/simulating_a_predefined_model_15_0.png b/docs/_images/simulating_a_predefined_model_15_0.png
diff --git a/docs/_images/simulating_a_predefined_model_16_0.png b/docs/_images/simulating_a_predefined_model_16_0.png
diff --git a/docs/_images/simulating_a_predefined_model_8_0.png b/docs/_images/simulating_a_predefined_model_8_0.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../changelog/v0.1.8.html">
+  <a class="reference internal" href="../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/basis_function/_basis_function.html b/docs/_modules/sysidentpy/basis_function/_basis_function.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/general_estimators/narx.html b/docs/_modules/sysidentpy/general_estimators/narx.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/metaheuristics/bpsogsa.html b/docs/_modules/sysidentpy/metaheuristics/bpsogsa.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/metrics/_regression.html b/docs/_modules/sysidentpy/metrics/_regression.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/narmax_base.html b/docs/_modules/sysidentpy/narmax_base.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/parameter_estimation/estimators.html b/docs/_modules/sysidentpy/parameter_estimation/estimators.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/residues/residues_correlation.html b/docs/_modules/sysidentpy/residues/residues_correlation.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/simulation/_simulation.html b/docs/_modules/sysidentpy/simulation/_simulation.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/utils/_check_arrays.html b/docs/_modules/sysidentpy/utils/_check_arrays.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/utils/display_results.html b/docs/_modules/sysidentpy/utils/display_results.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/utils/generate_data.html b/docs/_modules/sysidentpy/utils/generate_data.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_modules/sysidentpy/utils/save_load.html b/docs/_modules/sysidentpy/utils/save_load.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../../../changelog/v0.1.8.html">
+  <a class="reference internal" href="../../../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -320,5 +320,5 @@ Contents
     dev_guide
     notebooks
     notebooksv016
-    changelog/v0.1.8
+    changelog/v0.1.9
     code
diff --git a/docs/changelog/v0.1.3.html b/docs/changelog/v0.1.3.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="v0.1.8.html">
+  <a class="reference internal" href="v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/changelog/v0.1.4.html b/docs/changelog/v0.1.4.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="v0.1.8.html">
+  <a class="reference internal" href="v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/changelog/v0.1.5.html b/docs/changelog/v0.1.5.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="v0.1.8.html">
+  <a class="reference internal" href="v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/changelog/v0.1.6.html b/docs/changelog/v0.1.6.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="v0.1.8.html">
+  <a class="reference internal" href="v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/changelog/v0.1.7.html b/docs/changelog/v0.1.7.html
@@ -299,7 +299,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="v0.1.8.html">
+  <a class="reference internal" href="v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/changelog/v0.1.8.html b/docs/changelog/v0.1.8.html
@@ -42,8 +42,6 @@
     <link rel="canonical" href="http://sysidentpy.org/changelog/v0.1.8.html" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Code" href="../code.html" />
-    <link rel="prev" title="V0.1.6 - Example: N-steps-ahead prediction - F-16 Ground Vibration Test benchmark" href="../examples-v016/n_steps_ahead_prediction.html" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="docsearch:language" content="None">
 
@@ -85,7 +83,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   <input type="search" class="form-control" name="q" id="search-input" placeholder="Pesquise os documentos ..." aria-label="Pesquise os documentos ..." autocomplete="off" >
 </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
     <div class="bd-toc-item active">
-        <ul class="current nav bd-sidenav">
+        <ul class="nav bd-sidenav">
  <li class="toctree-l1">
   <a class="reference internal" href="../installation.html">
    Install Guide
@@ -300,8 +298,8 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
    </li>
   </ul>
  </li>
- <li class="toctree-l1 current active">
-  <a class="current reference internal" href="#">
+ <li class="toctree-l1">
+  <a class="reference internal" href="v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>
@@ -1264,21 +1262,7 @@ <h3>CHANGES<a class="headerlink" href="#id10" title="Permalink to this headline"
 
 
                 <!-- Previous / next buttons -->
-<div class='prev-next-area'> 
-    <a class='left-prev' id="prev-link" href="../examples-v016/n_steps_ahead_prediction.html" title="previous page">
-        <i class="fas fa-angle-left"></i>
-        <div class="prev-next-info">
-            <p class="prev-next-subtitle">previous</p>
-            <p class="prev-next-title">V0.1.6 - Example: N-steps-ahead prediction - F-16 Ground Vibration Test benchmark</p>
-        </div>
-    </a>
-    <a class='right-next' id="next-link" href="../code.html" title="next page">
-    <div class="prev-next-info">
-        <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">Code</p>
-    </div>
-    <i class="fas fa-angle-right"></i>
-    </a>
+<div class='prev-next-area'>
 </div>
 
         </div>

diff --git a/docs/changelog/v0.1.9.html b/docs/changelog/v0.1.9.html
@@ -42,6 +42,8 @@
     <link rel="canonical" href="http://sysidentpy.org/changelog/v0.1.9.html" />
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="Code" href="../code.html" />
+    <link rel="prev" title="V0.1.6 - Example: N-steps-ahead prediction - F-16 Ground Vibration Test benchmark" href="../examples-v016/n_steps_ahead_prediction.html" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="docsearch:language" content="None">
 
@@ -83,7 +85,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   <input type="search" class="form-control" name="q" id="search-input" placeholder="Pesquise os documentos ..." aria-label="Pesquise os documentos ..." autocomplete="off" >
 </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
     <div class="bd-toc-item active">
-        <ul class="nav bd-sidenav">
+        <ul class="current nav bd-sidenav">
  <li class="toctree-l1">
   <a class="reference internal" href="../installation.html">
    Install Guide
@@ -298,8 +300,8 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
    </li>
   </ul>
  </li>
- <li class="toctree-l1">
-  <a class="reference internal" href="v0.1.8.html">
+ <li class="toctree-l1 current active">
+  <a class="current reference internal" href="#">
    Changes in SysIdentPy
   </a>
  </li>
@@ -1359,7 +1361,21 @@ <h3>CHANGES<a class="headerlink" href="#id12" title="Permalink to this headline"
 
 
                 <!-- Previous / next buttons -->
-<div class='prev-next-area'>
+<div class='prev-next-area'> 
+    <a class='left-prev' id="prev-link" href="../examples-v016/n_steps_ahead_prediction.html" title="previous page">
+        <i class="fas fa-angle-left"></i>
+        <div class="prev-next-info">
+            <p class="prev-next-subtitle">previous</p>
+            <p class="prev-next-title">V0.1.6 - Example: N-steps-ahead prediction - F-16 Ground Vibration Test benchmark</p>
+        </div>
+    </a>
+    <a class='right-next' id="next-link" href="../code.html" title="next page">
+    <div class="prev-next-info">
+        <p class="prev-next-subtitle">next</p>
+        <p class="prev-next-title">Code</p>
+    </div>
+    <i class="fas fa-angle-right"></i>
+    </a>
 </div>
 
         </div>

diff --git a/docs/code.html b/docs/code.html
@@ -44,7 +44,7 @@
     <link rel="canonical" href="http://sysidentpy.org/code.html" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="prev" title="Changes in SysIdentPy" href="changelog/v0.1.8.html" />
+    <link rel="prev" title="Changes in SysIdentPy" href="changelog/v0.1.9.html" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="docsearch:language" content="None">
 
@@ -302,7 +302,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="changelog/v0.1.8.html">
+  <a class="reference internal" href="changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>
@@ -3426,7 +3426,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
 
                 <!-- Previous / next buttons -->
 <div class='prev-next-area'> 
-    <a class='left-prev' id="prev-link" href="changelog/v0.1.8.html" title="previous page">
+    <a class='left-prev' id="prev-link" href="changelog/v0.1.9.html" title="previous page">
         <i class="fas fa-angle-left"></i>
         <div class="prev-next-info">
             <p class="prev-next-subtitle">previous</p>

diff --git a/docs/dev_guide.html b/docs/dev_guide.html
@@ -301,7 +301,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="changelog/v0.1.8.html">
+  <a class="reference internal" href="changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>

diff --git a/docs/examples-v016/aols.html b/docs/examples-v016/aols.html
@@ -301,7 +301,7 @@ <h1 class="site-logo" id="site-title">NARMAX models</h1>
   </ul>
  </li>
  <li class="toctree-l1">
-  <a class="reference internal" href="../changelog/v0.1.8.html">
+  <a class="reference internal" href="../changelog/v0.1.9.html">
    Changes in SysIdentPy
   </a>
  </li>
@@ -470,7 +470,7 @@ <h1>V0.1.6 - Using the Accelerated Orthogonal Least-Squares algorithm for buildi
 </div>
 </div>
 <div class="cell_output docutils container">
-<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;sysidentpy.polynomial_basis.aols.AOLS at 0x17af1262a30&gt;
+<div class="output text_plain highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>&lt;sysidentpy.polynomial_basis.aols.AOLS at 0x204ca8223a0&gt;
 </pre></div>
 </div>
 </div>
@@ -489,12 +489,12 @@ <h1>V0.1.6 - Using the Accelerated Orthogonal Least-Squares algorithm for buildi
 </div>
 </div>
 <div class="cell_output docutils container">
-<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>0.0018936074444791853 
+<div class="output stream highlight-myst-ansi notranslate"><div class="highlight"><pre><span></span>0.0016822480366271283 
        Regressors Parameters         ERR
-0         y(k-1)     0.2001  0.00000000
+0         y(k-1)     0.2000  0.00000000
 1        x1(k-2)     0.9000  0.00000000
-2  x1(k-1)y(k-1)     0.0999  0.00000000
-3  x1(k-2)y(k-3)     0.0002  0.00000000
+2   y(k-2)y(k-1)     0.0003  0.00000000
+3  x1(k-1)y(k-1)     0.1000  0.00000000
 </pre></div>
 </div>
 </div>