AgentSims 项目使用教程

1. 项目目录结构及介绍

AgentSims 项目的目录结构如下：

AgentSims/
├── app.py
├── base.py
├── client.py
├── config.py
├── logs/
├── model/
├── utils/
├── gitignore
├── LICENSE
├── README.md
├── requirements.txt
├── restart.sh
├── tick.py
└── mayor.py

目录结构介绍

• app.py: 项目的启动文件，负责初始化和启动整个系统。
• base.py: 基础模块，包含一些通用的基础类和函数。
• client.py: 客户端模块，负责与用户交互的前端逻辑。
• config.py: 配置模块，包含项目的配置信息。
• logs/: 日志文件夹，存储系统运行时的日志文件。
• model/: 模型文件夹，存储项目中使用的各种模型文件。
• utils/: 工具模块，包含一些通用的工具函数。
• gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，包含项目的简介、安装和使用说明等。
• requirements.txt: 项目依赖文件，列出了项目运行所需的 Python 包。
• restart.sh: 重启脚本，用于重启整个系统。
• tick.py: 系统定时任务模块，负责定时执行某些任务。
• mayor.py: 系统管理模块，负责系统的管理和监控。

2. 项目启动文件介绍

app.py

app.py 是 AgentSims 项目的启动文件，负责初始化和启动整个系统。以下是 app.py 的主要功能：

• 初始化配置: 读取并加载项目的配置文件。
• 启动服务器: 启动 Tornado 服务器，监听指定的端口。
• 加载模型: 加载项目中使用的各种模型。
• 启动定时任务: 启动定时任务模块 tick.py。

启动命令

python app.py

3. 项目配置文件介绍

config.py

config.py 是 AgentSims 项目的配置文件，包含项目的各种配置信息。以下是 config.py 的主要配置项：

• 数据库配置: 配置 MySQL 数据库的连接信息。
• API 密钥: 配置 OpenAI 等 API 的密钥。
• 日志配置: 配置日志文件的路径和日志级别。
• 定时任务配置: 配置定时任务的执行频率和冷却时间。

配置示例

# config.py

# 数据库配置
DATABASE = {
    'host': 'localhost',
    'user': 'root',
    'password': '',
    'database': 'llm_account'
}

# API 密钥
API_KEYS = {
    'gpt-4': 'xxxx',
    'gpt-3.5': 'xxxx'
}

# 日志配置
LOGGING = {
    'path': 'logs/app.log',
    'level': 'DEBUG'
}

# 定时任务配置
TICK_CONFIG = {
    'count_limit': 100,
    'cooldown': 60
}

通过以上配置文件，可以灵活地调整项目的运行参数，以适应不同的环境和需求。