Merge pull request #54 from wilsonrljr/v0.1.6

V0.1.6

Author: wilsonrljr

CHANGELOG

@@ -2,6 +2,62 @@
 File for tracking changes in SysIdentPy
 --------------------------------------------------------------------------------------------------------------
 
+v0.1.6
+------
+
+CONTRIBUTORS
+~~~~~~~~~~~~
+
+- wilsonrljr
+
+CHANGES
+~~~~~~~
+
+- MAJOR: Meta-Model Structure Selection Algorithm (Meta-MSS).
+    - A new method for build NARMAX models based on metaheuristics. The algorithm uses a Binary hybrid Particle Swarm Optimization and Gravitational Search Algorithm with a new cost function to build parsimonious models.
+    - New class for the BPSOGSA algorithm. New algorithms can be adapted in the Meta-MSS framework.
+	- Future updates will add NARX models for classification and multiobjective model structure selection.
+
+- MAJOR: Accelerated Orthogonal Least-Squares algorithm.
+    - Added the new class AOLS to build NARX models using the Accelerated Orthogonal Least-Squares algorithm.
+    - At the best of my knowledge, this is the first time this algorithm is used in the NARMAX framework. The tests I've made are promising, but use it with caution until the results are formalized into a research paper.
+
+- Added notebook with a simple example of how to use MetaMSS and a simple model comparison of the Electromechanical system.
+
+- Added notebook with a simple example of how to use AOLS
+
+- Added ModelInformation class. This class have methods to return model information such as max_lag of a model code.
+    - added _list_output_regressor_code
+    - added _list_input_regressor_code
+    - added _get_lag_from_regressor_code
+    - added _get_max_lag_from_model_code
+
+- Minor performance improvement: added the argument "predefined_regressors" in build_information_matrix function on base.py to improve the performance of the Simulation method.
+
+- Pytorch is now an optional dependency. Use pip install sysidentpy['full'] 
+
+- Fix code format issues.
+
+- Fixed minor grammatical and spelling mistakes.
+
+- Fix issues related to html on Jupyter notebooks examples on documentation.
+
+- Updated Readme with examples of how to use.
+
+- Improved descriptions and comments in methods.
+
+- metaheuristics.bpsogsa (detailed description on code docstring)
+    - added evaluate_objective_function
+    - added optimize
+    - added generate_random_population
+    - added mass_calculation
+    - added calculate_gravitational_constant
+    - added calculate_acceleration
+    - added update_velocity_position
+
+- FIX issue #52
+
+
 v0.1.5
 ------
 

README.md

@@ -25,6 +25,12 @@ The project was started in by Wilson R. L. Junior, Luan Pascoal C. Andrade and S
 
 - Website: https://sysidentpy.org
 
+# New Update!
+
+The update v0.1.6 added new methods for structure selection of NARMAX models: MetaMSS and AOLS. The MetaMSS algorithm is based on metaheuristics (check the paper [Meta-Model Structure Selection: Building Polynomial NARX Model for Regression and Classification](https://arxiv.org/abs/2109.09917) ) and the AOLS is based on the [Accelerated Orthogonal Least-Squares for Large-Scale Sparse Reconstruction](https://users.ece.utexas.edu/~hvikalo/pubs/DSPpaper2018.pdf).
+
+Check the examples of how to use it in the documentation page: http://sysidentpy.org/notebooks.html
+
 # Examples
 
 ## SysIdentPy now support NARX Neural Network and General estimators, e.g., sklearn estimators and Catboost.
@@ -189,11 +195,11 @@ The easiest way to get sysidentpy running is to install it using ``pip``
 pip install sysidentpy
 ~~~~~~~~~~~~~~~~~~~~~~
 
-We will made it available at conda repository as soon as possible.
+We will make it available at conda repository as soon as possible.
 
 # Changelog
 
-See the [changelog]( <http://sysidentpy.org/changelog/v0.1.3.html>) for a history of notable changes to SysIdentPy.
+See the [changelog]( <http://sysidentpy.org/changelog/v0.1.6.html>) for a history of notable changes to SysIdentPy.
 
 # Development
 

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: aae1ba95b236ebb8b8c595c05936f299
+config: 39a4d3ea5d786bb3b85a17e8c8edf431
 tags: 645f666f9bcd5a90fca523b33c5a78b7