Skip to content

DOC Ensures that MultiTaskLassoCV passes numpydoc validation #21256

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 9 commits into from
Oct 21, 2021
Merged

DOC Ensures that MultiTaskLassoCV passes numpydoc validation #21256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7e4a4b9
Remove MultiTaskLassoCV from DOCSTRING_IGNORE_LIST
Pinky-Chaudhary Oct 6, 2021
effc497
Fix numpydocs from MultiTaskLassoCV
Pinky-Chaudhary Oct 6, 2021
a594819
Fix numpydocs from MultiTaskLassoCV
Pinky-Chaudhary Oct 6, 2021
1d4dd28
update _coordinate_decent.py for linting check
Pinky-Chaudhary Oct 18, 2021
62a1a36
Update _coordinate_descent.py
Pinky-Chaudhary Oct 18, 2021
3ddac33
fixing white spaces
Pinky-Chaudhary Oct 18, 2021
4a51323
remove trailing ws and shorten line length
Pinky-Chaudhary Oct 18, 2021
19e31c6
Merge remote-tracking branch 'origin/main' into pr/Pinky-Chaudhary/21256
glemaitre Oct 21, 2021
f8222f3
use 80 characters for docstring
glemaitre Oct 21, 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 @@ -18,7 +18,6 @@
"LabelSpreading",
"LocallyLinearEmbedding",
"MultiTaskElasticNetCV",
"MultiTaskLassoCV",
"OrthogonalMatchingPursuitCV",
"PassiveAggressiveRegressor",
"SpectralBiclustering",
Expand Down
29 changes: 16 additions & 13 deletions sklearn/linear_model/_coordinate_descent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2996,6 +2996,22 @@ class MultiTaskLassoCV(RegressorMixin, LinearModelCV):

.. versionadded:: 1.0

See Also
--------
MultiTaskElasticNet : Multi-task ElasticNet model trained with L1/L2
mixed-norm as regularizer.
ElasticNetCV : Elastic net model with best model selection by
cross-validation.
MultiTaskElasticNetCV : Multi-task L1/L2 ElasticNet with built-in
cross-validation.

Notes
-----
The algorithm used to fit the model is coordinate descent.

To avoid unnecessary memory duplication the X and y arguments of the fit
method should be directly passed as Fortran-contiguous numpy arrays.

Examples
--------
>>> from sklearn.linear_model import MultiTaskLassoCV
Expand All @@ -3009,19 +3025,6 @@ class MultiTaskLassoCV(RegressorMixin, LinearModelCV):
0.5713...
>>> reg.predict(X[:1,])
array([[153.7971..., 94.9015...]])

See Also
--------
MultiTaskElasticNet
ElasticNetCV
MultiTaskElasticNetCV

Notes
-----
The algorithm used to fit the model is coordinate descent.

To avoid unnecessary memory duplication the X and y arguments of the fit
method should be directly passed as Fortran-contiguous numpy arrays.
"""

path = staticmethod(lasso_path)
Expand Down