Skip to content

feat: Improve the developer journey for example notebooks #912

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 4, 2025
Merged

feat: Improve the developer journey for example notebooks #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c892328
feat: Improve the developer journey for example notebooks
willkill07 Oct 4, 2025
7ea0588
fix: path check
willkill07 Oct 4, 2025
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
4 changes: 2 additions & 2 deletions ci/scripts/path_checks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,8 @@
),
# ignore notebook-relative paths
(
r"^examples/notebooks/retail_sales_agent/.*configs/",
r"^\./retail_sales_agent/data/",
r"^examples/notebooks/",
r".*(configs|data|src).*",
),
(
r"^examples/frameworks/haystack_deep_research_agent/README.md",
Expand Down
3 changes: 3 additions & 0 deletions ci/vale/styles/config/vocabularies/nat/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Authlib
[Cc]hatbot(s?)
# clangd is never capitalized even at the start of a sentence https://clangd.llvm.org/
clangd
Colab
CMake
[Cc]omposability
[Cc]omposable
Expand Down Expand Up @@ -65,7 +66,9 @@ groundedness
[Gg]ranularities
[Hh]ashable
[Hh]yperparameter(s?)
impactful
[Ii]nferencing
[Ii]nterquartile
isort
Jira
jsonlines
Expand Down
11 changes: 7 additions & 4 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,13 @@ To run the examples, install the NeMo Agent toolkit from source, if you haven't
- **[`simple_calculator_mcp`](MCP/simple_calculator_mcp/README.md)**: Demonstrates Model Context Protocol support using the basic simple calculator example

### Notebooks
- **[Building an Agentic System](notebooks/README.md)**: Series of notebooks demonstrating how to build, connect, evaluate, profile and deploy an agentic system using the NeMo Agent toolkit
- **[`1_getting_started.ipynb`](notebooks/1_getting_started.ipynb)**: Getting started with the NeMo Agent toolkit
- **[`2_add_tools_and_agents.ipynb`](notebooks/2_add_tools_and_agents.ipynb)**: Adding tools and agents to your workflow
- **[`3_observability_evaluation_and_profiling.ipynb`](notebooks/3_observability_evaluation_and_profiling.ipynb)**: Observability, evaluation and profiling

**[Building an Agentic System](notebooks/README.md)**: Series of notebooks demonstrating how to build, connect, evaluate, profile and deploy an agentic system using the 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_and_agents.ipynb) - Adding tools and agents to your workflow
4. [Observability, Evaluation, and Profiling](notebooks/4_observability_evaluation_and_profiling.ipynb) - Observability, evaluation and profiling

#### Brev Launchables

Expand Down
Loading