mirror of https://github.com/microsoft/autogen.git
351 lines
20 KiB
Markdown
351 lines
20 KiB
Markdown
<a name="readme-top"></a>
|
||
|
||
[](https://badge.fury.io/py/pyautogen)
|
||
[](https://github.com/microsoft/autogen/actions/workflows/python-package.yml)
|
||
|
||
[](https://pepy.tech/project/pyautogen)
|
||
[](https://aka.ms/autogen-dc)
|
||
[](https://twitter.com/pyautogen)
|
||
|
||
[](https://badge.fury.io/nu/AutoGen.Core)
|
||
|
||
# AutoGen
|
||
[📚 Cite paper](#related-papers).
|
||
<!-- <p align="center">
|
||
<img src="https://github.com/microsoft/autogen/blob/main/website/static/img/flaml.svg" width=200>
|
||
<br>
|
||
</p> -->
|
||
|
||
:fire: May 24, 2024: Foundation Capital published an article on [Forbes: The Promise of Multi-Agent AI](https://www.forbes.com/sites/joannechen/2024/05/24/the-promise-of-multi-agent-ai/?sh=2c1e4f454d97) and a video [AI in the Real World Episode 2: Exploring Multi-Agent AI and AutoGen with Chi Wang](https://www.youtube.com/watch?v=RLwyXRVvlNk).
|
||
|
||
:fire: May 13, 2024: [The Economist](https://www.economist.com/science-and-technology/2024/05/13/todays-ai-models-are-impressive-teams-of-them-will-be-formidable) published an article about multi-agent systems (MAS) following a January 2024 interview with [Chi Wang](https://github.com/sonichi).
|
||
|
||
:fire: May 11, 2024: [AutoGen: Enabling Next-Gen LLM Applications via Multi-Agent Conversation](https://openreview.net/pdf?id=uAjxFFing2) received the best paper award at the [ICLR 2024 LLM Agents Workshop](https://llmagents.github.io/).
|
||
|
||
:fire: Apr 26, 2024: [AutoGen.NET](https://microsoft.github.io/autogen-for-net/) is available for .NET developers!
|
||
|
||
:fire: Apr 17, 2024: Andrew Ng cited AutoGen in [The Batch newsletter](https://www.deeplearning.ai/the-batch/issue-245/) and [What's next for AI agentic workflows](https://youtu.be/sal78ACtGTc?si=JduUzN_1kDnMq0vF) at Sequoia Capital's AI Ascent (Mar 26).
|
||
|
||
:fire: Mar 3, 2024: What's new in AutoGen? 📰[Blog](https://microsoft.github.io/autogen/blog/2024/03/03/AutoGen-Update); 📺[Youtube](https://www.youtube.com/watch?v=j_mtwQiaLGU).
|
||
|
||
:fire: Mar 1, 2024: the first AutoGen multi-agent experiment on the challenging [GAIA](https://huggingface.co/spaces/gaia-benchmark/leaderboard) benchmark achieved the No. 1 accuracy in all the three levels.
|
||
|
||
<!-- :tada: Jan 30, 2024: AutoGen is highlighted by Peter Lee in Microsoft Research Forum [Keynote](https://t.co/nUBSjPDjqD). -->
|
||
|
||
:tada: Dec 31, 2023: [AutoGen: Enabling Next-Gen LLM Applications via Multi-Agent Conversation Framework](https://arxiv.org/abs/2308.08155) is selected by [TheSequence: My Five Favorite AI Papers of 2023](https://thesequence.substack.com/p/my-five-favorite-ai-papers-of-2023).
|
||
|
||
<!-- :fire: Nov 24: pyautogen [v0.2](https://github.com/microsoft/autogen/releases/tag/v0.2.0) is released with many updates and new features compared to v0.1.1. It switches to using openai-python v1. Please read the [migration guide](https://microsoft.github.io/autogen/docs/Installation#python). -->
|
||
|
||
<!-- :fire: Nov 11: OpenAI's Assistants are available in AutoGen and interoperatable with other AutoGen agents! Checkout our [blogpost](https://microsoft.github.io/autogen/blog/2023/11/13/OAI-assistants) for details and examples. -->
|
||
|
||
:tada: Nov 8, 2023: AutoGen is selected into [Open100: Top 100 Open Source achievements](https://www.benchcouncil.org/evaluation/opencs/annual.html) 35 days after spinoff from [FLAML](https://github.com/microsoft/FLAML).
|
||
|
||
<!-- :tada: Nov 6, 2023: AutoGen is mentioned by Satya Nadella in a [fireside chat](https://youtu.be/0pLBvgYtv6U). -->
|
||
|
||
<!-- :tada: Nov 1, 2023: AutoGen is the top trending repo on GitHub in October 2023. -->
|
||
|
||
<!-- :tada: Oct 03, 2023: AutoGen spins off from [FLAML](https://github.com/microsoft/FLAML) on GitHub. -->
|
||
|
||
<!-- :tada: Aug 16: Paper about AutoGen on [arxiv](https://arxiv.org/abs/2308.08155). -->
|
||
|
||
:tada: Mar 29, 2023: AutoGen is first created in [FLAML](https://github.com/microsoft/FLAML).
|
||
|
||
<!--
|
||
:fire: FLAML is highlighted in OpenAI's [cookbook](https://github.com/openai/openai-cookbook#related-resources-from-around-the-web).
|
||
|
||
:fire: [autogen](https://microsoft.github.io/autogen/) is released with support for ChatGPT and GPT-4, based on [Cost-Effective Hyperparameter Optimization for Large Language Model Generation Inference](https://arxiv.org/abs/2303.04673).
|
||
|
||
:fire: FLAML supports Code-First AutoML & Tuning – Private Preview in [Microsoft Fabric Data Science](https://learn.microsoft.com/en-us/fabric/data-science/). -->
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## What is AutoGen
|
||
|
||
AutoGen is a framework that enables the development of LLM applications using multiple agents that can converse with each other to solve tasks. AutoGen agents are customizable, conversable, and seamlessly allow human participation. They can operate in various modes that employ combinations of LLMs, human inputs, and tools.
|
||
|
||
|
||
|
||
- AutoGen enables building next-gen LLM applications based on [multi-agent conversations](https://microsoft.github.io/autogen/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](https://microsoft.github.io/autogen/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](https://microsoft.github.io/autogen/docs/Use-Cases/agent_chat#diverse-applications-implemented-with-autogen) from various domains and complexities. This demonstrates how AutoGen can easily support diverse conversation patterns.
|
||
- AutoGen provides [enhanced LLM inference](https://microsoft.github.io/autogen/docs/Use-Cases/enhanced_inference#api-unification). It offers utilities like API unification and caching, and advanced usage patterns, such as error handling, multi-config inference, context programming, etc.
|
||
|
||
AutoGen is powered by collaborative [research studies](https://microsoft.github.io/autogen/docs/Research) from Microsoft, Penn State University, and the University of Washington.
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Roadmaps
|
||
|
||
To see what we are working on and what we plan to work on, please check our
|
||
[Roadmap Issues](https://aka.ms/autogen-roadmap).
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Quickstart
|
||
The easiest way to start playing is
|
||
1. Click below to use the GitHub Codespace
|
||
|
||
[](https://codespaces.new/microsoft/autogen?quickstart=1)
|
||
|
||
2. Copy OAI_CONFIG_LIST_sample to ./notebook folder, name to OAI_CONFIG_LIST, and set the correct configuration.
|
||
3. Start playing with the notebooks!
|
||
|
||
*NOTE*: OAI_CONFIG_LIST_sample lists GPT-4 as the default model, as this represents our current recommendation, and is known to work well with AutoGen. If you use a model other than GPT-4, you may need to revise various system prompts (especially if using weaker models like GPT-3.5-turbo). Moreover, if you use models other than those hosted by OpenAI or Azure, you may incur additional risks related to alignment and safety. Proceed with caution if updating this default.
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## [Installation](https://microsoft.github.io/autogen/docs/Installation)
|
||
### Option 1. Install and Run AutoGen in Docker
|
||
|
||
Find detailed instructions for users [here](https://microsoft.github.io/autogen/docs/installation/Docker#step-1-install-docker), and for developers [here](https://microsoft.github.io/autogen/docs/Contribute#docker-for-development).
|
||
|
||
### Option 2. Install AutoGen Locally
|
||
|
||
AutoGen requires **Python version >= 3.8, < 3.13**. It can be installed from pip:
|
||
|
||
```bash
|
||
pip install pyautogen
|
||
```
|
||
|
||
Minimal dependencies are installed without extra options. You can install extra options based on the feature you need.
|
||
|
||
<!-- For example, use the following to install the dependencies needed by the [`blendsearch`](https://microsoft.github.io/FLAML/docs/Use-Cases/Tune-User-Defined-Function#blendsearch-economical-hyperparameter-optimization-with-blended-search-strategy) option.
|
||
```bash
|
||
pip install "pyautogen[blendsearch]"
|
||
``` -->
|
||
|
||
Find more options in [Installation](https://microsoft.github.io/autogen/docs/Installation#option-2-install-autogen-locally-using-virtual-environment).
|
||
|
||
<!-- Each of the [`notebook examples`](https://github.com/microsoft/autogen/tree/main/notebook) may require a specific option to be installed. -->
|
||
|
||
Even if you are installing and running AutoGen locally outside of docker, the recommendation and default behavior of agents is to perform [code execution](https://microsoft.github.io/autogen/docs/FAQ/#code-execution) in docker. Find more instructions and how to change the default behaviour [here](https://microsoft.github.io/autogen/docs/Installation#code-execution-with-docker-(default)).
|
||
|
||
For LLM inference configurations, check the [FAQs](https://microsoft.github.io/autogen/docs/FAQ#set-your-api-endpoints).
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Multi-Agent Conversation Framework
|
||
|
||
Autogen enables the next-gen LLM applications with a generic [multi-agent conversation](https://microsoft.github.io/autogen/docs/Use-Cases/agent_chat) framework. It offers customizable and conversable agents that 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.
|
||
|
||
Features of this use case include:
|
||
|
||
- **Multi-agent conversations**: AutoGen agents can communicate with each other to solve tasks. This allows for more complex and sophisticated applications than would be possible with a single LLM.
|
||
- **Customization**: AutoGen agents can be customized to meet the specific needs of an application. This includes the ability to choose the LLMs to use, the types of human input to allow, and the tools to employ.
|
||
- **Human participation**: AutoGen seamlessly allows human participation. This means that humans can provide input and feedback to the agents as needed.
|
||
|
||
For [example](https://github.com/microsoft/autogen/blob/main/test/twoagent.py),
|
||
|
||
```python
|
||
from autogen import AssistantAgent, UserProxyAgent, config_list_from_json
|
||
# Load LLM inference endpoints from an env variable or a file
|
||
# See https://microsoft.github.io/autogen/docs/FAQ#set-your-api-endpoints
|
||
# and OAI_CONFIG_LIST_sample
|
||
config_list = config_list_from_json(env_or_file="OAI_CONFIG_LIST")
|
||
# You can also set config_list directly as a list, for example, config_list = [{'model': 'gpt-4', 'api_key': '<your OpenAI API key here>'},]
|
||
assistant = AssistantAgent("assistant", llm_config={"config_list": config_list})
|
||
user_proxy = UserProxyAgent("user_proxy", code_execution_config={"work_dir": "coding", "use_docker": False}) # IMPORTANT: set to True to run code in docker, recommended
|
||
user_proxy.initiate_chat(assistant, message="Plot a chart of NVDA and TESLA stock price change YTD.")
|
||
# This initiates an automated chat between the two agents to solve the task
|
||
```
|
||
|
||
This example can be run with
|
||
|
||
```python
|
||
python test/twoagent.py
|
||
```
|
||
|
||
After the repo is cloned.
|
||
The figure below shows an example conversation flow with AutoGen.
|
||
|
||
|
||
Alternatively, the [sample code](https://github.com/microsoft/autogen/blob/main/samples/simple_chat.py) here allows a user to chat with an AutoGen agent in ChatGPT style.
|
||
Please find more [code examples](https://microsoft.github.io/autogen/docs/Examples#automated-multi-agent-chat) for this feature.
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Enhanced LLM Inferences
|
||
|
||
Autogen also helps maximize the utility out of the expensive LLMs such as ChatGPT and GPT-4. It offers [enhanced LLM inference](https://microsoft.github.io/autogen/docs/Use-Cases/enhanced_inference#api-unification) with powerful functionalities like caching, error handling, multi-config inference and templating.
|
||
|
||
<!-- For example, you can optimize generations by LLM with your own tuning data, success metrics, and budgets.
|
||
|
||
```python
|
||
# perform tuning for openai<1
|
||
config, analysis = autogen.Completion.tune(
|
||
data=tune_data,
|
||
metric="success",
|
||
mode="max",
|
||
eval_func=eval_func,
|
||
inference_budget=0.05,
|
||
optimization_budget=3,
|
||
num_samples=-1,
|
||
)
|
||
# perform inference for a test instance
|
||
response = autogen.Completion.create(context=test_instance, **config)
|
||
```
|
||
|
||
Please find more [code examples](https://microsoft.github.io/autogen/docs/Examples#tune-gpt-models) for this feature. -->
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Documentation
|
||
|
||
You can find detailed documentation about AutoGen [here](https://microsoft.github.io/autogen/).
|
||
|
||
In addition, you can find:
|
||
|
||
- [Research](https://microsoft.github.io/autogen/docs/Research), [blogposts](https://microsoft.github.io/autogen/blog) around AutoGen, and [Transparency FAQs](https://github.com/microsoft/autogen/blob/main/TRANSPARENCY_FAQS.md)
|
||
|
||
- [Discord](https://aka.ms/autogen-dc)
|
||
|
||
- [Contributing guide](https://microsoft.github.io/autogen/docs/Contribute)
|
||
|
||
- [Roadmap](https://github.com/orgs/microsoft/projects/989/views/3)
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Related Papers
|
||
|
||
[AutoGen](https://arxiv.org/abs/2308.08155)
|
||
|
||
```
|
||
@inproceedings{wu2023autogen,
|
||
title={AutoGen: Enabling Next-Gen LLM Applications via Multi-Agent Conversation Framework},
|
||
author={Qingyun Wu and Gagan Bansal and Jieyu Zhang and Yiran Wu and Beibin Li and Erkang Zhu and Li Jiang and Xiaoyun Zhang and Shaokun Zhang and Jiale Liu and Ahmed Hassan Awadallah and Ryen W White and Doug Burger and Chi Wang},
|
||
year={2023},
|
||
eprint={2308.08155},
|
||
archivePrefix={arXiv},
|
||
primaryClass={cs.AI}
|
||
}
|
||
```
|
||
|
||
[EcoOptiGen](https://arxiv.org/abs/2303.04673)
|
||
|
||
```
|
||
@inproceedings{wang2023EcoOptiGen,
|
||
title={Cost-Effective Hyperparameter Optimization for Large Language Model Generation Inference},
|
||
author={Chi Wang and Susan Xueqing Liu and Ahmed H. Awadallah},
|
||
year={2023},
|
||
booktitle={AutoML'23},
|
||
}
|
||
```
|
||
|
||
[MathChat](https://arxiv.org/abs/2306.01337)
|
||
|
||
```
|
||
@inproceedings{wu2023empirical,
|
||
title={An Empirical Study on Challenging Math Problem Solving with GPT-4},
|
||
author={Yiran Wu and Feiran Jia and Shaokun Zhang and Hangyu Li and Erkang Zhu and Yue Wang and Yin Tat Lee and Richard Peng and Qingyun Wu and Chi Wang},
|
||
year={2023},
|
||
booktitle={ArXiv preprint arXiv:2306.01337},
|
||
}
|
||
```
|
||
|
||
[AgentOptimizer](https://arxiv.org/pdf/2402.11359)
|
||
|
||
```
|
||
@article{zhang2024training,
|
||
title={Training Language Model Agents without Modifying Language Models},
|
||
author={Zhang, Shaokun and Zhang, Jieyu and Liu, Jiale and Song, Linxin and Wang, Chi and Krishna, Ranjay and Wu, Qingyun},
|
||
journal={ICML'24},
|
||
year={2024}
|
||
}
|
||
```
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Contributing
|
||
|
||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
||
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
|
||
|
||
If you are new to GitHub, [here](https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution) is a detailed help source on getting involved with development on GitHub.
|
||
|
||
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
|
||
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
|
||
provided by the bot. You will only need to do this once across all repos using our CLA.
|
||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
## Contributors Wall
|
||
<a href="https://github.com/microsoft/autogen/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=microsoft/autogen&max=204" />
|
||
</a>
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|
||
|
||
# Legal Notices
|
||
|
||
Microsoft and any contributors grant you a license to the Microsoft documentation and other content
|
||
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),
|
||
see the [LICENSE](LICENSE) file, and grant you a license to any code in the repository under the [MIT License](https://opensource.org/licenses/MIT), see the
|
||
[LICENSE-CODE](LICENSE-CODE) file.
|
||
|
||
Microsoft, Windows, Microsoft Azure, and/or other Microsoft products and services referenced in the documentation
|
||
may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.
|
||
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks.
|
||
Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.
|
||
|
||
Privacy information can be found at https://privacy.microsoft.com/en-us/
|
||
|
||
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents,
|
||
or trademarks, whether by implication, estoppel, or otherwise.
|
||
|
||
<p align="right" style="font-size: 14px; color: #555; margin-top: 20px;">
|
||
<a href="#readme-top" style="text-decoration: none; color: blue; font-weight: bold;">
|
||
↑ Back to Top ↑
|
||
</a>
|
||
</p>
|