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.

Sign up for GitHub

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

Jump to bottom

[DOC] Operators that support device selection should indicate this capability in documentation. #5144

Closed
beckernick opened this issue Jan 20, 2023 · 0 comments · Fixed by #5239
Closed

[DOC] Operators that support device selection should indicate this capability in documentation. #5144

beckernick opened this issue Jan 20, 2023 · 0 comments · Fixed by #5239
Labels
Cython / Python Cython or Python issue doc Documentation

Comments

@beckernick
Copy link
Member

As noted in #5130 (comment) , operators that support CPU/GPU device selection should indicate this capability in their docstrings.
@beckernick beckernick added doc Documentation Cython / Python Cython or Python issue labels Jan 20, 2023
@beckernick beckernick mentioned this issue Jan 27, 2023
Closed
@beckernick beckernick mentioned this issue Feb 17, 2023
Merged
rapids-bot bot pushed a commit that referenced this issue Feb 21, 2023
@beckernick
Add supported CPU/GPU operators to API docs and update docstrings (#5239
f907cdf 
)

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](https://numpydoc.readthedocs.io/en/latest/format.html#sections)) and a link to the documentation to learn more. 

This closes #5143 and closes #5144

This is a replacement for #5150

Authors:
  - Nick Becker (https://github.com/beckernick)

Approvers:
  - Dante Gama Dessavre (https://github.com/dantegd)

URL: #5239
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Cython / Python Cython or Python issue doc Documentation
Projects
None yet
Milestone
No milestone
1 participant
@beckernick