Skip to content

DOC Ensures that metrics.pairwise.euclidean_distances passes numpydoc validation#21429

Merged
glemaitre merged 10 commits intoscikit-learn:mainfrom
embandera:euclidian_distances-numpydoc
Oct 24, 2021
Merged

DOC Ensures that metrics.pairwise.euclidean_distances passes numpydoc validation#21429
glemaitre merged 10 commits intoscikit-learn:mainfrom
embandera:euclidian_distances-numpydoc

Conversation

@embandera
Copy link
Copy Markdown
Contributor

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:

  • Remove metrics.pairwise.euclidean_distances from DOCSTRING_IGNORE_LIST.
  • Verify that all tests are passing.

Any other comments?

Partner: @genvalen

@embandera embandera marked this pull request as ready for review October 23, 2021 17:20
Copy link
Copy Markdown
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @embandera and @genvalen!

Copy link
Copy Markdown
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of changes

Array containing points.

Y : {array-like, sparse matrix} of shape (n_samples_Y, n_features), \
default=None
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just below, you can as well add:

An array where each row is a sample and each column is a feature. 

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You still need to add this line here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@glemaitre Got it! Adding this now

embandera and others added 5 commits October 23, 2021 14:01
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 glemaitre self-requested a review October 23, 2021 21:14
embandera and others added 2 commits October 23, 2021 14:18
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
@glemaitre glemaitre merged commit cbf04c9 into scikit-learn:main Oct 24, 2021
@glemaitre
Copy link
Copy Markdown
Member

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants