Skip to content

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Oct 6, 2025

Description

  • Redeclare ARG after FROM stage to ensure visibility.
  • Fix path typo in documentation (should reference NeMo Agent toolkit rather than example)

Closes nvbugs-5561420

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

  • New Features

    • Docker images now support configurable build-time versions for Python, UV, and NAT via build arguments.
    • UV binaries are bundled during build for faster, reproducible environments.
    • Build-time validation ensures NAT version is provided.
  • Chores

    • Standardized build-arg declarations across example Dockerfiles for consistency and easier parameterization.
  • Documentation

    • Updated example guides to reference the NeMo Agent toolkit repository.
    • Refreshed Docker build instructions to align with the new configurable build args.

@willkill07 willkill07 self-assigned this Oct 6, 2025
@willkill07 willkill07 requested a review from a team as a code owner October 6, 2025 12:57
@willkill07 willkill07 added bug Something isn't working non-breaking Non-breaking change labels Oct 6, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 6, 2025

Walkthrough

Multiple Dockerfiles were updated to declare build-time arguments (PYTHON_VERSION, UV_VERSION, NAT_VERSION). The root docker/Dockerfile additionally copies uv binaries from a uv image and adds a NAT_VERSION presence check during setup. Two README files update repository naming in Docker build instructions. No code interfaces were changed.

Changes

Cohort / File(s) Summary of Changes
Core image build updates
docker/Dockerfile
Added ARGs PYTHON_VERSION, UV_VERSION, NAT_VERSION after FROM; copied /uv, /uvx, and related binaries from ghcr.io/astral-sh/uv:${UV_VERSION}; retained existing ENV; added build-time validation ensuring NAT_VERSION is provided during uv venv/pip setup.
Example Dockerfiles: ARGs only
examples/evaluation_and_profiling/email_phishing_analyzer/Dockerfile, examples/frameworks/agno_personal_finance/Dockerfile, examples/getting_started/simple_calculator/Dockerfile
Declared ARG PYTHON_VERSION, ARG UV_VERSION, and ARG NAT_VERSION immediately after FROM to scope build-time parameters within the stage; no other functional changes.
Example Dockerfile: ARGs + uv binaries
examples/getting_started/simple_web_query/Dockerfile
Declared ARG PYTHON_VERSION, ARG UV_VERSION, ARG NAT_VERSION after FROM; added COPY from ghcr.io/astral-sh/uv:${UV_VERSION} to bring /uv, /uvx, and /bin/ into the image.
Documentation wording updates
examples/evaluation_and_profiling/email_phishing_analyzer/README.md, examples/getting_started/simple_calculator/README.md
Updated text to reference the NeMo Agent toolkit repository in Docker build instructions; no behavioral changes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant Docker as Docker Builder
  participant Base as Base Image
  participant UVImg as ghcr.io/astral-sh/uv:${UV_VERSION}
  participant Image as Build Stage

  Dev->>Docker: docker build --build-arg PYTHON_VERSION --build-arg UV_VERSION --build-arg NAT_VERSION
  Docker->>Base: FROM ${BASE_IMAGE}
  Docker->>Image: ARG PYTHON_VERSION, UV_VERSION, NAT_VERSION
  Docker->>UVImg: COPY /uv, /uvx, /bin/
  UVImg-->>Image: uv toolchain binaries
  Note over Image: Validate NAT_VERSION present<br/>(fail build if missing)
  Docker->>Image: Run uv venv/pip setup and install
  Image-->>Dev: Built image with parameterized tooling
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Pre-merge checks and finishing touches

✅ 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 begins with the imperative verb “fix” and clearly summarizes the two main changes—redeclaring build arguments in multi-stage Docker builds and correcting the documentation path—while remaining under the 72-character limit. It is descriptive of the intent and concise without extraneous wording. The combined use of a conventional commit prefix and a semicolon to separate related fixes maintains clarity and brevity.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
examples/getting_started/simple_calculator/README.md (1)

90-90: Use the canonical “NeMo Agent Toolkit” capitalization.

Please capitalize “Toolkit” to match the project’s naming convention and avoid reverting to deprecated wording.

