Skip to content

Commit

Permalink
Fixing parameter description (for assume_centered) (scikit-learn#13456)
Browse files Browse the repository at this point in the history
* Fixing parameter description (for assume_centered)

Fixing parameter description (for assume_centered)

* Update shrunk_covariance_.py

* Update empirical_covariance_.py
  • Loading branch information
falaktheoptimist authored and agramfort committed Apr 17, 2019
1 parent 2e6b6ea commit 7243cc3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions sklearn/covariance/empirical_covariance_.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ def empirical_covariance(X, assume_centered=False):
Data from which to compute the covariance estimate
assume_centered : boolean
If True, data are not 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 are centered before computation.
If False, data will be centered before computation.
Returns
-------
Expand Down
24 changes: 12 additions & 12 deletions sklearn/covariance/shrunk_covariance_.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ class ShrunkCovariance(EmpiricalCovariance):
Specify if the estimated precision is stored
assume_centered : boolean, default False
If True, data are not 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 are centered before computation.
If False, data will be centered before computation.
shrinkage : float, 0 <= shrinkage <= 1, default 0.1
Coefficient in the convex combination used for the computation
Expand Down Expand Up @@ -175,10 +175,10 @@ def ledoit_wolf_shrinkage(X, assume_centered=False, block_size=1000):
Data from which to compute the Ledoit-Wolf shrunk covariance shrinkage.
assume_centered : bool
If True, data are not centered before computation.
If True, data will not be centered before computation.
Useful to work with data whose mean is significantly equal to
zero but is not exactly zero.
If False, data are centered before computation.
If False, data will be centered before computation.
block_size : int
Size of the blocks into which the covariance matrix will be split.
Expand Down Expand Up @@ -270,10 +270,10 @@ def ledoit_wolf(X, assume_centered=False, block_size=1000):
Data from which to compute the covariance estimate
assume_centered : boolean, default=False
If True, data are not centered before computation.
If True, data will not be centered before computation.
Useful to work with data whose mean is significantly equal to
zero but is not exactly zero.
If False, data are centered before computation.
If False, data will be centered before computation.
block_size : int, default=1000
Size of the blocks into which the covariance matrix will be split.
Expand Down Expand Up @@ -339,10 +339,10 @@ class LedoitWolf(EmpiricalCovariance):
Specify if the estimated precision is stored.
assume_centered : bool, default=False
If True, data are not 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 (default), data are centered before computation.
If False (default), data will be centered before computation.
block_size : int, default=1000
Size of the blocks into which the covariance matrix will be split
Expand Down Expand Up @@ -448,10 +448,10 @@ def oas(X, assume_centered=False):
Data from which to compute the covariance estimate.
assume_centered : boolean
If True, data are not centered before computation.
If True, data will not be centered before computation.
Useful to work with data whose mean is significantly equal to
zero but is not exactly zero.
If False, data are centered before computation.
If False, data will be centered before computation.
Returns
-------
Expand Down Expand Up @@ -525,10 +525,10 @@ class OAS(EmpiricalCovariance):
Specify if the estimated precision is stored.
assume_centered : bool, default=False
If True, data are not 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 (default), data are centered before computation.
If False (default), data will be centered before computation.
Attributes
----------
Expand Down

0 comments on commit 7243cc3

Please sign in to comment.