mirror of https://github.com/microsoft/autogen.git
69 lines
4.2 KiB
Markdown
69 lines
4.2 KiB
Markdown
|
|
|
|
# Getting Started
|
|
|
|
<!-- ### Welcome to AutoGen, a library for enabling Next-Gen LLM Applications via Multi-Agent Conversation Framework! -->
|
|
|
|
AutoGen is a framework that enables development of LLM applications using multiple agents that can converse with each other to solve task. 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.
|
|
|
|
|
|
|
|
### Main Features
|
|
|
|
* 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 overcome their weaknesses.
|
|
* 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,
|
|
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** from various domains and complexities. They demonstrate how AutoGen can easily support different conversation patterns.
|
|
* 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 & caching, and advanced usage patterns, such as error handling, multi-config inference, context programming etc.
|
|
|
|
AutoGen is powered by collaborative [research studies](/docs/Research) from Microsoft, Penn State University, and University of Washington.
|
|
|
|
### Quickstart
|
|
|
|
Install from pip: `pip install pyautogen`. Find more options in [Installation](/docs/Installation).
|
|
|
|
|
|
#### 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 human.
|
|
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,
|
|
```python
|
|
from autogen import AssistantAgent, UserProxyAgent
|
|
assistant = AssistantAgent("assistant")
|
|
user_proxy = UserProxyAgent("user_proxy")
|
|
user_proxy.initiate_chat(assistant, message="Plot a chart of META and TESLA stock price change YTD.")
|
|
# This initiates an automated chat between the two agents to solve the task
|
|
```
|
|
|
|
The figure below shows an example conversation flow with AutoGen.
|
|
|
|
|
|
#### Enhanced LLM Inferences
|
|
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` with powerful functionalites like tuning, caching, error handling, templating. For example, you can optimize generations by LLM with your own tuning data, success metrics and budgets.
|
|
```python
|
|
# perform tuning
|
|
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)
|
|
```
|
|
|
|
### Where to Go Next?
|
|
|
|
* Understand the use cases for [multi-agent conversation](/docs/Use-Cases/agent_chat).
|
|
* Understand the use cases for [enhanced LLM inference](/docs/Use-Cases/enhanced_inference).
|
|
* Find code examples from [Examples](/docs/Examples/AutoGen-AgentChat).
|
|
* Read [SDK](/docs/reference/agentchat/conversable_agent/).
|
|
* Learn about [research](/docs/Research) around AutoGen.
|
|
* Chat on [Discord](https://discord.gg/be44TCXGpe).
|
|
|
|
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&repo=autogen&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe> -->
|