DOC Ensures that metrics.pairwise.euclidean_distances passes numpydoc validation #21429
Conversation
This file contains 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
ogrisel
approved these changes
Oct 23, 2021
glemaitre
reviewed
Oct 23, 2021
| @@ -250,6 +249,7 @@ def euclidean_distances( | |||
| Parameters | |||
| ---------- | |||
| X : {array-like, sparse matrix} of shape (n_samples_X, n_features) | |||
| Array containing points. | |||
|
|
|||
| Y : {array-like, sparse matrix} of shape (n_samples_Y, n_features), \ | |||
| default=None | |||
There was a problem hiding this comment.
Just below, you can as well add:
An array where each row is a sample and each column is a feature. There was a problem hiding this comment.
You still need to add this line here.
There was a problem hiding this comment.
@glemaitre Got it! Adding this now
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
reviewed
Oct 23, 2021
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
|
Thanks @embandera |
ogrisel
pushed a commit
to ogrisel/scikit-learn
that referenced
this pull request
Oct 28, 2021
… validation (scikit-learn#21429) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin
pushed a commit
to samronsin/scikit-learn
that referenced
this pull request
Nov 30, 2021
… validation (scikit-learn#21429) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
to glemaitre/scikit-learn
that referenced
this pull request
Dec 24, 2021
… validation (scikit-learn#21429) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
glemaitre
added a commit
that referenced
this pull request
Dec 25, 2021
… validation (#21429) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.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.
Reference Issues/PRs
Addresses #21350
#DataUmbrella
What does this implement/fix? Explain your changes.
This PR ensures metrics.pairwise.euclidean_distances is compatible with numpydoc:
Any other comments?
Partner: @genvalen