Skip to content

DOC Add third-party app example for cuml.accel - #8094

Merged
rapids-bot[bot] merged 6 commits into
NVIDIA:release/26.06from
betatim:embedding-atlas-example
May 15, 2026
Merged

DOC Add third-party app example for cuml.accel#8094
rapids-bot[bot] merged 6 commits into
NVIDIA:release/26.06from
betatim:embedding-atlas-example

Conversation

@betatim

@betatim betatim commented May 13, 2026

Copy link
Copy Markdown
Contributor

This adds to the cuml.accel documentation and documents the "third party application" use-case.

@betatim
betatim requested a review from a team as a code owner May 13, 2026 06:17
@betatim
betatim requested a review from dantegd May 13, 2026 06:17
Comment thread docs/source/cuml-accel/third-party-apps.rst Outdated
@coderabbitai

coderabbitai Bot commented May 13, 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: 89bbdf5e-da45-45f3-b509-650e52e4446e

📥 Commits

Reviewing files that changed from the base of the PR and between 3670d25 and 5df3ca9.

📒 Files selected for processing (2)
  • docs/source/cuml-accel/examples/third-party-apps.rst
  • docs/source/cuml-accel/index.rst
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/source/cuml-accel/index.rst
  • docs/source/cuml-accel/examples/third-party-apps.rst

📝 Walkthrough

Summary by CodeRabbit

Documentation

  • Clarified using the zero-code accelerator to boost third-party application performance without modifying their code.
  • Added a how-to guide showing enabling acceleration via environment configuration, with an end-to-end example comparing CPU vs GPU runs.
  • Described how to verify GPU dispatch through logging and how to detect CPU fallbacks and performance considerations.
  • Ensured the new example is included in the examples index.

Walkthrough

Adds documentation describing how to enable cuML's zero-code GPU acceleration for third‑party Python applications via the CUML_ACCEL_ENABLED environment variable, includes an embedding‑atlas walkthrough, and documents discovery and CPU fallback troubleshooting.

Changes

Third-party Application Acceleration Guide

Layer / File(s) Summary
Index and feature introduction
docs/source/cuml-accel/index.rst, docs/source/cuml-accel/examples/index.rst, docs/source/cuml-accel/examples/third-party-apps.rst (intro)
Adds a Sphinx anchor and toctree entry; introduces CUML_ACCEL_ENABLED, describes the .pth startup interception, and notes the approach is useful for accelerating third‑party apps without modifying their code.
Embedding-atlas walkthrough and verification
docs/source/cuml-accel/examples/third-party-apps.rst (walkthrough)
End-to-end embedding‑atlas example with CPU vs GPU invocation using CUML_ACCEL_ENABLED=1, explanation of where cuml.accel intercepts umap.UMAP.fit_transform, and GPU dispatch verification via CUML_ACCEL_LOG_LEVEL=info.
Discovery and CPU fallback troubleshooting
docs/source/cuml-accel/examples/third-party-apps.rst (discovery & fallback)
Guidance to identify acceleratable applications (look for sklearn estimators, umap.UMAP, hdbscan.HDBSCAN) and instructions to detect silent CPU fallbacks via info/debug logs showing falling back to CPU with reasons.

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for third-party app examples to cuml.accel.
Description check ✅ Passed The description is directly related to the changeset, explaining that it adds documentation for the third-party application use case to cuml.accel.
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

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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: 2

🤖 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/cuml-accel/third-party-apps.rst`:
- Around line 1-3: This file is missing the required repository copyright
header; add the standard project file header block immediately before the
document title "Accelerating Third-Party Applications" (i.e., at the top of the
file), using the repository's canonical header template and updating year/owner
fields as required so the file header format and content match other files in
the codebase.
- Around line 18-19: Update the wording to match the rest of the docs: clarify
that the environment variable CUML_ACCEL_ENABLED can be set to "1" or "true"
(case-insensitive) to activate accel, and that when set it causes
cuml.accel.install() to be called at the start of every Python process; replace
the current sentence that only mentions `CUML_ACCEL_ENABLED=1` with this
inclusive phrasing to ensure consistency with docs/source/cuml-accel/index.rst.
🪄 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: a4d3719d-5189-4d04-91c2-800d9dac32f6

📥 Commits

Reviewing files that changed from the base of the PR and between 57426c4 and 99fbcf6.

📒 Files selected for processing (2)
  • docs/source/cuml-accel/index.rst
  • docs/source/cuml-accel/third-party-apps.rst

Comment thread docs/source/cuml-accel/examples/third-party-apps.rst
Comment thread docs/source/cuml-accel/third-party-apps.rst Outdated
@betatim betatim added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change and removed improvement Improvement / enhancement to an existing function labels May 13, 2026
Comment thread docs/source/cuml-accel/examples/third-party-apps.rst
Comment thread docs/source/cuml-accel/third-party-apps.rst Outdated
Comment thread docs/source/cuml-accel/third-party-apps.rst Outdated
@betatim
betatim changed the base branch from main to release/26.06 May 15, 2026 14:22
@jcrist

jcrist commented May 15, 2026

Copy link
Copy Markdown
Member

/merge

@rapids-bot
rapids-bot Bot merged commit 4ad59e4 into NVIDIA:release/26.06 May 15, 2026
56 checks passed
@betatim
betatim deleted the embedding-atlas-example branch May 18, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants