Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add deprecated message for solver in RidgeRegression #174

Merged
merged 1 commit into from
Feb 22, 2025
Merged

add deprecated message for solver in RidgeRegression #174

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion sysidentpy/parameter_estimation/estimators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from scipy.sparse.linalg import lsmr

from .estimators_base import BaseEstimator
from ..utils.deprecation import deprecated


class EstimatorError(Exception):
Expand Down Expand Up @@ -77,6 +78,14 @@ def optimize(self, psi: np.ndarray, y: np.ndarray) -> np.ndarray:
return theta


@deprecated(
version="v0.5.4",
future_version="v0.6.0",
message=(
" `solver` is deprecated in v0.5.4 and will be removed in v0.6.0."
" A single solver option will be retained moving forward."
),
)
class RidgeRegression(BaseEstimator):
"""Ridge Regression estimator using classic and SVD methods.

Expand Down Expand Up @@ -1589,7 +1598,7 @@ class BoundedVariableLeastSquares(BaseEstimator):
This optimization problem is convex, hence a found minimum (if iterations
have converged) is guaranteed to be global.

Attributes
Parameters
----------
unbiased : bool
Indicates whether an unbiased estimator is applied.
Expand Down