Follow up changes from top bar change (#4758)

This commit is contained in:
Jack Gerrits
2024-12-19 12:01:03 -05:00
committed by GitHub
parent 97e5cab523
commit c74c2d6767
17 changed files with 199 additions and 143 deletions

View File

@@ -73,4 +73,15 @@ html[data-theme="light"] .bd-header {
.bd-content .sd-tab-set>label {
background-color: transparent;
border: none;
}
}
.card-title {
font-size: 1.2rem;
font-weight: bold;
}
.card-title svg {
font-size: 2rem;
vertical-align: bottom;
margin-right: 5px;
}

View File

@@ -13,7 +13,26 @@
)
-}}
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_agentchat')}}">API Reference</a></li>
<li class="toctree-l1">
<a class="reference internal" href="{{pathto('reference/python/autogen_agentchat')}}">
<i class="fa-solid fa-file-code"></i>
API Reference
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://pypi.org/project/autogen-agentchat/0.4.0.dev11/">
<i class="fa-brands fa-python"></i>
PyPi
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-agentchat">
<i class="fa-brands fa-github"></i>
Source
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
</ul>
</div>
</nav>
</div>
</nav>

View File

@@ -13,7 +13,26 @@
)
-}}
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_core')}}">API Reference</a></li>
<li class="toctree-l1">
<a class="reference internal" href="{{pathto('reference/python/autogen_core')}}">
<i class="fa-solid fa-file-code"></i>
API Reference
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://pypi.org/project/autogen-core/0.4.0.dev11/">
<i class="fa-brands fa-python"></i>
PyPi
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-core">
<i class="fa-brands fa-github"></i>
Source
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
</ul>
</div>
</nav>

View File

@@ -14,7 +14,26 @@
-}}
<p aria-level="2" class="caption" role="heading"><span class="caption-text">More</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="{{pathto('reference/python/autogen_ext.agents.magentic_one')}}">API Reference</a></li>
<li class="toctree-l1">
<a class="reference internal" href="{{pathto('reference/python/autogen_ext.agents.magentic_one')}}">
<i class="fa-solid fa-file-code"></i>
API Reference
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://pypi.org/project/autogen-ext/0.4.0.dev11/">
<i class="fa-brands fa-python"></i>
PyPi
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-ext">
<i class="fa-brands fa-github"></i>
Source
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
</ul>
</div>
</div>
</nav>

View File

@@ -0,0 +1,32 @@
{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. #}
<nav class="bd-docs-nav bd-links"
aria-label="{{ _('Section Navigation') }}">
<div class="bd-toc-item navbar-nav">
{{- generate_toctree_html(
"sidebar",
show_nav_level=theme_show_nav_level | int,
maxdepth=theme_navigation_depth | int,
collapse=theme_collapse_navigation | tobool,
includehidden=theme_sidebar_includehidden | tobool,
titles_only=True
)
-}}
<ul class="nav bd-sidenav">
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://pypi.org/project/autogenstudio/">
<i class="fa-brands fa-python"></i>
PyPi
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
<li class="toctree-l1">
<a target="_blank" class="reference internal" href="https://github.com/microsoft/autogen/tree/main/python/packages/autogen-studio">
<i class="fa-brands fa-github"></i>
Source
<i class="fa-solid fa-arrow-up-right-from-square fa-2xs"></i>
</a>
</li>
</ul>
</div>
</nav>

View File

@@ -135,6 +135,7 @@ html_sidebars = {
"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 = {

View File

@@ -43,11 +43,13 @@ A framework for building AI agents and multi-agent applications
<div style="margin-top: 2rem;">
::::{grid} 1 1 2 2
::::{grid}
:gutter: 2
:::{grid-item-card}
:shadow: none
:margin: 2 0 0 0
:columns: 12 12 12 12
<div class="sd-card-title sd-font-weight-bold docutils">
@@ -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
```
:::
::::
</div>
@@ -98,9 +143,8 @@ Get Started
:hidden:
user-guide/agentchat-user-guide/index
Studio <user-guide/autogenstudio-user-guide/index>
user-guide/core-user-guide/index
user-guide/extensions-user-guide/index
packages/index
Studio <user-guide/autogenstudio-user-guide/index>
reference/index
```

View File

@@ -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.
---
<style>
.card-title {
font-size: 1.2rem;
font-weight: bold;
}
.card-title svg {
font-size: 2rem;
vertical-align: bottom;
margin-right: 5px;
}
</style>
# 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)
:::

View File

@@ -1,5 +1,5 @@
autogen\_core.tools
==============================
===================
.. automodule:: autogen_core.tools

View File

@@ -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:

View File

@@ -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

View File

@@ -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:

View File

@@ -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.
```

View File

@@ -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",

View File

@@ -11,6 +11,7 @@ myst:
:maxdepth: 3
:hidden:
installation
discover
create-your-own
```

View File

@@ -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`