Skip to content
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

Add supported CPU/GPU operators to API docs and update docstrings #5239

Merged

Conversation

beckernick
Copy link
Member

@beckernick beckernick commented Feb 17, 2023

This PR:

  • Adds a section to the Module Configuration section of the API documentation (next to the section on Verbosity Levels). As device selection capabilities can be configured, this feels like a reasonable location
  • Updates the relevant estimator docstrings with a reference to device selection (always at the bottom of the "Extended Summary" section, based on recommendations in the numpydoc Style Guide) and a link to the documentation to learn more.

This closes #5143 and closes #5144

This is a replacement for #5150

@beckernick beckernick added doc Documentation non-breaking Non-breaking change labels Feb 17, 2023
@beckernick beckernick self-assigned this Feb 17, 2023
@github-actions github-actions bot added the Cython / Python Cython or Python issue label Feb 17, 2023
@@ -341,6 +341,10 @@ class HDBSCAN(UniversalBase, ClusterMixin, CMajorInputTagMixin):
(and often will) lead to some points being assigned different
cluster labels between the two implementations.

This estimator supports cuML's experimental device selection capabilities.
Copy link
Contributor

Choose a reason for hiding this comment

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

@beckernick I'll comment again just so it's in my "reviewed" list. Feel free to delete your comment after that.

Should we maybe automatically add this comment via a common decorator? Something like @device_interop_enabled ? This would also allow us to (maybe at a later stage) set some flag that helps with testing. This could of course be done in a follow-up to not block this PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! I agree. Doc utilities for this kind of behavior is a great idea.

Copy link
Member

Choose a reason for hiding this comment

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

It can be added to https://github.com/rapidsai/cuml/blob/branch-23.04/python/cuml/common/doc_utils.py, @beckernick could you open an issue to do it in a follow up? Thanks!

@beckernick beckernick marked this pull request as ready for review February 17, 2023 17:17
@beckernick beckernick requested a review from a team as a code owner February 17, 2023 17:17
@dantegd
Copy link
Member

dantegd commented Feb 21, 2023

/merge

@rapids-bot rapids-bot bot merged commit f907cdf into rapidsai:branch-23.04 Feb 21, 2023
@beckernick beckernick deleted the docs/device-selection-support branch February 21, 2023 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cython / Python Cython or Python issue doc Documentation non-breaking Non-breaking change
Projects
None yet
3 participants