A programming framework for agentic AI
Update index.md for better clarity and relationship between packages (#4896)
Eric Zhud55b8c9044e3
diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.mdindex 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: trueAutoGen</h1><h3>-A framework for building AI agents and multi-agent applications+A framework for building AI agents and applications</h3></div></div>@@ -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<div class="sd-card-title sd-font-weight-bold docutils">-{fas}`people-group;pst-color-primary`-AgentChat </div>-High-level API that includes preset agents and teams for building multi-agent systems.+{fas}`book;pst-color-primary`+Magentic-One </div>+A multi-agent assistant for web and file-based tasks.+Built on 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.*-+++-<a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="user-guide/agentchat-user-guide/quickstart.html"><span class="doc">Get Started</span></a>-<a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="user-guide/agentchat-user-guide/migration-guide.html"><span class="doc">Migration Guide (0.2.x to 0.4.x)</span></a>+```{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 [](https://pypi.org/project/autogenstudio/):shadow: none:margin: 2 0 0 0-:columns: 12 12 12 12+:columns: 12 12 6 6-<div class="sd-card-title sd-font-weight-bold docutils">+An app for prototyping and managing agents without writing code.+Built on AgentChat.-{fas}`book;pst-color-primary`-Magentic-One </div>-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: secondaryGet Started@@ -92,17 +94,41 @@ 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.+<div class="sd-card-title sd-font-weight-bold docutils">++{fas}`people-group;pst-color-primary` AgentChat+[](https://pypi.org/project/autogen-agentchat/0.4.0.dev13/)++</div>+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/autogenstudio-user-guide/index+```{button-ref} user-guide/agentchat-user-guide/quickstart:color: secondaryGet Started@@ -110,16 +136,18 @@ Get Started:::-:::{grid-item-card} {fas}`cube;pst-color-primary` Core+:::{grid-item-card} {fas}`cube;pst-color-primary` Core [](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.+An event-driven programming framework for building scalable multi-agent AI systems. Example scenarios:-```sh-pip install "autogen-core==0.4.0.dev13"-```+* 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._+++@@ -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 [](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-```+<a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="user-guide/extensions-user-guide/discover.html"><span class="doc">Discover Community Extensions</span></a>+<a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="user-guide/extensions-user-guide/create-your-own.html"><span class="doc">Create New Extension</span></a>:::diff --git a/python/pyproject.toml b/python/pyproject.tomlindex 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/srcgen-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"