开源项目 `reasoning-teacher` 使用教程

2024-09-26 12:08:00作者：范垣楠Rhoda

1. 项目的目录结构及介绍

reasoning-teacher 项目的目录结构如下：

reasoning-teacher/
├── data/
│   ├── dataset/
│   ├── splits/
│   └── few_shot_cot_prompts/
├── notebooks/
│   ├── example_oai_finetune_cot.ipynb
│   └── results.ipynb
├── scripts/
│   └── custom/
├── src/
├── .gitignore
├── LICENSE
├── README.md
├── acl2023.jpg
├── custom_test.py
├── custom_train.py
├── requirements.txt
├── setup.py
└── setup.sh

目录结构介绍

data/: 包含项目使用的数据集和相关数据文件。
- dataset/: 包含12个任务数据集，以统一的json格式组织。
- splits/: 包含MultiArith和Date Understanding的模板化分割。
- few_shot_cot_prompts/: 包含从Wei 2022改编的少样本提示。
notebooks/: 包含Jupyter Notebook文件，用于运行OpenAI API实验和生成论文结果。
- example_oai_finetune_cot.ipynb: 演示如何从头到尾运行Fine-tune-CoT。
- results.ipynb: 生成论文中的所有结果表格和图表。
scripts/: 包含自定义实验的脚本。
- custom/: 包含用于在GPU上进行自定义实验的脚本。
src/: 包含项目的源代码。
.gitignore: Git忽略文件。
LICENSE: 项目许可证（MIT许可证）。
README.md: 项目介绍和使用说明。
acl2023.jpg: 项目相关图片。
custom_test.py: 自定义测试脚本。
custom_train.py: 自定义训练脚本。
requirements.txt: 项目依赖包列表。
setup.py: 项目设置脚本。
setup.sh: 项目设置脚本（Shell脚本）。

2. 项目的启动文件介绍

项目的启动文件主要包括以下几个：

custom_train.py: 用于在GPU上进行自定义实验的训练脚本。可以通过运行以下命令启动训练：
```
python custom_train.py
```
custom_test.py: 用于在GPU上进行自定义实验的测试脚本。可以通过运行以下命令启动测试：
```
python custom_test.py
```
notebooks/example_oai_finetune_cot.ipynb: Jupyter Notebook文件，用于演示如何从头到尾运行Fine-tune-CoT。可以通过Jupyter Notebook启动并运行该文件。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

requirements.txt: 列出了项目所需的所有Python依赖包。可以通过以下命令安装所有依赖：
```
pip install -r requirements.txt
```
setup.py: 项目的设置脚本，用于安装项目的Python包。可以通过以下命令运行：
```
python setup.py develop
```
setup.sh: 项目的设置脚本（Shell脚本），用于设置项目环境。可以通过以下命令运行：
```
./setup.sh
```