-
Notifications
You must be signed in to change notification settings - Fork 481
feat: reduce phoenix dependencies #985
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
feat: reduce phoenix dependencies #985
Conversation
WalkthroughDocumentation and example updates introduce explicit Phoenix installation steps and file-based tracing. Dependencies shift to arize-phoenix-otel and arize-phoenix-client, with openinference-instrumentation added. Code changes include inlining Phoenix client construction in px_query and switching to dangerously_using_project in the Phoenix mixin. A new OTEL file tracing config is added. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Caller
participant Tool as px_query
participant PX as Phoenix Client
Caller->>Tool: px_query(config, _builder)
Tool->>PX: new Client(base_url=config.phoenix_url)
alt last_n provided
Tool->>PX: spans.get_spans_dataframe(last_n=...)
else time range provided
Tool->>PX: spans.get_spans_dataframe(start=..., end=...)
end
PX-->>Tool: DataFrame
Tool-->>Caller: DataFrame or error
note over Tool,PX: Client creation is now inline in px_query
sequenceDiagram
autonumber
participant App as App using PhoenixMixin
participant Ctx as dangerously_using_project(project)
participant Exporter as Phoenix Exporter
App->>Ctx: enter context
Ctx->>Exporter: scoped export operations
Exporter-->>Ctx: completed
Ctx-->>App: exit context
note over Ctx: using dangerously_using_project instead of using_project
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
c402ab6 to
acf0bc0
Compare
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: 3
🧹 Nitpick comments (1)
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (1)
98-100: Consider moving the import to module level.While inline imports are acceptable, importing
Clientat the module level (after line 15) would be more consistent with Python conventions and slightly improve performance by avoiding repeated imports on each function call.Apply this diff to move the import to module level:
from datetime import datetime +from phoenix.client import Client from pydantic import BaseModelThen remove the inline import:
async def px_query(config: PxQueryConfig, _builder: Builder): """Query the Phoenix server for a dataframe of LLM traces""" - from phoenix.client import Client - px_client = Client(base_url=config.phoenix_url)
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
uv.lockis excluded by!**/*.lock
📒 Files selected for processing (11)
docs/source/workflows/observe/observe-workflow-with-phoenix.md(1 hunks)examples/advanced_agents/profiler_agent/README.md(2 hunks)examples/advanced_agents/profiler_agent/pyproject.toml(1 hunks)examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py(3 hunks)examples/evaluation_and_profiling/email_phishing_analyzer/pyproject.toml(1 hunks)examples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml(1 hunks)examples/notebooks/4_observability_evaluation_and_profiling.ipynb(2 hunks)examples/observability/simple_calculator_observability/README.md(2 hunks)examples/observability/simple_calculator_observability/configs/config-otel-file.yml(1 hunks)packages/nvidia_nat_phoenix/pyproject.toml(1 hunks)packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py(2 hunks)
🧰 Additional context used
📓 Path-based instructions (14)
**/*.{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:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pyexamples/observability/simple_calculator_observability/configs/config-otel-file.ymlexamples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.ymlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.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:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pyexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py
packages/*/src/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Importable Python code inside packages must live under packages//src/
Files:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.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:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.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:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pyexamples/observability/simple_calculator_observability/configs/config-otel-file.ymlexamples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.ymldocs/source/workflows/observe/observe-workflow-with-phoenix.mdexamples/advanced_agents/profiler_agent/pyproject.tomlexamples/observability/simple_calculator_observability/README.mdexamples/advanced_agents/profiler_agent/README.mdexamples/notebooks/4_observability_evaluation_and_profiling.ipynbpackages/nvidia_nat_phoenix/pyproject.tomlexamples/evaluation_and_profiling/email_phishing_analyzer/pyproject.tomlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py
packages/**/*
⚙️ CodeRabbit configuration file
packages/**/*: - This directory contains optional plugin packages for the toolkit, each should contain apyproject.tomlfile. - Thepyproject.tomlfile should declare a dependency onnvidia-nator another package with a name starting
withnvidia-nat-. This dependency should be declared using~=<version>, and the version should be a two
digit version (ex:~=1.0).
- Not all packages contain Python code, if they do they should also contain their own set of tests, in a
tests/directory at the same level as thepyproject.tomlfile.
Files:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pypackages/nvidia_nat_phoenix/pyproject.toml
**/*.{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/observability/simple_calculator_observability/configs/config-otel-file.ymlexamples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.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/observability/simple_calculator_observability/configs/config-otel-file.ymlexamples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml
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/observability/simple_calculator_observability/configs/config-otel-file.ymlexamples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.ymlexamples/advanced_agents/profiler_agent/pyproject.tomlexamples/observability/simple_calculator_observability/README.mdexamples/advanced_agents/profiler_agent/README.mdexamples/notebooks/4_observability_evaluation_and_profiling.ipynbexamples/evaluation_and_profiling/email_phishing_analyzer/pyproject.tomlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py
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/observe/observe-workflow-with-phoenix.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/_staticdirectory.
Files:
docs/source/workflows/observe/observe-workflow-with-phoenix.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:
examples/observability/simple_calculator_observability/README.mdexamples/advanced_agents/profiler_agent/README.md
packages/*/pyproject.toml
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
packages/*/pyproject.toml: Each package must contain a pyproject.toml
In packages, declare a dependency on nvidia-nat or packages starting with nvidia-nat-
Use ~= version constraints (e.g., ~=1.0) for dependencies
Files:
packages/nvidia_nat_phoenix/pyproject.toml
{packages/*/pyproject.toml,uv.lock}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Add new dependencies to both pyproject.toml (alphabetically) and uv.lock via uv pip install --sync
Files:
packages/nvidia_nat_phoenix/pyproject.toml
🧠 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:
examples/advanced_agents/profiler_agent/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.toml
🧬 Code graph analysis (1)
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (1)
src/nat/builder/builder.py (1)
Builder(68-290)
🪛 markdownlint-cli2 (0.18.1)
docs/source/workflows/observe/observe-workflow-with-phoenix.md
25-25: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
⏰ 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 (10)
docs/source/workflows/observe/observe-workflow-with-phoenix.md (1)
25-37: LGTM! Clear separation of installation steps.The updated documentation now clearly distinguishes between:
- Installing the Phoenix subpackage (for NAT integration)
- Installing the Phoenix server (for the UI)
This separation improves clarity and helps users understand what's needed for each component.
examples/evaluation_and_profiling/email_phishing_analyzer/pyproject.toml (1)
13-13: LGTM! Clean dependency consolidation.The change consolidates dependencies by using the
phoenixextra fromnvidia-natinstead of declaring a direct dependency onarize-phoenix. This:
- Simplifies dependency management
- Ensures version compatibility
- Aligns with the PR's goal of reducing dependencies
examples/notebooks/4_observability_evaluation_and_profiling.ipynb (1)
1204-1219: LGTM! Explicit Phoenix server installation step.The addition of explicit Phoenix server installation instructions improves the notebook's completeness and aligns with the updated documentation pattern across the PR. The step-by-step approach helps users understand the distinct components needed.
examples/observability/simple_calculator_observability/configs/config-otel-file.yml (1)
17-29: LGTM! Well-designed file-based tracing configuration.The file-based OTEL configuration provides a lightweight alternative to Phoenix for local development:
- JSONL format is appropriate for streaming traces
mode: appendallows accumulating traces across runsenable_rolling: falsesimplifies debugging during developmentThis configuration aligns well with the PR's goal of providing minimal-dependency tracing options.
examples/observability/simple_calculator_observability/README.md (1)
79-99: LGTM! Excellent addition of file-based tracing option.The new file-based tracing section provides:
- Clear instructions for local development without external services
- Good explanation of the JSONL format and its benefits
- Well-defined use cases (debugging, offline analysis, custom tooling, archiving)
This gives developers a lightweight option for tracing without requiring Phoenix server setup.
packages/nvidia_nat_phoenix/pyproject.toml (1)
24-24: Verify OTEL package compatibility Confirmed arize-phoenix-otel~=0.13.1 exists on PyPI with dependencies openinference-instrumentation>=0.1.38, openinference-semantic-conventions>=0.1.17, opentelemetry-exporter-otlp, opentelemetry-proto>=1.12.0, opentelemetry-sdk, opentelemetry-semantic-conventions, typing-extensions<5,>=4.5, and wrapt. Ensure these new dependencies don't conflict with existing requirements and that uv.lock is updated accordingly.examples/advanced_agents/profiler_agent/pyproject.toml (1)
19-19: Verify Phoenix client integration
The import ofphoenix.client.Clientinexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py:98confirms direct usage; ensure thearize-phoenix-client~=1.21.0constraint aligns with any other Phoenix dependencies and that the client is instantiated and configured correctly for its intended interactions.examples/advanced_agents/profiler_agent/README.md (1)
39-39: LGTM!The addition of "Natural Language Interface" as a key feature accurately describes the agent's capabilities.
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (2)
96-96: LGTM!Prefixing the unused
builderparameter with an underscore follows Python convention for indicating intentionally unused parameters.
134-134: No changes required—API compatibility confirmed.spans.get_spans_dataframe()is supported in arize-phoenix-client v1.21.0.
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
Show resolved
Hide resolved
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
Show resolved
Hide resolved
acf0bc0 to
66b6bb9
Compare
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: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
examples/observability/simple_calculator_observability/README.md (1)
20-24: Fix casing for “NeMo Agent Toolkit”.Line 20 spells the product name as “NeMo Agent toolkit”; per our documentation guidelines it must appear as “NeMo Agent Toolkit” (capital T). Please update the casing accordingly.
♻️ Duplicate comments (1)
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py (1)
72-72: Address the previous review comment about documentingdangerously_using_project.The prior review requested an inline comment above this line explaining:
- Why a temporary project override is needed
- The risks (data leakage, misrouting, analytics misattribution, billing/quota surprises)
- When to use the standard
using_projectinsteadThis documentation has not been added yet.
🧹 Nitpick comments (1)
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (1)
96-96: Consider removing the unused_builderparameter.The
_builderparameter is not used in the function. If it's required by the registration framework, add a comment explaining why it must be present despite being unused.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
uv.lockis excluded by!**/*.lock
📒 Files selected for processing (10)
docs/source/workflows/observe/observe-workflow-with-phoenix.md(1 hunks)examples/advanced_agents/profiler_agent/pyproject.toml(1 hunks)examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py(3 hunks)examples/evaluation_and_profiling/email_phishing_analyzer/pyproject.toml(1 hunks)examples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml(1 hunks)examples/notebooks/4_observability_evaluation_and_profiling.ipynb(2 hunks)examples/observability/simple_calculator_observability/README.md(2 hunks)examples/observability/simple_calculator_observability/configs/config-otel-file.yml(1 hunks)packages/nvidia_nat_phoenix/pyproject.toml(1 hunks)packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- examples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml
- examples/evaluation_and_profiling/email_phishing_analyzer/pyproject.toml
- examples/observability/simple_calculator_observability/configs/config-otel-file.yml
- examples/notebooks/4_observability_evaluation_and_profiling.ipynb
🧰 Additional context used
📓 Path-based instructions (12)
**/*
⚙️ 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/advanced_agents/profiler_agent/pyproject.tomlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pypackages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pypackages/nvidia_nat_phoenix/pyproject.tomldocs/source/workflows/observe/observe-workflow-with-phoenix.mdexamples/observability/simple_calculator_observability/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 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/advanced_agents/profiler_agent/pyproject.tomlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pyexamples/observability/simple_calculator_observability/README.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:
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pypackages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.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/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pypackages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
packages/*/src/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Importable Python code inside packages must live under packages//src/
Files:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.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:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
packages/**/*
⚙️ CodeRabbit configuration file
packages/**/*: - This directory contains optional plugin packages for the toolkit, each should contain apyproject.tomlfile. - Thepyproject.tomlfile should declare a dependency onnvidia-nator another package with a name starting
withnvidia-nat-. This dependency should be declared using~=<version>, and the version should be a two
digit version (ex:~=1.0).
- Not all packages contain Python code, if they do they should also contain their own set of tests, in a
tests/directory at the same level as thepyproject.tomlfile.
Files:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pypackages/nvidia_nat_phoenix/pyproject.toml
packages/*/pyproject.toml
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
packages/*/pyproject.toml: Each package must contain a pyproject.toml
In packages, declare a dependency on nvidia-nat or packages starting with nvidia-nat-
Use ~= version constraints (e.g., ~=1.0) for dependencies
Files:
packages/nvidia_nat_phoenix/pyproject.toml
{packages/*/pyproject.toml,uv.lock}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Add new dependencies to both pyproject.toml (alphabetically) and uv.lock via uv pip install --sync
Files:
packages/nvidia_nat_phoenix/pyproject.toml
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/observe/observe-workflow-with-phoenix.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/_staticdirectory.
Files:
docs/source/workflows/observe/observe-workflow-with-phoenix.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:
examples/observability/simple_calculator_observability/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:
examples/advanced_agents/profiler_agent/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.toml
🧬 Code graph analysis (1)
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (1)
src/nat/builder/builder.py (1)
Builder(68-290)
🪛 markdownlint-cli2 (0.18.1)
docs/source/workflows/observe/observe-workflow-with-phoenix.md
25-25: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (1)
examples/advanced_agents/profiler_agent/pyproject.toml (1)
19-19: Sort dependencies alphabetically.The
arize-phoenix-clientdependency should appear beforenvidia-natto maintain alphabetical ordering as specified in the coding guidelines.Apply this diff to fix the ordering:
# Keep sorted!!! + "arize-phoenix-client~=1.21.0", "nvidia-nat[langchain,profiling,telemetry]~=1.3", - "arize-phoenix-client~=1.21.0", "pydantic", # version determined by nvidia-natBased on coding guidelines.
Likely an incorrect or invalid review comment.
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py
Show resolved
Hide resolved
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: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (22)
packages/nvidia_nat_adk/pyproject.toml(1 hunks)packages/nvidia_nat_agno/pyproject.toml(1 hunks)packages/nvidia_nat_all/pyproject.toml(1 hunks)packages/nvidia_nat_crewai/pyproject.toml(1 hunks)packages/nvidia_nat_data_flywheel/pyproject.toml(1 hunks)packages/nvidia_nat_ingestion/pyproject.toml(1 hunks)packages/nvidia_nat_langchain/pyproject.toml(1 hunks)packages/nvidia_nat_llama_index/pyproject.toml(1 hunks)packages/nvidia_nat_mcp/pyproject.toml(1 hunks)packages/nvidia_nat_mem0ai/pyproject.toml(1 hunks)packages/nvidia_nat_mysql/pyproject.toml(1 hunks)packages/nvidia_nat_opentelemetry/pyproject.toml(1 hunks)packages/nvidia_nat_phoenix/pyproject.toml(2 hunks)packages/nvidia_nat_profiling/pyproject.toml(1 hunks)packages/nvidia_nat_ragaai/pyproject.toml(1 hunks)packages/nvidia_nat_redis/pyproject.toml(1 hunks)packages/nvidia_nat_s3/pyproject.toml(1 hunks)packages/nvidia_nat_semantic_kernel/pyproject.toml(1 hunks)packages/nvidia_nat_test/pyproject.toml(1 hunks)packages/nvidia_nat_weave/pyproject.toml(1 hunks)packages/nvidia_nat_zep_cloud/pyproject.toml(1 hunks)pyproject.toml(1 hunks)
✅ Files skipped from review due to trivial changes (12)
- packages/nvidia_nat_agno/pyproject.toml
- packages/nvidia_nat_mcp/pyproject.toml
- packages/nvidia_nat_redis/pyproject.toml
- packages/nvidia_nat_test/pyproject.toml
- packages/nvidia_nat_mysql/pyproject.toml
- packages/nvidia_nat_ingestion/pyproject.toml
- pyproject.toml
- packages/nvidia_nat_ragaai/pyproject.toml
- packages/nvidia_nat_adk/pyproject.toml
- packages/nvidia_nat_langchain/pyproject.toml
- packages/nvidia_nat_opentelemetry/pyproject.toml
- packages/nvidia_nat_crewai/pyproject.toml
🧰 Additional context used
📓 Path-based instructions (4)
packages/*/pyproject.toml
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
packages/*/pyproject.toml: Each package must contain a pyproject.toml
In packages, declare a dependency on nvidia-nat or packages starting with nvidia-nat-
Use ~= version constraints (e.g., ~=1.0) for dependencies
Files:
packages/nvidia_nat_mem0ai/pyproject.tomlpackages/nvidia_nat_semantic_kernel/pyproject.tomlpackages/nvidia_nat_llama_index/pyproject.tomlpackages/nvidia_nat_data_flywheel/pyproject.tomlpackages/nvidia_nat_zep_cloud/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.tomlpackages/nvidia_nat_profiling/pyproject.tomlpackages/nvidia_nat_weave/pyproject.tomlpackages/nvidia_nat_all/pyproject.tomlpackages/nvidia_nat_s3/pyproject.toml
{packages/*/pyproject.toml,uv.lock}
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Add new dependencies to both pyproject.toml (alphabetically) and uv.lock via uv pip install --sync
Files:
packages/nvidia_nat_mem0ai/pyproject.tomlpackages/nvidia_nat_semantic_kernel/pyproject.tomlpackages/nvidia_nat_llama_index/pyproject.tomlpackages/nvidia_nat_data_flywheel/pyproject.tomlpackages/nvidia_nat_zep_cloud/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.tomlpackages/nvidia_nat_profiling/pyproject.tomlpackages/nvidia_nat_weave/pyproject.tomlpackages/nvidia_nat_all/pyproject.tomlpackages/nvidia_nat_s3/pyproject.toml
**/*
⚙️ 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:
packages/nvidia_nat_mem0ai/pyproject.tomlpackages/nvidia_nat_semantic_kernel/pyproject.tomlpackages/nvidia_nat_llama_index/pyproject.tomlpackages/nvidia_nat_data_flywheel/pyproject.tomlpackages/nvidia_nat_zep_cloud/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.tomlpackages/nvidia_nat_profiling/pyproject.tomlpackages/nvidia_nat_weave/pyproject.tomlpackages/nvidia_nat_all/pyproject.tomlpackages/nvidia_nat_s3/pyproject.toml
packages/**/*
⚙️ CodeRabbit configuration file
packages/**/*: - This directory contains optional plugin packages for the toolkit, each should contain apyproject.tomlfile. - Thepyproject.tomlfile should declare a dependency onnvidia-nator another package with a name starting
withnvidia-nat-. This dependency should be declared using~=<version>, and the version should be a two
digit version (ex:~=1.0).
- Not all packages contain Python code, if they do they should also contain their own set of tests, in a
tests/directory at the same level as thepyproject.tomlfile.
Files:
packages/nvidia_nat_mem0ai/pyproject.tomlpackages/nvidia_nat_semantic_kernel/pyproject.tomlpackages/nvidia_nat_llama_index/pyproject.tomlpackages/nvidia_nat_data_flywheel/pyproject.tomlpackages/nvidia_nat_zep_cloud/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.tomlpackages/nvidia_nat_profiling/pyproject.tomlpackages/nvidia_nat_weave/pyproject.tomlpackages/nvidia_nat_all/pyproject.tomlpackages/nvidia_nat_s3/pyproject.toml
🧠 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:
packages/nvidia_nat_data_flywheel/pyproject.tomlpackages/nvidia_nat_zep_cloud/pyproject.tomlpackages/nvidia_nat_phoenix/pyproject.tomlpackages/nvidia_nat_all/pyproject.tomlpackages/nvidia_nat_s3/pyproject.toml
⏰ 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
examples/observability/simple_calculator_observability/configs/config-otel-file.yml
Outdated
Show resolved
Hide resolved
Signed-off-by: Will Killian <[email protected]>
Signed-off-by: Will Killian <[email protected]>
58036a0 to
5bf4034
Compare
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
♻️ Duplicate comments (2)
docs/source/workflows/observe/observe-workflow-with-phoenix.md (1)
25-25: Fix heading level to properly increment from h1.The heading uses h3 (
###) but should use h2 (##) to properly increment from the h1 heading at line 18. This violates the MD001 markdown rule for heading increments.examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (1)
98-100: Move import to module level.The
from phoenix.client import Clientimport should be at the module level (top of file) rather than inside the function. Inline imports are generally discouraged per PEP 8 unless there's a specific reason (e.g., circular imports, optional dependencies).Based on coding guidelines (PEP 8).
🧹 Nitpick comments (2)
examples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml (2)
17-18: Scope the note to when Phoenix tracing is enabledClarify that
phoenix serveis only needed if the Phoenix tracing block is enabled. Suggested tweak:-# Uncomment the following to enable tracing. -# Install `arize-phoenix` and run `phoenix serve` before launching +# Uncomment the following to enable Phoenix tracing. +# If enabling it, first `pip install arize-phoenix` and start `phoenix serve` in a separate terminal before launching.
50-70: Provide a commented nat_test_llm stub for CI/local testingPer config guidelines, consider adding an optional, commented stub LLM to avoid real calls during tests. Example to append under llms (commented by default), plus a note on how to toggle:
# nat_test_llm: # _type: nat_test_llm # # Responses cycle per call; [] yields empty string # response_seq: # - "42" # - "OK" # # Optional artificial latency in ms # delay_ms: 0You can then set
workflow.llm_name: nat_test_llmwhen stubbing. This keeps the example runnable while supporting CI.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
uv.lockis excluded by!**/*.lock
📒 Files selected for processing (10)
docs/source/workflows/observe/observe-workflow-with-phoenix.md(1 hunks)examples/advanced_agents/profiler_agent/pyproject.toml(1 hunks)examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py(3 hunks)examples/evaluation_and_profiling/email_phishing_analyzer/pyproject.toml(1 hunks)examples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml(1 hunks)examples/notebooks/4_observability_evaluation_and_profiling.ipynb(2 hunks)examples/observability/simple_calculator_observability/README.md(2 hunks)examples/observability/simple_calculator_observability/configs/config-otel-file.yml(1 hunks)packages/nvidia_nat_phoenix/pyproject.toml(1 hunks)packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py(2 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- examples/observability/simple_calculator_observability/configs/config-otel-file.yml
- packages/nvidia_nat_phoenix/pyproject.toml
- examples/advanced_agents/profiler_agent/pyproject.toml
🧰 Additional context used
📓 Path-based instructions (12)
**/*.{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/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml
**/*.{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/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.ymlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pypackages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
**/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/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml
**/*
⚙️ 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/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.ymlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pyexamples/observability/simple_calculator_observability/README.mdpackages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.pyexamples/evaluation_and_profiling/email_phishing_analyzer/pyproject.tomlexamples/notebooks/4_observability_evaluation_and_profiling.ipynbdocs/source/workflows/observe/observe-workflow-with-phoenix.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 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/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.ymlexamples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pyexamples/observability/simple_calculator_observability/README.mdexamples/evaluation_and_profiling/email_phishing_analyzer/pyproject.tomlexamples/notebooks/4_observability_evaluation_and_profiling.ipynb
**/*.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/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.pypackages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.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/observability/simple_calculator_observability/README.md
packages/*/src/**/*.py
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
Importable Python code inside packages must live under packages//src/
Files:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.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:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
packages/**/*
⚙️ CodeRabbit configuration file
packages/**/*: - This directory contains optional plugin packages for the toolkit, each should contain apyproject.tomlfile. - Thepyproject.tomlfile should declare a dependency onnvidia-nator another package with a name starting
withnvidia-nat-. This dependency should be declared using~=<version>, and the version should be a two
digit version (ex:~=1.0).
- Not all packages contain Python code, if they do they should also contain their own set of tests, in a
tests/directory at the same level as thepyproject.tomlfile.
Files:
packages/nvidia_nat_phoenix/src/nat/plugins/phoenix/mixin/phoenix_mixin.py
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/observe/observe-workflow-with-phoenix.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/_staticdirectory.
Files:
docs/source/workflows/observe/observe-workflow-with-phoenix.md
🧬 Code graph analysis (1)
examples/advanced_agents/profiler_agent/src/nat_profiler_agent/tool/px_query.py (1)
src/nat/builder/builder.py (1)
Builder(68-290)
🪛 LanguageTool
examples/observability/simple_calculator_observability/README.md
[grammar] ~95-~95: There might be a mistake here.
Context: ...ng a complete trace. This is useful for: - Quick debugging during development - Off...
(QB_NEW_EN)
[grammar] ~96-~96: There might be a mistake here.
Context: ...or: - Quick debugging during development - Offline analysis of workflow execution -...
(QB_NEW_EN)
[grammar] ~97-~97: There might be a mistake here.
Context: ...- Offline analysis of workflow execution - Integration with custom analysis tools -...
(QB_NEW_EN)
[grammar] ~98-~98: There might be a mistake here.
Context: ...- Integration with custom analysis tools - Archiving traces for later review ### P...
(QB_NEW_EN)
[grammar] ~221-~221: There might be a mistake here.
Context: ... tracing for development and debugging | | config-langfuse.yml | Langfuse | Pro...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.18.1)
docs/source/workflows/observe/observe-workflow-with-phoenix.md
25-25: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (4)
examples/evaluation_and_profiling/email_phishing_analyzer/pyproject.toml (1)
13-13: LGTM! Clean dependency consolidation.The consolidation of Phoenix dependencies into the main package extras (
nvidia-nat[langchain,phoenix]) is a clean improvement that simplifies dependency management and aligns with the PR's objective of reducing direct Phoenix dependencies.examples/notebooks/4_observability_evaluation_and_profiling.ipynb (1)
1204-1219: LGTM! Clear Phoenix installation flow.The addition of explicit Phoenix installation steps and the updated narrative flow ("First... Then... Finally...") provides clear, sequential instructions that align with the updated documentation and improve the user experience.
examples/observability/simple_calculator_observability/README.md (1)
60-99: LGTM! Excellent documentation improvements.The reordered installation flow (install Phoenix first, then start) is more logical, and the new File-Based Tracing section provides a valuable lightweight option for local development. The documentation is comprehensive and well-structured, covering both development and production scenarios effectively.
examples/getting_started/simple_calculator/src/nat_simple_calculator/configs/config-reasoning.yml (1)
61-64: No change needed for model_name gpt-3.5-turbo remains available as of October 2025; example is up to date.
|
/merge |
Description
phoenix serveis required.Closes
By Submitting this PR I confirm:
Summary by CodeRabbit
New Features
Documentation