DOC Improve pairwise_distances docstring
#31176
Merged
+21
−16
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
jeremiedbb
approved these changes
Apr 11, 2025
sklearn/metrics/pairwise.py
Outdated
| @@ -2285,26 +2285,31 @@ def pairwise_distances( | |||
| ): | |||
| """Compute the distance matrix from a vector array X and optional Y. | |||
|
|
|||
| This method takes either a vector array or a distance matrix, and returns | |||
| This method takes one or two vector arrays or a distance matrix, and returns | |||
There was a problem hiding this comment.
it's a function.
Suggested change
| This method takes one or two vector arrays or a distance matrix, and returns | |
| This function takes one or two vector arrays or a distance matrix, and returns |
let's update pairwise kernels as well
|
Thanks @jeremiedbb ! Changes made. Any thoughts on:
|
|
I find feature array more explicit. |
jeremiedbb
approved these changes
Apr 14, 2025
|
Thanks @jeremiedbb ! I've amended to "feature array" - there was one use case of "vector array" in |
|
Thanks |
lucyleeow
added a commit
to EmilyXinyi/scikit-learn
that referenced
this pull request
Apr 23, 2025
Co-authored-by: Jérémie du Boisberranger <jeremie@probabl.ai>
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
pairwise_distancesdocstring to be consistent withpairwise_kernels(which was updated in DOC Improvepairwise_kerneldocstring #31103)What does this implement/fix? Explain your changes.
Any other comments?
Also noticed that we use the term "vector array" in the docstring description, but later in the parameter description, we use the term "feature array" - should we be more consistent? Maybe some users will not quickly realise these mean the same thing.
cc @jeremiedbb @thomasjpfan who reviewed the previous RP