🤖 AgentVerse 🪐

【论文】

【英文 | 中文】

AgentVerse 旨在促进多种基于大模型的智能体在不同应用场景中的部署。AgentVerse 主要提供两种框架：任务解决和仿真。

• 任务解决：该框架将多个智能体组合成一个自动化的多智能体系统（AgentVerse-Tasksolving, 多智能体系统)，协同完成相应任务。
  应用：软件开发系统、咨询系统等。

• 仿真：该框架允许用户设置自定义环境，以观察或与多个智能体进行交互。⚠️⚠️⚠️ 我们正在重构代码。如果您需要仅支持仿真框架的稳定版本，可以使用 release-0.1 分支。应用：游戏、基于大模型的智能体社会行为研究等。

---

📰 最新动态

• [2024年3月17日] AgentVerse 被 NVIDIA 博客介绍——构建您的第一个大模型智能体应用。

• [2024年1月17日] 我们非常激动地宣布，我们的论文已被 ICLR 2024 接受。更多更新即将发布！

• [2023年10月17日] 我们很高兴地分享我们的开源 AI 社区 Hugging Face 页面：AgentVerse。您可以通过自己的 OpenAI API 密钥和组织信息，试用两个仿真应用：NLP 教室和囚徒困境。尽情体验吧！

• [2023年10月5日] 我们重新架构了代码库，以支持仿真和任务解决两大框架！我们已将论文中提到的 Minecraft 示例代码放置在 minecraft 分支中。我们的工具使用示例也将很快更新到 main 分支。敬请期待！

• [2023年8月22日] 我们很高兴地分享论文 AgentVerse：促进多智能体协作并探索智能体的涌现行为，详细阐述了 AgentVerse 的任务解决框架。

• [2023年6月5日] 我们非常高兴地展示了多组【演示视频】，包括【NLP 教室】、【囚徒困境】、【软件设计】、【数据库管理员】以及一个简单的【H5 宝可梦游戏】，让您能够与宝可梦角色互动！快来试试这些演示，享受乐趣吧！

• [2023年5月1日] 🚀 【AgentVerse】（https://github.com/OpenBMB/AgentVerse）正式上线！

🗓 即将到来

• 发布我们【论文】（https://arxiv.org/abs/2308.10848）的代码
• 增加对本地大模型（LLaMA、Vicuna 等）的支持
• 添加文档
• 支持更复杂的对话历史记忆

目录

• 📰 最新动态
• 🗓 即将推出
• 目录
• 🚀 入门指南
  • 安装
  • 环境变量
  • 仿真
    • 框架所需模块
    • CLI 示例
    • GUI 示例
  • 任务求解
    • 框架所需模块
    • CLI 示例
  • 本地模型支持
  • vLLM 支持
  • FSChat 支持
    • 1. 安装额外依赖
    • 2. 启动本地服务器
    • 3. 修改配置文件
• AgentVerse 展示
  • 仿真展示
  • 任务求解展示
• 🌟 加入我们！
  • 领导者
  • 贡献者
  • 如何贡献？
  • 社交媒体与社区
• Star 历史
  • 引用
• 联系方式

🚀 入门指南

安装

手动安装（推荐！）

请确保您已安装 Python >= 3.9

git clone https://github.com/OpenBMB/AgentVerse.git --depth 1
cd AgentVerse
pip install -e .

如果您希望使用 AgentVerse 运行本地模型，例如 LLaMA，还需要额外安装一些依赖：

pip install -r requirements_local.txt

通过 pip 安装

或者您也可以通过 pip 安装：

pip install -U agentverse

环境变量

您需要按照以下方式导出您的 OpenAI API 密钥：

# 导出您的 OpenAI API 密钥
export OPENAI_API_KEY="your_api_key_here"

如果您想使用 Azure OpenAI 服务，请按照如下方式导出您的 Azure OpenAI 密钥和 OpenAI API 基础地址：

export AZURE_OPENAI_API_KEY="your_api_key_here"
export AZURE_OPENAI_API_BASE="your_api_base_here"

仿真

脚本所需模块

- agentverse 
  - agents
    - simulation_agent
  - environments
    - simulation_env

CLI 示例

您可以创建我们提供的多智能体环境。以课堂场景为例，在这个场景中，有九个智能体，其中一位扮演教授，另外八位扮演学生。

agentverse-simulation --task simulation/nlp_classroom_9players

GUI 示例

我们还为该环境提供了一个本地网站演示。您可以通过以下命令启动它：

agentverse-simulation-gui --task simulation/nlp_classroom_9players

成功启动本地服务器后，您可以访问 http://127.0.0.1:7860/ 查看课堂环境。

如果您想运行带有工具的仿真案例（例如 simulation/nlp_classroom_3players_withtool），则需要按照如下步骤安装 BMTools：

git clone git+https://github.com/OpenBMB/BMTools.git
cd BMTools
pip install -r requirements.txt
python setup.py develop

