Xtuner 简介
XTuner 是由上海人工智能实验室开发的一款低成本大模型训练工具箱。它以高效、灵活和全能的特性，成为轻量化大模型微调的理想选择。借助 XTuner，用户仅需 8GB 显存即可对 InternLM2-7B 模型进行微调，从而定制出独一无二的 AI 助手。这一创新工具极大地降低了微调大型模型的门槛，使得更多研究者和开发者能够轻松地进行个性化 AI 应用的开发。
仓库地址：https://github.com/InternLM/xtuner
Xtuner 特点概览
高效性能
- 大模型支持：Xtuner 能够在仅 8GB 显存的环境下微调 7B 模型，同时支持跨多节点的更大规模模型（70B+）微调。
- 算子加速：自动集成高性能算子，如 FlashAttention 和 Triton kernels，显著提升训练效率。
- 深度优化：与 DeepSpeed 兼容，利用 ZeRO 优化策略，进一步提高训练性能。
灵活适应
- 模型多样性：支持多种大语言模型，包括 InternLM、Mixtral-8x7B、Llama2、ChatGLM、Qwen 和 Baichuan 等。
- 多模态能力：支持 LLaVA 等多模态图文模型的预训练与微调，如表现出色的 LLaVA-InternLM2-20B 模型。
- 数据管道：设计灵活的数据管道，兼容各种数据格式，无论是开源数据还是自定义数据，都能快速适应。
- 微调算法：提供 QLoRA、LoRA 及全量参数微调等多种微调算法，满足不同需求。
全能应用
- 训练模式：支持增量预训练、指令微调及 Agent 微调，适应多种训练场景。
- 对话模板：预设丰富的开源对话模板，便于与各类模型进行交互。
- 无缝集成：训练后的模型可直接部署于 LMDeploy，或通过 OpenCompass 和 VLMEvalKit 进行大规模评测。
环境准备
创建工作目录
创建本次微调实践的工作目录 /root/autodl-tmp/ft-learn
# 创建微调工作目录
mkdir -p /root/autodl-tmp/ft-learn
# 创建微调数据集存放目录
mkdir -p /root/autodl-tmp/ft-learn/dataset
# 创建微调配置文件存放目录
mkdir -p /root/autodl-tmp/ft-learn/config
安装
-
推荐使用 conda 先构建一个 Python-3.10 的虚拟环境
conda create --name xtuner-env python=3.10 -y conda activate xtuner-env -
通过 pip 安装 XTuner：
pip install -U xtuner亦可集成 DeepSpeed 安装：
pip install -U 'xtuner[deepspeed]' -
从源码安装 XTuner：
git clone https://github.com/InternLM/xtuner.git cd xtuner pip install -e '.[all]'
安装依赖
# 升级pip
python -m pip install --upgrade pip
# 安装python依赖
pip install modelscope==1.9.5
pip install transformers==4.36.2
pip install streamlit==1.24.0
pip install sentencepiece==0.1.99
pip install accelerate==0.24.1
pip install transformers_stream_generator==0.0.4
pip install einops ujson
pip install protobuf
使用 modelscope 下载模型
使用 modelscope 中的 snapshot_download 函数下载模型，第一个参数为模型名称，参数 cache_dir 为模型的下载路径。
在 Internlm2-7b-chat-web.ipynb 文件中新建一个代码块，运行下载 internlm2-chat-7b 模型。模型下载需要时间，我们直接往下看
from modelscope import snapshot_download
model_dir = snapshot_download('Shanghai_AI_Laboratory/internlm2-chat-7b', cache_dir='/root/autodl-tmp', revision='master')
数据集处理
我自己整理的 心理大模型-职场焦虑语料.xlsx, 通过 gen_qa_json.py 文件生成一个 career_coach.jsonl 文件
运行 python /root/autodl-tmp/ft-learn/dataset/gen_qa_json.py 生成文件，你们也可以按照我的数据语料格式，自定义你们自己的数据集。gen_qa_json.py 文件代码如下：
import pandas as pd
import json
# 读取Excel文件
excel_file = './Healthcare.xlsx' # 替换成实际的Excel文件路径
df = pd.read_excel(excel_file)
# 设置system的值
system_value = "你是一个专业的，经验丰富的有健康检测的助手。你总是根据有健康焦虑的病人的问题提供准确、全面和详细的答案。"
# 将数据整理成jsonL格式
json_data = []
for index, row in df.iterrows():
conversation = [
{
"system": system_value,
"input": str(row['q']),
"output": str(row['a'])
}
]
json_data.append({"conversation": conversation})
# 将json数据写入文件
output_json_file = 'career_coach.jsonl' # 替换成实际的输出文件路径
with open(output_json_file, 'w', encoding='utf-8') as f:
json.dump(json_data, f, ensure_ascii=False)
print("JSONL文件生成成功！")
配置文件准备
Xtuner 已经内置了许多的配置文件。可以通过 Xtuner 查看可配置文件
xtuner list-cfg
由于我们本次的基座微调模型为 internLM2-chat-7b，所以我们可以查看 Xtuner 现在在 InternLM2 下已经支持了哪些配置文件
xtuner list-cfg |grep internlm2
# 复制配置文件
xtuner copy-cfg internlm2_chat_7b_qlora_oasst1_e3 /root/autodl-tmp/ft-learn/config
# 修改配置文件名
mv /root/autodl-tmp/ft-learn/config/internlm2_chat_7b_qlora_oasst1_e3_copy.py /root/autodl-tmp/ft-learn/config/internlm2_chat_7b_qlora_oasst1_e3_career_coach.py
复制完成之后要修改配置文件的几处参数
# PART 1 中
# 预训练模型存放的位置
pretrained_model_name_or_path = '/root/autodl-tmp/Shanghai_AI_Laboratory/internlm2-chat-7b'
# 微调数据存放的位置
data_path = '/root/autodl-tmp/ft-learn/dataset/career_coach.jsonl'
# 训练中最大的文本长度
max_length = 512
# 每一批训练样本的大小
batch_size = 2
# 最大训练轮数
max_epochs = 3
# 验证的频率
evaluation_freq = 500
# 用于评估输出内容的问题（用于评估的问题尽量与数据集的question保持一致）
evaluation_inputs = [
'我感到在职场中压力很大，总是全身无力、掉头发，我该怎么办？',
'我在生活中总是失眠、头痛，怎样治疗？',
]
# PART 3 中
# 如果这里的
无法直接读取json文件
dataset=dict(type=load_dataset, path='json', data_files=dict(train=data_path))
# 这里也得改成None，否则会报错KeyError
dataset_map_fn=None
模型微调
微调启动
xtuner train /root/autodl-tmp/ft-learn/config/internlm2_chat_7b_qlora_oasst1_e3_career_coach.py --deepspeed deepspeed_zero2
训练完成之后，参数模型存放在 /root/work_dirs/internlm2_chat_7b_qlora_oasst1_e3_career_coach/ 目录下
模型转换成HF
# 新建模型存放的文件夹
mkdir -p /root/work_dirs/internlm2_chat_7b_qlora_oasst1_e3_career_coach/hf
# 添加环境变量
export MKL_SERVICE_FORCE_INTEL=1
# 模型转换
xtuner convert pth_to_hf /root/autodl-tmp/ft-learn/config/internlm2_chat_7b_qlora_oasst1_e3_career_coach.py /root/work_dirs/internlm2_chat_7b_qlora_oasst1_e3_career_coach/iter_51.pth/ /root/work_dirs/internlm2_chat_7b_qlora_oasst1_e3_career_coach/hf
合并HF adapter 到LLM
mkdir -p /root/autodl-tmp/ft-learn/merged
export MKL_SERVICE_FORCE_INTEL=1
export MKL_THREADING_LAYER='GNU'
# 原始模型参数存放的位置
export NAME_OR_PATH_TO_LLM=/root/autodl-tmp/Shanghai_AI_Laboratory/internlm2-chat-7b
# Hugging Face格式参数存放的位置
export NAME_OR_PATH_TO_ADAPTER=/root/work_dirs/internlm2_chat_7b_qlora_oasst1_e3_career_coach/hf
# 最终Merge后的参数存放的位置
mkdir -p /root/autodl-tmp/ft-learn/merged/internlm2_cc_hf_merge
export SAVE_PATH=/root/autodl-tmp/ft-learn/merged/internlm2_cc_hf_merge
# 执行参数Merge
xtuner convert merge \
$NAME_OR_PATH_TO_LLM \
$NAME_OR_PATH_TO_ADAPTER \
$SAVE_PATH \
--max-shard-size 2GB
Xtuner多轮对话介绍
XTuner 训练多轮对话模型时，采取了一种更加充分高效的方法。将多轮对话进行拼接，之后输入模型，并行计算每个位置的 loss，而只有 Output 部分的 loss 参与回传。
XTuner 中多轮对话数据集格式如下所示：
[{
"conversation":[
{
"system": "You are an AI assistant."
"input": "Hello?",
"output": "Hello! How can I help you?"
},
{
"input": "What's the date today?",
"output": "Today is Monday, August 14, 2023."
},
{
"input": "Thank you!",
"output": "You are welcome."
}
]
},
{
"conversation":[
{
"system": "You are an AI assistant."
"input": "Hello?",
"output": "Hello! How can I help you?"
},
{
"input": "How's the weather today in Rosso?",
"output": "The weather in Rosso on Wednesday, August 16th, is going to be cloudy for most of the day, together with moderate rain around noon."
},
{
"input": "Thank you!",
"output": "You are welcome."
}
]
}]
数据集中的 “conversation” 键对应的值是一个列表，用于保存每一轮对话的指令和实际回答（GroundTruth）。为了保持格式统一，增量预训练数据集和单轮对话数据集中的 “conversation” 键也对应一个列表，只不过该列表的长度为 1。而在多轮对话数据集中，“conversation” 列表的长度为 n，以容纳 n 轮的对话内容。
