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

Skip to content

DOC Ensures that make_sparse_spd_matrix passes numpydoc #22332

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 1 commit into from
Jan 29, 2022
Merged

DOC Ensures that make_sparse_spd_matrix passes numpydoc #22332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions sklearn/datasets/_samples_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1411,7 +1411,7 @@ def make_sparse_spd_matrix(

norm_diag : bool, default=False
Whether to normalize the output matrix to make the leading diagonal
elements all 1
elements all 1.

smallest_coef : float, default=0.1
The value of the smallest coefficient between 0 and 1.
Expand All @@ -1429,15 +1429,15 @@ def make_sparse_spd_matrix(
prec : sparse matrix of shape (dim, dim)
The generated matrix.

See Also
--------
make_spd_matrix : Generate a random symmetric, positive-definite matrix.

Notes
-----
The sparsity is actually imposed on the cholesky factor of the matrix.
Thus alpha does not translate directly into the filling fraction of
the matrix itself.

See Also
--------
make_spd_matrix
"""
random_state = check_random_state(random_state)

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 @@ -36,7 +36,6 @@
"sklearn.datasets._samples_generator.make_multilabel_classification",
"sklearn.datasets._samples_generator.make_regression",
"sklearn.datasets._samples_generator.make_sparse_coded_signal",
"sklearn.datasets._samples_generator.make_sparse_spd_matrix",
"sklearn.datasets._samples_generator.make_spd_matrix",
"sklearn.datasets._species_distributions.fetch_species_distributions",
"sklearn.datasets._svmlight_format_io.dump_svmlight_file",
Expand Down