CAMEL项目安装与使用教程

CAMEL项目安装与使用教程

camel 🐫 CAMEL: Communicative Agents for “Mind” Exploration of Large Language Model Society (NeruIPS'2023) https://www.camel-ai.org 项目地址: https://gitcode.com/gh_mirrors/cam/camel

1. 项目介绍

CAMEL（Communicative Agents for “Mind” Exploration of Large Language Model Society）是一个开源库，旨在研究自主和通信代理。该项目通过构建可扩展的技术，促进通信代理之间的自主合作，并深入了解它们的“认知”过程。CAMEL提供了一个角色扮演的通信代理框架，使用启发式提示引导聊天代理完成任务，同时保持与人类意图的一致性。

2. 项目快速启动

安装

从PyPI安装

# 安装基础库
pip install camel-ai

# 安装所有依赖
pip install 'camel-ai[all]'

# 安装HuggingFace代理
pip install 'camel-ai[huggingface-agent]'

# 启用RAG或使用代理内存
pip install 'camel-ai[tools]'

从源码安装（推荐）

# 确保Python版本大于3.10
# 克隆GitHub仓库
git clone https://github.com/camel-ai/camel.git
cd camel

# 安装poetry（如果未安装）
pip install poetry

# 使用Python 3.10
poetry env use python3.10
poetry shell

# 安装基础库
poetry install

# 安装所有依赖
poetry install -E all

# 退出虚拟环境
exit

使用Docker

详细指南请参考官方文档。

快速示例

设置OpenAI API密钥

# 对于Bash shell (Linux, macOS, Git Bash on Windows)
export OPENAI_API_KEY=<your_openai_api_key>
export OPENAI_API_BASE_URL=<your_openai_api_base_url>

# 对于Windows命令提示符
set OPENAI_API_KEY=<your_openai_api_key>
set OPENAI_API_BASE_URL=<your_openai_api_base_url>

# 对于Windows PowerShell
$env:OPENAI_API_KEY="<your_openai_api_key>"
$env:OPENAI_API_BASE_URL="<your_openai_api_base_url>"

运行角色扮演脚本

# 运行示例脚本
python examples/ai_society/role_playing.py

3. 应用案例和最佳实践

应用案例

• 聊天代理协作：CAMEL可以用于研究多个聊天代理如何协作完成任务。例如，一个Python程序员和一个股票交易员角色协作开发一个股票市场交易机器人。
• 数据生成：通过角色扮演生成对话数据，用于研究聊天代理的行为和能力。

最佳实践

• 环境配置：确保所有依赖正确安装，并配置好API密钥。
• 任务设计：设计明确的任务和角色，以便更好地观察代理的协作效果。
• 结果分析：详细记录和分析代理的对话过程，以获取有价值的洞察。

4. 典型生态项目

• HuggingFace：提供多种预训练模型，可与CAMEL结合使用，增强代理的能力。
• OpenAI：CAMEL支持使用OpenAI的API，利用其强大的语言模型进行实验。
• Ollama：可用于本地部署Llama 3模型，与CAMEL集成，提供更多模型选择。

通过以上步骤和指南，您可以快速上手CAMEL项目，进行自主和通信代理的研究。更多详细文档和示例请参考官方GitHub仓库。

camel 🐫 CAMEL: Communicative Agents for “Mind” Exploration of Large Language Model Society (NeruIPS'2023) https://www.camel-ai.org 项目地址: https://gitcode.com/gh_mirrors/cam/camel