OASIS 项目使用教程

OASIS 项目使用教程

oasis 🏝️ OASIS: Open Agent Social Interaction Simulations with One Million Agents. https://oasis.camel-ai.org 项目地址: https://gitcode.com/gh_mirrors/oasis2/oasis

1. 项目目录结构及介绍

OASIS 项目是一个开源的社会媒体模拟器，其目录结构如下：

oasis/
├── .github/
│   └── workflows/
├── assets/
├── data/
├── generator/
├── licenses/
├── log/
├── oasis/
├── scripts/
│   ├── reddit_gpt_example/
│   │   ├── gpt_example.yaml
│   │   └── reddit_simulation_gpt.py
│   ├── reddit_emall_demo/
│   │   ├── emall.yaml
│   │   └── emall_simulation.py
│   └── twitter_gpt_example/
│       ├── gpt_example.yaml
│       └── twitter_simulation_large.py
├── test/
├── tutorials/
├── visualization/
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE
├── README.md
├── deploy.py
├── poetry.lock
├── pyproject.toml

• .github/workflows/: 存放 GitHub Actions 工作流的配置文件。
• assets/: 存储项目所需的静态资源。
• data/: 包含模拟所需的数据文件。
• generator/: 可能包含用于生成模拟数据的脚本或代码。
• licenses/: 存放项目使用的各种许可证文件。
• log/: 记录项目的日志文件。
• oasis/: 核心代码库，包含模拟器的主体逻辑。
• scripts/: 包含启动和配置模拟的脚本。
• test/: 测试代码和测试用例。
• tutorials/: 教程和文档。
• visualization/: 可视化相关的代码和资源。
• .gitignore: 指定 Git 忽略的文件。
• .pre-commit-config.yaml: pre-commit 插件配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• deploy.py: 部署脚本。
• poetry.lock 和 pyproject.toml: Python 项目依赖管理和构建配置。

2. 项目的启动文件介绍

项目的启动文件位于 scripts/ 目录下，根据不同的模拟需求有不同的启动脚本：

• reddit_simulation_gpt.py: 启动 Reddit 模拟的主要脚本。
• emall_simulation.py: 启动 Reddit 结合电子商务平台模拟的脚本。
• twitter_simulation_large.py: 启动 Twitter 模拟的主要脚本。

使用这些脚本之前，需要确保环境变量和配置文件正确设置。

3. 项目的配置文件介绍

配置文件位于 scripts/ 目录下的相关示例目录中，主要包括：

• gpt_example.yaml: Reddit 和 Twitter 模拟的配置文件，定义了模拟参数、数据路径等。
• emall.yaml: 电子商务平台模拟的配置文件。

配置文件使用 YAML 格式，包含了模拟所需的各项参数，例如代理人的行为、环境设置、API 密钥等。在使用前，需要根据实际情况调整配置文件中的参数。

oasis 🏝️ OASIS: Open Agent Social Interaction Simulations with One Million Agents. https://oasis.camel-ai.org 项目地址: https://gitcode.com/gh_mirrors/oasis2/oasis