Skip to content

Conversation

@ericevans-nv
Copy link
Contributor

@ericevans-nv ericevans-nv commented Oct 1, 2025

Description

Updating all package references with square brackets to be properly quoted in README files.
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

    • Standardized installation instructions to quote package extras (e.g., "nvidia-nat[langchain]", "nvidia-nat[all]", "nvidia-nat[profiling]", "nvidia-nat[mcp]") across README, quick start, workflows, reference docs, and examples; updated code blocks and usage snippets accordingly.
  • Chores

    • Minor formatting and whitespace adjustments in example configs and installer hint/error message text to use quoted package specs.

@ericevans-nv ericevans-nv requested a review from a team as a code owner October 1, 2025 14:00
@coderabbitai
Copy link

coderabbitai bot commented Oct 1, 2025

Walkthrough

Documentation, example config comments, and several user-facing error/log messages were updated to wrap package extras in quotes (e.g., nvidia-nat[langchain] → "nvidia-nat[langchain]"). No behavioral, API, or control-flow changes.

Changes

Cohort / File(s) Summary of Changes
Root README install snippets
README.md
Quoted optional extras in install commands (pip install nvidia-nat[langchain], pip install nvidia-nat[all]pip install "nvidia-nat[langchain]", pip install "nvidia-nat[all]").
Documentation pages
docs/source/.../telemetry-exporters.md, docs/source/quick-start/installing.md, docs/source/workflows/evaluate.md, docs/source/workflows/mcp/mcp-client.md, docs/source/workflows/profiler.md, docs/source/reference/api-server-endpoints.md, docs/source/reference/evaluate-api.md, docs/source/workflows/mcp/index.md, docs/source/workflows/mcp/mcp-server.md
Replaced unquoted package extras in pip/uv install examples with quoted strings (e.g., nvidia-nat[mcp]"nvidia-nat[mcp]", nvidia-nat[profiling]"nvidia-nat[profiling]"). Presentation-only edits.
Examples and configs
examples/MCP/simple_auth_mcp/README.md, examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml, examples/RAG/simple_rag/configs/milvus_rag_tools_config.yml
Quoted package references in comments (nvidia-nat[langchain]"nvidia-nat[langchain]"), removed stray empty lines and adjusted YAML indentation/whitespace.
Project metadata / comment
pyproject.toml
Updated an example/comment to show quoted optional install target (install "nvidia-nat[langchain]").
Source: user-facing messages
src/nat/agent/prompt_optimizer/register.py, src/nat/profiler/decorators/framework_wrapper.py, src/nat/profiler/forecasting/models/linear_model.py, src/nat/profiler/forecasting/models/random_forest_regressor.py, src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py, src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
Updated exception and log message text to quote package specs (e.g., "nvidia-nat[langchain]", "nvidia-nat[profiler]"). No signature, behavioral, or control-flow changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The current title is a descriptive noun phrase rather than an imperative statement and it only mentions README updates, whereas the PR applies quoting fixes across all documentation files, so it does not fully adhere to the imperative mood guideline or accurately summarize the scope of changes. Please update the title to imperative mood and reflect the full scope of changes, for example: “Quote PyPI package specs in documentation to ensure proper bracket parsing.”
Docstring Coverage ⚠️ Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent 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 e0077d2 and e11b301.

📒 Files selected for processing (6)
  • src/nat/agent/prompt_optimizer/register.py (2 hunks)
  • src/nat/profiler/decorators/framework_wrapper.py (1 hunks)
  • src/nat/profiler/forecasting/models/linear_model.py (1 hunks)
  • src/nat/profiler/forecasting/models/random_forest_regressor.py (1 hunks)
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py (1 hunks)
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/nat/profiler/decorators/framework_wrapper.py
🧰 Additional context used
📓 Path-based instructions (6)
**/*.{py,yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

**/*.{py,yaml,yml}: Configure response_seq as a list of strings; values cycle per call, and [] yields an empty string.
Configure delay_ms to inject per-call artificial latency in milliseconds for nat_test_llm.

Files:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
**/*.py

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

**/*.py: Programmatic use: create TestLLMConfig(response_seq=[...], delay_ms=...), add with builder.add_llm("", cfg).
When retrieving the test LLM wrapper, use builder.get_llm(name, wrapper_type=LLMFrameworkEnum.) and call the framework’s method (e.g., ainvoke, achat, call).

**/*.py: In code comments/identifiers use NAT abbreviations as specified: nat for API namespace/CLI, nvidia-nat for package name, NAT for env var prefixes; do not use these abbreviations in documentation
Follow PEP 20 and PEP 8; run yapf with column_limit=120; use 4-space indentation; end files with a single trailing newline
Run ruff check --fix as linter (not formatter) using pyproject.toml config; fix warnings unless explicitly ignored
Respect naming: snake_case for functions/variables, PascalCase for classes, UPPER_CASE for constants
Treat pyright warnings as errors during development
Exception handling: use bare raise to re-raise; log with logger.error() when re-raising to avoid duplicate stack traces; use logger.exception() when catching without re-raising
Provide Google-style docstrings for every public module, class, function, and CLI command; first line concise and ending with a period; surround code entities with backticks
Validate and sanitize all user input, especially in web or CLI interfaces
Prefer httpx with SSL verification enabled by default and follow OWASP Top-10 recommendations
Use async/await for I/O-bound work; profile CPU-heavy paths with cProfile or mprof before optimizing; cache expensive computations with functools.lru_cache or external cache; leverage NumPy vectorized operations when beneficial

Files:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
src/**/*.py

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

All importable Python code must live under src/ (or packages//src/)

Files:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
src/nat/**/*

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

Changes in src/nat should prioritize backward compatibility

Files:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py

⚙️ CodeRabbit configuration file

This directory contains the core functionality of the toolkit. Changes should prioritize backward compatibility.

Files:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
{src/**/*.py,packages/*/src/**/*.py}

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

All public APIs must have Python 3.11+ type hints on parameters and return values; prefer typing/collections.abc abstractions; use typing.Annotated when useful

Files:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
**/*

⚙️ 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:

  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
🪛 Ruff (0.13.2)
src/nat/agent/prompt_optimizer/register.py

53-54: Avoid specifying long messages outside the exception class

(TRY003)


113-114: Avoid specifying long messages outside the exception class

(TRY003)

src/nat/profiler/forecasting/models/random_forest_regressor.py

37-39: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

src/nat/profiler/forecasting/models/linear_model.py

37-39: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py

306-307: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py

214-215: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

⏰ 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
🔇 Additional comments (4)
src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py (1)

214-215: LGTM! Quote formatting is correct.

The error message now properly quotes the package spec "nvidia-nat[profiler]" for shell safety.

Note: The static analysis hint (TRY400) suggesting logging.exception is a false positive. Per coding guidelines, logger.error() is correct when re-raising exceptions to avoid duplicate stack traces.

src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py (1)

306-307: LGTM! Quote formatting is correct.

The error message now properly quotes the package spec "nvidia-nat[profiler]" for shell safety.

Note: The static analysis hint (TRY400) is a false positive. Per coding guidelines, logger.error() is correct when re-raising exceptions.

src/nat/profiler/forecasting/models/linear_model.py (1)

37-39: LGTM! Quote formatting is correct.

The error message now properly quotes the package spec "nvidia-nat[profiler]" for shell safety.

Note: The static analysis hint (TRY400) is a false positive. Per coding guidelines, logger.error() is correct when re-raising exceptions.

src/nat/profiler/forecasting/models/random_forest_regressor.py (1)

37-39: LGTM! Quote formatting is correct.

The error message now properly quotes the package spec "nvidia-nat[profiler]" for shell safety.

Note: The static analysis hint (TRY400) is a false positive. Per coding guidelines, logger.error() is correct when re-raising exceptions.


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.

@ericevans-nv ericevans-nv self-assigned this Oct 1, 2025
@ericevans-nv ericevans-nv added ! - Release Related to a Major Release improvement Improvement to existing functionality non-breaking Non-breaking change labels Oct 1, 2025
@coderabbitai coderabbitai bot added the doc Improvements or additions to documentation label Oct 1, 2025
@ericevans-nv ericevans-nv removed the improvement Improvement to existing functionality label Oct 1, 2025
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: 7

📜 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 339f06c and 0a43f7e.

📒 Files selected for processing (6)
  • README.md (1 hunks)
  • docs/source/extend/telemetry-exporters.md (1 hunks)
  • docs/source/quick-start/installing.md (1 hunks)
  • docs/source/workflows/evaluate.md (1 hunks)
  • docs/source/workflows/mcp/mcp-client.md (1 hunks)
  • docs/source/workflows/profiler.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
docs/source/**/*.md

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

docs/source/**/*.md: Use the official naming throughout documentation: first use “NVIDIA NeMo Agent toolkit”, subsequent “NeMo Agent toolkit”; never use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq)
Documentation sources are Markdown files under docs/source; images belong in docs/source/_static
Keep docs in sync with code; documentation pipeline must pass Sphinx and link checks; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling correctness
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted terms in accept.txt are allowed

Files:

  • docs/source/workflows/evaluate.md
  • docs/source/extend/telemetry-exporters.md
  • docs/source/workflows/profiler.md
  • docs/source/quick-start/installing.md
  • docs/source/workflows/mcp/mcp-client.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:

  • docs/source/workflows/evaluate.md
  • docs/source/extend/telemetry-exporters.md
  • README.md
  • docs/source/workflows/profiler.md
  • docs/source/quick-start/installing.md
  • docs/source/workflows/mcp/mcp-client.md
docs/source/**/*

⚙️ CodeRabbit configuration file

This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the docs/source/_static directory.

Files:

  • docs/source/workflows/evaluate.md
  • docs/source/extend/telemetry-exporters.md
  • docs/source/workflows/profiler.md
  • docs/source/quick-start/installing.md
  • docs/source/workflows/mcp/mcp-client.md
**/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:

  • README.md
🧠 Learnings (1)
📚 Learning: 2025-09-23T18:39:15.023Z
Learnt from: CR
PR: NVIDIA/NeMo-Agent-Toolkit#0
File: .cursor/rules/general.mdc:0-0
Timestamp: 2025-09-23T18:39:15.023Z
Learning: Applies to packages/*/pyproject.toml : In packages, declare a dependency on nvidia-nat or packages starting with nvidia-nat-

Applied to files:

  • docs/source/workflows/evaluate.md
  • docs/source/workflows/profiler.md

@willkill07 willkill07 removed the ! - Release Related to a Major Release label Oct 1, 2025
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: 2

📜 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 c4148a5 and e0077d2.

📒 Files selected for processing (15)
  • docs/source/extend/telemetry-exporters.md (2 hunks)
  • docs/source/reference/api-server-endpoints.md (1 hunks)
  • docs/source/reference/evaluate-api.md (1 hunks)
  • docs/source/workflows/mcp/index.md (1 hunks)
  • docs/source/workflows/mcp/mcp-server.md (1 hunks)
  • examples/MCP/simple_auth_mcp/README.md (1 hunks)
  • examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml (2 hunks)
  • examples/RAG/simple_rag/configs/milvus_rag_tools_config.yml (2 hunks)
  • pyproject.toml (1 hunks)
  • src/nat/agent/prompt_optimizer/register.py (3 hunks)
  • src/nat/profiler/decorators/framework_wrapper.py (4 hunks)
  • src/nat/profiler/forecasting/models/linear_model.py (2 hunks)
  • src/nat/profiler/forecasting/models/random_forest_regressor.py (2 hunks)
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py (2 hunks)
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py (2 hunks)
✅ Files skipped from review due to trivial changes (4)
  • examples/RAG/simple_rag/configs/milvus_rag_tools_config.yml
  • docs/source/workflows/mcp/mcp-server.md
  • pyproject.toml
  • docs/source/reference/evaluate-api.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/extend/telemetry-exporters.md
🧰 Additional context used
📓 Path-based instructions (12)
docs/source/**/*.md

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

docs/source/**/*.md: Use the official naming throughout documentation: first use “NVIDIA NeMo Agent toolkit”, subsequent “NeMo Agent toolkit”; never use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq)
Documentation sources are Markdown files under docs/source; images belong in docs/source/_static
Keep docs in sync with code; documentation pipeline must pass Sphinx and link checks; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling correctness
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted terms in accept.txt are allowed

Files:

  • docs/source/workflows/mcp/index.md
  • docs/source/reference/api-server-endpoints.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:

  • docs/source/workflows/mcp/index.md
  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • docs/source/reference/api-server-endpoints.md
  • src/nat/profiler/decorators/framework_wrapper.py
  • examples/MCP/simple_auth_mcp/README.md
  • examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
docs/source/**/*

⚙️ CodeRabbit configuration file

This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the docs/source/_static directory.

Files:

  • docs/source/workflows/mcp/index.md
  • docs/source/reference/api-server-endpoints.md
**/*.{py,yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

**/*.{py,yaml,yml}: Configure response_seq as a list of strings; values cycle per call, and [] yields an empty string.
Configure delay_ms to inject per-call artificial latency in milliseconds for nat_test_llm.

Files:

  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/decorators/framework_wrapper.py
  • examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
**/*.py

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

**/*.py: Programmatic use: create TestLLMConfig(response_seq=[...], delay_ms=...), add with builder.add_llm("", cfg).
When retrieving the test LLM wrapper, use builder.get_llm(name, wrapper_type=LLMFrameworkEnum.) and call the framework’s method (e.g., ainvoke, achat, call).

