Merge pull request #158 from wilsonrljr/fix/152

wilsonrljr · web-flow · commit ec88a562c07c · 2025-01-28T23:01:55.000-03:00
Fix/152
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Changes in SysIdentPy
 
+## v0.5.1
+
+### CONTRIBUTORS
+
+- wilsonrljr
+
+### CHANGES
+
+This update addresses a critical bug related to the unbiased estimator. The issue previously impacted all basis functions but has now been resolved. This release keep providing crucial groundwork for the future development of SysIdentPy, making easier to add new features and improve the code, setting the stage for a robust and feature-complete 1.0.0 release in the feature.
+
+- **Documentation:**
+  - Remove unnecessary code when importing basis functions in many examples.
+
+- **API Changes:**
+  - Fix unbiased estimator for every basis function.
+
 ## v0.5.0
 
 ### CONTRIBUTORS
diff --git a/docs/changelog/changelog.md b/docs/changelog/changelog.md
@@ -5,6 +5,23 @@ template: overrides/main.html
 
 # Changes in SysIdentPy
 
+## v0.5.1
+
+### CONTRIBUTORS
+
+- wilsonrljr
+
+### CHANGES
+
+This update addresses a critical bug related to the unbiased estimator. The issue previously impacted all basis functions but has now been resolved. This release keep providing crucial groundwork for the future development of SysIdentPy, making easier to add new features and improve the code, setting the stage for a robust and feature-complete 1.0.0 release in the feature.
+
+- **Documentation:**
+  - Remove unnecessary code when importing basis functions in many examples.
+
+- **API Changes:**
+  - Fix unbiased estimator for every basis function.
+
+
 ## v0.5.0
 
 ### CONTRIBUTORS
diff --git a/docs/examples/NFIR.ipynb b/docs/examples/NFIR.ipynb
@@ -47,7 +47,7 @@
     "import numpy as np\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares, RecursiveLeastSquares\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_results\n",
diff --git a/docs/examples/aols.ipynb b/docs/examples/aols.ipynb
@@ -18,7 +18,7 @@
     "import pandas as pd\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
     "from sysidentpy.residues.residues_correlation import (\n",
diff --git a/docs/examples/basic_steps.ipynb b/docs/examples/basic_steps.ipynb
@@ -35,7 +35,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
@@ -51,7 +51,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Generating 1 input 1 output sample data  \n",
+    "## Generating 1 input 1 output sample data\n",
     "\n",
     "The data is generated by simulating the following model:\n",
     "\n",
