Merge pull request #119 from wilsonrljr/v0.3.3

V0.3.3
wilsonrljr · Sep 24, 2023 · 5d39051 · 5d39051
2 parents 8445d03 + 2f4a71b
commit 5d39051
Show file tree

Hide file tree

Showing 70 changed files with 12,285 additions and 1,147 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -18,9 +18,9 @@ jobs:
         python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

diff --git a/CHANGELOG b/CHANGELOG
@@ -5,6 +5,36 @@ File for tracking changes in SysIdentPy
 Changes in SysIdentPy
 =====================
 
+v0.3.0
+------
+
+CONTRIBUTORS
+~~~~~~~~~~~~
+
+- wilsonrljr
+- gamcorn
+- Gabo-Tor
+
+CHANGES
+~~~~~~~
+
+- The update **v0.3.3**  has been released with additional features, API changes and fixes. 
+
+- MAJOR: Multiobjective Framework: Affine Information Least Squares Algorithm (AILS)
+    - Now you can use AILS to estimate parameters of NARMAX models (and variants) using a multiobjective approach.
+    - AILS can be accessed using `from sysidentpy.multiobjective_parameter_estimation import AILS`
+    - See the docs for a more in depth explanation of how to use AILS.
+    - This feature is related to Issue #101. This work is the result of an undergraduate research conducted by Gabriel Bueno Leandro under the supervision of Samir Milani Martins and Wilson Rocha Lacerda Junior.
+
+- API Change: `regressor_code` variable was renamed as `enconding` to avoid using the same name as the method in `narmax_tool` `regressor_code` method.
+
+- DATASET: Added buck_id.csv and buck_valid.csv dataset to SysIdentPy repository.
+
+- DOC: Add a Multiobjetive Parameter Optimization Notebook showing how to use the new AILS method
+
+- DOC: Minor additions and grammar fixes.
+
+
 v0.3.2
 ------
 

diff --git a/docs/book/contents/index.html b/docs/book/contents/index.html
diff --git a/docs/book/preface.md b/docs/book/preface.md
@@ -26,4 +26,8 @@ In addition to these resources, we will also reference Luis Antônio Aguirre `In
 
 ## Contribute
 
-The `Nonlinear Dynamics: A Journey Through System Identification and Forecasting` is a comprehensive resource on the science of System Identification, offered as an open-source material. Our aim is to make this valuable resource accessible to all, both financially and intellectually. If you have found this book helpful and want to support our endeavor financially, you are referred to the Sponsor page. However, if you are not yet ready to contribute financially, you can still help us by pointing out typos, suggesting edits, or offering feedback on passages that you found difficult to comprehend. Simply navigate to the book's repository and open an issue. Lastly, if you enjoyed our content, please consider sharing it with others who may find it useful and leave us a star on GitHub.
+The `Nonlinear Dynamics: A Journey Through System Identification and Forecasting` is a comprehensive resource on the science of System Identification, offered as an open-source material. Our aim is to make this valuable resource accessible to all, both financially and intellectually. If you have found this book helpful and want to support our endeavor financially, you are referred to the Sponsor page. However, if you are not yet ready to contribute financially, you can still help us by pointing out typos, suggesting edits, or offering feedback on passages that you found difficult to comprehend. Simply navigate to the book's repository and open an issue. Lastly, if you enjoyed our content, please consider sharing it with others who may find it useful and leave us a star on GitHub.
+
+## Note
+
+The chapters will be released one by one until the book is complete.
diff --git a/docs/book/preface/index.html b/docs/book/preface/index.html
diff --git a/docs/book/preface/preface.md b/docs/book/preface/preface.md
@@ -26,4 +26,8 @@ In addition to these resources, we will also reference Luis Antônio Aguirre `In
 
 ## Contribute
 
