Skip to content

Latest commit

 

History

History
 
 

text_classification

README.md

PaddleHub 文本分类

本示例将展示如何使用PaddleHub Fine-tune API以及Transformer类预训练模型(ERNIE/BERT/RoBERTa)完成分类任务。

PaddleHub 1.7.0以上版本支持在Transformer类预训练模型之后拼接预置网络(bow, bilstm, cnn, dpcnn, gru, lstm)完成文本分类任务

目录结构

text_classification
├── finetuned_model_to_module # PaddleHub Fine-tune得到模型如何转化为module，从而利用PaddleHub Serving部署
│   ├── __init__.py
│   └── module.py
├── predict_predefine_net.py # 加入预置网络预测脚本
├── predict.py # 不使用预置网络（使用fc网络）的预测脚本
├── README.md # 文本分类迁移学习文档说明
├── run_cls_predefine_net.sh # 加入预置网络的文本分类任务训练启动脚本
├── run_cls.sh # 不使用预置网络（使用fc网络）的训练启动脚本
├── run_predict_predefine_net.sh # 使用预置网络（使用fc网络）的预测启动脚本
├── run_predict.sh # # 不使用预置网络（使用fc网络）的预测启动脚本
├── text_classifier_dygraph.py # 动态图训练脚本
├── text_cls_predefine_net.py # 加入预置网络训练脚本
└── text_cls.py # 不使用预置网络（使用fc网络）的训练脚本

如何开始Fine-tune

以下例子已不使用预置网络完成文本分类任务，说明PaddleHub如何完成迁移学习。使用预置网络完成文本分类任务，步骤类似。

在完成安装PaddlePaddle与PaddleHub后，通过执行脚本sh run_cls.sh即可开始使用ERNIE对ChnSentiCorp数据集进行Fine-tune。

其中脚本参数说明如下：

--batch_size: 批处理大小，请结合显存情况进行调整，若出现显存不足，请适当调低这一参数；
--learning_rate: Fine-tune的最大学习率；
--weight_decay: 控制正则项力度的参数，用于防止过拟合，默认为0.01；
--warmup_proportion: 学习率warmup策略的比例，如果0.1，则学习率会在前10%训练step的过程中从0慢慢增长到learning_rate, 而后再缓慢衰减，默认为0；
--num_epoch: Fine-tune迭代的轮数；
--max_seq_len: ERNIE/BERT模型使用的最大序列长度，最大不能超过512, 若出现显存不足，请适当调低这一参数；
--use_data_parallel: 是否使用并行计算，默认True。打开该功能依赖nccl库；
--checkpoint_dir: 模型保存路径，PaddleHub会自动保存验证集上表现最好的模型；

代码步骤

使用PaddleHub Fine-tune API进行Fine-tune可以分为4个步骤。

Step1: 加载预训练模型

module = hub.Module(name="ernie")
inputs, outputs, program = module.context(trainable=True, max_seq_len=128)

其中最大序列长度max_seq_len是可以调整的参数，建议值128，根据任务文本长度不同可以调整该值，但最大不超过512。

PaddleHub还提供BERT等模型可供选择, 模型对应的加载示例如下：

模型名 PaddleHub Module
ERNIE, Chinese hub.Module(name='ernie')
ERNIE tiny, Chinese hub.Module(name='ernie_tiny')
ERNIE 2.0 Base, English hub.Module(name='ernie_v2_eng_base')
ERNIE 2.0 Large, English hub.Module(name='ernie_v2_eng_large')
BERT-Base, Uncased hub.Module(name='bert_uncased_L-12_H-768_A-12')
BERT-Large, Uncased hub.Module(name='bert_uncased_L-24_H-1024_A-16')
BERT-Base, Cased hub.Module(name='bert_cased_L-12_H-768_A-12')
BERT-Large, Cased hub.Module(name='bert_cased_L-24_H-1024_A-16')
BERT-Base, Multilingual Cased hub.Module(nane='bert_multi_cased_L-12_H-768_A-12')
BERT-Base, Chinese hub.Module(name='bert_chinese_L-12_H-768_A-12')
BERT-wwm, Chinese hub.Module(name='bert_wwm_chinese_L-12_H-768_A-12')
BERT-wwm-ext, Chinese hub.Module(name='bert_wwm_ext_chinese_L-12_H-768_A-12')
RoBERTa-wwm-ext, Chinese hub.Module(name='roberta_wwm_ext_chinese_L-12_H-768_A-12')
RoBERTa-wwm-ext-large, Chinese hub.Module(name='roberta_wwm_ext_chinese_L-24_H-1024_A-16')

更多模型请参考PaddleHub官网。

如果想尝试BERT模型，只需要更换Module中的name参数即可.

