https://github.com/ulab-uiuc/research-town
[ICML 2025] ResearchTown: Simulator of Human Research Community
https://github.com/ulab-uiuc/research-town
automatic-scientific-discovery multi-agent-simulation research-agent
Last synced: 7 months ago
JSON representation
[ICML 2025] ResearchTown: Simulator of Human Research Community
- Host: GitHub
- URL: https://github.com/ulab-uiuc/research-town
- Owner: ulab-uiuc
- License: apache-2.0
- Created: 2024-05-02T04:30:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-31T23:05:24.000Z (7 months ago)
- Last Synced: 2025-08-04T03:10:04.124Z (7 months ago)
- Topics: automatic-scientific-discovery, multi-agent-simulation, research-agent
- Language: Python
- Homepage:
- Size: 146 MB
- Stars: 168
- Watchers: 2
- Forks: 21
- Open Issues: 28
-
Metadata Files:
- Readme: README-CN.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Research Town: Simulator of Research Community
[](https://www.python.org/downloads/release/python-3109/)
[](https://github.com/hiyouga/LLaMA-Factory/pulls)
[](https://github.com/ulab-uiuc/research-town)
[](https://discord.gg/TwXxGhMB)
[](assets/wechat.png)
[](https://codecov.io/github/ulab-uiuc/research-town)
[English](README.md) | [中文](README-CN.md)
## 简介
**Research Town** 是一个多智能体平台并实现基于社区环境的模拟，并定义了以下内容：
1. 🤖 *撰写者*：智能体具备阅读、撰写论文，讨论、反驳以及撰写评审的能力。
2. 🎩 *环境*：多智能体环境模拟虚拟的学习室，协作完成任务，讨论想法、撰写反驳并完成论文。
3. ⚙️ *驱动引擎*：我们定义了有限状态机(Finite-state Machines)，管理智能体在不同环境中的参与情况，决定任务完成后的下一步操作。引导智能体从想法讨论环境一步一步论文撰写环境，并帮助选择合适的智能体协作完成任务。
如果认为论文或者代码有价值，请考虑引用我们的工作：
```bibtex
@article{yu2024researchtown,
title={ResearchTown: Simulator of Human Research Community},
author={Yu, Haofei and Hong, Zhaochen and Cheng, Zirui and Zhu, Kunlun and Xuan, Keyang and Yao, Jinwei and Feng, Tao and You, Jiaxuan},
journal={arXiv preprint arXiv:2412.17767},
year={2024}
}
```
## 快速开始
### 使用 pip 安装
通过 `pypi` 安装 `research-town` ：
```bash
pip install research-town
```
### 虚拟环境安装
```bash
conda create -n research-town python=3.10
conda activate research-town
curl -sSL https://install.python-poetry.org | python3
```
### 配置环境变量
例如 `OPENAI_API_KEY` 和与数据库相关的配置。推荐的设置方法如下：
1. 将 `.env.template` 文件复制到项目根目录，并命名为 `.env`。
```bash
cp .env.template .env
```
2. 在 `.env` 文件中填写所需的环境变量。
### 运行示例
运行 `examples` 中提供的示例：
```bash
poetry install
cd examples
python research_town_demo.py
```
## 开发
### Demo
开发 Demo（包括前端和后端）：
设置 `DATABASE_FOLDER_PATH=./sample_data` 在 .env 文件中，然后运行：
```bash
cd frontend
npm install
npm start
```
```bash
poetry install -E backend
uvicorn backend.app.main:app --reload
```
### 安装开发选项
按照上面的安装步骤，然后执行以下命令代替运行 python -m pip install -e .：
```
python -m pip install -e ".[dev]"
mypy --install-types --non-interactive research_town
python -m pip install pre-commit
pre-commit install
```
安装 pre-commit 可避免代码格式错误和大文件被提交到 GitHub。
#### 为每个功能创建新分支
使用 `git checkout -b feature/feature-name` 创建新分支，并向 main 分支提交 修改。
#### 提交前检查
运行 poetry run pytest 确保所有测试通过（这将确保通过动态类型检查 beartype），并运行 poetry run mypy --config-file pyproject.toml . 检查静态类型。（您也可以运行 pre-commit run --all-files 来运行所有检查）
#### 检查 GitHub Actions 结果
检查 GitHub Actions 的结果，确保所有测试通过。若未通过，请修复错误并重新提交。
## ResearchBench
要执行ResearchBench实验，请运行 'research_bench/run_review_eval.sh' 脚本。你可以在脚本中调整参数，如使用实际的 `INPUT_PATH`。
如果遇到 `openreview` 未找到的错误，请通过运行 `pip install openreview` 安装该包。如果遇到与 `requests` 相关的问题，请将其版本更改为 `2.26`。
```bash
pip install requests==2.26
```