开源项目最佳实践：RARE 项目教程

1. 项目介绍

RARE（Retrieval-Augmented Reasoning Modeling）是一个新颖的框架，它将知识存储与推理建模解耦，从而加速推理建模过程，避免对低级别知识的机械记忆。该项目旨在通过结合领域知识和思考，提高大型语言模型（LLM）在推理方面的深度和准确性。RARE 的研究成果和实践进展将在本仓库中持续更新。

2. 项目快速启动

在开始之前，确保您已经安装了 Git 和 Conda。以下是快速启动 RARE 项目的步骤：

# 克隆项目仓库
git clone https://github.com/Open-DataFlow/RARE.git
cd RARE

# 创建并激活虚拟环境
conda create -n rare python=3.10
conda activate rare

# 安装项目依赖
pip install -r requirements.txt

快速启动示例

项目提供了两个完整的示例，一个是纯语言任务，一个是视觉-语言任务。

• 纯语言任务（PubMedQA 数据集）：

# 训练模型
bash demo/llama_pubmedqa_rare.sh

• 视觉-语言任务（MM-RAIT 数据集）：

# 训练模型
bash demo/qwenvl_mmrait_rare.sh

3. 应用案例和最佳实践

数据准备

项目提供了处理不同来源数据的方法。以下是将原始数据格式化的步骤：

# 下载和解压数据集
huggingface-cli download --repo-type dataset --resume-download yuhkalhic/rare_share --local-dir process/rare_share
unzip process/rare_share/system=planner_addret,dataset=all_dev,debug=False.zip -d process/rare_share/system=planner_addret,dataset=all_dev,debug=False
unzip process/rare_share/system=planner_addret,dataset=all_train,debug=False.zip -d process/rare_share/system=planner_addret,dataset=all_train,debug=False
unzip process/rare_share/system=planner_addret,dataset=all_test,debug=False.zip -d process/rare_share/system=planner_addret,dataset=all_test,debug=False

# 处理数据集
python process/process_medqa.py
python process/process_pubmed.py
python process/process_pubhealth.py
python process/process_casehold.py
python process/process_finfact.py
python process/process_mmrait.py

模型训练

训练代码支持多种类型的模型。以下是一些具体的模型名称示例：

• meta-llama/Llama-3.1-8B-Instruct
• Qwen/Qwen2.5-7B-Instruct
• mistralai/Mistral-7B-Instruct-v0.3

根据您的需要选择合适的模型，并修改 fsdp_config 参数。如果需要使用更多的模型，可以修改 train/sft.py 中的代码。

• 仅使用文本数据集（medqa, pubmed, pubhealth, casehold, finfact）：

# 训练模型
bash train/sft.sh

• 使用多模态数据集（mmrait）：

# 训练模型
accelerate launch --config_file train/accelerate_config_mm.yaml train/train.py train/training_args_mm.yaml

模型推理

推理脚本支持五种类型的模型。以下是一些具体的模型名称示例：

• meta-llama/Llama-3.1-8B-Instruct
• Qwen/Qwen2.5-7B-Instruct
• mistralai/Mistral-7B-Instruct-v0.3
• deepseek-ai/DeepSeek-R1-Distill-Llama-8B
• Qwen/Qwen2.5-VL-7B-Instruct

对于测试集，至少完成预处理的第一步，包括问题和标准答案。以下是一个推理示例：

# 推理
python inference/vllm_infer_text.py --model_name_or_path saves/medqa-llama --dataset_path data/test_medqa.json --template llama --prediction_key llm_predict_rare_llama --tensor_parallel_size 8

4. 典型生态项目

RARE 作为一个开源项目，其生态系统中包含了多个相关的项目和工具，例如：

• 数据集处理工具：用于处理不同来源和格式的数据集。
• 预训练模型：提供多种预训练模型以供选择和使用。
• 推理工具：支持多种模型进行推理，并提供了相应的脚本。

通过这些典型生态项目，开发者可以更方便地使用 RARE 进行研究和开发。