Skip to content

Conversation

@willkill07
Copy link
Member

@willkill07 willkill07 commented Oct 6, 2025

Description

  • Add Google ADK
  • be consistent with yml suffix
  • add more libraries to list
  • remove all remaining references to use_uvloop: true

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

    • Updated Key Features to explicitly include Google ADK.
    • Corrected Hello World example to use workflow.yml and aligned commands/output.
    • Marked Roadmap items (Google ADK, MCP auth/streamable HTTP) as complete.
    • Expanded Acknowledgements with additional open-source projects (e.g., Google ADK, MCP, observability tooling).
    • Refreshed feature/resource bullets to reflect new ADK/MCP and observability references.
  • Chores

    • Removed the optional event loop optimization setting from example configurations to simplify defaults.

@willkill07 willkill07 requested a review from a team as a code owner October 6, 2025 20:47
@willkill07 willkill07 added doc Improvements or additions to documentation non-breaking Non-breaking change labels Oct 6, 2025
@willkill07 willkill07 self-assigned this Oct 6, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 6, 2025

Walkthrough

Documentation updated to mention Google ADK, switch references from workflow.yaml to workflow.yml, adjust roadmap statuses, and expand acknowledgements. Two example configuration files removed the use_uvloop setting; no other config or control flow changes.

Changes

Cohort / File(s) Summary of Changes
Documentation updates
README.md
Updated features to include Google ADK; changed references from workflow.yaml to workflow.yml; marked roadmap items complete; expanded acknowledgements (ADK, MCP, MinIO, OpenTelemetry, Phoenix, Redis, Weave); synchronized example commands/output with workflow.yml and updated tool names.
Example config cleanup
examples/evaluation_and_profiling/email_phishing_analyzer/configs/config_optimizer.yml, examples/frameworks/adk_demo/configs/config.yml
Removed general.use_uvloop: true; no other configuration changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 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 succinctly describes the two primary changes—updating the top-level README and removing outdated uvloop references—in clear imperative language within the character limit, and it accurately reflects the modifications made across the README and configuration files.
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: 1

🧹 Nitpick comments (2)
README.md (2)

40-40: Nice addition of Google ADK; consider minor consistency tweaks.

  • Use “NeMo Agent Toolkit” capitalization in this sentence for consistency with branding elsewhere.
  • Optional: standardize ADK link target (docs vs GitHub) across the README to a single canonical URL.

187-199: Acknowledgements additions look accurate; minor polish optional.

  • Consider using a consistent link style for Google ADK (either docs or GitHub) throughout the README.
  • Optional: alphabetize or group entries for easier scanning.

Confirm Redis link intentionally targets redis-py (client) vs core redis repo.

📜 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 94e64ac and e0cad78.

📒 Files selected for processing (3)
  • README.md (5 hunks)
  • examples/evaluation_and_profiling/email_phishing_analyzer/configs/config_optimizer.yml (0 hunks)
  • examples/frameworks/adk_demo/configs/config.yml (0 hunks)
💤 Files with no reviewable changes (2)
  • examples/frameworks/adk_demo/configs/config.yml
  • examples/evaluation_and_profiling/email_phishing_analyzer/configs/config_optimizer.yml
🧰 Additional context used
📓 Path-based instructions (2)
**/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
**/*

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

  • README.md
🔇 Additional comments (2)
README.md (2)

140-144: LGTM on command/file consistency.

The nat run command matches the new workflow.yml filename.


171-174: Roadmap updates read well.

Marking Google ADK and MCP items as completed looks accurate.

@willkill07
Copy link
Member Author

/merge

@rapids-bot rapids-bot bot merged commit 4857d44 into NVIDIA:release/1.3 Oct 6, 2025
26 of 28 checks passed
@willkill07 willkill07 deleted the wkk_update-readme-and-remove-outdated-uvloop 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

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