Update `AIQ` to `NAT` in documentation and comments #614

yczhang-nv · 2025-08-09T00:44:50Z

Description

Update all occurrences of AIQ/aiq to the new name NeMo Agent Toolkit or NAT in documentation and comments.
Remove unused get_distribution_name and get_distribution_name_from_private_data methods from the nat.data_models.discovery_metadata module. This is a breaking change.

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.

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Copilot

Pull Request Overview

This PR updates all occurrences of AIQ/aiq to the new name NeMo Agent Toolkit or NAT in documentation and comments across the codebase. This is a comprehensive rebranding effort that maintains consistency throughout the project.

Key changes include:

Updating variable names, function names, and class references from aiq to nat
Changing package references from aiqtoolkit to nvidia-nat
Updating configuration paths, URLs, and file names to use the new naming convention

Reviewed Changes

Copilot reviewed 271 out of 271 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/nat/tool/retriever.py	Updates function alias from aiq_retriever_tool to nat_retriever_tool
src/nat/tool/mcp/exceptions.py	Updates CLI command reference from 'aiq info mcp' to 'nat info mcp'
src/nat/tool/code_execution/test_code_execution_sandbox.py	Updates sandbox directory path from src/aiq/ to src/nat/
src/nat/tool/code_execution/README.md	Updates documentation paths from src/aiq/ to src/nat/
src/nat/tool/chat_completion.py	Updates module description from "AIQ Toolkit" to "NAT"
src/nat/settings/global_settings.py	Updates environment variable from AIQ_CONFIG_DIR to NAT_CONFIG_DIR
src/nat/front_ends/mcp/mcp_front_end_config.py	Updates default MCP server name from "AIQ MCP" to "NeMo Agent Toolkit MCP"
src/nat/front_ends/fastapi/main.py	Updates environment variables from AIQ_CONFIG_FILE/AIQ_FRONT_END_WORKER to NAT equivalents
src/nat/registry_handlers/package_utils.py	Updates entry points from aiq.plugins to nat.plugins
src/nat/eval/evaluate.py	Updates default workflow alias from aiqtoolkit-eval to nvidia-nat-eval
examples/observability/simple_calculator_observability/configs/*.yml	Updates project names and component references to use nat instead of aiq
tests/*/.py	Updates variable names, comments, and test data from aiq/AIQ to nat/NAT throughout test files

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

src/nat/data_models/api_server.py

src/nat/registry_handlers/package_utils.py

dagardner-nv

reviewed up to docs/source/reference/cursor-rules-reference.md

.cursor/rules/nat-cli/nat-run-serve.mdc

.cursor/rules/nat-setup/nat-toolkit-installation.mdc

docs/source/reference/cli.md

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

willkill07

Mostly small grammar fixes.

tests/nat/eval/test_intermediate_step_adapter.py

src/nat/front_ends/console/console_front_end_config.py

packages/nvidia_nat_agno/src/nat/plugins/agno/tool_wrapper.py

packages/nvidia_nat_langchain/src/nat/plugins/langchain/tools/wikipedia_search.py

src/nat/agent/react_agent/register.py

src/nat/registry_handlers/schemas/publish.py

src/nat/runtime/loader.py

src/nat/tool/retriever.py

src/nat/tool/mcp/mcp_tool.py

docs/source/index.md

willkill07 · 2025-08-13T01:37:55Z

