Overhaul landing page, change top links (#611)
* Overhaul landing page, change top links * agent chat first
@ -0,0 +1,12 @@
|
||||
---
|
||||
myst:
|
||||
html_meta:
|
||||
"description lang=en": |
|
||||
User Guide for AutoGen AgentChat, a framework for building multi-agent applications with AI agents.
|
||||
---
|
||||
|
||||
# AgentChat
|
||||
|
||||
```{note}
|
||||
🚧 Under construction 🚧
|
||||
```
|
||||
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
|
Before Width: | Height: | Size: 199 KiB After Width: | Height: | Size: 199 KiB |
|
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 132 KiB After Width: | Height: | Size: 132 KiB |
|
Before Width: | Height: | Size: 221 KiB After Width: | Height: | Size: 221 KiB |
|
Before Width: | Height: | Size: 348 KiB After Width: | Height: | Size: 348 KiB |
|
Before Width: | Height: | Size: 317 KiB After Width: | Height: | Size: 317 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
@ -0,0 +1,98 @@
|
||||
---
|
||||
myst:
|
||||
html_meta:
|
||||
"description lang=en": |
|
||||
User Guide for AutoGen Core, a framework for building multi-agent applications with AI agents.
|
||||
---
|
||||
|
||||
# Core
|
||||
|
||||
```{warning}
|
||||
This project and documentation is a work in progress. If you have any questions or need help, please reach out to us on GitHub.
|
||||
```
|
||||
|
||||
AutoGen core offers an easy way to quickly build event-driven, distributed, scalable, resilient AI agent systems. Agents are developed by using the [Actor model](https://en.wikipedia.org/wiki/Actor_model). You can build and run your agent system locally and easily move to a distributed system in the cloud when you are ready.
|
||||
|
||||
Key features of AutoGen core include:
|
||||
|
||||
```{gallery-grid}
|
||||
:grid-columns: 1 2 2 3
|
||||
|
||||
- header: "{fas}`network-wired;pst-color-primary` Asynchronous Messaging"
|
||||
content: "Agents communicate through asynchronous messages, enabling event-driven and request/response communication models."
|
||||
- header: "{fas}`cube;pst-color-primary` Scalable & Distributed"
|
||||
content: "Enable complex scenarios with networks of agents across organizational boundaries."
|
||||
- header: "{fas}`code;pst-color-primary` Multi-Language Support"
|
||||
content: "Python & Dotnet interoperating agents today, with more languages coming soon."
|
||||
- header: "{fas}`globe;pst-color-primary` Modular & Extensible"
|
||||
content: "Highly customizable with features like custom agents, memory as a service, tools registry, and model library."
|
||||
- header: "{fas}`puzzle-piece;pst-color-primary` Observable & Debuggable"
|
||||
content: "Easily trace and debug your agent systems."
|
||||
- header: "{fas}`project-diagram;pst-color-primary` Event-Driven Architecture"
|
||||
content: "Build event-driven, distributed, scalable, and resilient AI agent systems."
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Getting Started
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/installation
|
||||
guides/quickstart
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Core Concepts
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
|
||||
core-concepts/agent-and-multi-agent-application
|
||||
core-concepts/architecture
|
||||
core-concepts/api-layers
|
||||
core-concepts/application-stack
|
||||
core-concepts/agent-identity-and-lifecycle
|
||||
core-concepts/topic-and-subscription
|
||||
core-concepts/faqs
|
||||
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Framework
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/agent-and-agent-runtime
|
||||
guides/message-and-communication
|
||||
guides/model-clients
|
||||
guides/tools
|
||||
guides/logging
|
||||
guides/distributed-agent-runtime
|
||||
guides/telemetry
|
||||
guides/command-line-code-executors
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Multi-Agent Design Patterns
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/multi-agent-design-patterns
|
||||
guides/group-chat
|
||||
guides/reflection
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Cookbook
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
cookbook/azure-openai-with-aad-auth
|
||||
cookbook/termination-with-intervention
|
||||
cookbook/extracting-results-with-an-agent
|
||||
cookbook/openai-assistant-agent
|
||||
cookbook/langgraph-agent
|
||||
cookbook/llamaindex-agent
|
||||
cookbook/local-llms-ollama-litellm
|
||||
|
||||
```
|
||||
@ -6,30 +6,78 @@ myst:
|
||||
html_theme.sidebar_secondary.remove: false
|
||||
---
|
||||
|
||||
# AutoGen
|
||||
<style>
|
||||
.hero-title {
|
||||
font-size: 60px;
|
||||
font-weight: bold;
|
||||
margin: 2rem auto 0;
|
||||
}
|
||||
</style>
|
||||
|
||||
AutoGen is an OSS framework for developing intelligent applications using AI Agents patterns.
|
||||
It offers an easy way to quickly build event-driven, distributed, scalable, resilient AI agent systems. Agents are developed by using the [Actor model](https://en.wikipedia.org/wiki/Actor_model). You can build and run your agent system locally and easily move to a distributed system in the cloud when you are ready.
|
||||
<div class="container">
|
||||
|
||||
Key features of AutoGen are summarized below.
|
||||
<div class="row text-center">
|
||||
<div class="col-sm-12">
|
||||
<h1 class="hero-title">
|
||||
AutoGen
|
||||
</h1>
|
||||
<h3>
|
||||
A framework for developing intelligent applications using AI agent patterns.
|
||||
</h3>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
```{gallery-grid}
|
||||
:grid-columns: 1 2 2 3
|
||||
|
||||
- header: "{fas}`network-wired;pst-color-primary` Asynchronous Messaging"
|
||||
content: "Agents communicate through asynchronous messages, enabling event-driven and request/response communication models."
|
||||
- header: "{fas}`cube;pst-color-primary` Scalable & Distributed"
|
||||
content: "Enable complex scenarios with networks of agents across organizational boundaries."
|
||||
- header: "{fas}`code;pst-color-primary` Multi-Language Support"
|
||||
content: "Python & Dotnet interoperating agents today, with more languages coming soon."
|
||||
- header: "{fas}`globe;pst-color-primary` Modular & Extensible"
|
||||
content: "Highly customizable with features like custom agents, memory as a service, tools registry, and model library."
|
||||
- header: "{fas}`puzzle-piece;pst-color-primary` Observable & Debuggable"
|
||||
content: "Easily trace and debug your agent systems."
|
||||
- header: "{fas}`project-diagram;pst-color-primary` Event-Driven Architecture"
|
||||
content: "Build event-driven, distributed, scalable, and resilient AI agent systems."
|
||||
<div class="row">
|
||||
|
||||
<div class="col-sm">
|
||||
<h2 class="text-center">
|
||||
|
||||
{fas}`people-group;pst-color-primary` AgentChat
|
||||
|
||||
</h2>
|
||||
|
||||
<p>
|
||||
Task driven, high level APIs for building multi-agent systems. Including group chat, pre-built agents, and more.
|
||||
|
||||
Built with <i>core</i>.
|
||||
<p>
|
||||
|
||||
```sh
|
||||
pip install autogen-agentchat
|
||||
```
|
||||
|
||||
<button onclick="location.href='agentchat-user-guide/guides/quickstart.html'" type="button" class="btn btn-primary">Get Started</button>
|
||||
<button onclick="location.href='reference/python/autogen_agentchat/autogen_agentchat.html'" type="button" class="btn btn-outline-secondary">API Reference</button>
|
||||
|
||||
<div class="versionadded">
|
||||
<p>Start here if you are looking for an API similar to AutoGen 0.2</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="col-sm">
|
||||
<h2 class="text-center">
|
||||
|
||||
{fas}`cube;pst-color-primary` Core
|
||||
|
||||
</h2>
|
||||
|
||||
<p>
|
||||
Primitive building blocks for creating asynchronous, event driven multi-agent systems.
|
||||
<p>
|
||||
|
||||
```sh
|
||||
pip install autogen-core
|
||||
```
|
||||
|
||||
<button onclick="location.href='core-user-guide/guides/quickstart.html'" type="button" class="btn btn-primary">Get Started</button>
|
||||
<button onclick="location.href='reference/python/autogen_core/autogen_core.html'" type="button" class="btn btn-outline-secondary">API Reference</button>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!--
|
||||
Key features of AutoGen include:
|
||||
|
||||
@ -39,15 +87,12 @@ Key features of AutoGen include:
|
||||
- x-lang support: Python & Dotnet interoperating agents today, others coming soon
|
||||
- Observable, traceable & debuggable -->
|
||||
|
||||
```{seealso}
|
||||
To start quickly, read the [Quick Start](user-guide/guides/quickstart) guide and follow the tutorial sections. To learn about the core concepts of AutoGen, begin with [Agent and Multi-Agent Application](user-guide/core-concepts/agent-and-multi-agent-application).
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
user-guide/index
|
||||
agentchat-user-guide/index
|
||||
core-user-guide/index
|
||||
```
|
||||
|
||||
<!-- ## Community
|
||||
|
||||
@ -20,18 +20,6 @@ myst:
|
||||
|
||||
# Packages
|
||||
|
||||
:::{card} {fas}`cube;pst-color-primary` AutoGen Core
|
||||
:class-title: card-title
|
||||
|
||||
Implements the core functionality of the AutoGen framework, providing basic building blocks for creating multi-agent systems.
|
||||
|
||||
```sh
|
||||
pip install autogen-core
|
||||
```
|
||||
|
||||
[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-core/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core/autogen_core.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-core)
|
||||
:::
|
||||
|
||||
:::{card} {fas}`people-group;pst-color-primary` AutoGen AgentChat
|
||||
:class-title: card-title
|
||||
|
||||
@ -44,6 +32,17 @@ pip install autogen-agentchat
|
||||
[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-agentchat/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat/autogen_agentchat.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-agentchat)
|
||||
:::
|
||||
|
||||
:::{card} {fas}`cube;pst-color-primary` AutoGen Core
|
||||
:class-title: card-title
|
||||
|
||||
Implements the core functionality of the AutoGen framework, providing basic building blocks for creating multi-agent systems.
|
||||
|
||||
```sh
|
||||
pip install autogen-core
|
||||
```
|
||||
|
||||
[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-core/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core/autogen_core.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-core)
|
||||
:::
|
||||
|
||||
:::{card} {fas}`puzzle-piece;pst-color-primary` AutoGen Extensions
|
||||
:class-title: card-title
|
||||
|
||||
@ -22,16 +22,16 @@ myst:
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
:caption: AutoGen Core
|
||||
:caption: AutoGen AgentChat
|
||||
|
||||
python/autogen_core/autogen_core
|
||||
python/autogen_agentchat/autogen_agentchat
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:hidden:
|
||||
:caption: AutoGen AgentChat
|
||||
:caption: AutoGen Core
|
||||
|
||||
python/autogen_agentchat/autogen_agentchat
|
||||
python/autogen_core/autogen_core
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
@ -46,14 +46,14 @@ python/autogen_ext/autogen_ext.tools
|
||||
:margin: 4 4 0 0
|
||||
:gutter: 1
|
||||
|
||||
:::{grid-item-card} {fas}`cube;pst-color-primary` <br> AutoGen Core
|
||||
:link: python/autogen_core/autogen_core
|
||||
:::{grid-item-card} {fas}`people-group;pst-color-primary` <br> AutoGen AgentChat
|
||||
:link: python/autogen_agentchat/autogen_agentchat
|
||||
:link-type: doc
|
||||
:class-item: api-card
|
||||
:::
|
||||
|
||||
:::{grid-item-card} {fas}`people-group;pst-color-primary` <br> AutoGen AgentChat
|
||||
:link: python/autogen_agentchat/autogen_agentchat
|
||||
:::{grid-item-card} {fas}`cube;pst-color-primary` <br> AutoGen Core
|
||||
:link: python/autogen_core/autogen_core
|
||||
:link-type: doc
|
||||
:class-item: api-card
|
||||
:::
|
||||
|
||||
@ -1,79 +0,0 @@
|
||||
---
|
||||
myst:
|
||||
html_meta:
|
||||
"description lang=en": |
|
||||
User Guide for AutoGen, a framework for building multi-agent applications with AI agents.
|
||||
---
|
||||
|
||||
# User Guide
|
||||
|
||||
AutoGen is a flexible framework for building multi-agent systems. Begin with the [installation](guides/installation.md) guide to set up the framework on your machine. Then, follow the [quickstart](guides/quickstart) guide to get started with building your first multi-agent application.
|
||||
|
||||
```{danger}
|
||||
This project and documentation is a work in progress. If you have any questions or need help, please reach out to us on GitHub.
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Getting Started
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/installation
|
||||
guides/quickstart
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Core Concepts
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
|
||||
core-concepts/agent-and-multi-agent-application
|
||||
core-concepts/architecture
|
||||
core-concepts/api-layers
|
||||
core-concepts/application-stack
|
||||
core-concepts/agent-identity-and-lifecycle
|
||||
core-concepts/topic-and-subscription
|
||||
core-concepts/faqs
|
||||
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Framework
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/agent-and-agent-runtime
|
||||
guides/message-and-communication
|
||||
guides/model-clients
|
||||
guides/tools
|
||||
guides/logging
|
||||
guides/distributed-agent-runtime
|
||||
guides/telemetry
|
||||
guides/command-line-code-executors
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Multi-Agent Design Patterns
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/multi-agent-design-patterns
|
||||
guides/group-chat
|
||||
guides/reflection
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Cookbook
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
cookbook/azure-openai-with-aad-auth
|
||||
cookbook/termination-with-intervention
|
||||
cookbook/extracting-results-with-an-agent
|
||||
cookbook/openai-assistant-agent
|
||||
cookbook/langgraph-agent
|
||||
cookbook/llamaindex-agent
|
||||
cookbook/local-llms-ollama-litellm
|
||||
|
||||
```
|
||||