Skip to content

Commit

Permalink
Add links to roadmap issues from README, Getting-Started, Contribute …
Browse files Browse the repository at this point in the history
…and Tutorial (microsoft#2072)

* Link to roadmap issues.

* Ordering
  • Loading branch information
ekzhu authored Mar 20, 2024
1 parent af08200 commit 7038a24
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 19 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ AutoGen is a framework that enables the development of LLM applications using mu

AutoGen is powered by collaborative [research studies](https://microsoft.github.io/autogen/docs/Research) from Microsoft, Penn State University, and the University of Washington.

## Roadmaps

To see what we are working on and what we plan to work on, please check our
[Roadmap Issues](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap).

## Quickstart
The easiest way to start playing is
1. Click below to use the GitHub Codespace
Expand Down
5 changes: 5 additions & 0 deletions website/docs/Contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## Roadmaps

To see what we are working on and what we plan to work on, please check our
[Roadmap Issues](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap).

## How to make a good bug report

When you submit an issue to [GitHub](https://github.com/microsoft/autogen/issues), please do your best to
Expand Down
42 changes: 23 additions & 19 deletions website/docs/Getting-Started.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";

# Getting Started

Expand All @@ -13,16 +13,15 @@ tools.

### Main Features


- AutoGen enables building next-gen LLM applications based on [multi-agent
conversations](/docs/Use-Cases/agent_chat) with minimal effort. It simplifies
the orchestration, automation, and optimization of a complex LLM workflow. It
maximizes the performance of LLM models and overcomes their weaknesses.
- It supports [diverse conversation
patterns](/docs/Use-Cases/agent_chat#supporting-diverse-conversation-patterns)
for complex workflows. With customizable and conversable agents, developers can
use AutoGen to build a wide range of conversation patterns concerning
conversation autonomy, the number of agents, and agent conversation topology.
patterns](/docs/Use-Cases/agent_chat#supporting-diverse-conversation-patterns)
for complex workflows. With customizable and conversable agents, developers can
use AutoGen to build a wide range of conversation patterns concerning
conversation autonomy, the number of agents, and agent conversation topology.
- It provides a collection of working systems with different complexities. These
systems span a [wide range of
applications](/docs/Use-Cases/agent_chat#diverse-applications-implemented-with-autogen)
Expand Down Expand Up @@ -75,7 +74,6 @@ user_proxy.initiate_chat(
</TabItem>
<TabItem value="docker" label="Docker execution" default>


```python
from autogen import AssistantAgent, UserProxyAgent
from autogen.coding import DockerCommandLineCodeExecutor
Expand Down Expand Up @@ -112,27 +110,33 @@ Open `coding/plot.png` to see the generated plot.
Learn more about configuring LLMs for agents [here](/docs/topics/llm_configuration).
:::



#### Multi-Agent Conversation Framework

Autogen enables the next-gen LLM applications with a generic multi-agent conversation framework. It offers customizable and conversable agents which integrate LLMs, tools, and humans.
By automating chat among multiple capable agents, one can easily make them collectively perform tasks autonomously or with human feedback, including tasks that require using tools via code. For [example](https://github.com/microsoft/autogen/blob/main/test/twoagent.py),

The figure below shows an example conversation flow with AutoGen.

![Agent Chat Example](/img/chat_example.png)


### Where to Go Next?

* Go through the [tutorial](/docs/tutorial/introduction) to learn more about the core concepts in AutoGen
* Read the examples and guides in the [notebooks section](/docs/notebooks)
* Understand the use cases for [multi-agent conversation](/docs/Use-Cases/agent_chat) and [enhanced LLM inference](/docs/Use-Cases/enhanced_inference)
* Read the [API](/docs/reference/agentchat/conversable_agent/) docs
* Learn about [research](/docs/Research) around AutoGen
* Chat on [Discord](https://discord.gg/pAbnFJrkgZ)
* Follow on [Twitter](https://twitter.com/pyautogen)
- Go through the [tutorial](/docs/tutorial/introduction) to learn more about the core concepts in AutoGen
- Read the examples and guides in the [notebooks section](/docs/notebooks)
- Understand the use cases for [multi-agent conversation](/docs/Use-Cases/agent_chat) and [enhanced LLM inference](/docs/Use-Cases/enhanced_inference)
- Read the [API](/docs/reference/agentchat/conversable_agent/) docs
- Learn about [research](/docs/Research) around AutoGen
- Chat on [Discord](https://discord.gg/pAbnFJrkgZ)
- Follow on [Twitter](https://twitter.com/pyautogen)
- See our [roadmaps](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap)

If you like our project, please give it a [star](https://github.com/microsoft/autogen/stargazers) on GitHub. If you are interested in contributing, please read [Contributor's Guide](/docs/Contribute).

<iframe src="https://ghbtns.com/github-btn.html?user=microsoft&amp;repo=autogen&amp;type=star&amp;count=true&amp;size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>
<iframe
src="https://ghbtns.com/github-btn.html?user=microsoft&amp;repo=autogen&amp;type=star&amp;count=true&amp;size=large"
frameborder="0"
scrolling="0"
width="170"
height="30"
title="GitHub"
></iframe>
1 change: 1 addition & 0 deletions website/docs/tutorial/what-next.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ our [Discord Server](https://discord.gg/pAbnFJrkgZ).

## Get Involved

- Check out [Roadmap Issues](https://github.com/microsoft/autogen/issues?q=is%3Aopen+is%3Aissue+label%3Aroadmap) to see what we are working on.
- Contribute your work to our [gallery](../Gallery)
- Follow our [contribution guide](../Contribute) to make a pull request to AutoGen
- You can also share your work with the community on the Discord server.

0 comments on commit 7038a24

Please sign in to comment.