From 0c68f3488323df099f2576596cc6c1e4ddf2dd64 Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Sun, 5 Jan 2025 00:43:24 -0800 Subject: [PATCH 1/7] Improve index page for better clarity --- .../packages/autogen-core/docs/src/index.md | 95 +++++++++++-------- 1 file changed, 56 insertions(+), 39 deletions(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index 1e0c5332afe5..c4641507ab7d 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -49,42 +49,44 @@ A framework for building AI agents and multi-agent applications :::{grid-item-card} :shadow: none :margin: 2 0 0 0 -:columns: 12 12 12 12 +:columns: 12 12 6 6
-{fas}`people-group;pst-color-primary` -AgentChat
-High-level API that includes preset agents and teams for building multi-agent systems. +{fas}`book;pst-color-primary` +Magentic-One +A multi-agent team for web and file-based tasks. +Built on top of AgentChat. -```sh -pip install "autogen-agentchat==0.4.0.dev13" +```bash +% m1 "Find flights from Seattle to Paris and format the result in a table" ``` -💡 *Start here if you are looking for an API similar to AutoGen 0.2.* - +++ -Get Started -Migration Guide (0.2.x to 0.4.x) +```{button-ref} user-guide/agentchat-user-guide/magentic-one +:color: secondary + +Get Started +``` ::: -:::{grid-item-card} +:::{grid-item-card} {fas}`palette;pst-color-primary` Studio [![PyPi autogenstudio](https://img.shields.io/badge/PyPi-autogen--studio-blue?logo=pypi)](https://pypi.org/project/autogenstudio/) :shadow: none :margin: 2 0 0 0 -:columns: 12 12 12 12 +:columns: 12 12 6 6 -
+Prototyping, testing and managing multi-agent teams without writing code. +Built on top of AgentChat. -{fas}`book;pst-color-primary` -Magentic-One
-Magentic-One is a generalist multi-agent system for solving open-ended web and file-based tasks across a variety of domains. +```bash +% autogenstudio ui --port 8080 +``` +++ - -```{button-ref} user-guide/agentchat-user-guide/magentic-one +```{button-ref} user-guide/autogenstudio-user-guide/index :color: secondary Get Started @@ -92,17 +94,32 @@ Get Started ::: - -:::{grid-item-card} {fas}`palette;pst-color-primary` Studio +:::{grid-item-card} :shadow: none :margin: 2 0 0 0 :columns: 12 12 12 12 -No-code platform for authoring and interacting with multi-agent teams. +
+ +{fas}`people-group;pst-color-primary` AgentChat +[![PyPi autogen-agentchat](https://img.shields.io/badge/PyPi-autogen--agentchat-blue?logo=pypi)](https://pypi.org/project/autogen-agentchat/0.4.0.dev13/) + +
+Preset agents and teams for building conversational single and multi-agent applications. +Built on top of Core. + +```python +from autogen_agentchat import AssistantAgent +from autogen_ext.models.openai import OpenAIChatCompletionClient + +agent = AssistantAgent("assistant", OpenAIChatCompletionClient(model="gpt-4o")) +``` + +_Migrating from AutoGen 0.2? Read the [guide](./user-guide/agentchat-user-guide/migration-guide.md)._ +++ -```{button-ref} user-guide/autogenstudio-user-guide/index +```{button-ref} user-guide/agentchat-user-guide/quickstart :color: secondary Get Started @@ -110,16 +127,17 @@ Get Started ::: -:::{grid-item-card} {fas}`cube;pst-color-primary` Core +:::{grid-item-card} {fas}`cube;pst-color-primary` Core [![PyPi autogen-core](https://img.shields.io/badge/PyPi-autogen--core-blue?logo=pypi)](https://pypi.org/project/autogen-core/0.4.0.dev13/) :shadow: none :margin: 2 0 0 0 -:columns: 12 12 6 6 +:columns: 12 12 12 12 -Provides building blocks for creating asynchronous, event driven multi-agent systems. +Foundational building blocks for asynchronous and event driven multi-agent systems. Examples scenarios: -```sh -pip install "autogen-core==0.4.0.dev13" -``` +* Deterministic and dynamic agentic workflows for business processes. +* Research on multi-agent collaboration. +* Parallel training data generation for agentic models. +* Distributed agents for multi-language applications. +++ @@ -131,24 +149,23 @@ Get Started ::: -:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` Extensions +:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` Extensions [![PyPi autogen-ext](https://img.shields.io/badge/PyPi-autogen--ext-blue?logo=pypi)](https://pypi.org/project/autogen-ext/0.4.0.dev13/) :shadow: none :margin: 2 0 0 0 -:columns: 12 12 6 6 +:columns: 12 12 12 12 -Implementations of core components that interface with external services, or use extra dependencies. For example, Docker based code execution. +Implementations of Core and AgentChat components that interface with external services or other libraries. +You can find and use community extensions or create your own. Examples of built-in extensions: -```sh -pip install "autogen-ext==0.4.0.dev13" -``` +* {py:class}`~autogen_ext.tools.langchain.LangChainToolAdapter` for using LangChain tools. +* {py:class}`~autogen_ext.agents.openai.OpenAIAssistantAgent` for using Assistant API. +* {py:class}`~autogen_ext.code_executors.docker.DockerCommandLineCodeExecutor` for running model-generated code in a Docker container. +* {py:class}`~autogen_ext.runtimes.grpc.GrpcWorkerAgentRuntime` for distributed agents. +++ -```{button-ref} user-guide/extensions-user-guide/index -:color: secondary - -Get Started -``` +Discover Community Extensions +Create New Extension ::: From fbbafa66a3e267b22006487e12a83255896fc85a Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Sun, 5 Jan 2025 00:44:15 -0800 Subject: [PATCH 2/7] Add markdown lint check --- python/pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/pyproject.toml b/python/pyproject.toml index fb58777f40a6..59c3e523f16d 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -89,7 +89,7 @@ gen-proto = "python -m grpc_tools.protoc --python_out=./packages/autogen-ext/src gen-proto-samples = "python -m grpc_tools.protoc --python_out=./packages/autogen-core/samples/protos --grpc_python_out=./packages/autogen-core/samples/protos --mypy_out=./packages/autogen-core/samples/protos --mypy_grpc_out=./packages/autogen-core/samples/protos --proto_path ../protos/ agent_events.proto" -markdown-code-lint = "python check_md_code_blocks.py ../README.md ./packages/autogen-core/docs/src/user-guide/agentchat-user-guide/*.md" +markdown-code-lint = "python check_md_code_blocks.py ../README.md ./packages/autogen-core/docs/src/user-guide/agentchat-user-guide/*.md ./packages/autogen-core/docs/src/index.md" [[tool.poe.tasks.gen-test-proto.sequence]] cmd = "python -m grpc_tools.protoc --python_out=./packages/autogen-core/tests/protos --grpc_python_out=./packages/autogen-core/tests/protos --mypy_out=./packages/autogen-core/tests/protos --mypy_grpc_out=./packages/autogen-core/tests/protos --proto_path ./packages/autogen-core/tests/protos serialization_test.proto" From 2530493bae98265bacc9dd9350bc796b45391236 Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Sun, 5 Jan 2025 21:56:53 -0800 Subject: [PATCH 3/7] Update info --- .../packages/autogen-core/docs/src/index.md | 32 ++++++++++++------- 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index c4641507ab7d..34a974f99ac8 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -35,7 +35,7 @@ sd_hide_title: true AutoGen

-A framework for building AI agents and multi-agent applications +For AI agents and multi-agent applications

@@ -55,8 +55,8 @@ A framework for building AI agents and multi-agent applications {fas}`book;pst-color-primary` Magentic-One -A multi-agent team for web and file-based tasks. -Built on top of AgentChat. +A multi-agent assistant for web and file-based tasks. +Built on AgentChat. ```bash % m1 "Find flights from Seattle to Paris and format the result in a table" @@ -77,8 +77,8 @@ Get Started :margin: 2 0 0 0 :columns: 12 12 6 6 -Prototyping, testing and managing multi-agent teams without writing code. -Built on top of AgentChat. +An app for prototyping and managing agents without writing code. +Built on AgentChat. ```bash % autogenstudio ui --port 8080 @@ -105,14 +105,23 @@ Get Started [![PyPi autogen-agentchat](https://img.shields.io/badge/PyPi-autogen--agentchat-blue?logo=pypi)](https://pypi.org/project/autogen-agentchat/0.4.0.dev13/) -Preset agents and teams for building conversational single and multi-agent applications. -Built on top of Core. +A programming framework for building conversational single and multi-agent applications. +Built on Core. ```python -from autogen_agentchat import AssistantAgent +# pip install "autogen-agentchat==0.4.0.dev13" "autogen-ext[openai]==0.4.0.dev13" "yfinance" "matplotlib" +import asyncio +from autogen_agentchat.agents import AssistantAgent +from autogen_agentchat.ui import Console from autogen_ext.models.openai import OpenAIChatCompletionClient - -agent = AssistantAgent("assistant", OpenAIChatCompletionClient(model="gpt-4o")) +from autogen_ext.code_executors.local import LocalCommandLineCodeExecutor +from autogen_ext.tools.code_execution import PythonCodeExecutionTool + +async def main() -> None: + tool = PythonCodeExecutionTool(LocalCommandLineCodeExecutor(work_dir="coding")) + agent = AssistantAgent("assistant", OpenAIChatCompletionClient(model="gpt-4o"), tools=[tool], reflect_on_tool_use=True) + await Console(agent.run_stream(task="Create a plot of MSFT stock prices in 2024 and save it to a file. Use yfinance and matplotlib.")) +asyncio.run(main()) ``` _Migrating from AutoGen 0.2? Read the [guide](./user-guide/agentchat-user-guide/migration-guide.md)._ @@ -132,11 +141,10 @@ Get Started :margin: 2 0 0 0 :columns: 12 12 12 12 -Foundational building blocks for asynchronous and event driven multi-agent systems. Examples scenarios: +An event-driven programming framework for building scalable multi-agent AI systems. Examples scenarios: * Deterministic and dynamic agentic workflows for business processes. * Research on multi-agent collaboration. -* Parallel training data generation for agentic models. * Distributed agents for multi-language applications. +++ From 93ae04471b7ba1dda19801f18da700ccd8138f71 Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Sun, 5 Jan 2025 22:15:14 -0800 Subject: [PATCH 4/7] Update --- python/packages/autogen-core/docs/src/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index 34a974f99ac8..2836aafd03da 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -124,7 +124,7 @@ async def main() -> None: asyncio.run(main()) ``` -_Migrating from AutoGen 0.2? Read the [guide](./user-guide/agentchat-user-guide/migration-guide.md)._ +_Start here if you are building conversational agents. [Migrating from AutoGen 0.2?](./user-guide/agentchat-user-guide/migration-guide.md)._ +++ @@ -147,6 +147,8 @@ An event-driven programming framework for building scalable multi-agent AI syste * Research on multi-agent collaboration. * Distributed agents for multi-language applications. +_Start here if you are building workflows or distributed agent systems._ + +++ ```{button-ref} user-guide/core-user-guide/quickstart From abd9f90dd7c29f8b4ffc7043ccbbe032f09b4c5c Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Sun, 5 Jan 2025 22:22:15 -0800 Subject: [PATCH 5/7] typo --- python/packages/autogen-core/docs/src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index 2836aafd03da..499b0df3d10d 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -141,7 +141,7 @@ Get Started :margin: 2 0 0 0 :columns: 12 12 12 12 -An event-driven programming framework for building scalable multi-agent AI systems. Examples scenarios: +An event-driven programming framework for building scalable multi-agent AI systems. Example scenarios: * Deterministic and dynamic agentic workflows for business processes. * Research on multi-agent collaboration. From 92f9452310177c9c3a8729d5ee2233aeeaea5244 Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Mon, 6 Jan 2025 13:55:14 -0800 Subject: [PATCH 6/7] tagline --- python/packages/autogen-core/docs/src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index 499b0df3d10d..382e65a7325b 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -35,7 +35,7 @@ sd_hide_title: true AutoGen

-For AI agents and multi-agent applications +A framework for building AI agents and multi-agent applications

From b79221070d3d44ca88f32971625d697dfe4c55ca Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Mon, 6 Jan 2025 13:56:44 -0800 Subject: [PATCH 7/7] tag line update --- python/packages/autogen-core/docs/src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index 382e65a7325b..e729679e055c 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -35,7 +35,7 @@ sd_hide_title: true AutoGen

-A framework for building AI agents and multi-agent applications +A framework for building AI agents and applications