本仓库为CPM模型的 fine-tune 代码仓库，可以用于模型 fine-tune 的多机多卡训练/测试。目前支持了 ChID 中文成语填空数据集和 STC 中文对话数据集。[项目首页] [模型下载] [技术报告]
同时，该仓库也提供了 ChID 数据集 zero-shot setting 下测试代码。
ChID 数据集来源于论文 ChID: A Large-scale Chinese IDiom Dataset for Cloze Test.
STC 数据集来源于论文 Neural Responding Machine for Short-Text Conversation.
两个数据集可从这里下载。
若您想使用CPM-1进行推理，我们建议使用高效推理工具BMInf，支持1060以上显卡单卡推理。
首先安装 pytorch 等基础依赖，再安装APEX以支持 fp16，然后安装 deepspeed：
安装基础依赖：
pip install -r requirements.txt
安装 apex：
git clone https://github.com/NVIDIA/apex
cd apex
pip install -v --no-cache-dir --global-option="--cpp_ext" --global-option="--cuda_ext" ./
考虑apex的安装容易发生问题，我们构建了对应的Docker容器，可以进行快速环境搭建。安装方式如下：
docker pull dmye/cpm:v0
参考运行指令如下：
sudo docker run --gpus '"device=0,1"' -it -v <path>:/CPM --name=cpm cpm:v0
其中<path>为代码所在目录，-v进行文件目录挂载
安装 deepspeed
使用 0.3.15 版本的 deepspeed，感谢 #26 指出问题。
python3 preprocess_chid_finetune.py --data_dir ${PATH_TO_DATA_DIR} --tokenizer_path ${PATH_TO_TOKENIZER} --output_dir ${PATH_TO_OUTPUT}
其中，模板定义与实现在 preprocess_chid_finetune.py 文件 process_one_sent 函数中。最终，该文件生成的数据格式为：
[
{
"sent": [8, 15, ....], # 经过 bpe 分词之后 token 对应的 id
"truth": 3 # 正确答案成语的编号（0~9之间的整数）
}
...
]
预处理完成后，指定的输出目录下会生成 train.json, valid.json, test.json 三个文件。
python3 preprocess_stc_finetune.py --data_dir ${PATH_TO_DATA_DIR} --output_dir ${PATH_TO_OUTPUT}
该文件会将每段对话写成一行，上文前加入“对话上文:”，下文前加入“回复:”：
对话上文:二十六年前的我挺瘦吧？不知这几位盲童现在好吗？ 回复:恩，不但瘦，头发还很多。
注意：由于 STC 数据集很大，我们在数据预处理的时候切了其训练集的前 10% 以方便使用者测试 Fine-tune。
进行 fine-tune 训练的时候可以选择 fp16 或者 fp32。我们在实验中发现，在使用 fp16 进行训练的时候，需要加载预训练时的动量才能使模型较快收敛，而采用 fp32 训练则不会有这个问题。因此，我们推荐直接使用 fp32 进行 fine-tune 训练。
另外，关于内存使用，我们使用了 deepspeed 的 activation checkpointing 以节省内存，相关选项已经在运行脚本中修改。
bash scripts/chid/finetune_chid_large.sh # for fp16 fine-tune
bash scripts/chid/finetune_chid_large_fp32.sh # for fp32 fine-tune
bash scripts/chid/finetune_chid_large_fp32_multinode.sh # for multi-node fp32 fine-tune
bash scripts/language_model/finetune_lm_large.sh # for fp16 fine-tune
bash scripts/language_model/finetune_lm_large_fp32.sh # for fp32 fine-tune
bash scripts/language_model/finetune_lm_large_fp32_multinode.sh # for multi-node fp32 fine-tune
运行脚本之前，需要先将脚本中以下变量更改为实际的路径：
DATA_DIR # 预处理后数据的目录
CHECKPOINT_PATH # 预训练结束后模型的路径
RESULTS_DIR # 训练结果的存放处
MODEL_NAME # 给模型起的名字
TOKENIZER_PATH # tokenizer 的路径
如果要进行多机训练，可能还需要修改
NUM_WORKERS # 节点数量
NUM_GPUS_PER_WORKER # 每个节点的卡数
以及 scripts/host_files/hostfile 文件。具体格式可以参考 deepspeed 的官方文档
进行测试之前，需要去掉脚本中 --do_train 选项，然后可以使用 --eval_ckpt_path 选项来指定需要测试的模型。
python3 preprocess_chid_zeroshot.py --data_dir ${PATH_TO_DATA_DIR} --tokenizer_path ${PATH_TO_TOKENIZER} --output_dir ${PATH_TO_OUTPUT}
该文件会将每个候选的成语填入文章相应的空白中，每个空白生成10个新的候选文章。最终，该文件生成的数据格式为：
{
"contents": [
[8, 15, ....],
....
], # 所有样本经过 bpe 分词之后 token 对应的 id。
"sids": [
0,
0,
...
1,
1,
...
], # 每个生成出的候选文章对应原来样本的编号
"cids": [
0,
1,
2,
...
9,
0,
1,
...
], # 每个生成出的候选文章对应的成语的编号
"labels": [
3,
2,
...
], # 每个原样本的正确答案编号（0~9之间的整数）
}
与处理完成后，指定的输出目录下会生成 test.json 文件。
bash scripts/chid/zero-shot_chid_large.sh
运行脚本之前，需要先将脚本中以下变量更改为实际的路径：
DATA_DIR # 预处理后数据的目录
CHECKPOINT_PATH # 预训练结束后模型的路径
RESULTS_DIR # 训练结果的存放处
MODEL_NAME # 给模型起的名字
TOKENIZER_PATH # tokenizer 的路径
| Fine-Tune | Zero-Shot | |
|---|---|---|
| CPM-small | 0.657 | 0.433 |
| CPM-medium | 0.695 | 0.524 |
| CPM-large | 0.804 | 0.685 |
@article{cpm-v1,
title={CPM: A Large-scale Generative Chinese Pre-trained Language Model},
author={Zhang, Zhengyan and Han, Xu, and Zhou, Hao, and Ke, Pei, and Gu, Yuxian and Ye, Deming and Qin, Yujia and Su, Yusheng and Ji, Haozhe and Guan, Jian and Qi, Fanchao and Wang, Xiaozhi and Zheng, Yanan and Zeng, Guoyang and Cao, Huanqi and Chen, Shengqi and Li, Daixuan and Sun, Zhenbo and Liu, Zhiyuan and Huang, Minlie and Han, Wentao and Tang, Jie and Li, Juanzi and Sun, Maosong},
year={2020}
}