Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,13 @@ To run the examples, install the NeMo Agent toolkit from source, if you haven't

[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/NVIDIA/NeMo-Agent-Toolkit/)

1. [Getting Started](notebooks/1_getting_started_with_nat.ipynb) - Getting started with the NeMo Agent toolkit
2. [Bringing Your Own Agent](notebooks/2_bringing_your_own_agent.ipynb) - Bringing your own agent to the NeMo Agent toolkit
3. [Adding Tools and Agents](notebooks/3_adding_tools_to_agents.ipynb) - Adding tools to your agentic workflow
4. [Multi-Agent Orchestration](notebooks/4_multi_agent_orchestration.ipynb) - Setting up a multi-agent orchestration workflow
5. [Observability, Evaluation, and Profiling](notebooks/5_observability_evaluation_and_profiling.ipynb) - Instrumenting with observability, evaluation and profiling tools
6. [Optimizing Model Selection, Parameters, and Prompts](notebooks/6_optimize_model_selection.ipynb) - Use NAT Optimize to compare models, parameters, and prompt variations
7. [MCP Client and Servers Setup](notebooks/7_mcp_setup_and_integration.ipynb) - Deploy and integrate MCP clients and servers with NeMo Agent toolkit workflows

1. [Getting Started](notebooks/getting_started_with_nat.ipynb) - Getting started with the NeMo Agent toolkit
2. [Bringing Your Own Agent](notebooks/bringing_your_own_agent.ipynb) - Bringing your own agent to the NeMo Agent toolkit
3. [Adding Tools and Agents](notebooks/adding_tools_to_agents.ipynb) - Adding tools to your agentic workflow
4. [MCP Client and Servers Setup](notebooks/mcp_setup_and_integration.ipynb) - Deploy and integrate MCP clients and servers with NeMo Agent toolkit workflows
5. [Multi-Agent Orchestration](notebooks/multi_agent_orchestration.ipynb) - Setting up a multi-agent orchestration workflow
6. [Observability, Evaluation, and Profiling](notebooks/observability_evaluation_and_profiling.ipynb) - Instrumenting with observability, evaluation and profiling tools
7. [Optimizing Model Selection, Parameters, and Prompts](notebooks/optimize_model_selection.ipynb) - Use NAT Optimize to compare models, parameters, and prompt variations

#### Brev Launchables

Expand Down
14 changes: 7 additions & 7 deletions examples/notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Through this series of notebooks, we demonstrate how you can use the NVIDIA NeMo

We showcase the building blocks that make up the agentic system, including tools, agents, workflows, and observability.

1. [Getting Started](1_getting_started_with_nat.ipynb) - Getting started with the NeMo Agent toolkit
2. [Bringing Your Own Agent](2_bringing_your_own_agent.ipynb) - Bringing your own agent to the NeMo Agent toolkit
3. [Adding Tools and Agents](3_adding_tools_to_agents.ipynb) - Adding tools to your agentic workflow
4. [Multi-Agent Orchestration](4_multi_agent_orchestration.ipynb) - Setting up a multi-agent orchestration workflow
5. [Observability, Evaluation, and Profiling](5_observability_evaluation_and_profiling.ipynb) - Instrumenting with observability, evaluation and profiling tools
6. [Optimizing Model Selection, Parameters, and Prompts](6_optimize_model_selection.ipynb) - Use NAT Optimize to compare models, parameters, and prompt variations
7. [MCP Client and Servers Setup](7_mcp_setup_and_integration.ipynb) - Deploy and integrate MCP clients and servers with NeMo Agent toolkit workflows
1. [Getting Started](getting_started_with_nat.ipynb) - Getting started with the NeMo Agent toolkit
2. [Bringing Your Own Agent](bringing_your_own_agent.ipynb) - Bringing your own agent to the NeMo Agent toolkit
3. [Adding Tools and Agents](adding_tools_to_agents.ipynb) - Adding tools to your agentic workflow
4. [MCP Client and Servers Setup](mcp_setup_and_integration.ipynb) - Deploy and integrate MCP clients and servers with NeMo Agent toolkit workflows
5. [Multi-Agent Orchestration](multi_agent_orchestration.ipynb) - Setting up a multi-agent orchestration workflow
6. [Observability, Evaluation, and Profiling](observability_evaluation_and_profiling.ipynb) - Instrumenting with observability, evaluation and profiling tools
7. [Optimizing Model Selection, Parameters, and Prompts](optimize_model_selection.ipynb) - Use NAT Optimize to compare models, parameters, and prompt variations

