Skip to content

DOC Ensures that empirical_covariance passes numpydoc validation #21439

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 4 commits into from
Oct 24, 2021
Merged

DOC Ensures that empirical_covariance passes numpydoc validation #21439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7cd91f4
Remove empirical_covariance from FUNCTION_DOCSTRING_IGNORE_LIST
genvalen Oct 24, 2021
327cfaf
Ensure empirical_covariance passes numpydoc validation
genvalen Oct 24, 2021
d5a70a3
Add backticks to bool values in docstring
genvalen Oct 24, 2021
cc2b145
Merge branch 'main' into numpydoc_empirical_covariance
glemaitre Oct 24, 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 @@ -30,7 +30,6 @@
"sklearn.cluster._optics.compute_optics_graph",
"sklearn.cluster._spectral.spectral_clustering",
"sklearn.compose._column_transformer.make_column_transformer",
"sklearn.covariance._empirical_covariance.empirical_covariance",
"sklearn.covariance._graph_lasso.graphical_lasso",
"sklearn.covariance._robust_covariance.fast_mcd",
"sklearn.covariance._shrunk_covariance.ledoit_wolf",
Expand Down
9 changes: 4 additions & 5 deletions sklearn/covariance/_empirical_covariance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,19 +49,18 @@ def log_likelihood(emp_cov, precision):


def empirical_covariance(X, *, assume_centered=False):
"""Computes the Maximum likelihood covariance estimator

"""Compute the Maximum likelihood covariance estimator.

Parameters
----------
X : ndarray of shape (n_samples, n_features)
Data from which to compute the covariance estimate
Data from which to compute the covariance estimate.

assume_centered : bool, default=False
If True, data will not be centered before computation.
If `True`, data will not be centered before computation.
Useful when working with data whose mean is almost, but not exactly
zero.
If False, data will be centered before computation.
If `False`, data will be centered before computation.

Returns
-------
Expand Down