Adaptive Retrieval 项目使用教程

Adaptive Retrieval 项目使用教程

1. 项目目录结构及介绍

adaptive-retrieval/
├── data/
│   └── (数据文件)
├── figures/
│   └── (图表文件)
├── LICENSE
├── README.md
├── adaptive-retrieval.ipynb
├── requirements.txt
├── run_model.py
└── util_clm.py

• data/: 存放项目所需的数据文件。
• figures/: 存放项目生成的图表文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• adaptive-retrieval.ipynb: 项目的Jupyter Notebook文件，用于执行和展示Adaptive Retrieval方法。
• requirements.txt: 项目所需的Python依赖包列表。
• run_model.py: 项目的启动文件，用于运行模型评估。
• util_clm.py: 项目中使用的工具函数文件。

2. 项目的启动文件介绍

run_model.py

run_model.py 是项目的启动文件，用于运行模型的评估和测试。该文件支持多种模型和评估方法，可以通过命令行参数进行配置。

主要功能

• 模型运行: 支持多种语言模型（如GPT-Neo、OPT等）的运行。
• 评估方法: 支持不同的评估方法，如vanilla、contriever、genread等。
• 量化运行: 支持int8bit量化运行，适用于资源受限的环境。

使用示例

python run_model.py \
  --model_name EleutherAI/gpt-neox-20b \
  --input_file data/popQA.tsv \
  --eval_method vanilla \
  --int8bit

3. 项目的配置文件介绍

requirements.txt

requirements.txt 文件列出了项目运行所需的Python依赖包。通过该文件，用户可以快速安装所有必要的依赖包。

安装依赖

pip install -r requirements.txt

adaptive-retrieval.ipynb

adaptive-retrieval.ipynb 是一个Jupyter Notebook文件，用于展示和执行Adaptive Retrieval方法。该文件包含了详细的代码示例和解释，帮助用户理解和使用Adaptive Retrieval方法。

主要内容

• 数据加载: 加载PopQA数据集。
• 模型评估: 运行不同模型的评估，并展示结果。
• Adaptive Retrieval: 展示Adaptive Retrieval方法的实现和效果。

通过以上内容，用户可以快速上手并使用Adaptive Retrieval项目。