# 更换name参数即可无缝切换BERT中文模型, 代码示例如下
module = hub.Module(name="bert_chinese_L-12_H-768_A-12")

Step2: 准备数据集并使用ClassifyReader读取数据

dataset = hub.dataset.ChnSentiCorp()
reader = hub.reader.ClassifyReader(
    dataset=dataset,
    vocab_path=module.get_vocab_path(),
    max_seq_len=128,
    sp_model_path=module.get_spm_path(),
    word_dict_path=module.get_word_dict_path())
metrics_choices = ["acc"]

hub.dataset.ChnSentiCorp() 会自动从网络下载数据集并解压到用户目录下$HOME/.paddlehub/dataset目录；

module.get_vocab_path() 会返回预训练模型对应的词表；

max_seq_len 需要与Step1中context接口传入的序列长度保持一致；

module.sp_model_path 若module为ernie_tiny则返回对应的子词切分模型，否则返回None；

module.word_dict_path 若module为ernie_tiny则返回对应的词语切分模型，否则返回None；

ClassifyReader中的data_generator会自动按照模型对应词表对数据进行切词，以迭代器的方式返回ERNIE/BERT所需要的Tensor格式，包括input_ids，position_ids，segment_id与序列对应的mask input_mask；

NOTE: Reader返回tensor的顺序是固定的，默认按照input_ids, position_ids, segment_id, input_mask这一顺序返回。

PaddleHub还提供了其他的文本分类数据集，分两类（单句分类和句对分类），具体信息如下表

数据集 API 单句/句对 推荐预训练模型 推荐评价指标
ChnSentiCorp hub.dataset.ChnSentiCorp() 单句 ernie_tiny accuracy
LCQMC hub.dataset.LCQMC() 句对 ernie_tiny accuracy
NLPCC-QBDA hub.dataset.NLPCC_DBQA() 句对 ernie_tiny accuracy
GLUE-CoLA hub.dataset.GLUE("CoLA") 单句 ernie_v2_eng_base matthews
GLUE-SST2 hub.dataset.GLUE("SST-2") 单句 ernie_v2_eng_base accuracy
GLUE-MNLI hub.dataset.GLUE("MNLI_m") 句对 ernie_v2_eng_base accuracy
GLUE-QQP hub.dataset.GLUE("QQP") 句对 ernie_v2_eng_base accuracy
GLUE-QNLI hub.dataset.GLUE("QNLI") 句对 ernie_v2_eng_base accuracy
GLUE-STS-B hub.dataset.GLUE("STS-B") 句对 ernie_v2_eng_base accuracy
GLUE-MRPC hub.dataset.GLUE("MRPC") 句对 ernie_v2_eng_base f1
GLUE-RTE hub.dataset.GLUE("RTE") 单句 ernie_v2_eng_base accuracy
XNLI hub.dataset.XNLI(language=zh) 句对 roberta_wwm_ext_chinese_L-24_H-1024_A-16 accuracy
ChineseGLUE-THUCNEWS hub.dataset.THUCNEWS() 单句 roberta_wwm_ext_chinese_L-24_H-1024_A-16 accuracy
ChineseGLUE-IFLYTEK hub.dataset.IFLYTEK() 单句 roberta_wwm_ext_chinese_L-24_H-1024_A-16 accuracy
ChineseGLUE-INEWS hub.dataset.INews() 句对 roberta_wwm_ext_chinese_L-24_H-1024_A-16 accuracy
ChineseGLUE-TNEWS hub.dataset.TNews() 句对 roberta_wwm_ext_chinese_L-24_H-1024_A-16 accuracy
ChinesGLUE-BQ hub.dataset.BQ() 句对 roberta_wwm_ext_chinese_L-24_H-1024_A-16 accuracy

更多数据集信息参考Dataset。

自定义数据集

如果想加载自定义数据集完成迁移学习，详细参见自定义数据集。

Step3：选择优化策略和运行配置

strategy = hub.AdamWeightDecayStrategy(
    learning_rate=5e-5,
    weight_decay=0.01,
    warmup_proportion=0.0,
    lr_scheduler="linear_decay",
)

config = hub.RunConfig(use_cuda=True, num_epoch=3, batch_size=32, strategy=strategy)

优化策略

针对ERNIE与BERT类任务，PaddleHub封装了适合这一任务的迁移学习优化策略AdamWeightDecayStrategy

  • learning_rate: Fine-tune过程中的最大学习率；
  • weight_decay: 模型的正则项参数，默认0.01，如果模型有过拟合倾向，可适当调高这一参数；
  • warmup_proportion: 如果warmup_proportion>0, 例如0.1, 则学习率会在前10%的steps中线性增长至最高值learning_rate；
  • lr_scheduler: 有两种策略可选(1) linear_decay策略学习率会在最高点后以线性方式衰减; noam_decay策略学习率会在最高点以多项式形式衰减；

