Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V0.3.0doc #33

Merged
merged 11 commits into from
Sep 5, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Feel free to modify these Dockerfiles for your specific project needs. Here are
- **Setting Environment Variables**: Add environment variables using the `ENV` command for any application-specific configurations. We have prestaged the line needed to inject your OpenAI_key into the docker environment as a environmental variable. Others can be staged in the same way. Just uncomment the line.
`# ENV OPENAI_API_KEY="{OpenAI-API-Key}"` to `ENV OPENAI_API_KEY="{OpenAI-API-Key}"`
- **Need a less "Advanced" Autogen build**: If the `./full/Dockerfile` is to much but you need more than advanced then update this line in the Dockerfile file.
`RUN pip install pyautogen[teachable,lmm,retrievechat,mathchat,blendsearch] autogenra` to install just what you need. `RUN pip install pyautogen[retrievechat,blendsearch] autogenra`
`RUN pip install autogen[teachable,lmm,retrievechat,mathchat,blendsearch] autogenra` to install just what you need. `RUN pip install autogen[retrievechat,blendsearch] autogenra`
- **Can't Dev without your favorite CLI tool**: if you need particular OS tools to be installed in your Docker container you can add those packages here right after the sudo for the `./base/Dockerfile` and `./full/Dockerfile` files. In the example below we are installing net-tools and vim to the environment.

```code
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/full/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ WORKDIR /home/autogen-ai

# Install Python packages
RUN pip install --upgrade pip
RUN pip install pyautogen[teachable,lmm,retrievechat,mathchat,blendsearch] autogenra
RUN pip install autogen[teachable,lmm,retrievechat,mathchat,blendsearch] autogenra
RUN pip install numpy pandas matplotlib seaborn scikit-learn requests urllib3 nltk pillow pytest beautifulsoup4

# Expose port
Expand Down
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
<a name="readme-top"></a>

[![PyPI version](https://badge.fury.io/py/pyautogen.svg)](https://badge.fury.io/py/pyautogen)
[![PyPI version](https://badge.fury.io/py/autogen.svg)](https://badge.fury.io/py/autogen)
[![Build](https://github.com/autogen-ai/autogen/actions/workflows/python-package.yml/badge.svg)](https://github.com/autogen-ai/autogen/actions/workflows/python-package.yml)
![Python Version](https://img.shields.io/badge/3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)
[![Downloads](https://static.pepy.tech/badge/pyautogen/month)](https://pepy.tech/project/pyautogen)
[![Discord](https://img.shields.io/discord/1153072414184452236?logo=discord&style=flat)](https://discord.gg/pAbnFJrkgZ)
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social&label=Follow%20%40Chi_Wang_)](https://x.com/Chi_Wang_)

[![NuGet version](https://badge.fury.io/nu/AutoGen.Core.svg)](https://badge.fury.io/nu/AutoGen.Core)

# AutoGen
# [AutoGen](https://github.com/autogen-ai/autogen)

[📚 Cite paper](#related-papers).
<!-- <p align="center">
<img src="https://github.com/autogen-ai/autogen/blob/main/website/static/img/flaml.svg" width=200>
<br>
</p> -->
:fire: :tada: Sep 06, 2024: AutoGen now available as `autogen` on PyPI! We're excited to announce a more convenient package name for AutoGen: Starting with version 0.3.0, you can now install AutoGen using:
```
pip install autogen
```
We extend our sincere gratitude to Simon Mackenzie for generously transferring the `autogen` package name to us.

**Note:** The previous package name `pyautogen` will remain valid for a transitional period. However, we encourage users to switch to the new, more intuitive `autogen` package name, as `pyautogen` will eventually be deprecated.

📄 **License Change:**
With this new release and package name, we are officially switching to the Apache 2.0 license. This enhances our commitment to open-source collaboration while providing additional protections for contributors and users alike.

:fire: Aug 24, 2024: A new organization [autogen-ai](https://github.com/autogen-ai) is created to host the development of AutoGen and related projects with open governance. We invite collaborators from all organizations and individuals.

:tada: May 29, 2024: DeepLearning.ai launched a new short course [AI Agentic Design Patterns with AutoGen](https://www.deeplearning.ai/short-courses/ai-agentic-design-patterns-with-autogen), made in collaboration with Microsoft and Penn State University, and taught by AutoGen creators [Chi Wang](https://github.com/sonichi) and [Qingyun Wu](https://github.com/qingyun-wu).
Expand Down Expand Up @@ -117,14 +128,14 @@ Find detailed instructions for users [here](https://autogen-ai.github.io/autogen
AutoGen requires **Python version >= 3.8, < 3.13**. It can be installed from pip:

```bash
pip install pyautogen
pip install autogen
```

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]"
pip install "autogen[blendsearch]"
``` -->