We recommend opening these notebooks in a Jupyter Lab environment or Google Colab environment.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@
"metadata": {},
"outputs": [],
"source": [
"!nat workflow create retail_sales_agent"
"!nat workflow create retail_sales_agent_nb3"
]
},
{
Expand Down Expand Up @@ -645,7 +645,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile retail_sales_agent/src/retail_sales_agent/total_product_sales_data_tool.py\n",
"%%writefile retail_sales_agent_nb3/src/retail_sales_agent_nb3/total_product_sales_data_tool.py\n",
"from pydantic import Field\n",
"\n",
"from nat.builder.builder import Builder\n",
Expand Down Expand Up @@ -706,7 +706,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile retail_sales_agent/src/retail_sales_agent/sales_per_day_tool.py\n",
"%%writefile retail_sales_agent_nb3/src/retail_sales_agent_nb3/sales_per_day_tool.py\n",
"from pydantic import Field\n",
"\n",
"from nat.builder.builder import Builder\n",
Expand Down Expand Up @@ -770,7 +770,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile retail_sales_agent/src/retail_sales_agent/detect_outliers_tool.py\n",
"%%writefile retail_sales_agent_nb3/src/retail_sales_agent_nb3/detect_outliers_tool.py\n",
"from pydantic import Field\n",
"\n",
"from nat.builder.builder import Builder\n",
Expand Down Expand Up @@ -837,7 +837,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile -a retail_sales_agent/src/retail_sales_agent/register.py\n",
"%%writefile -a retail_sales_agent_nb3/src/retail_sales_agent_nb3/register.py\n",
"\n",
"from . import sales_per_day_tool\n",
"from . import detect_outliers_tool\n",
Expand All @@ -855,7 +855,7 @@
"\n",
"Below we show how to update the default configuration file for this new tool-calling retail sales agent with the new tools (python methods) that have been defined and registered properly.\n",
"\n",
"Take a moment to analyze the new `retail_sales_agent/configs/config.yml` file below, where a `functions` header has been defined and each registered tool from the previous section is listed. "
"Take a moment to analyze the new `retail_sales_agent_nb3/configs/config.yml` file below, where a `functions` header has been defined and each registered tool from the previous section is listed. "
]
},
{
Expand All @@ -864,7 +864,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile retail_sales_agent/configs/config.yml\n",
"%%writefile retail_sales_agent_nb3/configs/config.yml\n",
"llms:\n",
" nim_llm:\n",
" _type: nim\n",
Expand Down Expand Up @@ -915,7 +915,7 @@
"outputs": [],
"source": [
"%%bash\n",
"nat workflow reinstall retail_sales_agent"
"nat workflow reinstall retail_sales_agent_nb3"
]
},
{
Expand All @@ -935,7 +935,7 @@
"metadata": {},
"outputs": [],
"source": [
"!nat run --config_file=retail_sales_agent/configs/config.yml --input \"How do laptop sales compare to phone sales?\""
"!nat run --config_file=retail_sales_agent_nb3/configs/config.yml --input \"How do laptop sales compare to phone sales?\""
]
},
{
Expand All @@ -955,7 +955,7 @@
"metadata": {},
"outputs": [],
"source": [
"!nat run --config_file=retail_sales_agent/configs/config.yml --input \"What were the laptop sales on February 16th 2024?\""
"!nat run --config_file=retail_sales_agent_nb3/configs/config.yml --input \"What were the laptop sales on February 16th 2024?\""
]
},
{
Expand All @@ -975,7 +975,7 @@
"metadata": {},
"outputs": [],
"source": [
"!nat run --config_file=retail_sales_agent/configs/config.yml --input \"What were the outliers in 'Revenue'?\""
"!nat run --config_file=retail_sales_agent_nb3/configs/config.yml --input \"What were the outliers in 'Revenue'?\""
]
},
{
Expand Down Expand Up @@ -1012,7 +1012,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile retail_sales_agent/src/retail_sales_agent/retail_sales_rag_tool.py\n",
"%%writefile retail_sales_agent_nb3/src/retail_sales_agent_nb3/retail_sales_rag_tool.py\n",
"import logging\n",
"import os\n",
"\n",
Expand Down Expand Up @@ -1103,7 +1103,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile -a retail_sales_agent/src/retail_sales_agent/register.py\n",
"%%writefile -a retail_sales_agent_nb3/src/retail_sales_agent_nb3/register.py\n",
"\n",
"from . import retail_sales_rag_tool"
]
Expand Down Expand Up @@ -1148,7 +1148,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%writefile retail_sales_agent/configs/config_rag.yml\n",
"%%writefile retail_sales_agent_nb3/configs/config_rag.yml\n",
"llms:\n",
" nim_llm:\n",
" _type: nim\n",
Expand Down Expand Up @@ -1216,7 +1216,7 @@
"metadata": {},
"outputs": [],
"source": [
"!nat run --config_file=retail_sales_agent/configs/config_rag.yml \\\n",
"!nat run --config_file=retail_sales_agent_nb3/configs/config_rag.yml \\\n",
" --input \"What is the Ark S12 Ultra tablet and what are its specifications?\""
]
},
Expand All @@ -1234,8 +1234,7 @@
"<a id=\"next-steps\"></a>\n",
"# 4.0) Next Steps\n",
"\n",
"\n",
"What we've shown here are powerful concepts that allow agents to be integrated easily with other APIs, services, and institutional data sources. But once agents are equipped with the tools they need to properly address user queries, we begin to wonder how and where to draw the line between one agent and another, and the concept of multi-agent systems and multi-agent orchestration takes center stage. In the next notebook, we will show how easily multi-agent orchestration can be coordinated using NAT and also show a quick demo of multi-modal asset handling with NAT agents."
"In the next notebook in our series: `mcp_setup_and_integration.ipynb` we will demonstrate how distributed sets of tools can be hosted on MCP servers and used by MCP clients."
]
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -857,7 +857,7 @@
"<a id=\"next-steps\"></a>\n",
"# 3.0) Next Steps\n",
"\n",
"Next, look at \"Adding Tools to NeMo Agent Toolkit Agents\" where you will interactively learn how to create your own tools and agents with NAT."
"The next exercise in this series is `adding_tools_to_agents.ipynb` where you will interactively learn how to create your own tools and agents with NAT."
]
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@
"<a id=\"next-steps\"></a>\n",
"# 3.0) Next Steps\n",
"\n",
"If you already have agents codified and don't need NAT to bring up your first agent, we also support bringing existing agents into the NAT framework. In the next notebook of this series, \\\"Bringing Your Own Agent into NeMo Agent Toolkit\\\" (2_bringing_your_own_agent.ipynb), we will walk you through adapting existing agents into NAT."
"If you already have agents codified and don't need NAT to bring up your first agent, we also support bringing existing agents into the NAT framework. In the next notebook of this series, `bringing_your_own_agent.ipynb`, we will walk you through adapting existing agents into NAT."
]
}
],
Expand Down
Loading
Loading