运行配置

RunConfig 主要控制Fine-tune的训练，包含以下可控制的参数:

  • use_cuda: 是否使用GPU训练，默认为False；
  • checkpoint_dir: 模型checkpoint保存路径, 若用户没有指定，程序会自动生成；
  • num_epoch: Fine-tune的轮数；
  • batch_size: 训练的批大小，如果使用GPU，请根据实际情况调整batch_size；
  • strategy: Fine-tune优化策略；

Step4: 构建网络并创建分类迁移任务进行Fine-tune

pooled_output = outputs["pooled_output"]

# feed_list的Tensor顺序不可以调整
feed_list = [
    inputs["input_ids"].name,
    inputs["position_ids"].name,
    inputs["segment_ids"].name,
    inputs["input_mask"].name,
]

cls_task = hub.TextClassifierTask(
    data_reader=reader,
    feature=pooled_output,
    feed_list=feed_list,
    num_classes=dataset.num_labels,
    config=config)

cls_task.finetune_and_eval()

NOTE:

  1. outputs["pooled_output"]返回了Transformer类预训练模型对应的[CLS]向量,可以用于句子或句对的特征表达。
  2. feed_list中的inputs参数指名了Transformer类预训练模型中的输入tensor的顺序，与ClassifyReader返回的结果一致。
  3. hub.TextClassifierTask通过输入特征，label与迁移的类别数，可以生成适用于文本分类的迁移任务TextClassifierTask。
  4. 使用预置网络与否，传入hub.TextClassifierTask的特征不相同。hub.TextClassifierTask通过参数feature和token_feature区分。 feature应是sentence-level特征，shape应为[-1, emb_size]；token_feature是token-levle特征，shape应为[-1, max_seq_len, emb_size]。 如果使用预置网络，则应取Transformer类预训练模型的sequence_output特征(outputs["sequence_output"])。并且hub.TextClassifierTask(token_feature=outputs["sequence_output"])。 如果不使用预置网络，直接通过fc网络进行分类，则应取Transformer类预训练模型的pooled_output特征(outputs["pooled_output"])。并且hub.TextClassifierTask(feature=outputs["pooled_output"])。
  5. 使用预置网络，可以通过hub.TextClassifierTask参数network进行指定不同的网络结构。如下代码表示选择bilstm网络拼接在Transformer类预训练模型之后。 PaddleHub文本分类任务预置网络支持BOW，Bi-LSTM，CNN，DPCNN，GRU，LSTM。指定network应是其中之一。 其中DPCNN网络实现为ACL2017-Deep Pyramid Convolutional Neural Networks for Text Categorization。
cls_task = hub.TextClassifierTask(
    data_reader=reader,
    token_feature=outputs["sequence_output"],
    feed_list=feed_list,
    network='bilstm',
    num_classes=dataset.num_labels,
    config=config,
    metrics_choices=metrics_choices)

自定义迁移任务

如果想改变迁移任务组网，详细参见自定义迁移任务。

可视化

Fine-tune API训练过程中会自动对关键训练指标进行打点，启动程序后执行下面命令：

$ visualdl --logdir $CKPT_DIR/visualization --host ${HOST_IP} --port ${PORT_NUM}

其中${HOST_IP}为本机IP地址，${PORT_NUM}为可用端口号，如本机IP地址为192.168.0.1，端口号8040，用浏览器打开192.168.0.1:8040，即可看到训练过程中指标的变化情况。

模型预测

通过Fine-tune完成模型训练后，在对应的ckpt目录下，会自动保存验证集上效果最好的模型。 配置脚本参数

CKPT_DIR="ckpt_chnsentiment/"
python predict.py --checkpoint_dir $CKPT_DIR --max_seq_len 128

其中CKPT_DIR为Fine-tune API保存最佳模型的路径, max_seq_len是ERNIE模型的最大序列长度，请与训练时配置的参数保持一致

参数配置正确后，请执行脚本sh run_predict.sh，即可看到文本分类预测结果。

我们在AI Studio上提供了IPython NoteBook形式的demo，点击PaddleHub教程合集，可使用AI Studio平台提供的GPU算力进行快速尝试。

超参优化AutoDL Finetuner

PaddleHub还提供了超参优化（Hyperparameter Tuning）功能， 自动搜索最优模型超参得到更好的模型效果。详细信息参见AutoDL Finetuner超参优化功能教程。

Fine-tune之后保存的模型转化为PaddleHub Module

代码详见finetuned_model_to_module文件夹下 Fine-tune之后保存的模型转化为PaddleHub Module教程