Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Ensures that RidgeCV passes numpydoc validation #20503

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

Merged
merged 6 commits into from
Jul 13, 2021
Merged

DOC Ensures that RidgeCV passes numpydoc validation #20503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bb38cd8
Remove RidgeCV from DOCSTRING_IGNORE_LIST
alinealfa Jul 10, 2021
59e75d1
Update RidgeCV docstring to pass validation RT03
alinealfa Jul 10, 2021
6b954da
Update RidgeCV docstring to pass validation PR06
alinealfa Jul 10, 2021
443d8bc
Update RidgeCV docstring to pass validation GL07
alinealfa Jul 10, 2021
4216b30
Update sklearn/linear_model/_ridge.py
ogrisel Jul 12, 2021
6ae3087
Update sklearn/linear_model/_ridge.py
ogrisel Jul 13, 2021
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
1 change: 0 additions & 1 deletion maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,6 @@
"RandomTreesEmbedding",
"RandomizedSearchCV",
"RegressorChain",
"RidgeCV",
"RidgeClassifier",
"RidgeClassifierCV",
"RobustScaler",
Expand Down
15 changes: 8 additions & 7 deletions sklearn/linear_model/_ridge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1930,6 +1930,7 @@ def fit(self, X, y, sample_weight=None):
Returns
-------
self : object
Fitted estimator.

Notes
-----
Expand Down Expand Up @@ -2024,7 +2025,7 @@ class RidgeCV(MultiOutputMixin, RegressorMixin, _BaseRidgeCV):
``normalize`` was deprecated in version 1.0 and will be removed in
1.2.

scoring : string, callable, default=None
scoring : str, callable, default=None
A string (see model evaluation documentation) or
a scorer callable object / function with signature
``scorer(estimator, X, y)``.
Expand Down Expand Up @@ -2107,6 +2108,12 @@ class RidgeCV(MultiOutputMixin, RegressorMixin, _BaseRidgeCV):

.. versionadded:: 0.24

See Also
--------
Ridge : Ridge regression.
RidgeClassifier : Classifier based on ridge regression on {-1, 1} labels.
RidgeClassifierCV : Ridge classifier with built-in cross validation.

Examples
--------
>>> from sklearn.datasets import load_diabetes
Expand All @@ -2115,12 +2122,6 @@ class RidgeCV(MultiOutputMixin, RegressorMixin, _BaseRidgeCV):
>>> clf = RidgeCV(alphas=[1e-3, 1e-2, 1e-1, 1]).fit(X, y)
>>> clf.score(X, y)
0.5166...

See Also
--------
Ridge : Ridge regression.
RidgeClassifier : Ridge classifier.
RidgeClassifierCV : Ridge classifier with built-in cross validation.
"""


Expand Down