这是可选的。如果您不安装 BMTools，没有工具的仿真案例仍然可以正常运行。

任务求解

框架所需模块

- agentverse 
  - agents
    - simulation_env
  - environments
    - tasksolving_env

CLI 示例

要运行我们在 论文 中提出的任务求解环境中的实验，您可以使用以下命令：

要在基准数据集上运行 AgentVerse，您可以尝试：

# 使用 gpt-3.5-turbo 运行 Humaneval 基准测试（配置文件 `agentverse/tasks/tasksolving/humaneval/gpt-3.5/config.yaml`）
agentverse-benchmark --task tasksolving/humaneval/gpt-3.5 --dataset_path data/humaneval/test.jsonl --overwrite

要针对特定问题运行 AgentVerse，您可以尝试：

# 运行单个查询（配置文件 `agentverse/tasks/tasksolving/brainstorming/gpt-3.5/config.yaml`）。任务在配置文件中指定。
agentverse-tasksolving --task tasksolving/brainstorming

要运行我们论文中提到的使用工具的案例，即多智能体使用网络浏览器、Jupyter Notebook、必应搜索等工具解决问题时，您可以先构建由 XAgent 提供的 ToolsServer。您可以按照他们的说明来构建并运行 ToolServer。

构建并启动 ToolServer 后，您可以使用以下命令运行带工具的任务求解案例：

agentverse-tasksolving --task tasksolving/tool_using/24point

我们在 agentverse/tasks/tasksolving/tool_using/ 中提供了更多任务，展示了多智能体如何利用工具解决问题。

此外，您还可以查看 agentverse/tasks/tasksolving，了解我们在论文中进行的更多实验。

本地模型支持

vLLM 支持

如果您想使用 vLLM，请按照此处的指南安装并设置 vLLM 服务器，用于处理更大的推理工作负载。创建以下环境变量以连接到 vLLM 服务器：

export VLLM_API_KEY="your_api_key_here"
export VLLM_API_BASE="http://your_vllm_url_here"

然后修改任务配置文件中的 model 字段，使其与 vLLM 服务器中的模型名称一致。例如：

model_type: vllm
model: llama-2-7b-chat-hf

FSChat 支持

本节提供将 FSChat 集成到 AgentVerse 的分步指南。FSChat 是一个支持本地模型（如 LLaMA、Vicunna 等）在本地机器上运行的框架。

1. 安装额外依赖

如果您想使用 LLaMA 等本地模型，还需要额外安装一些依赖：

pip install -r requirements_local.txt

2. 启动本地服务器

然后根据您的需求修改 MODEL_PATH 和 MODEL_NAME，使用以下命令启动本地服务器：

bash scripts/run_local_model_server.sh

该脚本将启动一个服务于 Llama 7B 对话模型的服务。 目前，AgentVerse 中的 MODEL_NAME 支持多种模型，包括 llama-2-7b-chat-hf、llama-2-13b-chat-hf、llama-2-70b-chat-hf、vicuna-7b-v1.5 和 vicuna-13b-v1.5。如果您希望集成其他与 FastChat 兼容的模型（详见 FastChat 的模型支持文档），则需要：

1. 将新的 MODEL_NAME 添加到 agentverse/llms/__init__.py 文件中的 LOCAL_LLMS 列表中。此外，还需建立
2. 在 agentverse/llms/__init__.py 文件中的 LOCAL_LLMS_MAPPING 中添加新 MODEL_NAME 与其对应的 HuggingFace 标识符之间的映射关系。

3. 修改配置文件

在你的配置文件中，将 llm_type 设置为 local，并将 model 设置为 MODEL_NAME。例如：

llm:
  llm_type: local
  model: llama-2-7b-chat-hf
  ...

你可以参考 agentverse/tasks/tasksolving/commongen/llama-2-7b-chat-hf/config.yaml 获取更详细的示例。

AgentVerse 展示案例

模拟展示案例

请参阅 模拟展示案例

任务解决展示案例

请参阅 任务解决展示案例

🌟 加入我们！

AgentVerse 的使命是彻底革新大型语言模型的多智能体环境，我们热切期待充满热情的合作者加入我们，共同开启这段激动人心的旅程。

领导团队

贡献者

你能如何贡献？

• 提交问题与拉取请求：如果您在使用 AgentVerse 时遇到任何问题，欢迎用英文提交问题。此外，您也可以主动联系我们，将问题分配给您，并在解决问题后提交拉取请求（请遵循 PULL_REQUEST_TEMPLATE）。

• 代码开发：如果您是一名工程师，请帮助我们完善、优化和扩展当前的框架。我们始终欢迎有才华的开发者加入，共同增强现有功能并开发新模块。

• 文档与教程：如果您擅长写作，欢迎您协助改进我们的文档、编写教程或撰写博客文章，使 AgentVerse 对更广泛的社区更加友好易用。

• 应用探索：如果您对多智能体应用充满兴趣，并渴望使用 AgentVerse 进行实验，我们将非常乐意支持您的探索之旅，期待看到您的成果！

