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

Skip to content

DOC Ensure manifold._locally_linear.locally_linear_embedding passes numpydoc validation #24330

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 2 commits into from
Sep 2, 2022
Merged

DOC Ensure manifold._locally_linear.locally_linear_embedding passes numpydoc validation #24330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7612eea
correct docstring
maikia Sep 2, 2022
cab1499
Merge branch 'main' into locally_linear_embedding_doc
jeremiedbb Sep 2, 2022
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
14 changes: 7 additions & 7 deletions sklearn/manifold/_locally_linear.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ def barycenter_weights(X, Y, indices, reg=1e-3):
Indices of the points in Y used to compute the barycenter

reg : float, default=1e-3
amount of regularization to add for the problem to be
Amount of regularization to add for the problem to be
well-posed in the case of n_neighbors > n_dim

Returns
Expand Down Expand Up @@ -224,13 +224,13 @@ def locally_linear_embedding(
numpy array or a NearestNeighbors object.

n_neighbors : int
number of neighbors to consider for each point.
Number of neighbors to consider for each point.

n_components : int
number of coordinates for the manifold.
Number of coordinates for the manifold.

reg : float, default=1e-3
regularization constant, multiplies the trace of the local covariance
Regularization constant, multiplies the trace of the local covariance
matrix of the distances.

eigen_solver : {'auto', 'arpack', 'dense'}, default='auto'
Expand All @@ -252,7 +252,7 @@ def locally_linear_embedding(
Not used if eigen_solver=='dense'.

max_iter : int, default=100
maximum number of iterations for the arpack solver.
Maximum number of iterations for the arpack solver.

method : {'standard', 'hessian', 'modified', 'ltsa'}, default='standard'
standard : use the standard locally linear embedding algorithm.
Expand All @@ -267,11 +267,11 @@ def locally_linear_embedding(

hessian_tol : float, default=1e-4
Tolerance for Hessian eigenmapping method.
Only used if method == 'hessian'
Only used if method == 'hessian'.

modified_tol : float, default=1e-12
Tolerance for modified LLE method.
Only used if method == 'modified'
Only used if method == 'modified'.

random_state : int, RandomState instance, default=None
Determines the random number generator when ``solver`` == 'arpack'.
Expand Down
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
"sklearn.decomposition._dict_learning.dict_learning",
"sklearn.externals._packaging.version.parse",
"sklearn.inspection._plot.partial_dependence.plot_partial_dependence",
"sklearn.manifold._locally_linear.locally_linear_embedding",
"sklearn.manifold._t_sne.trustworthiness",
"sklearn.metrics._plot.det_curve.plot_det_curve",
"sklearn.metrics._plot.precision_recall_curve.plot_precision_recall_curve",
Expand Down