Skip to content

docs: update examples README branding #19

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
alessiodevoto merged 1 commit into from
Jul 24, 2026
Merged

docs: update examples README branding #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 3 additions & 4 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# NeMo OO Agents — Examples
# NVIDIA OO Agents — Examples

A progressive tour of the framework. Each step is a standalone, copy-paste-runnable file under [`quickstart/`](quickstart/).

> The examples use `from nooa.util.quickstart import *`, which bundles common imports (`Agent`, `llm`, `BaseModel`, `strategy`, `autorun`, …) for brevity.

**Contents**

Expand Down Expand Up @@ -58,15 +57,15 @@ llm = get_llm_client("gemini/gemini-2.5-flash") # Google (needs GEMINI_API_K

Provider packages can register bundled model aliases automatically through the `nooa.bundled_configs` entry-point group. To customize the registry, run `nooa config eject`, drop an `llm_config.yaml` in your project's `.nooa/`, or point `NEMO_OO_LLM_CONFIG` at one or more YAML files. See [`src/nooa/unifiedllm/registry.py`](../src/nooa/unifiedllm/registry.py) for the YAML schema.

> **Key insight.** In NeMo OO Agents, your method name, parameters, and docstring ARE the prompt. Rename `analyze_feedback` to `analyze_feedback_briefly` or `give_detailed_feedback_analysis` — the output changes accordingly, without touching any other code.
> **Key insight.** In NVIDIA OO Agents, your method name, parameters, and docstring ARE the prompt. Rename `analyze_feedback` to `analyze_feedback_briefly` or `give_detailed_feedback_analysis` — the output changes accordingly, without touching any other code.

```bash
uv run python examples/quickstart/01_first_generation_method.py
```

## Step 2: Structured outputs

Use any Pydantic model as the return type. NeMo OO Agents validates outputs and auto-retries on error; the LLM sees the validation message and corrects itself.
Use any Pydantic model as the return type. NVIDIA OO Agents validates outputs and auto-retries on error; the LLM sees the validation message and corrects itself.

```python
from typing import Literal
Expand Down