OASIS 使用教程

1. 项目介绍

OASIS（Open Agent Social Interaction Simulations with One Million Agents）是一个可扩展的、开源的社交媒体模拟器。它集成了大型语言模型和基于规则的代理，以模拟高达一百万用户在类似Twitter和Reddit等平台上的行为。该项目旨在促进对复杂社会现象的研究，如信息传播、群体极化和羊群行为，提供了一个探索数字环境中多种社会动态和用户互动的多样化工具。

2. 项目快速启动

克隆仓库

首先，你需要克隆OASIS的GitHub仓库：

git clone https://github.com/camel-ai/oasis.git
cd oasis

创建并激活虚拟环境

接下来，创建并激活一个Python虚拟环境。以下是三种常见的方法：

方法1：使用Conda（适用于Linux、macOS和Windows）

conda create --name oasis python=3.10
conda activate oasis

方法2：使用venv（适用于Linux和macOS）

python -m venv oasis-venv
source oasis-venv/bin/activate

方法3：使用venv（适用于Windows）

python -m venv oasis-venv
oasis-venv\Scripts\activate

安装必要依赖

在虚拟环境中安装必要的Python包：

pip install --upgrade pip setuptools
pip install -e .

设置环境变量

在运行模拟之前，你需要设置你的OpenAI API密钥和环境变量。以下是如何在不同操作系统和shell中设置它们的示例：

对于Bash壳（Linux、macOS、Windows上的Git Bash）：

export OPENAI_API_KEY=<你的OpenAI API密钥>
export OPENAI_API_BASE_URL=<你的OpenAI API基础URL>

对于Windows命令提示符：

set OPENAI_API_KEY=<你的OpenAI API密钥>
set OPENAI_API_BASE_URL=<你的OpenAI API基础URL>

对于Windows PowerShell：

$env:OPENAI_API_KEY="<你的OpenAI API密钥>"
$env:OPENAI_API_BASE_URL="<你的OpenAI API基础URL>"

请替换<你的OpenAI API密钥>和<你的OpenAI API基础URL>为你实际的API密钥和基础URL。

运行主程序

根据你的需求，选择以下命令之一来运行模拟：

对于Reddit模拟

python scripts/reddit_gpt_example/reddit_simulation_gpt.py --config_path scripts/reddit_gpt_example/gpt_example.yaml

对于Reddit与电子商城结合的模拟

python scripts/reddit_emall_demo/emall_simulation.py --config_path scripts/reddit_emall_demo/emall.yaml

对于Twitter模拟

python scripts/twitter_gpt_example/twitter_simulation_large.py --config_path scripts/twitter_gpt_example/gpt_example.yaml

3. 应用案例和最佳实践

在这一部分，我们将介绍如何使用OASIS进行一些常见的社会媒体模拟案例，以及一些最佳实践。

• 案例1：模拟信息传播 - 使用OASIS可以模拟信息在社交媒体上的传播方式，分析不同因素（如用户行为、网络结构等）对信息传播效率的影响。
• 最佳实践 - 为了获得更准确的模拟结果，建议在模拟前对模型进行充分的训练，并根据实际情况调整参数。

4. 典型生态项目

OASIS是骆驼AI生态系统中的一个重要项目，以下是几个与OASIS相互配合的典型生态项目：

• CamelDB - 一个用于大规模数据存储和查询的数据库系统，可以与OASIS集成，存储模拟产生的大量数据。
• CamelAI - 一个AI平台，提供了多种机器学习和深度学习模型，可以用于分析OASIS模拟生成的数据。

通过这些项目的协同工作，可以更全面地研究社交媒体的复杂动态。