DOC fix docstring of EllipticEnvelope.fit #22997
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit updates the fit(X, y) definition, in the docs, of the sklearn.covariance.EllipticEnvelope class.
The original definition stated that parameter X could be of type 'array-like' or 'sparse matrix', however,
an error would be thrown if a 'sparse matrix' is passed ("TypeError: A sparse matrix was passed, but dense
data is required."). To resolve this, 'sparse matrix' was removed from the list of types X could be, in the
docstring.
This commit is part of the process to update the docs on the sklearn.covariance.EllipticEnvelope class's fit(X, y) definition, as explained in issue #14613.
jeremiedbb
reviewed
Mar 30, 2022
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
jeremiedbb
approved these changes
Mar 30, 2022
|
Thanks @Ben3940 |
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Apr 6, 2022
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
jjerphan
pushed a commit
to jjerphan/scikit-learn
that referenced
this pull request
Apr 29, 2022
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the
fit(X, y)definition, in the docs, of thesklearn.covariance.EllipticEnvelopeclass. The original definition stated that parameter X could be of type'array-like'or'sparse matrix', however, an error would be thrown if a 'sparse matrix' is passed (TypeError: A sparse matrix was passed, but dense data is required.). To resolve this,'sparse matrix'was removed from the list of types X could be, in the docstring.Fixes #14613