From d55b8c9044e334c853bb6ee400c2c8209c2748b0 Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Mon, 6 Jan 2025 14:13:22 -0800 Subject: [PATCH] Update index.md for better clarity and relationship between packages (#4896) * Improve index page for better clarity * Add markdown lint check * Update info * Update * typo * tagline * tag line update --- .../packages/autogen-core/docs/src/index.md | 123 +++++++++++------- python/pyproject.toml | 2 +- 2 files changed, 76 insertions(+), 49 deletions(-) diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index 1e0c5332a..e729679e0 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

@@ -49,41 +49,21 @@ 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 - -
- -{fas}`people-group;pst-color-primary` -AgentChat
-High-level API that includes preset agents and teams for building multi-agent systems. - -```sh -pip install "autogen-agentchat==0.4.0.dev13" -``` - -💡 *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) - -::: - -:::{grid-item-card} -:shadow: none -:margin: 2 0 0 0 -:columns: 12 12 12 12 +:columns: 12 12 6 6
{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. +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" +``` +++ - ```{button-ref} user-guide/agentchat-user-guide/magentic-one :color: secondary @@ -92,13 +72,17 @@ Get Started ::: - -:::{grid-item-card} {fas}`palette;pst-color-primary` Studio +:::{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 -No-code platform for authoring and interacting with multi-agent teams. +An app for prototyping and managing agents without writing code. +Built on AgentChat. + +```bash +% autogenstudio ui --port 8080 +``` +++ @@ -110,17 +94,61 @@ Get Started ::: -:::{grid-item-card} {fas}`cube;pst-color-primary` Core +:::{grid-item-card} :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. +
-```sh -pip install "autogen-core==0.4.0.dev13" +{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/) + +
+A programming framework for building conversational single and multi-agent applications. +Built on Core. + +```python +# 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 +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()) ``` +_Start here if you are building conversational agents. [Migrating from AutoGen 0.2?](./user-guide/agentchat-user-guide/migration-guide.md)._ + ++++ + +```{button-ref} user-guide/agentchat-user-guide/quickstart +:color: secondary + +Get Started +``` + +::: + +:::{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 12 12 + +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. +* 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 @@ -131,24 +159,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 ::: diff --git a/python/pyproject.toml b/python/pyproject.toml index fb58777f4..59c3e523f 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"