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] Add code examples #1784

Open
bdice opened this issue Jan 14, 2025 · 1 comment
Open

[DOC] Add code examples #1784

bdice opened this issue Jan 14, 2025 · 1 comment
Assignees
@bdice
Labels
doc Documentation

Comments

@bdice
Copy link
Contributor

bdice commented Jan 14, 2025 •
edited
Loading

Currently RMM does not provide any self-contained code examples like cudf or cuvs.

New users would benefit from seeing minimal, correct, and educational patterns of C++ usage and CMake build infrastructure.

One specific example we should include is using RMM in a multi-thread, multi-stream application, as that is a common request that our documentation does not serve well today.

The code examples should build and be run in our CI, as we do for cudf and cuvs.
@bdice bdice added the doc Documentation label Jan 14, 2025
@bdice bdice self-assigned this Jan 14, 2025
@bdice bdice mentioned this issue Jan 30, 2025
Merged
3 tasks
@bdice
Copy link
Contributor Author

bdice commented Mar 1, 2025 •
edited
Loading

Initial steps in #1800. I filed a follow-up in #1845 to test examples in CI.

Intermediate / advanced example codes are still needed.

rapids-bot bot pushed a commit that referenced this issue Mar 1, 2025
@bdice
Add basic example. (#1800)
b44ebb6 
This is a skeleton for adding examples, requested in issue #1784.

I plan to merge some minimal form of this, and then add a few examples that answer common questions about RMM, such as how to use specific memory resource adaptors or how to use RMM for managing multi-thread, multi-stream work.

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - Jake Awe (https://github.com/AyodeAwe)
  - Mark Harris (https://github.com/harrism)
  - Lawrence Mitchell (https://github.com/wence-)

URL: #1800
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bdice bdice

Labels
doc Documentation
Projects
RMM Project Board
Status: To-do
Milestone
No milestone
Development

No branches or pull requests
1 participant
@bdice