Add "Advanced Topics" doc - #8134
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdds 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.). ChangesAdvanced Topics Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (3)
.gitignoredocs/source/advanced.rstdocs/source/user_guide.rst
csadorf
left a comment
There was a problem hiding this comment.
Thanks for the write-up! I have some suggestions for improvement.
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.
2622a5b to
729567f
Compare
729567f to
b3600e6
Compare
|
I believe all comments have been addressed. |
|
/merge |
c2eaf61
into
NVIDIA:release/26.06
Adds a new doc with some advanced topics. Includes:
xref #8128