Skip to content

DOC Ensures that Lars passes numpydoc validation #20472

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 53 commits into from
Jul 6, 2021
Merged

DOC Ensures that Lars passes numpydoc validation #20472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
1a7f2fb
Update default doc string values
genvalen Jun 6, 2020
ca94a79
Update default docstrings for Metrics
genvalen Jun 7, 2020
cc09f9d
Fix lint error
genvalen Jun 7, 2020
a899bef
Merge remote-tracking branch 'upstream/master' into linear-model-defa…
genvalen Jun 7, 2020
c8cd424
Resolve merge conflicts
genvalen Jun 7, 2020
da935ac
Fix flake8 error
genvalen Jun 7, 2020
bede6d0
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
7b4647e
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
cfe8b2b
Update sklearn/metrics/_base.py
genvalen Jun 9, 2020
1ec16e8
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
5e52205
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
8df195e
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
c93effd
Update sklearn/metrics/pairwise.py
genvalen Jun 9, 2020
57ca202
Update sklearn/metrics/pairwise.py
genvalen Jun 9, 2020
3937592
Update sklearn/metrics/pairwise.py
genvalen Jun 9, 2020
a069d00
Update sklearn/metrics/pairwise.py
genvalen Jun 9, 2020
a82ee38
Update sklearn/metrics/pairwise.py
genvalen Jun 9, 2020
572ca85
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
89af371
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
601c757
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
4ed3830
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
1fa4425
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
48a5908
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
881f733
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
c85c836
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
9286fcb
Update sklearn/metrics/_classification.py
genvalen Jun 9, 2020
8367323
Update sklearn/metrics/_ranking.py
genvalen Jun 9, 2020
056c8e9
Update sklearn/metrics/_classification.py
genvalen Jun 10, 2020
036b8b6
Update sklearn/metrics/_classification.py
genvalen Jun 10, 2020
1a83796
Update sklearn/metrics/_classification.py
genvalen Jun 10, 2020
a3d0e1a
Update sklearn/metrics/_ranking.py
genvalen Jun 10, 2020
8573644
Update sklearn/metrics/_ranking.py
genvalen Jun 11, 2020
c291010
Update sklearn/metrics/_ranking.py
genvalen Jun 11, 2020
40dc8b0
Update sklearn/metrics/_ranking.py
genvalen Jun 12, 2020
769e6fb
Update sklearn/metrics/_ranking.py
genvalen Jun 12, 2020
0848721
Update sklearn/metrics/_regression.py
genvalen Jun 12, 2020
37963a2
Apply suggestions from code review
genvalen Jun 12, 2020
dc5cc39
Make edits
genvalen Jun 12, 2020
711658b
Make edits
genvalen Jun 12, 2020
808e240
Fix merge conflicts
genvalen Jun 11, 2021
0da8b25
Fix another merge conflict
genvalen Jun 11, 2021
abeeb66
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jun 12, 2021
12082a8
Merge remote-tracking branch 'upstream/main' into main
genvalen Jun 20, 2021
f592334
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jun 26, 2021
c826dc9
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jun 29, 2021
1f701ee
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jun 29, 2021
20ab7df
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jun 30, 2021
0c63c29
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jul 2, 2021
0fa9b85
Accept incoming change from previous merge
genvalen Jul 2, 2021
c8c6886
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jul 5, 2021
97f16c1
Merge branch 'main' of https://github.com/scikit-learn/scikit-learn i…
genvalen Jul 6, 2021
e0ab807
Remove Lars from DOCSTRING_IGNORE_LIST.
genvalen Jul 6, 2021
4da84c4
Ensure Lars passes numpydoc validation
genvalen Jul 6, 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 @@ -75,7 +75,6 @@
"LabelEncoder",
"LabelPropagation",
"LabelSpreading",
"Lars",
"LarsCV",
"LassoCV",
"LassoLars",
Expand Down
17 changes: 9 additions & 8 deletions sklearn/linear_model/_least_angle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -842,7 +842,7 @@ def _lars_path_solver(


class Lars(MultiOutputMixin, RegressorMixin, LinearModel):
"""Least Angle Regression model a.k.a. LAR
"""Least Angle Regression model a.k.a. LAR.

Read more in the :ref:`User Guide <least_angle_regression>`.

Expand Down Expand Up @@ -940,6 +940,13 @@ class Lars(MultiOutputMixin, RegressorMixin, LinearModel):

.. versionadded:: 0.24

See Also
--------
lars_path: Compute Least Angle Regression or Lasso
path using LARS algorithm.
LarsCV : Cross-validated Least Angle Regression model.
sklearn.decomposition.sparse_encode : Sparse coding.

Examples
--------
>>> from sklearn import linear_model
Expand All @@ -948,12 +955,6 @@ class Lars(MultiOutputMixin, RegressorMixin, LinearModel):
Lars(n_nonzero_coefs=1, normalize=False)
>>> print(reg.coef_)
[ 0. -1.11...]

See Also
--------
lars_path, LarsCV
sklearn.decomposition.sparse_encode

"""

method = "lar"
Expand Down Expand Up @@ -1094,7 +1095,7 @@ def fit(self, X, y, Xy=None):
Returns
-------
self : object
returns an instance of self.
Returns an instance of self.
"""
X, y = self._validate_data(X, y, y_numeric=True, multi_output=True)

Expand Down