-The `Nonlinear Dynamics: A Journey Through System Identification and Forecasting` is a comprehensive resource on the science of System Identification, offered as an open-source material. Our aim is to make this valuable resource accessible to all, both financially and intellectually. If you have found this book helpful and want to support our endeavor financially, you are referred to the Sponsor page. However, if you are not yet ready to contribute financially, you can still help us by pointing out typos, suggesting edits, or offering feedback on passages that you found difficult to comprehend. Simply navigate to the book's repository and open an issue. Lastly, if you enjoyed our content, please consider sharing it with others who may find it useful and leave us a star on GitHub.
+The `Nonlinear Dynamics: A Journey Through System Identification and Forecasting` is a comprehensive resource on the science of System Identification, offered as an open-source material. Our aim is to make this valuable resource accessible to all, both financially and intellectually. If you have found this book helpful and want to support our endeavor financially, you are referred to the Sponsor page. However, if you are not yet ready to contribute financially, you can still help us by pointing out typos, suggesting edits, or offering feedback on passages that you found difficult to comprehend. Simply navigate to the book's repository and open an issue. Lastly, if you enjoyed our content, please consider sharing it with others who may find it useful and leave us a star on GitHub.
+
+## Note
+
+The chapters will be released one by one until the book is complete.
diff --git a/docs/changelog/changelog.md b/docs/changelog/changelog.md
@@ -5,6 +5,33 @@ template: overrides/main.html
 
 # Changes in SysIdentPy
 
+## v0.3.3
+
+### CONTRIBUTORS
+
+- wilsonrljr
+- GabrielBuenoLeandro
+- samirmartins
+
+### CHANGES
+
+- The update **v0.3.3**  has been released with additional features, API changes and fixes. 
+
+- MAJOR: Multiobjective Framework: Affine Information Least Squares Algorithm (AILS)
+    - Now you can use AILS to estimate parameters of NARMAX models (and variants) using a multiobjective approach.
+    - AILS can be accessed using `from sysidentpy.multiobjective_parameter_estimation import AILS`
+    - See the docs for a more in depth explanation of how to use AILS.
+    - This feature is related to Issue #101. This work is the result of an undergraduate research conducted by Gabriel Bueno Leandro under the supervision of Samir Milani Martins and Wilson Rocha Lacerda Junior.
+    - Several new methods were implemented to get the new feature and you can check all of it in sysidentpy -> multiobjective_parameter_estimation.
+
+- API Change: `regressor_code` variable was renamed as `enconding` to avoid using the same name as the method in `narmax_tool` `regressor_code` method.
+
+- DATASET: Added buck_id.csv and buck_valid.csv dataset to SysIdentPy repository.
+
+- DOC: Add a Multiobjetive Parameter Optimization Notebook showing how to use the new AILS method
+
+- DOC: Minor additions and grammar fixes.
+
 ## v0.3.2
 
 ### CONTRIBUTORS

diff --git a/docs/changelog/changelog/changelog.md b/docs/changelog/changelog/changelog.md
@@ -5,6 +5,33 @@ template: overrides/main.html
 
 # Changes in SysIdentPy
 
+## v0.3.3
+
+### CONTRIBUTORS
+
+- wilsonrljr
+- GabrielBuenoLeandro
+- samirmartins
+
+### CHANGES
+
+- The update **v0.3.3**  has been released with additional features, API changes and fixes. 
+
+- MAJOR: Multiobjective Framework: Affine Information Least Squares Algorithm (AILS)
+    - Now you can use AILS to estimate parameters of NARMAX models (and variants) using a multiobjective approach.
+    - AILS can be accessed using `from sysidentpy.multiobjective_parameter_estimation import AILS`
+    - See the docs for a more in depth explanation of how to use AILS.
+    - This feature is related to Issue #101. This work is the result of an undergraduate research conducted by Gabriel Bueno Leandro under the supervision of Samir Milani Martins and Wilson Rocha Lacerda Junior.
+    - Several new methods were implemented to get the new feature and you can check all of it in sysidentpy -> multiobjective_parameter_estimation.
+
+- API Change: `regressor_code` variable was renamed as `enconding` to avoid using the same name as the method in `narmax_tool` `regressor_code` method.
+
+- DATASET: Added buck_id.csv and buck_valid.csv dataset to SysIdentPy repository.
+
+- DOC: Add a Multiobjetive Parameter Optimization Notebook showing how to use the new AILS method
+
+- DOC: Minor additions and grammar fixes.
+
 ## v0.3.2
 
 ### 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/basis-function/index.html b/docs/code/basis-function/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/metaheuristics/index.html b/docs/code/metaheuristics/index.html
