Skip to content

Commit 1c1ec5b

Browse files
Krish0909Krishnan Vigneshjeremiedbb
authored
DOC: Fix assume_centered parameter documentation in EmpiricalCovariance (scikit-learn#31809)
Co-authored-by: Krishnan Vignesh <krishnanvignesh@Krishnans-MacBook-Air.local> Co-authored-by: Jérémie du Boisberranger <jeremie@probabl.ai>
1 parent 3843f82 commit 1c1ec5b

1 file changed

Lines changed: 3 additions & 4 deletions

File tree

doc/modules/covariance.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,9 @@ The empirical covariance matrix of a sample can be computed using the
3535
:class:`EmpiricalCovariance` object to the data sample with the
3636
:meth:`EmpiricalCovariance.fit` method. Be careful that results depend
3737
on whether the data are centered, so one may want to use the
38-
``assume_centered`` parameter accurately. More precisely, if
39-
``assume_centered=False``, then the test set is supposed to have the
40-
same mean vector as the training set. If not, both should be centered
41-
by the user, and ``assume_centered=True`` should be used.
38+
`assume_centered` parameter accurately. More precisely, if `assume_centered=True`, then
39+
all features in the train and test sets should have a mean of zero. If not, both should
40+
be centered by the user, or `assume_centered=False` should be used.
4241

4342
.. rubric:: Examples
4443

0 commit comments

Comments
 (0)