Skip to content

Commit c3f41ae

Browse files
DOC Ensures that MultiTaskLassoCV passes numpydoc validation (#21256)
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
1 parent 5187554 commit c3f41ae

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

maint_tools/test_docstrings.py

-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818
"LabelSpreading",
1919
"LocallyLinearEmbedding",
2020
"MultiTaskElasticNetCV",
21-
"MultiTaskLassoCV",
2221
"OrthogonalMatchingPursuitCV",
2322
"PassiveAggressiveRegressor",
2423
"SpectralBiclustering",

sklearn/linear_model/_coordinate_descent.py

+16-13
Original file line numberDiff line numberDiff line change
@@ -2996,6 +2996,22 @@ class MultiTaskLassoCV(RegressorMixin, LinearModelCV):
29962996
29972997
.. versionadded:: 1.0
29982998
2999+
See Also
3000+
--------
3001+
MultiTaskElasticNet : Multi-task ElasticNet model trained with L1/L2
3002+
mixed-norm as regularizer.
3003+
ElasticNetCV : Elastic net model with best model selection by
3004+
cross-validation.
3005+
MultiTaskElasticNetCV : Multi-task L1/L2 ElasticNet with built-in
3006+
cross-validation.
3007+
3008+
Notes
3009+
-----
3010+
The algorithm used to fit the model is coordinate descent.
3011+
3012+
To avoid unnecessary memory duplication the X and y arguments of the fit
3013+
method should be directly passed as Fortran-contiguous numpy arrays.
3014+
29993015
Examples
30003016
--------
30013017
>>> from sklearn.linear_model import MultiTaskLassoCV
@@ -3009,19 +3025,6 @@ class MultiTaskLassoCV(RegressorMixin, LinearModelCV):
30093025
0.5713...
30103026
>>> reg.predict(X[:1,])
30113027
array([[153.7971..., 94.9015...]])
3012-
3013-
See Also
3014-
--------
3015-
MultiTaskElasticNet
3016-
ElasticNetCV
3017-
MultiTaskElasticNetCV
3018-
3019-
Notes
3020-
-----
3021-
The algorithm used to fit the model is coordinate descent.
3022-
3023-
To avoid unnecessary memory duplication the X and y arguments of the fit
3024-
method should be directly passed as Fortran-contiguous numpy arrays.
30253028
"""
30263029

30273030
path = staticmethod(lasso_path)

0 commit comments

Comments
 (0)