As per coding guidelines

-From the root directory of the NeMo Agent toolkit repository, build the Docker image:
+From the root directory of the NeMo Agent Toolkit repository, build the Docker image:
examples/evaluation_and_profiling/email_phishing_analyzer/README.md (1)

228-232: Capitalize “Toolkit” in the product name

Per the documentation guidelines, the product name should appear as “NeMo Agent Toolkit.” Please capitalize “Toolkit” in the updated sentence.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 14cfda4 and 98706dd.

📒 Files selected for processing (7)
  • docker/Dockerfile (1 hunks)
  • examples/evaluation_and_profiling/email_phishing_analyzer/Dockerfile (1 hunks)
  • examples/evaluation_and_profiling/email_phishing_analyzer/README.md (1 hunks)
  • examples/frameworks/agno_personal_finance/Dockerfile (1 hunks)
  • examples/getting_started/simple_calculator/Dockerfile (1 hunks)
  • examples/getting_started/simple_calculator/README.md (1 hunks)
  • examples/getting_started/simple_web_query/Dockerfile (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/README.@(md|ipynb)

📄 CodeRabbit inference engine (.cursor/rules/general.mdc)

Ensure READMEs follow the naming convention; avoid deprecated names; use “NeMo Agent Toolkit” (capital T) in headings

Files:

  • examples/getting_started/simple_calculator/README.md
  • examples/evaluation_and_profiling/email_phishing_analyzer/README.md
**/*

⚙️ CodeRabbit configuration file

**/*: # Code Review Instructions

  • Ensure the code follows best practices and coding standards. - For Python code, follow
    PEP 20 and
    PEP 8 for style guidelines.
  • Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
    Example:
    def my_function(param1: int, param2: str) -> bool:
        pass
  • For Python exception handling, ensure proper stack trace preservation:
    • When re-raising exceptions: use bare raise statements to maintain the original stack trace,
      and use logger.error() (not logger.exception()) to avoid duplicate stack trace output.
    • When catching and logging exceptions without re-raising: always use logger.exception()
      to capture the full stack trace information.

Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any

words listed in the ci/vale/styles/config/vocabularies/nat/reject.txt file, words that might appear to be
spelling mistakes but are listed in the ci/vale/styles/config/vocabularies/nat/accept.txt file are OK.

Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,

and should contain an Apache License 2.0 header comment at the top of each file.

  • Confirm that copyright years are up-to date whenever a file is changed.

Files:

  • examples/getting_started/simple_calculator/README.md
  • examples/frameworks/agno_personal_finance/Dockerfile
  • docker/Dockerfile
  • examples/getting_started/simple_calculator/Dockerfile
  • examples/evaluation_and_profiling/email_phishing_analyzer/README.md
  • examples/getting_started/simple_web_query/Dockerfile
  • examples/evaluation_and_profiling/email_phishing_analyzer/Dockerfile
examples/**/*

⚙️ CodeRabbit configuration file

examples/**/*: - This directory contains example code and usage scenarios for the toolkit, at a minimum an example should
contain a README.md or file README.ipynb.

  • If an example contains Python code, it should be placed in a subdirectory named src/ and should
    contain a pyproject.toml file. Optionally, it might also contain scripts in a scripts/ directory.
  • If an example contains YAML files, they should be placed in a subdirectory named configs/. - If an example contains sample data files, they should be placed in a subdirectory named data/, and should
    be checked into git-lfs.

Files:

  • examples/getting_started/simple_calculator/README.md
  • examples/frameworks/agno_personal_finance/Dockerfile
  • examples/getting_started/simple_calculator/Dockerfile
  • examples/evaluation_and_profiling/email_phishing_analyzer/README.md
  • examples/getting_started/simple_web_query/Dockerfile
  • examples/evaluation_and_profiling/email_phishing_analyzer/Dockerfile
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: CI Pipeline / Check

@willkill07
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit 107b72a into NVIDIA:release/1.3 Oct 6, 2025
17 checks passed
@willkill07 willkill07 deleted the wkk_fix-docker-build-and-documentation branch October 23, 2025 18:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants