-
Notifications
You must be signed in to change notification settings - Fork 412
fix: ensure registration of adk demo functions; reduce warnings #885
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Will Killian <[email protected]>
WalkthroughAdds LLMFrameworkEnum imports and extends @register_function decorators in two ADK demo tools to include framework_wrappers=[LLMFrameworkEnum.ADK], scoping their registration to the ADK framework. No function bodies, signatures, or return types changed. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Module as ADK Demo Module (on import)
participant Decorator as register_function(...)
participant Registry as ToolRegistry
participant Enum as LLMFrameworkEnum
Note over Module: Module import
Module->>Decorator: Apply @register_function(..., framework_wrappers=[Enum.ADK])
Decorator->>Enum: Resolve ADK
Decorator->>Registry: register(tool_fn, config_type, frameworks=[ADK])
Note right of Registry: Tool is scoped to ADK framework
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
✨ Finishing touches
🧪 Generate unit tests
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. Comment |
There was a problem hiding this 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 (1)
examples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.py (1)
31-32: Consider adding a docstring for the outer function.The
weather_updatefunction (the registration generator) lacks its own docstring. While the inner_weather_updatefunction is well-documented, adding a docstring similar to the one innat_time_mcp_tool.py(lines 36-42) would improve consistency and clarity.Apply this diff to add the missing docstring:
@register_function(config_type=WeatherToolConfig, framework_wrappers=[LLMFrameworkEnum.ADK]) async def weather_update(_config: WeatherToolConfig, _builder: Builder) -> AsyncIterator[FunctionInfo]: + """ + Register a weather_update(city: str) -> str tool for ADK. + + Args: + _config (WeatherToolConfig): The configuration for the weather_update tool. + _builder (Builder): The NAT builder instance. + """ async def _weather_update(city: str) -> str:
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
examples/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.py(2 hunks)examples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.py(2 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
**/*.{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:
examples/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.pyexamples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.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:
examples/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.pyexamples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.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
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.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.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile 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/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.pyexamples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.py
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 apyproject.tomlfile. Optionally, it might also contain scripts in ascripts/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 nameddata/, and should
be checked into git-lfs.
Files:
examples/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.pyexamples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.py
🧬 Code graph analysis (2)
examples/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.py (1)
src/nat/builder/framework_enum.py (1)
LLMFrameworkEnum(19-25)
examples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.py (1)
src/nat/builder/framework_enum.py (1)
LLMFrameworkEnum(19-25)
🔇 Additional comments (4)
examples/frameworks/adk_demo/src/nat_adk_demo/nat_time_mcp_tool.py (2)
22-22: LGTM: Import added correctly.The
LLMFrameworkEnumimport is properly added to support the framework-specific registration.
34-34: Approve ADK-specific function registrations
Verified that all functions inexamples/frameworks/adk_demo/src/nat_adk_demo/are registered withframework_wrappers=[LLMFrameworkEnum.ADK].examples/frameworks/adk_demo/src/nat_adk_demo/weather_update_tool.py (2)
20-20: LGTM: Import added correctly.The
LLMFrameworkEnumimport is properly added to support framework-specific registration.
30-30: LGTM: Function registration now explicitly scoped to ADK framework.The
framework_wrappers=[LLMFrameworkEnum.ADK]parameter ensures this tool is only registered for the ADK framework, which aligns with the PR objective to fix ADK demo registration.
|
/merge |
In the last PR #885 I forgot to add this file to the commit, resulting in the bug still persisting. 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 - Chores - Updated demo module linting configuration to reduce false-positive warnings and streamline code maintenance. - Adjusted imports to align with available tool integrations, preparing the demo for time and weather-related capabilities. - No changes to existing user workflows or features; behavior remains unchanged. - Tests - No test impact identified. - Documentation - No user-facing documentation changes. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Zhongxuan (Daniel) Wang (https://github.com/zhongxuanwang-nv) URL: #901
In the last PR NVIDIA#885 I forgot to add this file to the commit, resulting in the bug still persisting. 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 - Chores - Updated demo module linting configuration to reduce false-positive warnings and streamline code maintenance. - Adjusted imports to align with available tool integrations, preparing the demo for time and weather-related capabilities. - No changes to existing user workflows or features; behavior remains unchanged. - Tests - No test impact identified. - Documentation - No user-facing documentation changes. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Zhongxuan (Daniel) Wang (https://github.com/zhongxuanwang-nv) URL: NVIDIA#901 Signed-off-by: Yuchen Zhang <[email protected]>
…IA#885) Updates the ADK Demo example to work. * add missing registration imports * exactly specify `framework_wrappers` Closes nvbugs-5554110 ## 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 * **New Features** * Enabled ADK framework support in the demo: City Time and Weather Update tools are now registered for ADK, making them discoverable and usable in ADK-based workflows and integrations. * Improves out-of-the-box experience for ADK users running the examples by ensuring these tools are available without additional configuration. * **Chores** * Updated tool registrations to target the ADK framework while keeping existing function behavior and signatures unchanged. Authors: - Will Killian (https://github.com/willkill07) Approvers: - Eric Evans II (https://github.com/ericevans-nv) URL: NVIDIA#885
Description
Updates the ADK Demo example to work.
framework_wrappersCloses nvbugs-5554110
By Submitting this PR I confirm:
Summary by CodeRabbit
New Features
Chores