Skip to content

Add "Advanced Topics" doc - #8134

Merged
rapids-bot[bot] merged 3 commits into
NVIDIA:release/26.06from
jcrist:advanced-topics-doc
May 21, 2026
Merged

Add "Advanced Topics" doc#8134
rapids-bot[bot] merged 3 commits into
NVIDIA:release/26.06from
jcrist:advanced-topics-doc

Conversation

@jcrist

@jcrist jcrist commented May 19, 2026

Copy link
Copy Markdown
Member

Adds a new doc with some advanced topics. Includes:

  • CUDA streams and synchronization
  • CUDA device selection
  • A very small section on configuring RMM. I wanted to mention something, but not provide a full guide. Once the upstream RMM one lands we can link there.

xref #8128

@jcrist jcrist self-assigned this May 19, 2026
@jcrist
jcrist requested review from a team as code owners May 19, 2026 19:01
@jcrist jcrist added improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels May 19, 2026
@jcrist
jcrist requested review from divyegala and gforsyth May 19, 2026 19:01
@coderabbitai

coderabbitai Bot commented May 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 24af9e01-ad88-4d75-b5e8-12663f02f669

📥 Commits

Reviewing files that changed from the base of the PR and between 729567f and b3600e6.

📒 Files selected for processing (2)
  • docs/source/advanced.rst
  • docs/source/conf.py
✅ Files skipped from review due to trivial changes (2)
  • docs/source/conf.py
  • docs/source/advanced.rst

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Added an "Advanced Topics" doc covering CUDA stream synchronization, GPU device selection, and memory manager configuration with examples and references.
    • Updated the docs table of contents to include the new Advanced Topics page.
    • Added cross-reference links to cuPy, CUDA, and RMM documentation.
  • Chores

    • Expanded build artifact ignore patterns for docs outputs.

Walkthrough

Adds a new Advanced Topics Sphinx page on CUDA streams, device selection, and RMM allocator configuration; updates the user guide TOC and intersphinx mappings; and expands .gitignore to exclude additional documentation build artifacts (models, pickles, joblib, ONNX, etc.).

Changes

Advanced Topics Documentation

Layer / File(s) Summary
Advanced Topics content
docs/source/advanced.rst
New Sphinx page covering CUDA stream synchronization (PTDS vs legacy), default CUDA device selection and CUDA_VISIBLE_DEVICES, and RMM memory allocator configuration with code examples and references.
Documentation navigation and build artifacts
docs/source/user_guide.rst, docs/source/conf.py, .gitignore
Adds advanced.rst to the user guide TOC; extends intersphinx_mapping with cupy, cuda.core, and rmm; updates .gitignore to ignore *.model, *.pkl, *.tl, *.joblib, and docs/source/**/*.onnx.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

  • Add advanced-topics docs #8128: Implements the requested "Advanced Topics" documentation page covering CUDA streams, device selection, and RMM configuration.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change—addition of new documentation covering advanced topics (CUDA streams, device selection, RMM configuration).
Description check ✅ Passed The description is directly related to the changeset, clearly explaining what was added (CUDA streams/synchronization, device selection, RMM configuration section) and linking to the related issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/source/advanced.rst`:
- Around line 90-91: The RST named target "Rapids Memory Manager" is declared
without a URL (broken target); replace the bare target ".. _Rapids Memory
Manager:" with a proper external target that includes the RMM docs URL (for
example ".. _Rapids Memory Manager: https://docs.rapids.ai/api/rmm/stable/") or
ensure the referenced label used elsewhere matches an existing target; update
the target declaration so the reference to "Rapids Memory Manager" resolves
cleanly during Sphinx build.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: aef5908e-f36b-490f-bdf0-4884b2597bd3

📥 Commits

Reviewing files that changed from the base of the PR and between ac61931 and 2622a5b.

📒 Files selected for processing (3)
  • .gitignore
  • docs/source/advanced.rst
  • docs/source/user_guide.rst

Comment thread docs/source/advanced.rst

@csadorf csadorf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the write-up! I have some suggestions for improvement.

Comment thread docs/source/advanced.rst Outdated
Comment thread docs/source/advanced.rst
Comment thread docs/source/advanced.rst Outdated
Comment thread docs/source/advanced.rst Outdated
jcrist added 2 commits May 21, 2026 09:56
Adds a new doc with some advanced topics. Includes:

- CUDA streams and synchronization
- CUDA device selection
- A very small section on configuring RMM. I wanted to mention
  something, but not provide a full guide. Once the upstream RMM one
  lands we can link there.
@jcrist
jcrist force-pushed the advanced-topics-doc branch from 2622a5b to 729567f Compare May 21, 2026 16:37
@jcrist
jcrist force-pushed the advanced-topics-doc branch from 729567f to b3600e6 Compare May 21, 2026 16:45
@jcrist

jcrist commented May 21, 2026

Copy link
Copy Markdown
Member Author

I believe all comments have been addressed.

@jcrist

jcrist commented May 21, 2026

Copy link
Copy Markdown
Member Author

/merge

@rapids-bot
rapids-bot Bot merged commit c2eaf61 into NVIDIA:release/26.06 May 21, 2026
187 of 191 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improvement / enhancement to an existing function non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants