From ef12ca4b4ebe1b84b0507364861c6c177275e5ad Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Fri, 21 Jun 2024 08:49:57 -0700 Subject: [PATCH] small doc fixes (#103) --- python/docs/src/index.rst | 13 ++++--------- python/examples/README.md | 19 +++++++++++++++++-- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/python/docs/src/index.rst b/python/docs/src/index.rst index 73c142589e..16922a9a66 100644 --- a/python/docs/src/index.rst +++ b/python/docs/src/index.rst @@ -13,15 +13,10 @@ common uses, such as chat completion agents, but also allows for fully custom ag AGNext's developer API consists of the following layers: -- :doc:`core ` - The core interfaces that defines agent - and runtime. -- :doc:`application ` - Implementations of the runtime - and other modules (e.g., logging) for building applications. -- :doc:`components ` - Interfaces and implementations - for agents, models, memory, and tools. -- :doc:`chat ` - High-level API for creating demos and - experimenting with multi-agent patterns. It offers pre-built agents, patterns, - message types, and memory stores. +- :doc:`core ` - The core interfaces that defines agent and runtime. +- :doc:`application ` - Implementations of the runtime and other modules (e.g., logging) for building applications. +- :doc:`components ` - Interfaces and implementations for agents, models, memory, and tools. +- :doc:`chat ` - High-level API for creating demos and experimenting with multi-agent patterns. It offers pre-built agents, patterns, message types, and memory stores. diff --git a/python/examples/README.md b/python/examples/README.md index 322f171ce4..fbe3a35822 100644 --- a/python/examples/README.md +++ b/python/examples/README.md @@ -2,23 +2,38 @@ This directory contains examples of how to use AGNext. +## `chat` layer examples + We provide examples that use pre-built agents and message types in the `chat` layer. These examples are intended for users who want to quickly create demos and experimenting with multi-agent design paterns. +### Single agent examples + +- `assistant.py`: a demonstration of how to use the OpenAI Assistant API to create + a ChatGPT agent. + +### Reflection pattern examples + - `coder_reviewer.py`: using a coder and reviewer agents to implement the reflection pattern for code generation. - `illustrator_critics.py`: using an illustrator, critics and descriptor agent to implement the reflection pattern for image generation. - `chest_game.py`: using two chess player agents to demonstrate tool use and reflection on tool use. -- `assistant.py`: a demonstration of how to use the OpenAI Assistant API to create - a ChatGPT agent. + +### Group chat pattern examples + - `software_consultancy.py`: a demonstration of multi-agent interaction using the group chat pattern. + +### Orchestrator pattern examples + - `orchestrator.py`: a demonstration of multi-agent problem solving using the orchestrator pattern. +## Advanced examples + We also provide examples that use only the `core`, `application`, and `components` layers. These examples are intended for advanced users who want to create custom agents and message types for building applications.