FYI, I ran all e2e, integration, and long tests locally:

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃  File                                                          ┃  Function                                                                           ┃  Function Line  ┃  Error Line  ┃  Error                  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩
│  tests/nat/compat/test_compatibility_aliases.py                │  test_compatibility_aliases[False-aiq.runtime.loader-get_all_aiq_entrypoints_dist…  │  40             │  94          │  AttributeError         │
│  tests/nat/compat/test_compatibility_aliases.py                │  test_compatibility_aliases[False-aiq.tool.retriever-aiq_retriever_tool-retriever…  │  40             │  94          │  AttributeError         │
│  tests/nat/compat/test_compatibility_aliases.py                │  test_compatibility_aliases[True-aiq.runtime.loader-get_all_aiq_entrypoints_distr…  │  40             │  94          │  AttributeError         │
│  tests/nat/compat/test_compatibility_aliases.py                │  test_compatibility_aliases[True-aiq.tool.retriever-aiq_retriever_tool-retriever_…  │  40             │  665         │  AssertionError         │
│  tests/nat/server/test_unified_api_server.py                   │  test_chat_stream_endpoint                                                          │  334            │  342         │  ValidationError        │
└────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────┴─────────────────┴──────────────┴─────────────────────────┘

Of those, only the tests/nat/compat/test_compatibility_aliases.py tests run by default, so we will need to resolve them before merge.

For test_chat_stream_endpoint, the failure is Pydantic validation:

E       pydantic_core._pydantic_core.ValidationError: 2 validation errors for ChatResponseChunk
E       choices
E         Field required [type=missing, input_value={'id': '170c1871-601e-460...owledge_base=True\n```"}, input_type=dict]
E           For further information visit https://errors.pydantic.dev/2.10/v/missing
E       created
E         Field required [type=missing, input_value={'id': '170c1871-601e-460...owledge_base=True\n```"}, input_type=dict]
E           For further information visit https://errors.pydantic.dev/2.10/v/missing

I have fixed this locally with the following patch:

diff --git a/tests/nat/server/test_unified_api_server.py b/tests/nat/server/test_unified_api_server.py
index 2a9f8c0a..35f1609a 100644
--- a/tests/nat/server/test_unified_api_server.py
+++ b/tests/nat/server/test_unified_api_server.py
@@ -337,7 +337,9 @@ async def test_chat_stream_endpoint(client: httpx.AsyncClient, config: Config):
     input_message = {"messages": [{"role": "user", "content": f"{config.app.input}"}], "use_knowledge_base": True}
     response = await client.post(f"{config.endpoint.chat_stream}", json=input_message)
     assert response.status_code == 200
-    data_match: re.Match[str] | None = re.search(r'data:\s*(.*)', response.text)
+    # only match the explicit `data:` json response
+    data_match: re.Match[str] | None = re.search(r'\bdata:\s*(.[^\n]*)\n', response.text)
+    assert data_match is not None
     data_match_dict: dict = json.loads(data_match.group(1))
     validated_response = ChatResponseChunk(**data_match_dict)
     assert isinstance(validated_response, ChatResponseChunk)

willkill07

Fixes pytest failures

src/nat/runtime/loader.py

src/nat/tool/retriever.py

dagardner-nv

Reviewed up to examples/evaluation_and_profiling/simple_calculator_eval/README.md

docs/source/resources/contributing.md

docs/source/store-and-retrieve/retrievers.md

examples/HITL/por_to_jiratickets/README.md

examples/HITL/simple_calculator_hitl/README.md

examples/advanced_agents/profiler_agent/README.md

examples/agents/mixture_of_agents/README.md

examples/custom_functions/plot_charts/README.md

Co-authored-by: Will Killian <2007799+willkill07@users.noreply.github.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>

Signed-off-by: David Gardner <dagardner@nvidia.com>

…ntIQ into david-yuchen-update-naming-docs-p3 Signed-off-by: David Gardner <dagardner@nvidia.com>

Signed-off-by: David Gardner <dagardner@nvidia.com>

…cs-p3 Update to new documentation URL

Signed-off-by: David Gardner <dagardner@nvidia.com>

…ntIQ into david-yuchen-update-naming-docs-p3 Signed-off-by: David Gardner <dagardner@nvidia.com>

…cs-p3 Ignore the 'custom-server' url in list_mcp.py module

Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>

…xecute_function.py Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Signed-off-by: David Gardner <dagardner@nvidia.com>

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

…cs-p4 Lint fix

src/nat/front_ends/fastapi/fastapi_front_end_plugin.py

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Signed-off-by: David Gardner <dagardner@nvidia.com>

Literals must actually be literals

Signed-off-by: David Gardner <dagardner@nvidia.com>

Applying Will's fix

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

## Description    - Update all occurrences of `AIQ/aiq` to the new name `NeMo Agent Toolkit` or `NAT` in documentation and comments. - Remove unused `get_distribution_name` and `get_distribution_name_from_private_data` methods from the `nat.data_models.discovery_metadata` module. **This is a breaking change.** ## 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. --------- Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com> Signed-off-by: David Gardner <dagardner@nvidia.com> Co-authored-by: Will Killian <2007799+willkill07@users.noreply.github.com> Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com> Co-authored-by: David Gardner <dagardner@nvidia.com> Signed-off-by: Sangharsh Aglave <aglave@synopsys.com>

yczhang-nv added 2 commits August 8, 2025 17:37

update naming

f326e1f

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Merge remote-tracking branch 'upstream/develop' into yuchen-update-na…

ee4c683

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

yczhang-nv self-assigned this Aug 9, 2025

yczhang-nv added doc Improvements or additions to documentation non-breaking Non-breaking change labels Aug 9, 2025

yczhang-nv added 12 commits August 8, 2025 18:06

update all AIQ-prefix

c8e615c

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

update AIQ-prefix

4908eb5

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

remove more AIQ occurences

e2cbd36

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

rename cursor rules

474f812

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Merge remote-tracking branch 'upstream/develop' into yuchen-update-na…

44fd739

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Merge remote-tracking branch 'upstream/develop' into yuchen-update-na…

5d68551

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

update Cursor rules

caae581

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

first round of clean-up

1797a27

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

second round of update

91c9b78

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

update CLI command in doc

65dfd63

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

update CLI commands again

fabfbef

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

update some READMEs

472feff

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

mpenn mentioned this pull request Aug 12, 2025

Fixing nat workflow create templates with deprecated references to aiqtoolkit #629

Closed

yczhang-nv added 2 commits August 12, 2025 16:27

another round of clean-up

6dc399c

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

final clean up for Cursor rules

6620048

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

dagardner-nv requested a review from Copilot August 12, 2025 23:38

Copilot AI reviewed Aug 12, 2025

View reviewed changes

src/nat/data_models/api_server.py Outdated Show resolved Hide resolved

src/nat/data_models/api_server.py Show resolved Hide resolved

src/nat/registry_handlers/package_utils.py Show resolved Hide resolved

dagardner-nv reviewed Aug 12, 2025

View reviewed changes

yczhang-nv added 2 commits August 12, 2025 17:15

fix comments

a0510a9

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

revert banner link

dd676fc

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

willkill07 requested changes Aug 13, 2025

View reviewed changes

src/nat/runtime/loader.py Outdated Show resolved Hide resolved

src/nat/tool/retriever.py Outdated Show resolved Hide resolved

dagardner-nv reviewed Aug 13, 2025

View reviewed changes

Update src/nat/agent/reasoning_agent/reasoning_agent.py

6e8a5bd

Co-authored-by: Will Killian <2007799+willkill07@users.noreply.github.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>

dagardner-nv and others added 15 commits August 13, 2025 14:03

Remove unused imports

b81e8c6

Signed-off-by: David Gardner <dagardner@nvidia.com>

Ignore the new documentation url until it has been published

604e944

Signed-off-by: David Gardner <dagardner@nvidia.com>

Merge branch 'yuchen-update-naming-docs' of github.com:yczhang-nv/Age…

926808b

…ntIQ into david-yuchen-update-naming-docs-p3 Signed-off-by: David Gardner <dagardner@nvidia.com>

Add a comment about the banner.png ignore

2ef3c6b

Signed-off-by: David Gardner <dagardner@nvidia.com>

Merge pull request #3 from dagardner-nv/david-yuchen-update-naming-do…

fdd5ec0

…cs-p3 Update to new documentation URL

Ignore the 'custom-server' url in list_mcp.py module

c199aeb

Signed-off-by: David Gardner <dagardner@nvidia.com>

Merge branch 'yuchen-update-naming-docs' of github.com:yczhang-nv/Age…

b4b5f81

…ntIQ into david-yuchen-update-naming-docs-p3 Signed-off-by: David Gardner <dagardner@nvidia.com>

Merge pull request #4 from dagardner-nv/david-yuchen-update-naming-do…

033fe28

…cs-p3 Ignore the 'custom-server' url in list_mcp.py module

Update src/nat/eval/evaluate.py

0c30c17

Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>

Update src/nat/experimental/test_time_compute/functions/plan_select_e…

bd5f55f

…xecute_function.py Co-authored-by: David Gardner <96306125+dagardner-nv@users.noreply.github.com> Signed-off-by: Yuchen Zhang <134643420+yczhang-nv@users.noreply.github.com>

update object_store.py env var

1f40e1d

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Ignore long line

fe0a3c9

Signed-off-by: David Gardner <dagardner@nvidia.com>

several code file updates

b6080e3

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

some other code updates

ab3f386

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

Merge pull request #5 from dagardner-nv/david-yuchen-update-naming-do…

661bc97

…cs-p4 Lint fix

vikalluru reviewed Aug 13, 2025

View reviewed changes

src/nat/front_ends/fastapi/fastapi_front_end_plugin.py Show resolved Hide resolved

fix api_server.py

c6db929

Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

dagardner-nv self-requested a review August 13, 2025 22:05

dagardner-nv approved these changes Aug 13, 2025

View reviewed changes

dagardner-nv requested a review from willkill07 August 13, 2025 22:06

dagardner-nv and others added 2 commits August 13, 2025 15:12

Literals must actually be literals

1930f18

Signed-off-by: David Gardner <dagardner@nvidia.com>

Merge pull request #6 from dagardner-nv/yuchen-update-naming-docs-tests

cabc4ae

Literals must actually be literals

willkill07 approved these changes Aug 13, 2025

View reviewed changes

dagardner-nv and others added 3 commits August 13, 2025 15:37

Applying Will's fix

9650b97

Signed-off-by: David Gardner <dagardner@nvidia.com>

Merge pull request #7 from dagardner-nv/yuchen-update-naming-docs-tests

6bb7da4

Applying Will's fix

Merge remote-tracking branch 'upstream/develop' into yuchen-update-na…

c702761

…ming-docs Signed-off-by: Yuchen Zhang <yuchenz@nvidia.com>

dagardner-nv merged commit 2264108 into NVIDIA:develop Aug 13, 2025
8 of 9 checks passed

yczhang-nv deleted the yuchen-update-naming-docs branch August 15, 2025 21:15

vikalluru mentioned this pull request Aug 18, 2025

Agentic AI workflow for Predictive Maintenance NVIDIA/GenerativeAIExamples#304

Merged

Update AIQ to NAT in documentation and comments #614

Update AIQ to NAT in documentation and comments #614

Uh oh!

Conversation

yczhang-nv commented Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

By Submitting this PR I confirm:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dagardner-nv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

willkill07 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

willkill07 commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

willkill07 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

dagardner-nv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Update `AIQ` to `NAT` in documentation and comments #614

Update `AIQ` to `NAT` in documentation and comments #614

yczhang-nv commented Aug 9, 2025 •

edited

Loading

willkill07 commented Aug 13, 2025 •

edited

Loading