Merge pull request #112 from wilsonrljr/v0.3.1

V0.3.1
wilsonrljr · May 18, 2023 · 255e97a · 255e97a
2 parents 663b7f3 + f2b95c6
commit 255e97a
Show file tree

Hide file tree

Showing 31 changed files with 8,826 additions and 8,325 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -27,7 +27,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install flake8 pytest pytest-cov scikit-learn black isort>=5.0.6
-        if [ -f requirements.txt ]; then pip install .["dev"]; fi
+        if [ -f requirements.txt ]; then pip install ."[dev, all]"; fi
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names

diff --git a/CHANGELOG b/CHANGELOG
@@ -5,6 +5,30 @@ File for tracking changes in SysIdentPy
 Changes in SysIdentPy
 =====================
 
+v0.3.1
+------
+
+CONTRIBUTORS
+~~~~~~~~~~~~
+
+- wilsonrljr
+
+CHANGES
+~~~~~~~
+
+- The update **v0.3.1**  has been released with API changes and fixes. 
+
+- API Change: 
+    - MetaMSS was returning the max lag of the final model instead of the maximum lag related to the xlag and ylag. This is not wrong (its related to the issue #55), but this change will be made for all methods at the same time. In this respect, I'm reverted this to return the maximum lag of the xlag and ylag.  
+
+- API Change: Added build_matrix method in BaseMSS. This change improved overall code readability by rewriting if/elif/else clauses in every model structure selection algorithm.
+
+- API Change: Added bic, aic, fpe, and lilc methods in FROLS. Now the method is selected by using a predefined dictionary with the available options. This change improved overall code readability by rewriting if/elif/else clauses in the FROLS algorithm. 
+
+- TESTS: Added tests for Neural NARX class. The issue with pytorch was fixed and now we have the tests for every model class.
+
+- Remove unused code and comments.
+
 v0.3.0
 ------
 

diff --git a/docs/changelog/changelog.md b/docs/changelog/changelog.md
@@ -5,6 +5,28 @@ template: overrides/main.html
 
 # Changes in SysIdentPy
 
+## v0.3.1
+
+### CONTRIBUTORS
+
+- wilsonrljr
+
+### CHANGES
+
+- The update **v0.3.1**  has been released with API changes and fixes. 
+
+- API Change: 
+    - MetaMSS was returning the max lag of the final model instead of the maximum lag related to the xlag and ylag. This is not wrong (its related to the issue #55), but this change will be made for all methods at the same time. In this respect, I'm reverted this to return the maximum lag of the xlag and ylag.  
+
+- API Change: Added build_matrix method in BaseMSS. This change improved overall code readability by rewriting if/elif/else clauses in every model structure selection algorithm.
+
+- API Change: Added bic, aic, fpe, and lilc methods in FROLS. Now the method is selected by using a predefined dictionary with the available options. This change improved overall code readability by rewriting if/elif/else clauses in the FROLS algorithm. 
+
+- TESTS: Added tests for Neural NARX class. The issue with pytorch was fixed and now we have the tests for every model class.
+
+- Remove unused code and comments.
+
+
 ## v0.3.0
 
 ### CONTRIBUTORS

diff --git a/docs/changelog/changelog/changelog.md b/docs/changelog/changelog/changelog.md
@@ -5,6 +5,28 @@ template: overrides/main.html
 
 # Changes in SysIdentPy
 
+## v0.3.1
+
+### CONTRIBUTORS
+
+- wilsonrljr
+
+### CHANGES
+
+- The update **v0.3.1**  has been released with API changes and fixes. 
+
+- API Change: 
+    - MetaMSS was returning the max lag of the final model instead of the maximum lag related to the xlag and ylag. This is not wrong (its related to the issue #55), but this change will be made for all methods at the same time. In this respect, I'm reverted this to return the maximum lag of the xlag and ylag.  
+
+- API Change: Added build_matrix method in BaseMSS. This change improved overall code readability by rewriting if/elif/else clauses in every model structure selection algorithm.
+
+- API Change: Added bic, aic, fpe, and lilc methods in FROLS. Now the method is selected by using a predefined dictionary with the available options. This change improved overall code readability by rewriting if/elif/else clauses in the FROLS algorithm. 
+
+- TESTS: Added tests for Neural NARX class. The issue with pytorch was fixed and now we have the tests for every model class.
+
+- Remove unused code and comments.
+
+
 ## v0.3.0
 
 ### CONTRIBUTORS

diff --git a/docs/changelog/changelog/index.html b/docs/changelog/changelog/index.html
diff --git a/docs/code/aols/index.html b/docs/code/aols/index.html
diff --git a/docs/code/entropic-regression/index.html b/docs/code/entropic-regression/index.html
diff --git a/docs/code/frols/index.html b/docs/code/frols/index.html
diff --git a/docs/code/general-estimators/index.html b/docs/code/general-estimators/index.html
diff --git a/docs/code/metamss/index.html b/docs/code/metamss/index.html
diff --git a/docs/code/narmax-base/index.html b/docs/code/narmax-base/index.html
diff --git a/docs/code/neural-narx/index.html b/docs/code/neural-narx/index.html
diff --git a/docs/code/parameter-estimation/index.html b/docs/code/parameter-estimation/index.html
@@ -1032,7 +1032,7 @@
 <a id="__codelineno-0-157" name="__codelineno-0-157"></a>        <span class="k">for</span> <span class="n">_</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">30</span><span class="p">):</span>
 <a id="__codelineno-0-158" name="__codelineno-0-158"></a>            <span class="n">e</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">concatenate</span><span class="p">([</span><span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">([</span><span class="n">max_lag</span><span class="p">,</span> <span class="mi">1</span><span class="p">]),</span> <span class="n">e</span><span class="p">],</span> <span class="n">axis</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
 <a id="__codelineno-0-159" name="__codelineno-0-159"></a>
-<a id="__codelineno-0-160" name="__codelineno-0-160"></a>            <span class="n">lagged_data</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">build_output_matrix</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
+<a id="__codelineno-0-160" name="__codelineno-0-160"></a>            <span class="n">lagged_data</span> <span class="o">=</span> <span class="n">im</span><span class="o">.</span><span class="n">build_output_matrix</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
 <a id="__codelineno-0-161" name="__codelineno-0-161"></a>
 <a id="__codelineno-0-162" name="__codelineno-0-162"></a>            <span class="n">e_regressors</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">basis_function</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span>
 <a id="__codelineno-0-163" name="__codelineno-0-163"></a>                <span class="n">lagged_data</span><span class="p">,</span> <span class="n">max_lag</span><span class="p">,</span> <span class="n">predefined_regressors</span><span class="o">=</span><span class="kc">None</span>