diff --git a/docs/code/metamss/index.html b/docs/code/metamss/index.html
diff --git a/docs/code/metrics/index.html b/docs/code/metrics/index.html
diff --git a/docs/code/multiobjective-parameter-estimation.md b/docs/code/multiobjective-parameter-estimation.md
@@ -0,0 +1,8 @@
+---
+template: overrides/main.html
+---
+
+# Documentation for `Multiobjective Parameter Estimation`
+
+::: sysidentpy.multiobjective_parameter_estimation.estimators
+      show_root_heading: false
diff --git a/docs/code/multiobjective-parameter-estimation/index.html b/docs/code/multiobjective-parameter-estimation/index.html
diff --git a/...code/multiobjective-parameter-estimation/multiobjective-parameter-estimation.md b/...code/multiobjective-parameter-estimation/multiobjective-parameter-estimation.md
@@ -0,0 +1,8 @@
+---
+template: overrides/main.html
+---
+
+# Documentation for `Multiobjective Parameter Estimation`
+
+::: sysidentpy.multiobjective_parameter_estimation.estimators
+      show_root_heading: false
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
diff --git a/docs/code/residues/index.html b/docs/code/residues/index.html
diff --git a/docs/code/simulation/index.html b/docs/code/simulation/index.html
diff --git a/docs/code/utils/index.html b/docs/code/utils/index.html
diff --git a/docs/events/estatidados/index.html b/docs/events/estatidados/index.html
diff --git a/docs/events/events/index.html b/docs/events/events/index.html
diff --git a/docs/events/gcom-meetup/index.html b/docs/events/gcom-meetup/index.html
diff --git a/docs/events/nubank-meetup-open-source/index.html b/docs/events/nubank-meetup-open-source/index.html
diff --git a/docs/events/nubank-meetup/index.html b/docs/events/nubank-meetup/index.html
diff --git a/docs/examples/PV_forecasting_benchmark/index.html b/docs/examples/PV_forecasting_benchmark/index.html
diff --git a/docs/examples/air_passenger_benchmark/index.html b/docs/examples/air_passenger_benchmark/index.html
diff --git a/docs/examples/aols/index.html b/docs/examples/aols/index.html
diff --git a/docs/examples/basic_steps/index.html b/docs/examples/basic_steps/index.html
diff --git a/docs/examples/defining_lags/index.html b/docs/examples/defining_lags/index.html
diff --git a/docs/examples/entropic_regression/index.html b/docs/examples/entropic_regression/index.html
diff --git a/docs/examples/extended_least_squares/index.html b/docs/examples/extended_least_squares/index.html
diff --git a/docs/examples/f_16_benchmark/index.html b/docs/examples/f_16_benchmark/index.html
diff --git a/docs/examples/fourier_basis_function/index.html b/docs/examples/fourier_basis_function/index.html
diff --git a/docs/examples/general_estimators/index.html b/docs/examples/general_estimators/index.html
diff --git a/docs/examples/identification_of_an_electromechanical_system/index.html b/docs/examples/identification_of_an_electromechanical_system/index.html
diff --git a/docs/examples/information_criteria_examples/index.html b/docs/examples/information_criteria_examples/index.html
diff --git a/docs/examples/load_forecasting_benchmark/index.html b/docs/examples/load_forecasting_benchmark/index.html
diff --git a/docs/examples/metamss/index.html b/docs/examples/metamss/index.html
diff --git a/docs/examples/multiobjective_parameter_estimation.ipynb b/docs/examples/multiobjective_parameter_estimation.ipynb
diff --git a/docs/examples/multiobjective_parameter_estimation/index.html b/docs/examples/multiobjective_parameter_estimation/index.html
diff --git a/docs/examples/multiobjective_parameter_estimation/multiobjective_parameter_estimation.ipynb b/docs/examples/multiobjective_parameter_estimation/multiobjective_parameter_estimation.ipynb
diff --git a/docs/examples/multiple_inputs_example/index.html b/docs/examples/multiple_inputs_example/index.html
diff --git a/docs/examples/n_steps_ahead_prediction/index.html b/docs/examples/n_steps_ahead_prediction/index.html
diff --git a/docs/examples/narx_neural_network/index.html b/docs/examples/narx_neural_network/index.html
diff --git a/docs/examples/parameter_estimation/index.html b/docs/examples/parameter_estimation/index.html
diff --git a/docs/examples/save_and_load_models/index.html b/docs/examples/save_and_load_models/index.html
diff --git a/docs/examples/simulating_a_predefined_model/index.html b/docs/examples/simulating_a_predefined_model/index.html
diff --git a/docs/index.html b/docs/index.html
@@ -19,7 +19,7 @@
     <link href="https://sysidentpy.org/" rel="canonical" />
     <link href="landing-page/getting-started/" rel="next" />
     <link href="overrides/assets/images/favicon.png" rel="icon" />
