mirror of
https://github.com/microsoft/autogen.git
synced 2026-04-20 03:02:16 -04:00
Website design tweaks (#3699)
* Style updates for website * tab styling
This commit is contained in:
Jack Gerrits
@@ -1,3 +1,76 @@
|
||||
.bd-links__title {
|
||||
display: none;
|
||||
.bd-footer {
|
||||
font-size: 0.8rem;
|
||||
}
|
||||
|
||||
html[data-theme="light"] {
|
||||
--pst-color-primary: hsl(222.2 47.4% 11.2%);
|
||||
--pst-color-secondary: #007bff;
|
||||
--pst-color-secondary-bg: #007bff;
|
||||
--pst-color-accent: #007bff;
|
||||
--sd-color-secondary-highlight: #0062cc;
|
||||
--pst-color-shadow: rgba(0, 0, 0, 0.0);
|
||||
}
|
||||
|
||||
html[data-theme="dark"] {
|
||||
--pst-color-primary: hsl(213 31% 91%);
|
||||
--pst-color-secondary: #007bff;
|
||||
--pst-color-secondary-bg: #007bff;
|
||||
--pst-color-accent: #007bff;
|
||||
--sd-color-secondary-highlight: #0062cc;
|
||||
--pst-color-shadow: rgba(0, 0, 0, 0.0);
|
||||
}
|
||||
|
||||
.bd-header-announcement {
|
||||
color: white;
|
||||
}
|
||||
|
||||
.bd-header-announcement a {
|
||||
color: white;
|
||||
}
|
||||
|
||||
.bd-header-announcement a:hover {
|
||||
color: white;
|
||||
text-shadow: 0.5px 0 0 currentColor;
|
||||
}
|
||||
|
||||
nav.bd-links .current>a {
|
||||
box-shadow: inset 1px 0 0 var(--pst-color-primary);
|
||||
}
|
||||
|
||||
html[data-theme="light"] .bd-header {
|
||||
border-bottom: 1px solid var(--pst-color-border);
|
||||
}
|
||||
|
||||
.admonition, div.admonition {
|
||||
border: 1px solid var(--pst-color-border);
|
||||
}
|
||||
|
||||
.api-card {
|
||||
text-align: center;
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
.api-card svg {
|
||||
font-size: 2rem;
|
||||
}
|
||||
|
||||
.search-button-field {
|
||||
border-radius: var(--bs-btn-border-radius);
|
||||
}
|
||||
|
||||
.bd-content .sd-tab-set .sd-tab-content {
|
||||
border: none;
|
||||
border-top: 3px solid var(--pst-color-border);
|
||||
|
||||
}
|
||||
.bd-content .sd-tab-set>input:checked+label {
|
||||
border: none;
|
||||
transform: translateY(0);
|
||||
font-weight: 600;
|
||||
border-bottom: 2px solid var(--pst-color-secondary);
|
||||
|
||||
}
|
||||
.bd-content .sd-tab-set>label {
|
||||
background-color: transparent;
|
||||
border: none;
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:b4a649cf9cca62edf0f4f6e4acf76981fb9b27399b4d598b22b189c92424f4ea
|
||||
size 434
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:a272fc4c4a508fd936c130a727728da6c773de710a5ae600d06fac06329e0f6d
|
||||
size 998
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:c1f90048923bdaa4e2eeb6ab70f3cc059dc706d43e7208f336102702fc231b81
|
||||
size 45618
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
@@ -0,0 +1,4 @@
|
||||
<svg width="96" height="85" viewBox="0 0 96 85" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<rect width="96" height="85" rx="6" fill="#2D2D2F"/>
|
||||
<path d="M32.6484 28.7109L23.3672 57H15.8906L28.5703 22.875H33.3281L32.6484 28.7109ZM40.3594 57L31.0547 28.7109L30.3047 22.875H35.1094L47.8594 57H40.3594ZM39.9375 44.2969V49.8047H21.9141V44.2969H39.9375ZM77.6484 39.1641V52.6875C77.1172 53.3281 76.2969 54.0234 75.1875 54.7734C74.0781 55.5078 72.6484 56.1406 70.8984 56.6719C69.1484 57.2031 67.0312 57.4688 64.5469 57.4688C62.3438 57.4688 60.3359 57.1094 58.5234 56.3906C56.7109 55.6562 55.1484 54.5859 53.8359 53.1797C52.5391 51.7734 51.5391 50.0547 50.8359 48.0234C50.1328 45.9766 49.7812 43.6406 49.7812 41.0156V38.8828C49.7812 36.2578 50.1172 33.9219 50.7891 31.875C51.4766 29.8281 52.4531 28.1016 53.7188 26.6953C54.9844 25.2891 56.4922 24.2188 58.2422 23.4844C59.9922 22.75 61.9375 22.3828 64.0781 22.3828C67.0469 22.3828 69.4844 22.8672 71.3906 23.8359C73.2969 24.7891 74.75 26.1172 75.75 27.8203C76.7656 29.5078 77.3906 31.4453 77.625 33.6328H70.8047C70.6328 32.4766 70.3047 31.4688 69.8203 30.6094C69.3359 29.75 68.6406 29.0781 67.7344 28.5938C66.8438 28.1094 65.6875 27.8672 64.2656 27.8672C63.0938 27.8672 62.0469 28.1094 61.125 28.5938C60.2188 29.0625 59.4531 29.7578 58.8281 30.6797C58.2031 31.6016 57.7266 32.7422 57.3984 34.1016C57.0703 35.4609 56.9062 37.0391 56.9062 38.8359V41.0156C56.9062 42.7969 57.0781 44.375 57.4219 45.75C57.7656 47.1094 58.2734 48.2578 58.9453 49.1953C59.6328 50.1172 60.4766 50.8125 61.4766 51.2812C62.4766 51.75 63.6406 51.9844 64.9688 51.9844C66.0781 51.9844 67 51.8906 67.7344 51.7031C68.4844 51.5156 69.0859 51.2891 69.5391 51.0234C70.0078 50.7422 70.3672 50.4766 70.6172 50.2266V44.1797H64.1953V39.1641H77.6484Z" fill="white"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.7 KiB |
@@ -2,10 +2,10 @@
|
||||
{
|
||||
"name": "v0.2 (stable)",
|
||||
"version": "0.2",
|
||||
"url": "https://microsoft.github.io/autogen/en/0.2/"
|
||||
"url": "https://microsoft.github.io/autogen/0.2/"
|
||||
},
|
||||
{
|
||||
"version": "dev",
|
||||
"url": "https://microsoft.github.io/autogen/en/dev/"
|
||||
"url": "https://microsoft.github.io/autogen/dev/"
|
||||
}
|
||||
]
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
<p><a href="https://go.microsoft.com/fwlink/?LinkId=521839">Privacy Policy</a> | <a href="https://go.microsoft.com/fwlink/?linkid=2259814">Consumer Health Privacy</a> </p>
|
||||
@@ -1,27 +0,0 @@
|
||||
{% extends "!layout.html" %}
|
||||
|
||||
{% block footer %}
|
||||
<footer class="bd-footer">
|
||||
<div class="container">
|
||||
<div class="row">
|
||||
<div class="col-12 col-md-4 mb-4 mb-md-0">
|
||||
<h6>About</h5>
|
||||
<p>© 2024 Microsoft.</p>
|
||||
</div>
|
||||
<div class="col-6 col-md-4 mb-4 mb-md-0">
|
||||
<h6>Links</h5>
|
||||
<ul class="list-unstyled">
|
||||
<li><a href="https://go.microsoft.com/fwlink/?LinkId=521839">Privacy Policy</a> | <a href="https://go.microsoft.com/fwlink/?linkid=2259814">Consumer Health Privacy</a> </li>
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
<div class="col-6 col-md-4">
|
||||
<h6>
|
||||
{% trans theme_version=theme_version|e %}Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> {{ theme_version }}.{% endtrans %}
|
||||
</h6>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
{% endblock %}
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
{# 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
|
||||
)
|
||||
-}}
|
||||
</div>
|
||||
</nav>
|
||||
@@ -0,0 +1,7 @@
|
||||
{# Displays an icon to switch between light mode, dark mode, and auto (use browser's setting). #}
|
||||
{# As the theme switcher will only work when JavaScript is enabled, we hide it with `pst-js-only`. #}
|
||||
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="{{ _('Color mode') }}" data-bs-title="{{ _('Color mode') }}" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
||||
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="{{ _('Light') }}"></i>
|
||||
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="{{ _('Dark') }}"></i>
|
||||
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="{{ _('System Settings') }}"></i>
|
||||
</button>
|
||||
@@ -71,6 +71,9 @@ html_static_path = ["_static"]
|
||||
html_css_files = ["custom.css"]
|
||||
html_sidebars = {'packages/index': []}
|
||||
|
||||
html_logo = "_static/images/logo/logo.svg"
|
||||
html_favicon = "_static/images/logo/favicon-512x512.png"
|
||||
|
||||
html_theme_options = {
|
||||
|
||||
"header_links_before_dropdown": 4,
|
||||
@@ -81,7 +84,6 @@ html_theme_options = {
|
||||
# "json_url": "/_static/switcher.json",
|
||||
# },
|
||||
"show_prev_next": False,
|
||||
""
|
||||
"icon_links": [
|
||||
{
|
||||
"name": "Twitter",
|
||||
@@ -90,7 +92,7 @@ html_theme_options = {
|
||||
},
|
||||
{
|
||||
"name": "GitHub",
|
||||
"url": "https://github.com/microsoft/agnext",
|
||||
"url": "https://github.com/microsoft/autogen",
|
||||
"icon": "fa-brands fa-github",
|
||||
},
|
||||
{
|
||||
@@ -99,19 +101,24 @@ html_theme_options = {
|
||||
"icon": "fa-custom fa-pypi",
|
||||
},
|
||||
],
|
||||
"announcement": '🚧 AutoGen 0.4 is a work in progress, learn more about what\'s new and different <a href="#">here</a>. To continue using the latest stable version, please visit the <a href="/autogen/0.2/">0.2 documentation</a>. 🚧',
|
||||
|
||||
"announcement": 'AutoGen 0.4 is a work in progress. Go <a href="/autogen/0.2/">here</a> to find the 0.2 documentation.',
|
||||
"footer_start": ["copyright"],
|
||||
"footer_center": ["footer-middle-links"],
|
||||
"footer_end": ["theme-version"],
|
||||
"pygments_light_style": "xcode",
|
||||
"pygments_dark_style": "monokai"
|
||||
}
|
||||
|
||||
html_js_files = ["custom-icon.js"]
|
||||
html_sidebars = {
|
||||
"reference/index": [],
|
||||
"packages/index": [],
|
||||
}
|
||||
|
||||
html_context = {
|
||||
'display_github': True,
|
||||
"github_user": "microsoft",
|
||||
"github_repo": "agnext",
|
||||
"github_repo": "autogen",
|
||||
"github_version": "main",
|
||||
"doc_path": "python/packages/autogen-core/docs/src/",
|
||||
}
|
||||
@@ -121,8 +128,6 @@ autodoc_default_options = {
|
||||
"undoc-members": True,
|
||||
}
|
||||
|
||||
|
||||
|
||||
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
|
||||
|
||||
|
||||
|
||||
@@ -18,105 +18,72 @@ sd_hide_title: true
|
||||
# AutoGen
|
||||
|
||||
<div class="container">
|
||||
|
||||
<div class="row text-center">
|
||||
<div class="col-sm-12">
|
||||
<h1 class="hero-title">
|
||||
AutoGen
|
||||
</h1>
|
||||
<h3>
|
||||
A framework for developing applications using AI agents
|
||||
A framework for building AI agents and multi-agent applications
|
||||
</h3>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style="margin-top: 2rem;">
|
||||
|
||||
|
||||
<div class="row">
|
||||
::::{grid} 1 1 2 2
|
||||
|
||||
<div class="col-sm">
|
||||
<h2 class="text-center">
|
||||
:::{grid-item-card} {fas}`people-group;pst-color-primary` AgentChat
|
||||
:shadow: none
|
||||
:margin: 2 0 0 0
|
||||
|
||||
{fas}`people-group;pst-color-primary` AgentChat
|
||||
|
||||
</h2>
|
||||
|
||||
<p>
|
||||
Task driven, high level APIs for building multi-agent systems. Including group chat, pre-built agents, and more.
|
||||
|
||||
Built with <i>core</i>.
|
||||
<p>
|
||||
High-level API that includes preset agents and teams for building multi-agent systems.
|
||||
|
||||
```sh
|
||||
pip install autogen-agentchat==0.4.0dev0
|
||||
```
|
||||
|
||||
<button onclick="location.href='agentchat-user-guide/guides/quickstart.html'" type="button" class="btn btn-primary">Get Started</button>
|
||||
<button onclick="location.href='reference/python/autogen_agentchat/autogen_agentchat.html'" type="button" class="btn btn-outline-secondary">API Reference</button>
|
||||
💡 *Start here if you are looking for an API similar to AutoGen 0.2*
|
||||
|
||||
<div class="versionadded">
|
||||
<p>Start here if you are looking for an API similar to AutoGen 0.2</p>
|
||||
</div>
|
||||
+++
|
||||
|
||||
</div>
|
||||
<div class="col-sm">
|
||||
<h2 class="text-center">
|
||||
```{button-ref} user-guide/agentchat-user-guide/quickstart
|
||||
:color: secondary
|
||||
|
||||
{fas}`cube;pst-color-primary` Core
|
||||
Get Started
|
||||
```
|
||||
|
||||
</h2>
|
||||
:::
|
||||
:::{grid-item-card} {fas}`cube;pst-color-primary` Core
|
||||
:shadow: none
|
||||
:margin: 2 0 0 0
|
||||
|
||||
<p>
|
||||
Primitive building blocks for creating asynchronous, event driven multi-agent systems.
|
||||
<p>
|
||||
Provides building blocks for creating asynchronous, event driven multi-agent systems.
|
||||
|
||||
```sh
|
||||
pip install autogen-core==0.4.0dev0
|
||||
```
|
||||
|
||||
<button onclick="location.href='core-user-guide/guides/quickstart.html'" type="button" class="btn btn-primary">Get Started</button>
|
||||
<button onclick="location.href='reference/python/autogen_core/autogen_core.html'" type="button" class="btn btn-outline-secondary">API Reference</button>
|
||||
+++
|
||||
|
||||
</div>
|
||||
```{button-ref} user-guide/core-user-guide/quickstart
|
||||
:color: secondary
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!--
|
||||
Key features of AutoGen include:
|
||||
|
||||
- Asynchronous messaging: Agents communicate with each other through asynchronous messages, enabling event-driven and request/response communication models.
|
||||
- Scalable & Distributed: Enable complex scenarios with networks of agents across org boundaries
|
||||
- Modular, extensible & highly customizable: E.g. custom agents, memory as a service, tools registry, model library
|
||||
- x-lang support: Python & Dotnet interoperating agents today, others coming soon
|
||||
- Observable, traceable & debuggable -->
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
agentchat-user-guide/index
|
||||
core-user-guide/index
|
||||
Get Started
|
||||
```
|
||||
|
||||
<!-- ## Community
|
||||
:::
|
||||
::::
|
||||
|
||||
Information about the community that leads, supports, and develops AutoGen.
|
||||
</div>
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
|
||||
community/index
|
||||
``` -->
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
:maxdepth: 3
|
||||
:hidden:
|
||||
|
||||
user-guide/index
|
||||
packages/index
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
reference/index
|
||||
```
|
||||
|
||||
|
||||
@@ -24,6 +24,7 @@ myst:
|
||||
|
||||
:::{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.
|
||||
|
||||
@@ -31,9 +32,6 @@ Library that is at a similar level of abstraction as AutoGen 0.2, including defa
|
||||
pip install autogen-agentchat==0.4.0dev0
|
||||
```
|
||||
|
||||
```{note}
|
||||
This package is a work in progress, it will be available on PyPI when it is ready.
|
||||
```
|
||||
|
||||
[{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_agentchat/autogen_agentchat.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-agentchat)
|
||||
:::
|
||||
@@ -42,6 +40,7 @@ This package is a work in progress, it will be available on PyPI when it is read
|
||||
|
||||
:::{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.
|
||||
|
||||
@@ -49,9 +48,6 @@ Implements the core functionality of the AutoGen framework, providing basic buil
|
||||
pip install autogen-core==0.4.0dev0
|
||||
```
|
||||
|
||||
```{note}
|
||||
This package is a work in progress, it will be available on PyPI when it is ready.
|
||||
```
|
||||
[{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_core/autogen_core.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-core)
|
||||
:::
|
||||
|
||||
@@ -59,6 +55,7 @@ This package is a work in progress, it will be available on PyPI when it is read
|
||||
|
||||
:::{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.
|
||||
|
||||
@@ -66,35 +63,29 @@ Implementations of core components that interface with external services, or use
|
||||
pip install autogen-ext==0.4.0dev0
|
||||
```
|
||||
|
||||
```{note}
|
||||
This package is a work in progress, it will be available on PyPI when it is ready.
|
||||
```
|
||||
|
||||
[{fas}`file-code;pst-color-primary` API Reference](/reference/python/autogen_ext/autogen_ext.rst) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-ext)
|
||||
:::
|
||||
|
||||
(pkg-info-autogen-team-one)=
|
||||
(pkg-info-autogen-magentic-one)=
|
||||
|
||||
:::{card} {fas}`users;pst-color-primary` Team 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.
|
||||
|
||||
```sh
|
||||
pip install autogen-team-one==0.1.0dev0
|
||||
pip install autogen-magentic-one==0.1.0dev0
|
||||
```
|
||||
|
||||
```{note}
|
||||
This package is a work in progress, it will be available on PyPI when it is ready.
|
||||
```
|
||||
|
||||
[{fas}`file-code;pst-color-primary` API Reference](/reference/index.md) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/team-one)
|
||||
[{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/autogen-magentic-one)
|
||||
:::
|
||||
|
||||
(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.
|
||||
|
||||
@@ -102,5 +93,5 @@ AutoGenBench is a tool for repeatedly running pre-defined AutoGen tasks in tight
|
||||
pip install autogenbench
|
||||
```
|
||||
|
||||
[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogenbench/) | [{fas}`file-code;pst-color-primary` API Reference](/reference/index.md) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/agbench)
|
||||
[{fab}`python;pst-color-primary` PyPI](https://pypi.org/project/autogenbench/) | [{fab}`github;pst-color-primary` Source](https://github.com/microsoft/agnext/tree/main/python/packages/agbench)
|
||||
:::
|
||||
|
||||
@@ -5,19 +5,6 @@ myst:
|
||||
AutoGen is a community-driven project. Learn how to get involved, contribute, and connect with the community.
|
||||
---
|
||||
|
||||
<style>
|
||||
.api-card {
|
||||
text-align: center;
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
.api-card svg {
|
||||
font-size: 2rem;
|
||||
}
|
||||
|
||||
|
||||
</style>
|
||||
|
||||
# API Reference
|
||||
|
||||
```{toctree}
|
||||
|
||||
@@ -12,7 +12,7 @@ A list of examples to help you get started with AgentChat.
|
||||
:::::{grid} 2 2 2 3
|
||||
|
||||
::::{grid-item-card} Travel Planning
|
||||
:img-top: ../../images/code.svg
|
||||
:img-top: ../../../images/code.svg
|
||||
:img-alt: travel planning example
|
||||
:link: ./travel-planning.html
|
||||
|
||||
@@ -22,7 +22,7 @@ Generating a travel plan using multiple agents.
|
||||
::::
|
||||
|
||||
::::{grid-item-card} Company Research
|
||||
:img-top: ../../images/code.svg
|
||||
:img-top: ../../../images/code.svg
|
||||
:img-alt: company research example
|
||||
:link: ./company-research.html
|
||||
|
||||
@@ -32,7 +32,7 @@ Generating a company research report using multiple agents with tools.
|
||||
::::
|
||||
|
||||
::::{grid-item-card} Literature Review
|
||||
:img-top: ../../images/code.svg
|
||||
:img-top: ../../../images/code.svg
|
||||
:img-alt: literature review example
|
||||
:link: ./literature-review.html
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
myst:
|
||||
html_meta:
|
||||
"description lang=en": |
|
||||
User Guide for AutoGen AgentChat, a framework for building multi-agent applications with AI agents.
|
||||
---
|
||||
|
||||
# Guides
|
||||
|
||||
```{warning}
|
||||
🚧 Under construction 🚧
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
tool_use
|
||||
code-execution
|
||||
selector-group-chat
|
||||
```
|
||||
|
||||
@@ -32,29 +32,10 @@ Teams define how groups of agents communicate to address tasks. The following Te
|
||||
- `SelectorGroupChat` - A team where a model is used to select the next agent to send a message based on the current conversation history.
|
||||
|
||||
```{toctree}
|
||||
:caption: Getting Started
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
quickstart
|
||||
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Guides
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
guides/code-execution
|
||||
guides/tool_use
|
||||
guides/selector-group-chat
|
||||
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Examples
|
||||
:maxdepth: 3
|
||||
:hidden:
|
||||
|
||||
guides/index
|
||||
examples/index
|
||||
```
|
||||
@@ -26,7 +26,8 @@ For further installation instructions, please refer to the [package information]
|
||||
|
||||
The following example illustrates creating a simple agent team with two agents that interact to solve a task.
|
||||
|
||||
1. `CodingAssistantAgent` that generates responses using an LLM model. 2.`CodeExecutorAgent` that executes code snippets and returns the output.
|
||||
1. `CodingAssistantAgent` that generates responses using an LLM model.
|
||||
2. `CodeExecutorAgent` that executes code snippets and returns the output.
|
||||
|
||||
The task is to "Create a plot of NVIDIA and TESLA stock returns YTD from 2024-01-01 and save it to 'nvidia_tesla_2024_ytd.png'."
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# Cookbook
|
||||
|
||||
```{toctree}
|
||||
|
||||
azure-openai-with-aad-auth
|
||||
termination-with-intervention
|
||||
tool-use-with-intervention
|
||||
extracting-results-with-an-agent
|
||||
openai-assistant-agent
|
||||
langgraph-agent
|
||||
llamaindex-agent
|
||||
local-llms-ollama-litellm
|
||||
instrumenting
|
||||
topic-subscription-scenarios
|
||||
azure-container-code-executor
|
||||
```
|
||||
@@ -10,7 +10,7 @@ Follow the instructions [here](https://learn.microsoft.com/en-us/dotnet/aspire/f
|
||||
|
||||
## Instrumenting your code
|
||||
|
||||
Once you have a dashboard set up, now it's a matter of sending traces and logs to it. You can follow the steps in the [Telemetry Guide](../guides/telemetry.md) to set up the opentelemetry sdk and exporter.
|
||||
Once you have a dashboard set up, now it's a matter of sending traces and logs to it. You can follow the steps in the [Telemetry Guide](../framework/telemetry.md) to set up the opentelemetry sdk and exporter.
|
||||
|
||||
After instrumenting your code with the Aspire Dashboard running, you should see traces and logs appear in the dashboard as your code runs.
|
||||
|
||||
@@ -32,4 +32,4 @@ OpenAIInstrumentor().instrument()
|
||||
|
||||
Now running your code will send traces including the LLM calls to your telemetry backend (Aspire in our case).
|
||||
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
@@ -11,7 +11,7 @@ The following diagram shows the application stack.
|
||||
At the bottom of the stack is the base messaging and routing facilities that
|
||||
enable agents to communicate with each other. These are managed by the
|
||||
agent runtime, and for most applications, developers only need to interact
|
||||
with the high-level APIs provided by the runtime (see [Agent and Agent Runtime](../guides/agent-and-agent-runtime.ipynb)).
|
||||
with the high-level APIs provided by the runtime (see [Agent and Agent Runtime](../framework/agent-and-agent-runtime.ipynb)).
|
||||
|
||||
At the top of the stack, developers need to define the
|
||||
types of the messages that agents exchange. This set of message types
|
||||
@@ -20,7 +20,7 @@ implementation of the contracts determines how agents handle messages.
|
||||
The behavior contract is also sometimes referred to as the message protocol.
|
||||
It is the developer's responsibility to implement the behavior contract.
|
||||
Multi-agent patterns emerge from these behavior contracts
|
||||
(see [Multi-Agent Design Patterns](../guides/multi-agent-design-patterns.md)).
|
||||
(see [Multi-Agent Design Patterns](../design-patterns/multi-agent-design-patterns.md)).
|
||||
|
||||
## An Example Application
|
||||
|
||||
|
Before Width: | Height: | Size: 114 KiB After Width: | Height: | Size: 114 KiB |
|
Before Width: | Height: | Size: 199 KiB After Width: | Height: | Size: 199 KiB |
|
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 109 KiB After Width: | Height: | Size: 109 KiB |
@@ -0,0 +1,13 @@
|
||||
# Core Concepts
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
agent-and-multi-agent-application
|
||||
architecture
|
||||
api-layers
|
||||
application-stack
|
||||
agent-identity-and-lifecycle
|
||||
topic-and-subscription
|
||||
```
|
||||
|
||||
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 99 KiB |
|
Before Width: | Height: | Size: 132 KiB After Width: | Height: | Size: 132 KiB |
|
Before Width: | Height: | Size: 221 KiB After Width: | Height: | Size: 221 KiB |
|
Before Width: | Height: | Size: 348 KiB After Width: | Height: | Size: 348 KiB |
|
Before Width: | Height: | Size: 317 KiB After Width: | Height: | Size: 317 KiB |
|
Before Width: | Height: | Size: 61 KiB After Width: | Height: | Size: 61 KiB |
@@ -0,0 +1,11 @@
|
||||
# Multi-Agent Design Patterns
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
group-chat
|
||||
mixture-of-agents
|
||||
multi-agent-debate
|
||||
multi-agent-design-patterns
|
||||
reflection
|
||||
```
|
||||
@@ -9,7 +9,7 @@ like software development.
|
||||
|
||||
A multi-agent design pattern is a structure that emerges from message protocols:
|
||||
it describes how agents interact with each other to solve problems.
|
||||
For example, the [tool-equiped agent](./tools.ipynb#tool-equipped-agent) in
|
||||
For example, the [tool-equiped agent](../framework/tools.ipynb#tool-equipped-agent) in
|
||||
the previous section employs a design pattern called ReAct,
|
||||
which involves an agent interacting with tools.
|
||||
|
||||
@@ -115,7 +115,7 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"We use the [Broadcast](./message-and-communication.ipynb#broadcast) API\n",
|
||||
"We use the [Broadcast](../framework/message-and-communication.ipynb#broadcast) API\n",
|
||||
"to implement the design pattern. The agents implements the pub/sub model.\n",
|
||||
"The coder agent subscribes to the `CodeWritingTask` and `CodeReviewResult` messages,\n",
|
||||
"and publishes the `CodeReviewTask` and `CodeWritingResult` messages."
|
||||
@@ -0,0 +1,16 @@
|
||||
# Framework
|
||||
|
||||
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
agent-and-agent-runtime
|
||||
command-line-code-executors
|
||||
distributed-agent-runtime
|
||||
logging
|
||||
message-and-communication
|
||||
model-clients
|
||||
telemetry
|
||||
tools
|
||||
```
|
||||
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
@@ -7,6 +7,18 @@ myst:
|
||||
|
||||
# Core
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
quickstart
|
||||
core-concepts/index
|
||||
framework/index
|
||||
design-patterns/index
|
||||
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.
|
||||
```
|
||||
@@ -31,72 +43,3 @@ Key features of AutoGen core include:
|
||||
- header: "{fas}`project-diagram;pst-color-primary` Event-Driven Architecture"
|
||||
content: "Build event-driven, distributed, scalable, and resilient AI agent systems."
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Getting Started
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/quickstart
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Core Concepts
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
|
||||
core-concepts/agent-and-multi-agent-application
|
||||
core-concepts/architecture
|
||||
core-concepts/api-layers
|
||||
core-concepts/application-stack
|
||||
core-concepts/agent-identity-and-lifecycle
|
||||
core-concepts/topic-and-subscription
|
||||
core-concepts/faqs
|
||||
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Framework
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/agent-and-agent-runtime
|
||||
guides/message-and-communication
|
||||
guides/model-clients
|
||||
guides/tools
|
||||
guides/logging
|
||||
guides/distributed-agent-runtime
|
||||
guides/telemetry
|
||||
guides/command-line-code-executors
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Multi-Agent Design Patterns
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
guides/multi-agent-design-patterns
|
||||
guides/group-chat
|
||||
guides/reflection
|
||||
guides/mixture-of-agents
|
||||
guides/multi-agent-debate
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:caption: Cookbook
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
cookbook/azure-openai-with-aad-auth
|
||||
cookbook/termination-with-intervention
|
||||
cookbook/tool-use-with-intervention
|
||||
cookbook/extracting-results-with-an-agent
|
||||
cookbook/openai-assistant-agent
|
||||
cookbook/langgraph-agent
|
||||
cookbook/llamaindex-agent
|
||||
cookbook/local-llms-ollama-litellm
|
||||
cookbook/instrumenting
|
||||
cookbook/topic-subscription-scenarios
|
||||
cookbook/azure-container-code-executor
|
||||
```
|
||||
34
python/packages/autogen-core/docs/src/user-guide/index.md
Normal file
34
python/packages/autogen-core/docs/src/user-guide/index.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# User Guide
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 3
|
||||
:hidden:
|
||||
|
||||
agentchat-user-guide/index
|
||||
core-user-guide/index
|
||||
```
|
||||
|
||||
::::{grid} 1 2 2 3
|
||||
:margin: 4 4 0 0
|
||||
:gutter: 1
|
||||
|
||||
:::{grid-item-card} {fas}`people-group;pst-color-primary` <br> AutoGen AgentChat
|
||||
:link: agentchat-user-guide/index
|
||||
:link-type: doc
|
||||
:class-item: api-card
|
||||
:::
|
||||
|
||||
:::{grid-item-card} {fas}`cube;pst-color-primary` <br> AutoGen Core
|
||||
:link: core-user-guide/index
|
||||
:link-type: doc
|
||||
:class-item: api-card
|
||||
:::
|
||||
|
||||
::::
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
setTimeout(function() {
|
||||
window.location.href = "agentchat-user-guide/quickstart.html";
|
||||
}, 0);
|
||||
</script>
|
||||
@@ -33,7 +33,6 @@ dev-dependencies = [
|
||||
"azure-identity",
|
||||
"chess",
|
||||
"colorama",
|
||||
"furo",
|
||||
"langchain-openai",
|
||||
"langgraph",
|
||||
"llama-index-embeddings-azure-openai",
|
||||
@@ -43,15 +42,11 @@ dev-dependencies = [
|
||||
"llama-index-tools-wikipedia",
|
||||
"llama-index",
|
||||
"markdownify",
|
||||
"myst-nb",
|
||||
"nbqa",
|
||||
"pip",
|
||||
"polars",
|
||||
"python-dotenv",
|
||||
"requests",
|
||||
"sphinx-autobuild",
|
||||
"sphinx",
|
||||
"sphinxcontrib-apidoc",
|
||||
"tavily-python",
|
||||
"textual-dev",
|
||||
"textual-imageview",
|
||||
@@ -63,9 +58,17 @@ dev-dependencies = [
|
||||
"types-docker",
|
||||
"wikipedia",
|
||||
"opentelemetry-sdk>=1.27.0",
|
||||
"sphinx-design",
|
||||
"pydata-sphinx-theme",
|
||||
|
||||
# Documentation
|
||||
"myst-nb==1.1.2",
|
||||
"pydata-sphinx-theme==0.15.4",
|
||||
"sphinx-copybutton",
|
||||
"sphinx-design",
|
||||
"sphinx",
|
||||
"sphinxcontrib-apidoc",
|
||||
|
||||
# Documentation tooling
|
||||
"sphinx-autobuild",
|
||||
]
|
||||
|
||||
|
||||
@@ -135,7 +138,7 @@ cmd = "sphinx-build docs/src docs/build"
|
||||
ref = "docs-apidoc-all"
|
||||
|
||||
[[tool.poe.tasks.docs-serve.sequence]]
|
||||
cmd = "sphinx-autobuild --watch src docs/src docs/build"
|
||||
cmd = "sphinx-autobuild --watch src docs/src docs/build --port 8000 --jobs auto"
|
||||
|
||||
[[tool.poe.tasks.docs-check.sequence]]
|
||||
ref = "docs-apidoc-all"
|
||||
|
||||
39
python/uv.lock
generated
39
python/uv.lock
generated
@@ -377,7 +377,6 @@ dev = [
|
||||
{ name = "azure-identity" },
|
||||
{ name = "chess" },
|
||||
{ name = "colorama" },
|
||||
{ name = "furo" },
|
||||
{ name = "langchain-openai" },
|
||||
{ name = "langgraph" },
|
||||
{ name = "llama-index" },
|
||||
@@ -433,7 +432,6 @@ dev = [
|
||||
{ name = "azure-identity" },
|
||||
{ name = "chess" },
|
||||
{ name = "colorama" },
|
||||
{ name = "furo" },
|
||||
{ name = "langchain-openai" },
|
||||
{ name = "langgraph" },
|
||||
{ name = "llama-index" },
|
||||
@@ -443,12 +441,12 @@ dev = [
|
||||
{ name = "llama-index-readers-wikipedia" },
|
||||
{ name = "llama-index-tools-wikipedia" },
|
||||
{ name = "markdownify" },
|
||||
{ name = "myst-nb" },
|
||||
{ name = "myst-nb", specifier = "==1.1.2" },
|
||||
{ name = "nbqa" },
|
||||
{ name = "opentelemetry-sdk", specifier = ">=1.27.0" },
|
||||
{ name = "pip" },
|
||||
{ name = "polars" },
|
||||
{ name = "pydata-sphinx-theme" },
|
||||
{ name = "pydata-sphinx-theme", specifier = "==0.15.4" },
|
||||
{ name = "python-dotenv" },
|
||||
{ name = "requests" },
|
||||
{ name = "sphinx" },
|
||||
@@ -1225,21 +1223,6 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/5e/44/73bea497ac69bafde2ee4269292fa3b41f1198f4bb7bbaaabde30ad29d4a/fsspec-2024.6.1-py3-none-any.whl", hash = "sha256:3cb443f8bcd2efb31295a5b9fdb02aee81d8452c80d28f97a6d0959e6cee101e", size = 177561 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "furo"
|
||||
version = "2024.8.6"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "beautifulsoup4" },
|
||||
{ name = "pygments" },
|
||||
{ name = "sphinx" },
|
||||
{ name = "sphinx-basic-ng" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/a0/e2/d351d69a9a9e4badb4a5be062c2d0e87bd9e6c23b5e57337fef14bef34c8/furo-2024.8.6.tar.gz", hash = "sha256:b63e4cee8abfc3136d3bc03a3d45a76a850bada4d6374d24c1716b0e01394a01", size = 1661506 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/27/48/e791a7ed487dbb9729ef32bb5d1af16693d8925f4366befef54119b2e576/furo-2024.8.6-py3-none-any.whl", hash = "sha256:6cd97c58b47813d3619e63e9081169880fbe331f0ca883c871ff1f3f11814f5c", size = 341333 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "google-ai-generativelanguage"
|
||||
version = "0.6.10"
|
||||
@@ -2841,7 +2824,7 @@ wheels = [
|
||||
|
||||
[[package]]
|
||||
name = "myst-nb"
|
||||
version = "1.1.1"
|
||||
version = "1.1.2"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "importlib-metadata" },
|
||||
@@ -2855,9 +2838,9 @@ dependencies = [
|
||||
{ name = "sphinx" },
|
||||
{ name = "typing-extensions" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/6c/20/0a085f78d1b5445847574df9937a6560fbd37fa19d472adc0899d3fd6f97/myst_nb-1.1.1.tar.gz", hash = "sha256:74227c11f76d03494f43b7788659b161b94f4dedef230a2912412bc8c3c9e553", size = 77351 }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/04/e3/01c093f6a46be2edc0fd370cbf6d227495ea19452939b2810b36657c63d4/myst_nb-1.1.2.tar.gz", hash = "sha256:961b4005657029ca89892a4c75edbf0856c54ceaf6172368b46bf7676c1f7700", size = 78036 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/af/42/814f84c78fa45cbd03fea27b10f4edf303ccf3890e377d3cda6d7ec729c3/myst_nb-1.1.1-py3-none-any.whl", hash = "sha256:8b8f9085287d948eef46cb3764aafc21915e0e981882b8c742719f5b1a84c36f", size = 80282 },
|
||||
{ url = "https://files.pythonhosted.org/packages/04/45/cf78b2f09c46b36f486b75c34a8b48580e53b543bd9a467b3c7eb9054b70/myst_nb-1.1.2-py3-none-any.whl", hash = "sha256:9b7034e5d62640cb6daf03f9ca16ef45d0462fced27944c77aa3f98c7cdcd566", size = 80281 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
@@ -4387,18 +4370,6 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/53/de/1d005ba60b4b754d6e05079a479f16a8f6e08c1ec4f8d80288238502b4b6/sphinx_autobuild-2024.4.16-py3-none-any.whl", hash = "sha256:f2522779d30fcbf0253e09714f274ce8c608cb6ebcd67922b1c54de59faba702", size = 11222 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sphinx-basic-ng"
|
||||
version = "1.0.0b2"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "sphinx" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/98/0b/a866924ded68efec7a1759587a4e478aec7559d8165fac8b2ad1c0e774d6/sphinx_basic_ng-1.0.0b2.tar.gz", hash = "sha256:9ec55a47c90c8c002b5960c57492ec3021f5193cb26cebc2dc4ea226848651c9", size = 20736 }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/3c/dd/018ce05c532a22007ac58d4f45232514cd9d6dd0ee1dc374e309db830983/sphinx_basic_ng-1.0.0b2-py3-none-any.whl", hash = "sha256:eb09aedbabfb650607e9b4b68c9d240b90b1e1be221d6ad71d61c52e29f7932b", size = 22496 },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "sphinx-copybutton"
|
||||
version = "0.5.2"
|
||||
|
||||
Reference in New Issue
Block a user