diff --git a/python/packages/autogen-core/docs/src/_static/custom.css b/python/packages/autogen-core/docs/src/_static/custom.css index 6023df8b191e..3b32374aa797 100644 --- a/python/packages/autogen-core/docs/src/_static/custom.css +++ b/python/packages/autogen-core/docs/src/_static/custom.css @@ -73,4 +73,15 @@ html[data-theme="light"] .bd-header { .bd-content .sd-tab-set>label { background-color: transparent; border: none; -} \ No newline at end of file +} + +.card-title { + font-size: 1.2rem; + font-weight: bold; +} + +.card-title svg { + font-size: 2rem; + vertical-align: bottom; + margin-right: 5px; +} diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html index 78de010cad48..684eb304ac7f 100644 --- a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html +++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-agentchat.html @@ -13,7 +13,26 @@ ) -}} - - \ No newline at end of file + + diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html index 125146575385..17defa6c773a 100644 --- a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html +++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-core.html @@ -13,7 +13,26 @@ ) -}} \ No newline at end of file diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html index 6128f240480c..6c252fe3fb9f 100644 --- a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html +++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-extensions.html @@ -14,7 +14,26 @@ -}}

More

- + \ No newline at end of file diff --git a/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-studio.html b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-studio.html new file mode 100644 index 000000000000..7408ca37e084 --- /dev/null +++ b/python/packages/autogen-core/docs/src/_templates/sidebar-nav-bs-studio.html @@ -0,0 +1,32 @@ +{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #} + + \ No newline at end of file diff --git a/python/packages/autogen-core/docs/src/conf.py b/python/packages/autogen-core/docs/src/conf.py index 42ef158dd074..dd4eac7744ba 100644 --- a/python/packages/autogen-core/docs/src/conf.py +++ b/python/packages/autogen-core/docs/src/conf.py @@ -135,6 +135,7 @@ "user-guide/core-user-guide/**": ["sidebar-nav-bs-core"], "user-guide/agentchat-user-guide/**": ["sidebar-nav-bs-agentchat"], "user-guide/extensions-user-guide/**": ["sidebar-nav-bs-extensions"], + "user-guide/autogenstudio-user-guide/**": ["sidebar-nav-bs-studio"], } html_context = { diff --git a/python/packages/autogen-core/docs/src/index.md b/python/packages/autogen-core/docs/src/index.md index d11080b6bdc6..cc10e405693b 100644 --- a/python/packages/autogen-core/docs/src/index.md +++ b/python/packages/autogen-core/docs/src/index.md @@ -43,11 +43,13 @@ A framework for building AI agents and multi-agent applications
-::::{grid} 1 1 2 2 +::::{grid} +:gutter: 2 :::{grid-item-card} :shadow: none :margin: 2 0 0 0 +:columns: 12 12 12 12
@@ -70,9 +72,29 @@ Get Started ``` ::: +:::{grid-item-card} {fas}`palette;pst-color-primary` Studio +:shadow: none +:margin: 2 0 0 0 +:columns: 12 12 12 12 + +No-code platform for authoring and interacting with multi-agent teams. + ++++ + +```{button-ref} user-guide/autogenstudio-user-guide/index +:color: secondary + +Get Started +``` + +::: + + :::{grid-item-card} {fas}`cube;pst-color-primary` Core :shadow: none :margin: 2 0 0 0 +:columns: 12 12 6 6 + Provides building blocks for creating asynchronous, event driven multi-agent systems. @@ -89,6 +111,29 @@ Get Started ``` ::: + +:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` Extensions +:shadow: none +:margin: 2 0 0 0 +:columns: 12 12 6 6 + + +Implementations of core components that interface with external services, or use extra dependencies. For example, Docker based code execution. + +```sh +pip install 'autogen-ext==0.4.0.dev11' +``` + ++++ + +```{button-ref} user-guide/extensions-user-guide/index +:color: secondary + +Get Started +``` + +::: + ::::
@@ -98,9 +143,8 @@ Get Started :hidden: user-guide/agentchat-user-guide/index -Studio user-guide/core-user-guide/index user-guide/extensions-user-guide/index -packages/index +Studio reference/index ``` diff --git a/python/packages/autogen-core/docs/src/packages/index.md b/python/packages/autogen-core/docs/src/packages/index.md deleted file mode 100644 index 913ce842e5c8..000000000000 --- a/python/packages/autogen-core/docs/src/packages/index.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -myst: - html_meta: - "description lang=en": | - AutoGen packages provide a set of functionality for building multi-agent applications with AI agents. ---- - - - -# Packages - -## 0.4 - -(pkg-info-autogen-agentchat)= - -:::{card} {fas}`people-group;pst-color-primary` AutoGen AgentChat -:class-title: card-title -:shadow: none - -Library that is at a similar level of abstraction as AutoGen 0.2, including default agents and group chat. - -```sh -pip install 'autogen-agentchat==0.4.0.dev11' -``` - -[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/agentchat-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-agentchat/0.4.0.dev11/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-agentchat) -::: - -(pkg-info-autogen-core)= - -:::{card} {fas}`cube;pst-color-primary` AutoGen Core -:class-title: card-title -:shadow: none - -Implements the core functionality of the AutoGen framework, providing basic building blocks for creating multi-agent systems. - -```sh -pip install 'autogen-core==0.4.0.dev11' -``` - -[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/core-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-core/0.4.0.dev11/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-core) -::: - -(pkg-info-autogen-ext)= - -:::{card} {fas}`puzzle-piece;pst-color-primary` AutoGen Extensions -:class-title: card-title -:shadow: none - -Implementations of core components that interface with external services, or use extra dependencies. For example, Docker based code execution. - -```sh -pip install 'autogen-ext==0.4.0.dev11' -``` - -Extras: - -- `langchain` needed for {py:class}`~autogen_ext.tools.LangChainToolAdapter` -- `azure` needed for {py:class}`~autogen_ext.code_executors.azure.ACADynamicSessionsCodeExecutor` -- `docker` needed for {py:class}`~autogen_ext.code_executors.docker.DockerCommandLineCodeExecutor` -- `openai` needed for {py:class}`~autogen_ext.models.OpenAIChatCompletionClient` - -[{fas}`circle-info;pst-color-primary` User Guide](/user-guide/extensions-user-guide/index.md) | [{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_ext.agents.web_surfer.rst) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-ext/0.4.0.dev11/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-ext) -::: - -(pkg-info-autogen-magentic-one)= - -:::{card} {fas}`users;pst-color-primary` Magentic One -:class-title: card-title -:shadow: none - -A generalist multi-agent softbot utilizing five agents to tackle intricate tasks involving multi-step planning and real-world actions. - -```{note} -Not yet available on PyPI. Please install from source. -``` - -[{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-magentic-one) -::: - -## 0.2 - -(pkg-info-autogen-02)= - -:::{card} {fas}`robot;pst-color-primary` AutoGen -:class-title: card-title -:shadow: none -Existing AutoGen library that provides a high-level abstraction for building multi-agent systems. - -```sh -pip install 'autogen-agentchat~=0.2' -``` - -[{fas}`circle-info;pst-color-primary` Documentation](https://microsoft.github.io/autogen/0.2/) | [{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogen-agentchat/0.2.38/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/0.2/) -::: - -## Other - -(pkg-info-autogenbench)= - -:::{card} {fas}`chart-bar;pst-color-primary` AutoGen Bench -:class-title: card-title -:shadow: none - -AutoGenBench is a tool for repeatedly running pre-defined AutoGen tasks in tightly-controlled initial conditions. - -```sh -pip install autogenbench -``` - -[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogenbench/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/autogen/tree/main/python/packages/agbench) -::: diff --git a/python/packages/autogen-core/docs/src/reference/python/autogen_core.tools.rst b/python/packages/autogen-core/docs/src/reference/python/autogen_core.tools.rst index d4cba212476b..c78d6a750614 100644 --- a/python/packages/autogen-core/docs/src/reference/python/autogen_core.tools.rst +++ b/python/packages/autogen-core/docs/src/reference/python/autogen_core.tools.rst @@ -1,5 +1,5 @@ autogen\_core.tools -============================== +=================== .. automodule:: autogen_core.tools diff --git a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.tools.langchain.rst b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.tools.langchain.rst index 68a3291e6a61..416a3b550e6c 100644 --- a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.tools.langchain.rst +++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.tools.langchain.rst @@ -1,8 +1,8 @@ -autogen\_ext.tools -================== +autogen\_ext.tools.langchain +============================ -.. automodule:: autogen_ext.tools +.. automodule:: autogen_ext.tools.langchain :members: :undoc-members: :show-inheritance: diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md index 391fe8f647a2..d5df491a69a8 100644 --- a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md +++ b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/index.md @@ -16,7 +16,6 @@ programming model provides more flexibility and control over the underlying comp AgentChat provides intuitive defaults, such as **Agents** with preset behaviors and **Teams** with predefined [multi-agent design patterns](../core-user-guide/design-patterns/intro.md). - ::::{grid} 2 2 2 2 :gutter: 3 diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md index ead8623b2d8c..6a2f31211a0b 100644 --- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md +++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/index.md @@ -11,6 +11,7 @@ myst: :maxdepth: 1 :hidden: +installation quickstart ``` @@ -66,10 +67,6 @@ cookbook/index faqs ``` -```{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: diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/installation.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/installation.md new file mode 100644 index 000000000000..ba39aa481da5 --- /dev/null +++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/installation.md @@ -0,0 +1,14 @@ +# Installation + +## Install using pip + +Install the `autogen-core` package using pip: + +```bash + +pip install 'autogen-core==0.4.0.dev11' +``` + +```{note} +Python 3.10 or later is required. +``` diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/quickstart.ipynb b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/quickstart.ipynb index fde686badf75..f193979c856d 100644 --- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/quickstart.ipynb +++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/quickstart.ipynb @@ -7,7 +7,7 @@ "# Quick Start\n", "\n", ":::{note}\n", - "See [here](pkg-info-autogen-core) for installation instructions.\n", + "See [here](installation) for installation instructions.\n", ":::\n", "\n", "Before diving into the core APIs, let's start with a simple example of two agents that count down from 10 to 1.\n", diff --git a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md index 9b5fc111fb4d..a60b9447ad1e 100644 --- a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md +++ b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/index.md @@ -11,6 +11,7 @@ myst: :maxdepth: 3 :hidden: +installation discover create-your-own ``` diff --git a/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/installation.md b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/installation.md new file mode 100644 index 000000000000..f98d4361d918 --- /dev/null +++ b/python/packages/autogen-core/docs/src/user-guide/extensions-user-guide/installation.md @@ -0,0 +1,23 @@ +--- +myst: + html_meta: + "description lang=en": | + User Guide for AutoGen Extensions, a framework for building multi-agent applications with AI agents. +--- + +# Installation + +First-part maintained extensions are available in the `autogen-ext` package. + + +```sh +pip install 'autogen-ext==0.4.0.dev11' +``` + +Extras: + +- `langchain` needed for {py:class}`~autogen_ext.tools.langchain.LangChainToolAdapter` +- `azure` needed for {py:class}`~autogen_ext.code_executors.azure.ACADynamicSessionsCodeExecutor` +- `docker` needed for {py:class}`~autogen_ext.code_executors.docker.DockerCommandLineCodeExecutor` +- `openai` needed for {py:class}`~autogen_ext.models.openai.OpenAIChatCompletionClient` + diff --git a/python/packages/autogen-ext/src/autogen_ext/tools/__init__.py b/python/packages/autogen-ext/src/autogen_ext/tools/__init__.py new file mode 100644 index 000000000000..e69de29bb2d1