Skip to content

Commit 9ded32b

Browse files
Revise README for clarity and consistency
Updated the README to clarify the framework's design and usage.
1 parent 2507e9a commit 9ded32b

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
>
1919
</picture>
2020
21-
<p align="center"><b>The Pythonic way to build AI agents.</b></p>
21+
<p align="center"><b>A Pythonic way to build AI agents.</b></p>
2222

2323
[![NVIDIA](https://img.shields.io/badge/NVIDIA-76B900?logo=nvidia&logoColor=white)](https://www.nvidia.com/)
2424
[![Paper](https://img.shields.io/badge/paper-arXiv-b31b1b?logo=arxiv&logoColor=white)](PAPER_URL)
@@ -32,7 +32,7 @@
3232
</div>
3333

3434

35-
NVIDIA-labs OO Agents (NOOA) is a model-agnostic Python framework for building reliable AI agents. Traditional agent frameworks scatter your code across prompt templates, tool schemas, callback handlers, and workflow graphs. NOOA collapses all of that into a single Python class:
35+
NVIDIA-labs OO Agents (NOOA) is a model-agnostic Python framework designed to support reliable AI agent development. Many agent frameworks represent prompts, tools, callbacks, and workflows as separate abstractions. NOOA offers an alternative object-oriented interface that brings these concepts together in a Python class. NOOA lets developers express an agent’s state, capabilities, prompts, and typed interfaces through a single Python class:
3636

3737
```python
3838
from nooa import Agent
@@ -58,10 +58,10 @@ class SupportAgent(Agent):
5858

5959
- **Agents are Python objects.** Fields are state, methods are capabilities, docstrings are prompts, type annotations are contracts.
6060
- **`...` bodies are LLM-driven.** A method with `...` becomes an agentic loop; a real body stays deterministic Python.
61-
- **Code as action.** The model acts by writing Python in a Jupyter-style REPL with access to `self`, imports, and helpers — no bespoke tool schemas.
62-
- **Pythonic and agent-ready.** Typed I/O with auto-retry, live-object arguments passed by reference, and model-callable context and event APIs — designed for agents from the ground up.
61+
- **Code as action.** The model acts by writing Python in a Jupyter-style REPL with access to `self`, imports, and helpers — Python methods and type annotations supply the callable interfaces, reducing the need to write separate tool-schema definitions.
62+
- **Pythonic and agent-ready.** Typed I/O with auto-retry, live-object arguments passed by reference, and model-callable context and event APIs — designed around agent-oriented Python workflows.
6363

64-
The result: agents you can test, trace, refactor, and version — **just like the rest of your software**. Read the paper for the design principles and evaluation results: [NVIDIA OO Agents: Native Python Object-Oriented Agents](PAPER_URL).
64+
This design supports familiar Python testing, tracing, refactoring, and version-control workflows**just like the rest of your software**. Read the paper for the design principles and evaluation results: [NVIDIA OO Agents: Native Python Object-Oriented Agents](PAPER_URL).
6565

6666
## Installation
6767

@@ -98,7 +98,7 @@ uv add "eval_pipeline @ git+https://github.com/NVIDIA-NeMo/labs-OO-Agents.git@ma
9898

9999
### Choose a model
100100

101-
Pick any [LiteLLM-supported](https://docs.litellm.ai/) model — hosted or local:
101+
Choose from supported hosted or local [LiteLLM-supported](https://docs.litellm.ai/) model:
102102

103103
```python
104104
from nooa.unifiedllm.registry import get_llm_client

0 commit comments

Comments
 (0)