• 反馈与建议：请积极使用 AgentVerse，并向我们提供反馈。您的宝贵意见将有助于我们不断改进，确保框架始终保持行业领先水平。

此外，如果您热衷于推动多智能体应用领域的前沿发展，希望成为 AgentVerse 核心团队成员，或渴望深入研究智能体相关技术，请随时联系 AgentVerse 团队，并抄送 陈伟泽 和 苏宇生。我们诚挚地欢迎像您这样充满热情的伙伴加入我们的团队！

社交媒体与社区

• Twitter: https://twitter.com/Agentverse71134

• Discord: https://discord.gg/gDAXfjMw。

• Hugging Face: https://huggingface.co/spaces/AgentVerse/agentVerse。

星标历史

引用

如果您觉得本仓库对您有所帮助，欢迎引用我们：

@article{chen2023agentverse,
  title={Agentverse: Facilitating multi-agent collaboration and exploring emergent behaviors in agents},
  author={Chen, Weize and Su, Yusheng and Zuo, Jingwei and Yang, Cheng and Yuan, Chenfei and Qian, Chen and Chan, Chi-Min and Qin, Yujia and Lu, Yaxi and Xie, Ruobing and others},
  journal={arXiv preprint arXiv:2308.10848},
  year={2023}
}

联系方式

AgentVerse 团队：agentverse2@gmail.com

项目负责人：

• 陈伟泽：chenweize1998@gmail.com

• 苏宇生：yushengsu.thu@gmail.com

AgentVerse 快速上手指南

AgentVerse 是一个旨在促进基于大语言模型（LLM）的多智能体在各种应用中部署的框架。它主要提供两种核心框架：任务求解（Task-solving）（多智能体协作解决问题）和仿真（Simulation）（构建环境观察智能体行为或与之交互）。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: Linux, macOS 或 Windows
• Python 版本: 3.9 或更高版本 (推荐 3.9+)
• 依赖管理: pip
• API Key: 如果您使用 OpenAI 等云端模型，需准备好 API Key 和组织 ID；若使用本地模型，需预留足够的显存。

2. 安装步骤

克隆项目

首先从 GitHub 克隆仓库：

git clone https://github.com/OpenBMB/AgentVerse.git
cd AgentVerse

安装依赖

建议使用虚拟环境进行安装。

标准安装（使用 pip）：

pip install -r requirements.txt

国内加速建议：如果下载速度较慢，可以使用国内镜像源加速安装：

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

可选：安装额外依赖 如果您计划使用本地模型（如 LLaMA, Vicuna）或通过 FastChat/vLLM 部署，可能需要安装额外的依赖包（具体参考项目根目录下的可选 requirement 文件或后续本地模型支持章节）。

3. 基本使用

AgentVerse 支持通过命令行（CLI）或图形界面（GUI）运行示例。使用前请配置环境变量。

3.1 配置环境变量

设置您的 OpenAI API 密钥（如果使用云端模型）：

export OPENAI_API_KEY="your-api-key"
export OPENAI_ORGANIZATION="your-organization-id" # 可选

(Windows PowerShell 用户请使用 $env:OPENAI_API_KEY="your-api-key")

3.2 运行仿真示例 (Simulation)

仿真框架允许您观察多个智能体在自定义环境中的行为。

命令行模式 (CLI): 运行“囚徒困境”示例：

python agentverse_command/main_simulation_cli.py --task simulation/prisoner_dilemma

图形界面模式 (GUI): 运行"NLP 课堂”示例，可视化观察教授与学生的互动：

python agentverse_command/main_simulation_gui.py --task simulation/nlp_classroom_9players

3.3 运行任务求解示例 (Task-solving)

任务求解框架将多个智能体组装成系统以协作完成任务（如软件开发、数据库诊断）。

命令行模式 (CLI): 运行软件开发团队示例（包含代码编写者、测试者和审查者）：

python agentverse_command/main_task_cli.py --task tasksolving/sde_team

3.4 本地模型支持 (Local Model)

AgentVerse 支持接入本地部署的大模型（如通过 FastChat 或 vLLM）。

1. 启动本地服务 (以 FastChat 为例):

   python -m fastchat.serve.controller
   python -m fastchat.serve.model_worker --model-path <your-model-path>
   python -m fastchat.serve.openai_api_server --host localhost --port 8000
   

2. 修改配置文件: 在对应的任务配置文件（通常位于 agentverse/configs/ 下）中，将 model_name 修改为您的本地模型名称，并将 api_base 指向本地服务地址（例如 http://localhost:8000/v1）。

3. 运行命令: 使用与上述相同的命令运行任务，系统将自动连接到本地 API 服务器。

---

注：部分高级功能（如 Minecraft 示例或旧版 H5 Pokemon 游戏）可能位于特定的分支（如 release-0.1 或 minecraft），如需体验请切换至对应分支。当前主分支专注于重构后的通用仿真与任务求解框架。