Find more options in [Installation](https://autogen-ai.github.io/autogen/docs/Installation#option-2-install-autogen-locally-using-virtual-environment).
Expand Down
4 changes: 1 addition & 3 deletions autogen/agentchat/contrib/capabilities/text_compressors.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@
try:
import llmlingua
except ImportError:
IMPORT_ERROR = ImportError(
"LLMLingua is not installed. Please install it with `pip install pyautogen[long-context]`"
)
IMPORT_ERROR = ImportError("LLMLingua is not installed. Please install it with `pip install autogen[long-context]`")
PromptCompressor = object
else:
from llmlingua import PromptCompressor
Expand Down
2 changes: 1 addition & 1 deletion autogen/agentchat/contrib/retrieve_user_proxy_agent.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
try:
import chromadb
except ImportError as e:
raise ImportError(f"{e}. You can try `pip install pyautogen[retrievechat]`, or install `chromadb` manually.")
raise ImportError(f"{e}. You can try `pip install autogen[retrievechat]`, or install `chromadb` manually.")
from autogen.agentchat import UserProxyAgent
from autogen.agentchat.agent import Agent
from autogen.agentchat.contrib.vectordb.base import Document, QueryResults, VectorDB, VectorDBFactory
Expand Down
6 changes: 3 additions & 3 deletions autogen/oai/completion.py
Original file line number Diff line number Diff line change
Expand Up @@ -580,7 +580,7 @@ def eval_func(responses, **data):
tune.ExperimentAnalysis: The tuning results.
"""
logger.warning(
"tuning via Completion.tune is deprecated in pyautogen v0.2 and openai>=1. "
"tuning via Completion.tune is deprecated in autogen, pyautogen v0.2 and openai>=1. "
"flaml.tune supports tuning more generically."
)
if ERROR:
Expand Down Expand Up @@ -792,7 +792,7 @@ def yes_or_no_filter(context, config, response):
- `pass_filter`: whether the response passes the filter function. None if no filter is provided.
"""
logger.warning(
"Completion.create is deprecated in pyautogen v0.2 and openai>=1. "
"Completion.create is deprecated in autogen, pyautogen v0.2 and openai>=1. "
"The new openai requires initiating a client for inference. "
"Please refer to https://autogen-ai.github.io/autogen/docs/Use-Cases/enhanced_inference#api-unification"
)
Expand Down Expand Up @@ -1183,7 +1183,7 @@ def start_logging(
reset_counter (bool): whether to reset the counter of the number of API calls.
"""
logger.warning(
"logging via Completion.start_logging is deprecated in pyautogen v0.2. "
"logging via Completion.start_logging is deprecated in autogen and pyautogen v0.2. "
"logging via OpenAIWrapper will be added back in a future release."
)
if ERROR:
Expand Down
2 changes: 1 addition & 1 deletion autogen/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
#
# Portions derived from https://github.com/microsoft/autogen are under the MIT License.
# SPDX-License-Identifier: MIT
__version__ = "0.3.0b4"
__version__ = "0.3.0"
6 changes: 3 additions & 3 deletions notebook/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ You don't need to explain in depth how to install AutoGen. Unless there are spec
``````
````{=mdx}
:::info Requirements
Install `pyautogen`:
Install `autogen`:
```bash
pip install pyautogen
pip install autogen
```

For more information, please refer to the [installation guide](/docs/installation/).
Expand All @@ -54,7 +54,7 @@ Or if extras are needed:
Some extra dependencies are needed for this notebook, which can be installed via pip:

```bash
pip install pyautogen[retrievechat] flaml[automl]
pip install autogen[retrievechat] flaml[automl]
```

For more information, please refer to the [installation guide](/docs/installation/).
Expand Down
4 changes: 2 additions & 2 deletions website/blog/2023-10-18-RetrieveChat/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ The conversation terminates if no more documents are available for the context.
## Basic Usage of RAG Agents
0. Install dependencies

Please install pyautogen with the [retrievechat] option before using RAG agents.
Please install autogen with the [retrievechat] option before using RAG agents.
```bash
pip install "pyautogen[retrievechat]"
pip install "autogen[retrievechat]"
```

RetrieveChat can handle various types of documents. By default, it can process
Expand Down
4 changes: 2 additions & 2 deletions website/blog/2023-10-26-TeachableAgent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ AutoGen contains four code examples that use `Teachability`.

1. Install dependencies

Please install pyautogen with the [teachable] option before using `Teachability`.
Please install autogen with the [teachable] option before using `Teachability`.

```bash
pip install "pyautogen[teachable]"
pip install "autogen[teachable]"
```

2. Import agents
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2023-11-06-LMM-Agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ GPT-4V represents the forefront in image comprehension, while LLaVA is an effici
Incorporate the `lmm` feature during AutoGen installation:

```bash
pip install "pyautogen[lmm]"
pip install "autogen[lmm]"
```

Subsequently, import the **Multimodal Conversable Agent** or **LLaVA Agent** from AutoGen:
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2023-11-13-OAI-assistants/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This integration shows great potential and synergy, and we plan to continue enha
## Installation

```bash
pip install pyautogen==0.2.0b5
pip install autogen
```

## Basic Example
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2023-11-26-Agent-AutoBuild/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ up an endpoint server automatically without any user participation.
## Installation
- AutoGen:
```bash
pip install pyautogen[autobuild]
pip install autogen[autobuild]
```
- (Optional: if you want to use open-source LLMs) vLLM and FastChat
```bash
Expand Down
2 changes: 1 addition & 1 deletion website/blog/2024-03-03-AutoGen-Update/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ These tools have been used for improving the AutoGen library as well as applicat
We are making rapid progress in further improving the interface to make it even easier to build agent applications. For example:

- [AutoBuild](/blog/2023/11/26/Agent-AutoBuild). AutoBuild is an ongoing area of research to automatically create or select a group of agents for a given task and objective. If successful, it will greatly reduce the effort from users or developers when using the multi-agent technology. It also paves the way for agentic decomposition to handle complex tasks. It is available as an experimental feature and demonstrated in two modes: free-form [creation](https://github.com/microsoft/autogen/blob/main/notebook/autobuild_basic.ipynb) and [selection](https://github.com/microsoft/autogen/blob/main/notebook/autobuild_agent_library.ipynb) from a library.
- [AutoGen Studio](/blog/2023/12/01/AutoGenStudio). AutoGen Studio is a no-code UI for fast experimentation with the multi-agent conversations. It lowers the barrier of entrance to the AutoGen technology. Models, agents, and workflows can all be configured without writing code. And chatting with multiple agents in a playground is immediately available after the configuration. Although only a subset of `pyautogen` features are available in this sample app, it demonstrates a promising experience. It has generated tremendous excitement in the community.
- [AutoGen Studio](/blog/2023/12/01/AutoGenStudio). AutoGen Studio is a no-code UI for fast experimentation with the multi-agent conversations. It lowers the barrier of entrance to the AutoGen technology. Models, agents, and workflows can all be configured without writing code. And chatting with multiple agents in a playground is immediately available after the configuration. Although only a subset of `autogen` features are available in this sample app, it demonstrates a promising experience. It has generated tremendous excitement in the community.
- Conversation Programming+. The [AutoGen paper](https://arxiv.org/abs/2308.08155) introduced a key concept of _Conversation Programming_, which can be used to program diverse conversation patterns such as 1-1 chat, group chat, hierarchical chat, nested chat etc. While we offered dynamic group chat as an example of high-level orchestration, it made other patterns relatively less discoverable. Therefore, we have added more convenient conversation programming features which enables easier definition of other types of complex workflow, such as [finite state machine based group chat](/blog/2024/02/11/FSM-GroupChat), [sequential chats](/docs/notebooks/agentchats_sequential_chats), and [nested chats](/docs/notebooks/agentchat_nestedchat). Many users have found them useful in implementing specific patterns, which have been always possible but more obvious with the added features. I will write another blog post for a deep dive.

### Learning/Optimization/Teaching
Expand Down
8 changes: 4 additions & 4 deletions website/blog/2024-06-24-AltModels-Classes/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ Now it's time to try them out.
Install the appropriate client based on the model you wish to use.

```sh
pip install pyautogen["mistral"] # for Mistral AI client
pip install pyautogen["anthropic"] # for Anthropic client
pip install pyautogen["together"] # for Together.AI client
pip install pyautogen["groq"] # for Groq client
pip install autogen["mistral"] # for Mistral AI client
pip install autogen["anthropic"] # for Anthropic client
pip install autogen["together"] # for Together.AI client
pip install autogen["groq"] # for Groq client
```

### Configuration Setup
Expand Down
6 changes: 3 additions & 3 deletions website/docs/FAQ.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import TOCInline from "@theme/TOCInline";

<TOCInline toc={toc} />

## Install the correct package - `pyautogen`
## Install the correct package - `autogen`

The name of Autogen package at PyPI is `pyautogen`:
The name of Autogen package at PyPI is `autogen`:

```
pip install pyautogen
pip install autogen
```

Typical errors that you might face when using the wrong package are `AttributeError: module 'autogen' has no attribute 'Agent'`, `AttributeError: module 'autogen' has no attribute 'config_list_from_json'` etc.
Expand Down
4 changes: 2 additions & 2 deletions website/docs/Getting-Started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Microsoft, Penn State University, and University of Washington.
### Quickstart

```sh
pip install pyautogen
pip install autogen
```
:::tip
You can also install with different [optional dependencies](/docs/installation/Optional-Dependencies).
Expand Down Expand Up @@ -135,7 +135,7 @@ The figure below shows an example conversation flow with AutoGen.
- Read the [API](/docs/reference/agentchat/conversable_agent/) docs
- Learn about [research](/docs/Research) around AutoGen
- Chat on [Discord](https://aka.ms/autogen-dc)
- Follow on [Twitter](https://twitter.com/pyautogen)
- Follow on [Twitter](https://twitter.com/Chi_Wang_)
- See our [roadmaps](https://aka.ms/autogen-roadmap)

If you like our project, please give it a [star](https://github.com/autogen-ai/autogen/stargazers) on GitHub. If you are interested in contributing, please read [Contributor's Guide](/docs/contributor-guide/contributing).
Expand Down
14 changes: 7 additions & 7 deletions website/docs/installation/Installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ When installing AutoGen locally, we recommend using a virtual environment for th
Create and activate:

```bash
python3 -m venv pyautogen
source pyautogen/bin/activate
python3 -m venv autogen
source autogen/bin/activate
```

To deactivate later, run:
Expand All @@ -32,8 +32,8 @@ When installing AutoGen locally, we recommend using a virtual environment for th
Create and activate:

```bash
conda create -n pyautogen python=3.10
conda activate pyautogen
conda create -n autogen python=3.10
conda activate autogen
```

To deactivate later, run:
Expand All @@ -52,7 +52,7 @@ When installing AutoGen locally, we recommend using a virtual environment for th
poetry init
poetry shell

poetry add pyautogen
poetry add autogen
```

To deactivate later, run:
Expand All @@ -69,12 +69,12 @@ When installing AutoGen locally, we recommend using a virtual environment for th
AutoGen requires **Python version >= 3.8, < 3.13**. It can be installed from pip:

```bash
pip install pyautogen
pip install autogen
```

:::info

`pyautogen<0.2` required `openai<1`. Starting from pyautogen v0.2, `openai>=1` is required.
`openai>=1` is required.

:::

Expand Down
Loading
Loading