**/*.py: In code comments/identifiers use NAT abbreviations as specified: nat for API namespace/CLI, nvidia-nat for package name, NAT for env var prefixes; do not use these abbreviations in documentation
Follow PEP 20 and PEP 8; run yapf with column_limit=120; use 4-space indentation; end files with a single trailing newline
Run ruff check --fix as linter (not formatter) using pyproject.toml config; fix warnings unless explicitly ignored
Respect naming: snake_case for functions/variables, PascalCase for classes, UPPER_CASE for constants
Treat pyright warnings as errors during development
Exception handling: use bare raise to re-raise; log with logger.error() when re-raising to avoid duplicate stack traces; use logger.exception() when catching without re-raising
Provide Google-style docstrings for every public module, class, function, and CLI command; first line concise and ending with a period; surround code entities with backticks
Validate and sanitize all user input, especially in web or CLI interfaces
Prefer httpx with SSL verification enabled by default and follow OWASP Top-10 recommendations
Use async/await for I/O-bound work; profile CPU-heavy paths with cProfile or mprof before optimizing; cache expensive computations with functools.lru_cache or external cache; leverage NumPy vectorized operations when beneficial

Files:

  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/decorators/framework_wrapper.py
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
src/**/*.py

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

All importable Python code must live under src/ (or packages//src/)

Files:

  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/decorators/framework_wrapper.py
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
src/nat/**/*

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

Changes in src/nat should prioritize backward compatibility

Files:

  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/decorators/framework_wrapper.py
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py

⚙️ CodeRabbit configuration file

This directory contains the core functionality of the toolkit. Changes should prioritize backward compatibility.

Files:

  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/decorators/framework_wrapper.py
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
{src/**/*.py,packages/*/src/**/*.py}

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

All public APIs must have Python 3.11+ type hints on parameters and return values; prefer typing/collections.abc abstractions; use typing.Annotated when useful

Files:

  • src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py
  • src/nat/profiler/forecasting/models/random_forest_regressor.py
  • src/nat/profiler/forecasting/models/linear_model.py
  • src/nat/profiler/decorators/framework_wrapper.py
  • src/nat/agent/prompt_optimizer/register.py
  • src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py
**/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/MCP/simple_auth_mcp/README.md
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/MCP/simple_auth_mcp/README.md
  • examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml
**/*.{yaml,yml}

📄 CodeRabbit inference engine (.cursor/rules/nat-test-llm.mdc)

In workflow/config YAML, set llms.._type: nat_test_llm to stub responses.

Files:

  • examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml
**/configs/**

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

Configuration files consumed by code must be stored next to that code in a configs/ folder

Files:

  • examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml
🧬 Code graph analysis (2)
src/nat/profiler/decorators/framework_wrapper.py (6)
src/nat/profiler/callbacks/langchain_callback_handler.py (1)
  • LangchainProfilerHandler (56-297)
src/nat/profiler/callbacks/llama_index_callback_handler.py (1)
  • LlamaIndexProfilerHandler (42-205)
packages/nvidia_nat_crewai/src/nat/plugins/crewai/crewai_callback_handler.py (1)
  • CrewAIProfilerHandler (39-205)
packages/nvidia_nat_adk/src/nat/plugins/adk/adk_callback_handler.py (2)
  • instrument (56-84)
  • ADKProfilerHandler (36-307)
src/nat/profiler/callbacks/semantic_kernel_callback_handler.py (1)
  • SemanticKernelProfilerHandler (50-238)
src/nat/profiler/callbacks/agno_callback_handler.py (1)
  • AgnoProfilerHandler (39-295)
src/nat/agent/prompt_optimizer/register.py (1)
src/nat/profiler/parameter_optimization/prompt_optimizer.py (1)
  • PromptOptimizerInputSchema (39-42)
🪛 Ruff (0.13.2)
src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py

306-307: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

src/nat/profiler/forecasting/models/random_forest_regressor.py

39-41: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

src/nat/profiler/forecasting/models/linear_model.py

39-41: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

src/nat/agent/prompt_optimizer/register.py

54-55: Avoid specifying long messages outside the exception class

(TRY003)


114-115: Avoid specifying long messages outside the exception class

(TRY003)

src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py

214-215: Use logging.exception instead of logging.error

Replace with exception

(TRY400)

🔇 Additional comments (16)
src/nat/profiler/inference_optimization/experimental/prefix_span_analysis.py (2)

36-38: LGTM: Import grouping improvement.

The multi-line import statement properly groups related imports from the same module, improving readability.


215-215: LGTM: Package name properly quoted.

The error message now correctly quotes the package specifier with square brackets, aligning with the PR objective to standardize PyPI package references in error messages and documentation.

src/nat/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py (2)

38-41: LGTM: Import grouping improvement.

The multi-line import statement properly groups related imports from the same module, maintaining consistency with the codebase style.


307-307: LGTM: Package name properly quoted.

The error message now correctly quotes the package specifier with square brackets, aligning with the PR objective to standardize PyPI package references in error messages and documentation.

docs/source/workflows/mcp/index.md (1)

24-24: Quoting the extra spec is correct.

Great catch quoting the extras package; this avoids shell globbing issues when users copy the command.

examples/MCP/simple_auth_mcp/README.md (1)

29-29: Thanks for tightening the install note.

Adding quotes around the extras install command keeps zsh/bash from expanding the brackets and ensures readers get a working command.

examples/RAG/simple_rag/configs/milvus_memory_rag_tools_config.yml (1)

58-92: Config comment + indentation look good.

Quoting the extras package in the comment and normalizing the list indentation both keep the config clear and conform to the new install guidance.

src/nat/profiler/forecasting/models/linear_model.py (2)

20-23: LGTM: Import formatting update.

The multi-line import formatting with backslash continuations is consistent with similar imports in the codebase.


39-43: Correct logging pattern for re-raised exceptions.

The code correctly uses logger.error() (not logger.exception()) before re-raising with bare raise, which follows the coding guidelines to avoid duplicate stack traces.

The error message update to quote "nvidia-nat[profiler]" aligns with the PR objectives.

Note: The Ruff warning TRY400 suggesting logger.exception() is a false positive in this context, as the exception is being re-raised and the current pattern is correct per the coding guidelines.

src/nat/agent/prompt_optimizer/register.py (1)

24-25: LGTM: Import formatting update.

The multi-line import formatting is consistent with the codebase style.

src/nat/profiler/forecasting/models/random_forest_regressor.py (2)

20-23: LGTM: Import formatting update.

The multi-line import formatting with backslash continuations is consistent with the codebase.


39-43: Correct logging pattern for re-raised exceptions.

The code correctly uses logger.error() before re-raising with bare raise, which follows the coding guidelines. The error message update to quote "nvidia-nat[profiler]" aligns with the PR objectives.

Note: The Ruff warning TRY400 is a false positive, as the current pattern is correct per the coding guidelines.

src/nat/profiler/decorators/framework_wrapper.py (4)

20-20: LGTM: Import consolidation.

Consolidating AsyncIterator and Callable imports on a single line improves readability.


74-75: LGTM: Import formatting updates.

The multi-line import formatting with backslash continuations is consistent across all handler imports.

Also applies to: 81-82, 91-92, 99-100, 108-109, 117-118, 127-128


123-123: Verify intentional log level change from DEBUG to INFO.

The Agno callback handler registration now logs at INFO level instead of DEBUG. This differs from other framework registrations (LangChain, LlamaIndex, CrewAI, SemanticKernel, ADK) which all use DEBUG level.

Is this log level change intentional? If not, consider using DEBUG for consistency:

-                logger.info("Agno callback handler registered")
+                logger.debug("Agno callback handler registered")

130-133: LGTM: Error message update with quoted package name.

The error message correctly quotes "nvidia-nat[adk]" in the installation instruction, aligning with the PR objectives.

@ericevans-nv
Copy link
Contributor Author

/merge

@rapids-bot rapids-bot bot merged commit 3d1b465 into NVIDIA:release/1.3 Oct 1, 2025
17 checks passed
nouraellm pushed a commit to nouraellm/NeMo-Agent-Toolkit that referenced this pull request Oct 3, 2025
Updating all package references with square brackets to be properly quoted in README files.
Closes

## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing.md).
- 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**
  - Standardized installation instructions to quote package extras (e.g., "nvidia-nat[langchain]", "nvidia-nat[all]", "nvidia-nat[profiling]", "nvidia-nat[mcp]") across README, quick start, workflows, reference docs, and examples; updated code blocks and usage snippets accordingly.

- **Chores**
  - Minor formatting and whitespace adjustments in example configs and installer hint/error message text to use quoted package specs.

Authors:
  - Eric Evans II (https://github.com/ericevans-nv)

Approvers:
  - Will Killian (https://github.com/willkill07)

URL: NVIDIA#886
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.

2 participants