Skip to content

DOC Update Pairwise Distances Reductions' documentation #27525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

jjerphan
Copy link
Member

@jjerphan jjerphan commented Oct 3, 2023

Reference Issues/PRs

Part of #25888.

What does this implement/fix? Explain your changes.

Since I do not have as much bandwidth for scikit-learn as before, I am wondering how we can continue to actively maintain a shared understanding and ownership of the Private Distances Reductions' submodule.

There are already a few external resources out, but they are not entirely up to date, and to me it is more appropriate to actually have pieces of knowledge sit next to the actual implementations.

Currently this PR updates to the documentation of the private Pairwise Distances Reductions' sub-module to reflect the latest changes.

What do you think? Do you have any suggestions to help in this regards?

Any other comments?

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
@github-actions
Copy link

github-actions bot commented Oct 3, 2023

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 6506817. Link to the linter CI: here

Copy link
Member

@lorentzenchr lorentzenchr left a comment

Choose a reason for hiding this comment

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

Apart from the authors 😆

jjerphan and others added 2 commits October 29, 2023 08:33
See: scikit-learn#20813

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>

Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com>
@jjerphan jjerphan marked this pull request as ready for review October 29, 2023 10:44
# x | | x
# +-----------⊳ ArgKmin{32,64} RadiusNeighbors{32,64} ⊲-------+
# | | ∆ ∆ | |
# ArgKminClassmode{32,64} | | | | RadiusNeighborsClassMode{32,64} # noqa: E501
Copy link
Member

Choose a reason for hiding this comment

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

ArgKminClassMode is the dispatcher for ArgKminClassmode{32, 64}. I'm not sure where to put that information in the diagram, without getting too confusing.

Copy link
Member Author

Choose a reason for hiding this comment

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

I proposed something in a198103.

jjerphan and others added 2 commits November 4, 2023 11:28
Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
@jjerphan jjerphan added the Waiting for Second Reviewer First reviewer is done, need a second one! label Nov 6, 2023
Copy link
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

LGTM

@thomasjpfan thomasjpfan merged commit 02da144 into scikit-learn:main Nov 7, 2023
@jjerphan jjerphan deleted the doc/pairwise-distances-reductions branch November 7, 2023 16:40
REDVM pushed a commit to REDVM/scikit-learn that referenced this pull request Nov 16, 2023
…#27525)

Signed-off-by: Julien Jerphanion <git@jjerphan.xyz>
Co-authored-by: Christian Lorentzen <lorentzen.ch@gmail.com>
Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation module:metrics Waiting for Second Reviewer First reviewer is done, need a second one!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants