Skip to content

docs: add CUDA prereq warning to examples#1455

Merged
rapids-bot[bot] merged 2 commits intoNVIDIA:release/1.4from
bbednarski9:bb/dynamo-cuda-dep-prereq
Jan 22, 2026
Merged

docs: add CUDA prereq warning to examples#1455
rapids-bot[bot] merged 2 commits intoNVIDIA:release/1.4from
bbednarski9:bb/dynamo-cuda-dep-prereq

Conversation

@bbednarski9
Copy link
Contributor

@bbednarski9 bbednarski9 commented Jan 22, 2026

Description

Adds an explicit warning about CUDA compatibility requirements and note about why ai-dynamo does not need to be explicitly installed
Closes

By Submitting this PR I confirm:

  • I am familiar with the Contributing Guidelines.
  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
    • Any contribution which contains commits that are not Signed-Off will not be accepted.
  • When the PR is ready for review, new or existing tests cover these changes.
  • When the PR is ready for review, the documentation is up to date with these changes.

Summary by CodeRabbit

  • Documentation
    • Clarified system requirements for Dynamo integration examples: a CUDA-compatible NVIDIA GPU and drivers are required; systems without NVIDIA GPUs are unsupported. Noted that provided Docker images include the necessary ai-dynamo packages.

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
@bbednarski9 bbednarski9 requested a review from a team as a code owner January 22, 2026 20:19
@bbednarski9 bbednarski9 added doc Improvements or additions to documentation non-breaking Non-breaking change labels Jan 22, 2026
@coderabbitai
Copy link

coderabbitai bot commented Jan 22, 2026

Walkthrough

Three README files in the Dynamo integration examples were updated to add identical warning blocks stating CUDA/NVIDIA GPU hardware and driver requirements; Docker images include ai-dynamo packages and examples cannot run on non-NVIDIA systems.

Changes

Cohort / File(s) Summary
CUDA Requirements Warnings
examples/dynamo_integration/README.md, examples/dynamo_integration/react_benchmark_agent/README.md, external/dynamo/README.md
Added warning blocks under Software Requirements stating a CUDA-compatible device with NVIDIA drivers is required; examples cannot run on systems without NVIDIA GPU hardware; ai-dynamo packages are included in provided Docker images.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately describes the main change: adding CUDA prerequisite warnings to example documentation using imperative mood and within the character limit.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Contributor

@mnajafian-nv mnajafian-nv left a comment

Choose a reason for hiding this comment

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

LGTM!
Minor suggestions

  1. The warning emoji (⚠️) is redundant since > [!WARNING] already adds a warning indicator in most markdown renderers.
  2. In technical documentation, avoid contractions like "do not" should be preferred over "don't".

Signed-off-by: Bryan Bednarski <bbednarski@nvidia.com>
@willkill07
Copy link
Member

/merge

@rapids-bot rapids-bot bot merged commit 3ce734c into NVIDIA:release/1.4 Jan 22, 2026
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants