Skip to content

Commit 28d22e7

Browse files
authored
move citation before contributing (microsoft#154)
1 parent 8752e17 commit 28d22e7

File tree

1 file changed

+49
-42
lines changed

1 file changed

+49
-42
lines changed

README.md

+49-42
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
[![PyPI version](https://badge.fury.io/py/pyautogen.svg)](https://badge.fury.io/py/pyautogen)
32
[![Build](https://github.com/microsoft/autogen/actions/workflows/python-package.yml/badge.svg)](https://github.com/microsoft/autogen/actions/workflows/python-package.yml)
43
![Python Version](https://img.shields.io/badge/3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)
@@ -23,18 +22,17 @@ This project is a spinoff from [FLAML](https://github.com/microsoft/FLAML).
2322
2423
:fire: FLAML supports Code-First AutoML & Tuning – Private Preview in [Microsoft Fabric Data Science](https://learn.microsoft.com/en-us/fabric/data-science/). -->
2524

26-
2725
## What is AutoGen
2826

2927
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.
3028

3129
![AutoGen Overview](https://github.com/microsoft/autogen/blob/main/website/static/img/autogen_agentchat.png)
3230

33-
* AutoGen enables building next-gen LLM applications based on **multi-agent conversations** 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.
34-
* It supports **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,
35-
the number of agents, and agent conversation topology.
36-
* It provides a collection of working systems with different complexities. These systems span a **wide range of applications** from various domains and complexities. This demonstrates how AutoGen can easily support diverse conversation patterns.
37-
* AutoGen provides a drop-in replacement of `openai.Completion` or `openai.ChatCompletion` as an **enhanced inference API**. It allows easy performance tuning, utilities like API unification and caching, and advanced usage patterns, such as error handling, multi-config inference, context programming, etc.
31+
- AutoGen enables building next-gen LLM applications based on **multi-agent conversations** 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.
32+
- It supports **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,
33+
the number of agents, and agent conversation topology.
34+
- It provides a collection of working systems with different complexities. These systems span a **wide range of applications** from various domains and complexities. This demonstrates how AutoGen can easily support diverse conversation patterns.
35+
- AutoGen provides a drop-in replacement of `openai.Completion` or `openai.ChatCompletion` as an **enhanced inference API**. It allows easy performance tuning, utilities like API unification and caching, and advanced usage patterns, such as error handling, multi-config inference, context programming, etc.
3836

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

@@ -47,18 +45,20 @@ pip install pyautogen
4745
```
4846

4947
Minimal dependencies are installed without extra options. You can install extra options based on the feature you need.
48+
5049
<!-- 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.
5150
```bash
5251
pip install "pyautogen[blendsearch]"
5352
``` -->
5453

5554
Find more options in [Installation](https://microsoft.github.io/autogen/docs/Installation).
55+
5656
<!-- Each of the [`notebook examples`](https://github.com/microsoft/autogen/tree/main/notebook) may require a specific option to be installed. -->
57+
5758
For [code execution](https://microsoft.github.io/autogen/docs/FAQ/#code-execution), we strongly recommend installing the python docker package, and using docker.
5859

5960
For LLM inference configurations, check the [FAQ](https://microsoft.github.io/autogen/docs/FAQ#set-your-api-endpoints).
6061

61-
6262
## Quickstart
6363

6464
## Multi-Agent Conversation Framework
@@ -73,6 +73,7 @@ Features of this use case include:
7373
- **Human participation**: AutoGen seamlessly allows human participation. This means that humans can provide input and feedback to the agents as needed.
7474

7575
For [example](https://github.com/microsoft/autogen/blob/main/test/twoagent.py),
76+
7677
```python
7778
from autogen import AssistantAgent, UserProxyAgent, config_list_from_json
7879
# Load LLM inference endpoints from an env variable or a file
@@ -86,17 +87,21 @@ user_proxy.initiate_chat(assistant, message="Plot a chart of NVDA and TESLA stoc
8687
```
8788

8889
This example can be run with
90+
8991
```python
9092
python test/twoagent.py
9193
```
94+
9295
After the repo is cloned.
9396
The figure below shows an example conversation flow with AutoGen.
9497
![Agent Chat Example](https://github.com/microsoft/autogen/blob/main/website/static/img/chat_example.png)
9598

9699
Please find more [code examples](https://microsoft.github.io/autogen/docs/Examples/AutoGen-AgentChat) for this feature.
100+
97101
## Enhanced LLM Inferences
98102

99103
Autogen also helps maximize the utility out of the expensive LLMs such as ChatGPT and GPT-4. It offers a drop-in replacement of `openai.Completion` or `openai.ChatCompletion` adding powerful functionalities like tuning, caching, error handling, and templating. For example, you can optimize generations by LLM with your own tuning data, success metrics, and budgets.
104+
100105
```python
101106
# perform tuning
102107
config, analysis = autogen.Completion.tune(
@@ -126,42 +131,10 @@ In addition, you can find:
126131

127132
- [Contributing guide](https://microsoft.github.io/autogen/docs/Contribute).
128133

129-
## Contributing
130-
131-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
132-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
133-
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
134-
135-
If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub.
136-
137-
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
138-
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
139-
provided by the bot. You will only need to do this once across all repos using our CLA.
140-
141-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
142-
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
143-
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
144-
145-
# Legal Notices
146-
147-
Microsoft and any contributors grant you a license to the Microsoft documentation and other content
148-
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),
149-
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
150-
[LICENSE-CODE](LICENSE-CODE) file.
151-
152-
Microsoft, Windows, Microsoft Azure, and/or other Microsoft products and services referenced in the documentation
153-
may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.
154-
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks.
155-
Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.
156-
157-
Privacy information can be found at https://privacy.microsoft.com/en-us/
158-
159-
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents,
160-
or trademarks, whether by implication, estoppel, or otherwise.
161-
162-
163134
## Citation
135+
164136
[AutoGen](https://arxiv.org/abs/2308.08155).
137+
165138
```
166139
@inproceedings{wu2023autogen,
167140
title={AutoGen: Enabling Next-Gen LLM Applications via Multi-Agent Conversation Framework},
@@ -174,6 +147,7 @@ or trademarks, whether by implication, estoppel, or otherwise.
174147
```
175148

176149
[EcoOptiGen](https://arxiv.org/abs/2303.04673).
150+
177151
```
178152
@inproceedings{wang2023EcoOptiGen,
179153
title={Cost-Effective Hyperparameter Optimization for Large Language Model Generation Inference},
@@ -193,3 +167,36 @@ or trademarks, whether by implication, estoppel, or otherwise.
193167
booktitle={ArXiv preprint arXiv:2306.01337},
194168
}
195169
```
170+
171+
## Contributing
172+
173+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
174+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
175+
the rights to use your contribution. For details, visit <https://cla.opensource.microsoft.com>.
176+
177+
If you are new to GitHub [here](https://help.github.com/categories/collaborating-with-issues-and-pull-requests/) is a detailed help source on getting involved with development on GitHub.
178+
179+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
180+
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
181+
provided by the bot. You will only need to do this once across all repos using our CLA.
182+
183+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
184+
For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
185+
contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
186+
187+
# Legal Notices
188+
189+
Microsoft and any contributors grant you a license to the Microsoft documentation and other content
190+
in this repository under the [Creative Commons Attribution 4.0 International Public License](https://creativecommons.org/licenses/by/4.0/legalcode),
191+
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
192+
[LICENSE-CODE](LICENSE-CODE) file.
193+
194+
Microsoft, Windows, Microsoft Azure, and/or other Microsoft products and services referenced in the documentation
195+
may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries.
196+
The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks.
197+
Microsoft's general trademark guidelines can be found at http://go.microsoft.com/fwlink/?LinkID=254653.
198+
199+
Privacy information can be found at https://privacy.microsoft.com/en-us/
200+
201+
Microsoft and any contributors reserve all other rights, whether under their respective copyrights, patents,
202+
or trademarks, whether by implication, estoppel, or otherwise.

0 commit comments

Comments
 (0)