@@ -400,9 +400,9 @@
    "source": [
     "```{note}\n",
     " Here we are creating random samples with white noise and letting the algorithm choose\n",
-    " the number of terms based on the minimum value of information criteria. \n",
-    " This is not the best approach in System Identification, but serves as a simple example. \n",
-    " The information criteria must be used as an __auxiliary tool__ to select *n_terms*. \n",
+    " the number of terms based on the minimum value of information criteria.\n",
+    " This is not the best approach in System Identification, but serves as a simple example.\n",
+    " The information criteria must be used as an __auxiliary tool__ to select *n_terms*.\n",
     " Plot the information values to help you on that!\n",
     "\n",
     " If you run the example above several times you might find some cases where the\n",
@@ -416,18 +416,6 @@
     "```"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "```{note}\n",
-    "This documentation and the examples below are written with MyST Markdown, a form\n",
-    "of markdown that works with Sphinx. For more information about MyST markdown, and\n",
-    "to use MyST markdown with your Sphinx website,\n",
-    "see [the MyST-parser documentation](https://myst-parser.readthedocs.io/)\n",
-    "```"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
diff --git a/docs/examples/defining_lags.ipynb b/docs/examples/defining_lags.ipynb
@@ -32,7 +32,7 @@
    "outputs": [],
    "source": [
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial"
+    "from sysidentpy.basis_function import Polynomial"
    ]
   },
   {
diff --git a/docs/examples/entropic_regression.ipynb b/docs/examples/entropic_regression.ipynb
@@ -32,7 +32,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import ER\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import RecursiveLeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/docs/examples/extended_least_squares.ipynb b/docs/examples/extended_least_squares.ipynb
diff --git a/docs/examples/f_16_benchmark.ipynb b/docs/examples/f_16_benchmark.ipynb
@@ -53,7 +53,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/docs/examples/general_estimators.ipynb b/docs/examples/general_estimators.ipynb
@@ -39,7 +39,7 @@
     "from sklearn.ensemble import GradientBoostingRegressor\n",
     "from catboost import CatBoostRegressor\n",
     "\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial, Fourier\n",
+    "from sysidentpy.basis_function import Polynomial, Fourier\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
     "from sysidentpy.residues.residues_correlation import (\n",
     "    compute_residues_autocorrelation,\n",
diff --git a/docs/examples/identification_of_an_electromechanical_system.ipynb b/docs/examples/identification_of_an_electromechanical_system.ipynb
@@ -31,7 +31,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import RecursiveLeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/docs/examples/information_criteria_examples.ipynb b/docs/examples/information_criteria_examples.ipynb
@@ -42,7 +42,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
diff --git a/docs/examples/metamss.ipynb b/docs/examples/metamss.ipynb
@@ -20,7 +20,7 @@
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import MetaMSS, FROLS\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import RecursiveLeastSquares\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
diff --git a/docs/examples/multiobjective_parameter_estimation.ipynb b/docs/examples/multiobjective_parameter_estimation.ipynb
diff --git a/docs/examples/multiple_inputs_example.ipynb b/docs/examples/multiple_inputs_example.ipynb
@@ -46,7 +46,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/docs/examples/narx_neural_network.ipynb b/docs/examples/narx_neural_network.ipynb
@@ -59,8 +59,7 @@
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.neural_network import NARXNN\n",
     "\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
-    "from sysidentpy.utils.generate_data import get_siso_data\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
     "from sysidentpy.residues.residues_correlation import (\n",
     "    compute_residues_autocorrelation,\n",
diff --git a/docs/examples/parameter_estimation.ipynb b/docs/examples/parameter_estimation.ipynb
@@ -24,7 +24,7 @@
    "source": [
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import (\n",
     "    TotalLeastSquares,\n",
     "    RecursiveLeastSquares,\n",
diff --git a/docs/examples/save_and_load_models.ipynb b/docs/examples/save_and_load_models.ipynb
@@ -25,7 +25,7 @@
    "source": [
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/examples/NFIR.ipynb b/examples/NFIR.ipynb
@@ -47,7 +47,7 @@
     "import numpy as np\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares, RecursiveLeastSquares\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_results\n",
diff --git a/examples/aols.ipynb b/examples/aols.ipynb
@@ -18,7 +18,7 @@
     "import pandas as pd\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
     "from sysidentpy.residues.residues_correlation import (\n",
diff --git a/examples/basic_steps.ipynb b/examples/basic_steps.ipynb
@@ -35,7 +35,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
diff --git a/examples/defining_lags.ipynb b/examples/defining_lags.ipynb
@@ -32,7 +32,7 @@
    "outputs": [],
    "source": [
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial"
+    "from sysidentpy.basis_function import Polynomial"
    ]
   },
   {
diff --git a/examples/entropic_regression.ipynb b/examples/entropic_regression.ipynb
@@ -32,7 +32,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import ER\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import RecursiveLeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/examples/extended_least_squares.ipynb b/examples/extended_least_squares.ipynb
diff --git a/examples/f_16_benchmark.ipynb b/examples/f_16_benchmark.ipynb
@@ -53,7 +53,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/examples/general_estimators.ipynb b/examples/general_estimators.ipynb
@@ -39,7 +39,7 @@
     "from sklearn.ensemble import GradientBoostingRegressor\n",
     "from catboost import CatBoostRegressor\n",
     "\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial, Fourier\n",
+    "from sysidentpy.basis_function import Polynomial, Fourier\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
     "from sysidentpy.residues.residues_correlation import (\n",
     "    compute_residues_autocorrelation,\n",
diff --git a/examples/identification_of_an_electromechanical_system.ipynb b/examples/identification_of_an_electromechanical_system.ipynb
@@ -31,7 +31,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import RecursiveLeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/examples/information_criteria_examples.ipynb b/examples/information_criteria_examples.ipynb
@@ -42,7 +42,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
diff --git a/examples/metamss.ipynb b/examples/metamss.ipynb
@@ -20,7 +20,7 @@
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import MetaMSS, FROLS\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import RecursiveLeastSquares\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
diff --git a/examples/multiobjective_parameter_estimation.ipynb b/examples/multiobjective_parameter_estimation.ipynb
@@ -48,7 +48,7 @@
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
     "from sysidentpy.multiobjective_parameter_estimation import AILS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.utils.display_results import results\n",
     "from sysidentpy.utils.plotting import plot_results\n",
diff --git a/examples/multiple_inputs_example.ipynb b/examples/multiple_inputs_example.ipynb
@@ -46,7 +46,7 @@
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.metrics import root_relative_squared_error\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/examples/narx_neural_network.ipynb b/examples/narx_neural_network.ipynb
@@ -59,8 +59,7 @@
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.neural_network import NARXNN\n",
     "\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
-    "from sysidentpy.utils.generate_data import get_siso_data\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.utils.plotting import plot_residues_correlation, plot_results\n",
     "from sysidentpy.residues.residues_correlation import (\n",
     "    compute_residues_autocorrelation,\n",
diff --git a/examples/parameter_estimation.ipynb b/examples/parameter_estimation.ipynb
@@ -24,7 +24,7 @@
    "source": [
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import (\n",
     "    TotalLeastSquares,\n",
     "    RecursiveLeastSquares,\n",
diff --git a/examples/save_and_load_models.ipynb b/examples/save_and_load_models.ipynb
@@ -25,7 +25,7 @@
    "source": [
     "import pandas as pd\n",
     "from sysidentpy.model_structure_selection import FROLS\n",
-    "from sysidentpy.basis_function._basis_function import Polynomial\n",
+    "from sysidentpy.basis_function import Polynomial\n",
     "from sysidentpy.parameter_estimation import LeastSquares\n",
     "from sysidentpy.utils.generate_data import get_siso_data\n",
     "from sysidentpy.utils.display_results import results\n",
diff --git a/sysidentpy/__init__.py b/sysidentpy/__init__.py
@@ -1 +1 @@
-__version__ = "0.5.0"
+__version__ = "0.5.1"
diff --git a/sysidentpy/parameter_estimation/estimators_base.py b/sysidentpy/parameter_estimation/estimators_base.py
@@ -88,7 +88,11 @@ def unbiased_estimator(
             lagged_data = im.build_output_matrix(None, e)
 
             e_regressors = basis_function.fit(
-                lagged_data, max_lag, ylag=elag, predefined_regressors=None
+                lagged_data,
+                max_lag,
+                ylag=elag,
+                model_type="NAR",  # using residuals, but the same method as NAR
+                predefined_regressors=None,
             )
 
             psi_extended = np.concatenate([psi, e_regressors], axis=1)

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`"outputs": [],`
`33`	`33`	`"source": [`
`34`	`34`	`"from sysidentpy.model_structure_selection import FROLS\n",`
`35`		`- "from sysidentpy.basis_function._basis_function import Polynomial"`
	`35`	`+ "from sysidentpy.basis_function import Polynomial"`
`36`	`36`	`]`
`37`	`37`	`},`
`38`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "0.5.0"`
	`1`	`+__version__ = "0.5.1"`