贡献¶

感谢你有兴趣改进 Arbor。本页介绍参与代码库和文档工作的基础。

开发环境¶

git clone https://github.com/RUC-NLPIR/Arbor.git
cd Arbor
python -m venv .venv && source .venv/bin/activate
pip install -e .

验证你的环境：

arbor doctor

项目结构¶

源码位于 src/，作为 arbor 包被导入：

src/
├── cli/            # Typer CLI：命令、接入对话、仪表盘
├── coordinator/    # 研究总监：想法树、编排器、工具
├── core/           # 智能体循环、LLM provider、共享工具、配置
├── executor/       # 运行单个实验的研究工程师
├── events/         # 事件总线 + 订阅者（日志、统计）
├── plugins/        # 领域插件（如 mle_kaggle.yaml）
├── report/         # REPORT.md 生成
├── search_agent/   # 文献/检索智能体
├── skills/         # markdown 技能手册
└── webui/          # 只读浏览器监控

打包细节

磁盘上的目录是 src/，但通过 pyproject.toml 里的 package-dir 映射，它以 arbor 的名字安装和导入。当你新增一个子包（一个带 __init__.py 的新目录）时，把它加进 pyproject.toml 里显式的 packages 列表，这样它才会随 wheel 一起发布。

参与文档¶

文档站点用 MkDocs Material 构建。

pip install -e ".[docs]"     # 安装文档依赖
mkdocs serve                 # 在 http://127.0.0.1:8000 实时预览
mkdocs build                 # 在 ./site 产出静态站点

文档源是 docs/ 下的 markdown 文件，导航在 mkdocs.yml 中定义。要新增一页，创建 markdown 文件并把它加到 nav: 树中。

提交改动¶

为你的改动创建一个分支。
让改动保持聚焦；与周围代码风格一致。
验证 CLI 仍然可用（arbor version、arbor doctor）；若你动了文档，确认 mkdocs build 无误。
开一个 pull request，说明动机与改动。

引用¶

如果你在研究中使用了 Arbor，请引用论文：

@misc{jin2026arbor,
  title  = {Toward Generalist Autonomous Research via Hypothesis-Tree Refinement},
  author = {Jiajie Jin and Yuyang Hu and Kai Qiu and Qi Dai and Chong Luo and
            Guanting Dong and Xiaoxi Li and Tong Zhao and Xiaolong Ma and
            Gongrui Zhang and Zhirong Wu and Bei Liu and Zhengyuan Yang and
            Linjie Li and Lijuan Wang and Hongjin Qian and Yutao Zhu and Zhicheng Dou},
  year   = {2026},
  eprint = {2606.11926},
  archivePrefix = {arXiv},
  url    = {https://arxiv.org/abs/2606.11926}
}