-    <meta content="mkdocs-1.4.3, mkdocs-material-9.1.11" name="generator" />
+    <meta content="mkdocs-1.5.3, mkdocs-material-9.1.11" name="generator" />
     <title>SysIdentPy - SysIdentPy</title>
     <link href="assets/stylesheets/main.85bb2934.min.css" rel="stylesheet" />
     <link href="assets/stylesheets/palette.a6bdf11c.min.css" rel="stylesheet" />
@@ -899,6 +899,10 @@ <h4 class="title">Contact Us</h4>
                                                             <li class="md-nav__item"> <a class="md-nav__link"
                                                                     href="examples/parameter_estimation/"> Parameter
                                                                     Estimation </a> </li>
+                                                            <li class="md-nav__item"> <a class="md-nav__link"
+                                                                    href="examples/multiobjective_parameter_estimation/">
+                                                                    Multiobjective Parameter Estimation for NARMAX
+                                                                    models - An Overview </a> </li>
                                                             <li class="md-nav__item"> <a class="md-nav__link"
                                                                     href="examples/extended_least_squares/"> Extended
                                                                     Least Squares </a> </li>
@@ -1080,6 +1084,9 @@ <h4 class="title">Contact Us</h4>
                                                 <li class="md-nav__item"> <a class="md-nav__link"
                                                         href="code/parameter-estimation/"> Parameter Estimation </a>
                                                 </li>
+                                                <li class="md-nav__item"> <a class="md-nav__link"
+                                                        href="code/multiobjective-parameter-estimation/"> Multiobjective
+                                                        Parameter Estimation </a> </li>
                                                 <li class="md-nav__item"> <a class="md-nav__link"
                                                         href="code/simulation/"> Simulation </a> </li>
                                                 <li class="md-nav__item"> <a class="md-nav__link" href="code/residues/">

diff --git a/docs/landing-page/about-us/index.html b/docs/landing-page/about-us/index.html
diff --git a/docs/landing-page/attribute/index.html b/docs/landing-page/attribute/index.html
diff --git a/docs/landing-page/basic-usage/index.html b/docs/landing-page/basic-usage/index.html
diff --git a/docs/landing-page/ch0-narmax-intro/index.html b/docs/landing-page/ch0-narmax-intro/index.html
diff --git a/docs/landing-page/contribute/index.html b/docs/landing-page/contribute/index.html
diff --git a/docs/landing-page/get-help/index.html b/docs/landing-page/get-help/index.html
diff --git a/docs/landing-page/getting-started/index.html b/docs/landing-page/getting-started/index.html
diff --git a/docs/landing-page/license/index.html b/docs/landing-page/license/index.html
diff --git a/docs/landing-page/sponsor/index.html b/docs/landing-page/sponsor/index.html
diff --git a/docs/sitemap.xml.gz b/docs/sitemap.xml.gz
diff --git a/examples/multiobjective.ipynb b/examples/multiobjective.ipynb