From 68d55d77dfadfdd25492102ff532cb7170b66061 Mon Sep 17 00:00:00 2001 From: kinghuin Date: Tue, 21 Jul 2020 15:08:20 +0800 Subject: [PATCH] modify demo readme (#749) --- demo/image_classification/README.md | 8 +- demo/multi_label_classification/README.md | 62 +++---- demo/qa_classification/README.md | 55 +++--- demo/reading_comprehension/README.md | 66 ++++---- demo/regression/README.md | 56 ++++--- demo/senta/README.md | 6 +- demo/sequence_labeling/README.md | 54 +++--- demo/text_classification/README.md | 71 ++++---- demo/text_generation/README.md | 195 ++++++++++++++++++++++ docs/reference/dataset.md | 19 +++ 10 files changed, 410 insertions(+), 182 deletions(-) create mode 100644 demo/text_generation/README.md diff --git a/demo/image_classification/README.md b/demo/image_classification/README.md index 32f3c3e0..058ff88b 100644 --- a/demo/image_classification/README.md +++ b/demo/image_classification/README.md @@ -4,7 +4,7 @@ ## 如何开始Fine-tune -在完成安装PaddlePaddle与PaddleHub后，通过执行脚本`sh run_classifier.sh`即可开始使用ResNet对[Flowers](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Dataset#class-hubdatasetflowersdataset)等数据集进行Fine-tune。 +在完成安装PaddlePaddle与PaddleHub后，通过执行脚本`sh run_classifier.sh`即可开始使用ResNet对[Flowers](../../docs/reference/dataset.md#class-hubdatasetflowers)等数据集进行Fine-tune。 其中脚本参数说明如下： @@ -66,7 +66,7 @@ data_reader = hub.reader.ImageClassificationReader( #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -81,7 +81,7 @@ config = hub.RunConfig(use_cuda=True, use_data_parallel=True, num_epoch=3, batch #### 优化策略 -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)。 +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 其中`DefaultFinetuneStrategy`: @@ -125,7 +125,7 @@ task.finetune_and_eval() #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/multi_label_classification/README.md b/demo/multi_label_classification/README.md index 86d00cd5..79b3f99b 100644 --- a/demo/multi_label_classification/README.md +++ b/demo/multi_label_classification/README.md @@ -6,7 +6,7 @@ 如下图所示：

-
+

*图片来源于https://mc.ai/building-a-multi-label-text-classifier-using-bert-and-tensorflow/* @@ -39,6 +39,8 @@ ### Step1: 加载预训练模型 ```python +import paddlehub as hub + module = hub.Module(name="ernie_v2_eng_base") inputs, outputs, program = module.context(trainable=True, max_seq_len=128) ``` @@ -66,32 +68,44 @@ RoBERTa-wwm-ext-large, Chinese | `hub.Module(name='roberta_wwm_ext_chinese_L 更多模型请参考[PaddleHub官网](https://www.paddlepaddle.org.cn/hub)。 -### Step2: 准备数据集并使用MultiLabelClassifyReader读取数据 +### Step2: 准备数据集并使用tokenizer预处理数据 ```python -dataset = hub.dataset.Toxic() -reader = hub.reader.MultiLabelClassifyReader( - dataset=dataset, - vocab_path=module.get_vocab_path(), - max_seq_len=128) +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) +dataset = hub.dataset.Toxic( + tokenizer=tokenizer, max_seq_len=128) +``` +如果是使用ernie_tiny预训练模型，请使用ErnieTinyTokenizer。 ``` +tokenizer = hub.ErnieTinyTokenizer( + vocab_file=module.get_vocab_path(), + spm_path=module.get_spm_path(), + word_dict_path=module.get_word_dict_path()) +``` +ErnieTinyTokenizer和BertTokenizer的区别在于它将按词粒度进行切分，详情请参考[文章](https://www.jiqizhixin.com/articles/2019-11-06-9)。 -其中数据集的准备代码可以参考[toxic.py](https://github.com/PaddlePaddle/PaddleHub/blob/release/v1.2/paddlehub/dataset/toxic.py)。 +数据集的准备代码可以参考[toxic.py](../../paddlehub/dataset/toxic.py)。 `hub.dataset.Toxic()` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录； `module.get_vocab_path()` 会返回预训练模型对应的词表； -`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； - -MultiLabelClassifyReader中的`data_generator`会自动按照模型对应词表对数据进行tokenize，以迭代器的方式返回BERT所需要的Tensor格式，包括`input_ids`，`position_ids`，`segment_id`与序列对应的mask `input_mask`； +`module.sp_model_path` 若module为ernie_tiny则返回对应的子词切分模型路径，否则返回None； -**NOTE**: Reader返回tensor的顺序是固定的，默认按照input_ids, position_ids, segment_id, input_mask这一顺序返回。 +`module.word_dict_path` 若module为ernie_tiny则返回对应的词语切分模型路径，否则返回None； +`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 10 +# {'input_ids': [101, 2233, 2289, 1006, 11396, 1007, 2003, 3746, 1024, 102], 'segment_ids': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'seq_len': 10, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'label': [0, 0, 0, 0, 0, 0]} +``` #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90\)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -114,7 +128,7 @@ config = hub.RunConfig(use_cuda=True, use_data_parallel=True, use_pyreader=True, * `warmup_proportion`: 如果warmup_proportion>0, 例如0.1, 则学习率会在前10%的steps中线性增长至最高值learning_rate； * `lr_scheduler`: 有两种策略可选(1) `linear_decay`策略学习率会在最高点后以线性方式衰减; `noam_decay`策略学习率会在最高点以多项式形式衰减； -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)。 +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 #### 运行配置 `RunConfig` 主要控制Fine-tune的训练，包含以下可控制的参数: @@ -135,31 +149,21 @@ PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStr ```python 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.MultiLabelClassifierTask( - data_reader=reader, +multi_label_cls_task = hub.MultiLabelClassifierTask( + dataset=dataset, feature=pooled_output, - feed_list=feed_list, num_classes=dataset.num_labels, config=config) -cls_task.finetune_and_eval() +multi_label_cls_task.finetune_and_eval() ``` **NOTE:** 1. `outputs["pooled_output"]`返回了ERNIE/BERT模型对应的[CLS]向量,可以用于句子或句对的特征表达。 -2. `feed_list`中的inputs参数指名了ERNIE/BERT中的输入tensor的顺序，与MultiLabelClassifierTask返回的结果一致。 -3. `hub.MultiLabelClassifierTask`通过输入特征，label与迁移的类别数，可以生成适用于多标签分类的迁移任务`MultiLabelClassifierTask`。 +2. `hub.MultiLabelClassifierTask`通过输入特征，label与迁移的类别数，可以生成适用于多标签分类的迁移任务`MultiLabelClassifierTask`。 #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/qa_classification/README.md b/demo/qa_classification/README.md index 1410d99d..65c8303e 100644 --- a/demo/qa_classification/README.md +++ b/demo/qa_classification/README.md @@ -28,6 +28,8 @@ ### Step1: 加载预训练模型 ```python +import paddlehub as hub + module = hub.Module(name="ernie") inputs, outputs, program = module.context(trainable=True, max_seq_len=128) ``` @@ -60,31 +62,44 @@ RoBERTa-wwm-ext-large, Chinese | `hub.Module(name='roberta_wwm_ext_chinese_L module = hub.Module(name="bert_chinese_L-12_H-768_A-12") ``` -### Step2: 准备数据集并使用ClassifyReader读取数据 +### Step2: 准备数据集并使用tokenizer预处理数据 ```python -dataset = hub.dataset.NLPCC_DBQA() -reader = hub.reader.ClassifyReader( - dataset=dataset, - vocab_path=module.get_vocab_path(), - max_seq_len=128) +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) +dataset = hub.dataset.NLPCC_DBQA( + tokenizer=tokenizer, max_seq_len=128) +``` +如果是使用ernie_tiny预训练模型，请使用ErnieTinyTokenizer。 ``` +tokenizer = hub.ErnieTinyTokenizer( + vocab_file=module.get_vocab_path(), + spm_path=module.get_spm_path(), + word_dict_path=module.get_word_dict_path()) +``` +ErnieTinyTokenizer和BertTokenizer的区别在于它将按词粒度进行切分，详情请参考[文章](https://www.jiqizhixin.com/articles/2019-11-06-9)。 -其中数据集的准备代码可以参考[nlpcc_dbqa.py](https://github.com/PaddlePaddle/PaddleHub/blob/release/v1.2/paddlehub/dataset/nlpcc_dbqa.py)。 +数据集的准备代码可以参考[nlpcc_dbqa.py](../../paddlehub/dataset/nlpcc_dbqa.py)。 `hub.dataset.NLPCC_DBQA())` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录； `module.get_vocab_path()` 会返回预训练模型对应的词表； -`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； +`module.sp_model_path` 若module为ernie_tiny则返回对应的子词切分模型路径，否则返回None； -ClassifyReader中的`data_generator`会自动按照模型对应词表对数据进行切词，以迭代器的方式返回ERNIE/BERT所需要的Tensor格式，包括`input_ids`，`position_ids`，`segment_id`与序列对应的mask `input_mask`； +`module.word_dict_path` 若module为ernie_tiny则返回对应的词语切分模型路径，否则返回None； -**NOTE**: Reader返回tensor的顺序是固定的，默认按照input_ids, position_ids, segment_id, input_mask这一顺序返回。 +`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 10 +# {'input_ids': [3, 1637, 964, 1676, 613, 5, 1637, 964, 1676, 5], 'segment_ids': [0, 0, 0, 0, 0, 0, 1, 1, 1, 1], 'seq_len': 10, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'label': 0} +``` #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -101,7 +116,7 @@ config = hub.RunConfig(use_cuda=True, use_data_parallel=True, use_pyreader=True, #### 优化策略 -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)。 +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 针对ERNIE与BERT类任务，PaddleHub封装了适合这一任务的迁移学习优化策略`AdamWeightDecayStrategy`： @@ -129,18 +144,9 @@ PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStr ```python 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, + dataset=dataset, feature=pooled_output, - feed_list=feed_list, num_classes=dataset.num_labels, config=config) @@ -148,12 +154,11 @@ cls_task.finetune_and_eval() ``` **NOTE:** 1. `outputs["pooled_output"]`返回了ERNIE/BERT模型对应的[CLS]向量,可以用于句子或句对的特征表达。 -2. `feed_list`中的inputs参数指名了ERNIE/BERT中的输入tensor的顺序，与ClassifyReader返回的结果一致。 -3. `hub.TextClassifierTask`通过输入特征，label与迁移的类别数，可以生成适用于文本分类的迁移任务`TextClassifierTask` +2. `hub.TextClassifierTask`通过输入特征，label与迁移的类别数，可以生成适用于文本分类的迁移任务`TextClassifierTask` #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/reading_comprehension/README.md b/demo/reading_comprehension/README.md index 7e12d081..4ce406dc 100644 --- a/demo/reading_comprehension/README.md +++ b/demo/reading_comprehension/README.md @@ -29,6 +29,8 @@ ### Step1: 加载预训练模型 ```python +import paddlehub as hub + module = hub.Module(name="bert_uncased_L-12_H-768_A-12") inputs, outputs, program = module.context(trainable=True, max_seq_len=384) ``` @@ -61,27 +63,42 @@ RoBERTa-wwm-ext-large, Chinese | `hub.Module(name='roberta_wwm_ext_chinese_L module = hub.Module(name="bert_chinese_L-12_H-768_A-12") ``` -### Step2: 准备数据集并使用ReadingComprehensionReader读取数据 +### Step2: 准备数据集并使用tokenizer预处理数据 ```python +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) dataset = hub.dataset.SQUAD( - version_2_with_negative=False) -reader = hub.reader.ReadingComprehensionReader( - dataset=dataset, - vocab_path=module.get_vocab_path(), - max_seq_length=384) + version_2_with_negative=False, + tokenizer=tokenizer, + max_seq_len=128) +``` +如果是使用ernie_tiny预训练模型，请使用ErnieTinyTokenizer。 ``` +tokenizer = hub.ErnieTinyTokenizer( + vocab_file=module.get_vocab_path(), + spm_path=module.get_spm_path(), + word_dict_path=module.get_word_dict_path()) +``` +ErnieTinyTokenizer和BertTokenizer的区别在于它将按词粒度进行切分，详情请参考[文章](https://www.jiqizhixin.com/articles/2019-11-06-9)。 -其中数据集的准备代码可以参考 [squad.py](https://github.com/PaddlePaddle/PaddleHub/blob/release/v1.2/paddlehub/dataset/squad.py)。 +数据集的准备代码可以参考 [squad.py](../../paddlehub/dataset/squad.py)。 `hub.dataset.SQUAD(version_2_with_negative=False)` 会自动从网络下载数据集SQuAD v1.1并解压到用户目录下`$HOME/.paddlehub/dataset`目录；如果想选择数据集SQuAD v2.0，则只需version_2_with_negative=True； `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； -ReadingComprehensionReader中的`data_generator`会自动按照模型对应词表对数据进行切词，以迭代器的方式返回BERT所需要的Tensor格式，包括`input_ids`，`position_ids`，`segment_id`与序列对应的mask `input_mask`； +`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； -**NOTE**: Reader返回tensor的顺序是固定的，默认按照input_ids, position_ids, segment_id, input_mask这一顺序返回。 +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 50 +# {'input_ids': [101, 2029, 5088, 2136, 3421, 1996, 10511, 2012, 3565, 4605, 2753, 1029, 102, 3565, 4605, 2753, 2001, 2019, 2137, 2374, 2208, 2000, 5646, 1996, 3410, 1997, 1996, 2120, 2374, 2223, 1006, 5088, 1007, 2005, 1996, 2325, 2161, 1012, 1996, 2137, 2374, 3034, 1006, 10511, 1007, 3410, 7573, 14169, 3249, 102], 'segment_ids': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'seq_len': 50, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49], 'start_position': 46, 'end_position': 47, 'unique_id': 1000000000} +``` PaddleHub还提供了其他的阅读理解数据集，具体信息如下表： @@ -92,11 +109,11 @@ SQuAD v2.0 | hub.dataset.SQUAD(version_2_with_negative=True) DRCD | hub.dataset.DRCD() |roberta_wwm_ext_chinese_L-24_H-1024_A-16| CMRC 2018 | hub.dataset.CMRC2018() |roberta_wwm_ext_chinese_L-24_H-1024_A-16| -更多数据集信息参考[Dataset](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Dataset)。 +更多数据集信息参考[Dataset](../../docs/reference/dataset.md)。 #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -121,7 +138,7 @@ config = hub.RunConfig(use_cuda=True, num_epoch=2, batch_size=12, strategy=strat `lr_scheduler`: 有两种策略可选（1）`linear_decay`策略学习率会在最高点后以线性方式衰减; （2）`noam_decay`策略学习率会在最高点以多项式形式衰减； -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)。 +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 #### 运行配置 `RunConfig` 主要控制Fine-tune的训练，包含以下可控制的参数: @@ -140,33 +157,24 @@ PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStr ```python seq_output = outputs["sequence_output"] -# feed_list的Tensor顺序不可以调整 -feed_list = [ - inputs["input_ids"].name, - inputs["position_ids"].name, - inputs["segment_ids"].name, - inputs["input_mask"].name, -] - reading_comprehension_task = hub.ReadingComprehensionTask( - data_reader=reader, - feature=seq_output, - feed_list=feed_list, + dataset=dataset, + feature=outputs["sequence_output"], config=config, - sub_task="squad") + sub_task="squad", +) reading_comprehension_task.finetune_and_eval() ``` **NOTE:** 1. `outputs["sequence_output"]`返回了ERNIE/BERT模型输入单词的对应输出,可以用于单词的特征表达。 -2. `feed_list`中的inputs参数指名了BERT中的输入tensor的顺序，与ReadingComprehensionReader返回的结果一致。 -3. `sub_task`指明阅读理解数据集名称，可选{squad, squad2.0, cmrc2018, drcd}, 用于适配各个数据集的模型训练过程中的评估方法。 -4. `hub.ReadingComprehensionTask`通过输入特征、段落背景、问题和答案，可以生成适用于阅读理解迁移任务ReadingComprehensionTask。 +2. `sub_task`指明阅读理解数据集名称，可选{squad, squad2.0, cmrc2018, drcd}, 用于适配各个数据集的模型训练过程中的评估方法。 +3. `hub.ReadingComprehensionTask`通过输入特征、段落背景、问题和答案，可以生成适用于阅读理解迁移任务ReadingComprehensionTask。 #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/regression/README.md b/demo/regression/README.md index 82e76cb9..ee932107 100644 --- a/demo/regression/README.md +++ b/demo/regression/README.md @@ -30,6 +30,8 @@ ### Step1: 加载预训练模型 ```python +import paddlehub as hub + module = hub.Module(name="ernie_v2_eng_base") inputs, outputs, program = module.context(trainable=True, max_seq_len=128) ``` @@ -62,30 +64,44 @@ RoBERTa-wwm-ext-large, Chinese | `hub.Module(name='roberta_wwm_ext_chinese_L module = hub.Module(name="bert_cased_L-12_H-768_A-12") ``` -### Step2: 准备数据集并使用RegressionReader读取数据 +### Step2: 准备数据集并使用tokenizer预处理数据 ```python -dataset = hub.dataset.GLUE("STS-B") -reader = hub.reader.RegressionReader( - dataset=dataset, - vocab_path=module.get_vocab_path(), - max_seq_len=args.max_seq_len) +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) +dataset = hub.dataset.GLUE( + "STS-B", tokenizer=tokenizer, max_seq_len=128) +``` +如果是使用ernie_tiny预训练模型，请使用ErnieTinyTokenizer。 +``` +tokenizer = hub.ErnieTinyTokenizer( + vocab_file=module.get_vocab_path(), + spm_path=module.get_spm_path(), + word_dict_path=module.get_word_dict_path()) ``` +ErnieTinyTokenizer和BertTokenizer的区别在于它将按词粒度进行切分，详情请参考[文章](https://www.jiqizhixin.com/articles/2019-11-06-9)。 -其中数据集的准备代码可以参考[glue.py](https://github.com/PaddlePaddle/PaddleHub/blob/release/v1.2/paddlehub/dataset/glue.py)。 +数据集的准备代码可以参考[glue.py](../../paddlehub/dataset/glue.py)。 `hub.dataset.GLUE("STS-B")` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录； `module.get_vocab_path()` 会返回预训练模型对应的词表； -`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； +`module.sp_model_path` 若module为ernie_tiny则返回对应的子词切分模型路径，否则返回None； -RegressionReader中的`data_generator`会自动按照模型对应词表对数据进行切词，以迭代器的方式返回ERNIE/BERT所需要的Tensor格式，包括`input_ids`，`position_ids`，`segment_id`与序列对应的mask `input_mask`； +`module.word_dict_path` 若module为ernie_tiny则返回对应的词语切分模型路径，否则返回None； -**NOTE**: Reader返回tensor的顺序是固定的，默认按照input_ids, position_ids, segment_id, input_mask这一顺序返回。 +`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； + +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 10 +# {'input_ids': [101, 1037, 2158, 2007, 1037, 102, 1037, 2158, 4147, 102], 'segment_ids': [0, 0, 0, 0, 0, 0, 1, 1, 1, 1], 'seq_len': 10, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'label': 5.0} +``` #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -102,7 +118,7 @@ config = hub.RunConfig(use_cuda=True, num_epoch=3, batch_size=32, strategy=strat #### 优化策略 -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)。 +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 针对ERNIE与BERT类任务，PaddleHub封装了适合这一任务的迁移学习优化策略`AdamWeightDecayStrategy`： @@ -128,29 +144,17 @@ PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStr ```python 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, -] - reg_task = hub.RegressionTask( - data_reader=reader, - feature=pooled_output, - feed_list=feed_list, - config=config) + dataset=dataset, feature=pooled_output, config=config) reg_task.finetune_and_eval() ``` **NOTE:** 1. `outputs["pooled_output"]`返回了ERNIE/BERT模型对应的[CLS]向量,可以用于句子或句对的特征表达。 -2. `feed_list`中的inputs参数指名了BERT中的输入tensor的顺序，与RegressionReader返回的结果一致。 #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/senta/README.md b/demo/senta/README.md index cb365557..ce54e846 100644 --- a/demo/senta/README.md +++ b/demo/senta/README.md @@ -85,11 +85,11 @@ reader = hub.reader.LACClassifyReader( LACClassifyReader中的`data_generator`会自动按照模型对应词表对数据进行切词，以迭代器的方式返回Senta所需要的word id； -更多数据集信息参考[Dataset](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Dataset)； +更多数据集信息参考[Dataset](../../docs/reference/dataset.md)； #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -106,7 +106,7 @@ config = hub.RunConfig(use_cuda=True, num_epoch=3, batch_size=32, strategy=strat #### 优化策略 -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)。 +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 其中`AdamWeightDecayStrategy`： diff --git a/demo/sequence_labeling/README.md b/demo/sequence_labeling/README.md index 4504858c..af166c2d 100644 --- a/demo/sequence_labeling/README.md +++ b/demo/sequence_labeling/README.md @@ -28,6 +28,8 @@ ### Step1: 加载预训练模型 ```python +import paddlehub as hub + module = hub.Module(name="ernie") inputs, outputs, program = module.context(trainable=True, max_seq_len=128) ``` @@ -60,18 +62,16 @@ RoBERTa-wwm-ext-large, Chinese | `hub.Module(name='roberta_wwm_ext_chinese_L module = hub.Module(name="bert_chinese_L-12_H-768_A-12") ``` -### Step2: 准备数据集并使用SequenceLabelReader读取数据 +### Step2: 准备数据集并使用tokenizer预处理数据 ```python -dataset = hub.dataset.MSRA_NER() -reader = hub.reader.SequenceLabelReader( - 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()) +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) +dataset = hub.dataset.MSRA_NER( + tokenizer=tokenizer, max_seq_len=128) ``` +**NOTE**: +* 即使是使用ernie_tiny预训练模型，也请使用BertTokenizer，而不要使用ErnieTinyTokenizer。因为序列标注任务需要为每一个字进行标注。 -其中数据集的准备代码可以参考[msra_ner.py](https://github.com/PaddlePaddle/PaddleHub/blob/release/v1.2/paddlehub/dataset/msra_ner.py)。 +数据集的准备代码可以参考[msra_ner.py](../../paddlehub/dataset/msra_ner.py)。 `hub.dataset.MSRA_NER()` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录； @@ -79,17 +79,17 @@ reader = hub.reader.SequenceLabelReader( `max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； -`module.sp_model_path` 和 `module.word_dict_path` 用于 ERNIE Tiny 中文sub-word中文切词技术； - -SequenceLabelReader中的`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这一顺序返回。 -* 如果选择的预训练模型不是ERNIE Tiny，则无需设定sp_model_path和word_dict_path参数。 +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 10 +# {'input_ids': [101, 100, 100, 1962, 100, 100, 1744, 100, 1749, 102], 'segment_ids': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'seq_len': 10, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'label': [6, 6, 6, 6, 6, 6, 6, 6, 6, 6]} +``` #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -105,7 +105,7 @@ config = hub.RunConfig(use_cuda=True, num_epoch=3, batch_size=32, strategy=strat ``` #### 优化策略 -PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Strategy)； +PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStrategy`、`DefaultFinetuneStrategy`等，详细信息参见[策略](../../docs/reference/strategy.md)。 针对ERNIE与BERT类任务，PaddleHub封装了适合这一任务的迁移学习优化策略`AdamWeightDecayStrategy`； @@ -132,17 +132,10 @@ PaddleHub提供了许多优化策略，如`AdamWeightDecayStrategy`、`ULMFiTStr sequence_output = outputs["sequence_output"] -# feed_list的Tensor顺序不可以调整 -feed_list = [ - inputs["input_ids"].name, inputs["position_ids"].name, - inputs["segment_ids"].name, inputs["input_mask"].name -] - seq_label_task = hub.SequenceLabelTask( - data_reader=reader, + dataset=dataset, feature=sequence_output, - feed_list=feed_list, - max_seq_len=args.max_seq_len, + max_seq_len=128, num_classes=dataset.num_labels, config=config, add_crf=False) @@ -152,13 +145,12 @@ seq_label_task.finetune_and_eval() **NOTE:** 1. `outputs["sequence_output"]`返回了ERNIE/BERT模型输入单词的对应输出,可以用于单词的特征表达； -2. `feed_list`中的inputs参数指名了ERNIE/BERT中的输入tensor的顺序，与SequenceLabelReader返回的结果一致； -3. `hub.SequenceLabelTask`通过输入特征，迁移的类别数，可以生成适用于序列标注的迁移任务`SequenceLabelTask`； -4. `hub.SequenceLabelTask`通过add_crf, 选择是否加入crf作为decoder。如果add_crf=True, 则在预训练模型计算图加入fc+crf层，否则只在在预训练模型计算图加入fc层； +2. `hub.SequenceLabelTask`通过输入特征，迁移的类别数，可以生成适用于序列标注的迁移任务`SequenceLabelTask`； +3. `hub.SequenceLabelTask`通过add_crf, 选择是否加入crf作为decoder。如果add_crf=True, 则在预训练模型计算图加入fc+crf层，否则只在在预训练模型计算图加入fc层； #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/text_classification/README.md b/demo/text_classification/README.md index 7e3c7c64..f8bc83ca 100644 --- a/demo/text_classification/README.md +++ b/demo/text_classification/README.md @@ -24,7 +24,7 @@ text_classification ## 如何开始Fine-tune -以下例子已不使用预置网络完成文本分类任务，说明PaddleHub如何完成迁移学习。使用预置网络完成文本分类任务，步骤类似。 +以下以不使用预置网络的文本分类任务为例，说明PaddleHub如何完成迁移学习。使用预置网络完成文本分类任务，步骤类似。 在完成安装PaddlePaddle与PaddleHub后，通过执行脚本`sh run_cls.sh`即可开始使用ERNIE对ChnSentiCorp数据集进行Fine-tune。 @@ -48,6 +48,8 @@ text_classification ### Step1: 加载预训练模型 ```python +import paddlehub as hub + module = hub.Module(name="ernie") inputs, outputs, program = module.context(trainable=True, max_seq_len=128) ``` @@ -80,31 +82,40 @@ RoBERTa-wwm-ext-large, Chinese | `hub.Module(name='roberta_wwm_ext_chinese_L module = hub.Module(name="bert_chinese_L-12_H-768_A-12") ``` -### Step2: 准备数据集并使用ClassifyReader读取数据 +### Step2: 准备数据集并使用tokenizer预处理数据 ```python -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(), +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) +dataset = hub.dataset.ChnSentiCorp( + tokenizer=tokenizer, max_seq_len=128) +``` +如果是使用ernie_tiny预训练模型，请使用ErnieTinyTokenizer。 +``` +tokenizer = hub.ErnieTinyTokenizer( + vocab_file=module.get_vocab_path(), + spm_path=module.get_spm_path(), word_dict_path=module.get_word_dict_path()) -metrics_choices = ["acc"] ``` +ErnieTinyTokenizer和BertTokenizer的区别在于它将按词粒度进行切分，详情请参考[文章](https://www.jiqizhixin.com/articles/2019-11-06-9)。 + +数据集的准备代码可以参考 [chnsenticorp.py](../../paddlehub/dataset/chnsenticorp.py)。 `hub.dataset.ChnSentiCorp()` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录； `module.get_vocab_path()` 会返回预训练模型对应的词表； -`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； - -`module.sp_model_path` 若module为ernie_tiny则返回对应的子词切分模型，否则返回None； +`module.sp_model_path` 若module为ernie_tiny则返回对应的子词切分模型路径，否则返回None； -`module.word_dict_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`； +`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； -**NOTE**: Reader返回tensor的顺序是固定的，默认按照input_ids, position_ids, segment_id, input_mask这一顺序返回。 +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 10 +# {'input_ids': [101, 100, 1969, 100, 100, 100, 100, 1796, 100, 102], 'segment_ids': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'seq_len': 10, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'label': 1} +``` PaddleHub还提供了其他的文本分类数据集，分两类（单句分类和句对分类），具体信息如下表 @@ -128,11 +139,11 @@ ChineseGLUE-INEWS | hub.dataset.INews() | 句对 | roberta_wwm_ext_ 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](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API:-Dataset)。 +更多数据集信息参考[Dataset](../../docs/reference/dataset.md)。 #### 自定义数据集 -如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E9%80%82%E9%85%8D%E8%87%AA%E5%AE%9A%E4%B9%89%E6%95%B0%E6%8D%AE%E5%AE%8C%E6%88%90FineTune)。 +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 ### Step3：选择优化策略和运行配置 @@ -168,39 +179,29 @@ config = hub.RunConfig(use_cuda=True, num_epoch=3, batch_size=32, strategy=strat ```python 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, + dataset=dataset, feature=pooled_output, - feed_list=feed_list, num_classes=dataset.num_labels, - config=config) + config=config, + metrics_choices=["acc"]) 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`区分。 +2. `hub.TextClassifierTask`通过输入特征，label与迁移的类别数，可以生成适用于文本分类的迁移任务`TextClassifierTask`。 +3. 使用预置网络与否，传入`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类预训练模型之后。 +4. 使用预置网络，可以通过`hub.TextClassifierTask`参数network进行指定不同的网络结构。如下代码表示选择bilstm网络拼接在Transformer类预训练模型之后。 PaddleHub文本分类任务预置网络支持BOW，Bi-LSTM，CNN，DPCNN，GRU，LSTM。指定network应是其中之一。 其中DPCNN网络实现为[ACL2017-Deep Pyramid Convolutional Neural Networks for Text Categorization](https://www.aclweb.org/anthology/P17-1052.pdf)。 ```python cls_task = hub.TextClassifierTask( - data_reader=reader, + dataset=dataset, token_feature=outputs["sequence_output"], - feed_list=feed_list, network='bilstm', num_classes=dataset.num_labels, config=config, @@ -210,7 +211,7 @@ cls_task = hub.TextClassifierTask( #### 自定义迁移任务 -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 ## 可视化 diff --git a/demo/text_generation/README.md b/demo/text_generation/README.md new file mode 100644 index 00000000..c959920a --- /dev/null +++ b/demo/text_generation/README.md @@ -0,0 +1,195 @@ +# PaddleHub 文本生成 + +本示例将展示如何使用PaddleHub Fine-tune API以及Transformer类预训练模型(ERNIE/BERT/RoBERTa)完成生成任务。 + +## 目录结构 +``` +text_generation +├── predict.py # 预测脚本 +├── README.md # 文本生成迁移学习文档说明 +├── run_text_gen.sh # 训练启动脚本 +├── run_predict.sh # # 预测启动脚本 +├── text_gen.py # 训练脚本 +``` + +## 如何开始Fine-tune + +在完成安装PaddlePaddle与PaddleHub后，通过执行脚本`sh run_text_gen.sh`即可开始使用ERNIE对Couplet数据集进行Fine-tune。 + +其中脚本参数说明如下： + +```bash +--batch_size: 批处理大小，请结合显存情况进行调整，若出现显存不足，请适当调低这一参数； +--learning_rate: Fine-tune的最大学习率； +--cut_fraction: Slanted triangular策略中学习率上升阶段的比例，如果0.1，则学习率会在前10%训练step的过程中从0慢慢增长到learning_rate, 而后再缓慢衰减，默认为learning_rate/32； +--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: 加载预训练模型 + +```python +import paddlehub as hub + +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官网](https://www.paddlepaddle.org.cn/hub?filter=hot&value=1)。 + +如果想尝试BERT模型，只需要更换Module中的`name`参数即可. +```python +# 更换name参数即可无缝切换BERT中文模型, 代码示例如下 +module = hub.Module(name="bert_chinese_L-12_H-768_A-12") +``` + +### Step2: 准备数据集并使用tokenizer预处理数据 +```python +tokenizer = hub.BertTokenizer(vocab_file=module.get_vocab_path()) +dataset = hub.dataset.Couplet( + tokenizer=tokenizer, max_seq_len=128) +``` +**NOTE**: +* 即使是使用ernie_tiny预训练模型，也请使用BertTokenizer，而不要使用ErnieTinyTokenizer。因为对联数据集中上联是按字切分并以特殊字符"\002"作为分隔符的。 + +数据集的准备代码可以参考 [couplet.py](../../paddlehub/dataset/couplet.py)。 + +`hub.dataset.Couplet()` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录； + +`module.get_vocab_path()` 会返回预训练模型对应的词表； + +`max_seq_len` 需要与Step1中context接口传入的序列长度保持一致； + +dataset将调用传入的tokenizer提供的encode接口对全量数据进行预处理，您可以通过以下方式观察数据的处理流程： +``` +single_result = tokenizer.encode(text="hello", text_pair="world", max_seq_len=10) # BertTokenizer +# {'input_ids': [3, 1, 5, 39825, 5, 0, 0, 0, 0, 0], 'segment_ids': [0, 0, 0, 1, 1, 0, 0, 0, 0, 0], 'seq_len': 5, 'input_mask': [1, 1, 1, 1, 1, 0, 0, 0, 0, 0], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]} +dataset_result = dataset.get_dev_records() # set dataset max_seq_len = 10 +# {'input_ids': [101, 1745, 1751, 100, 100, 100, 100, 100, 100, 102], 'segment_ids': [0, 0, 0, 0, 0, 0, 0, 0, 0, 0], 'seq_len': 10, 'input_mask': [1, 1, 1, 1, 1, 1, 1, 1, 1, 1], 'position_ids': [0, 1, 2, 3, 4, 5, 6, 7, 8, 9], 'label': [144, 643, 7057, 12130, 8375, 296, 525, 1884, 702, 702], 'dec_input': [134, 144, 643, 7057, 12130, 8375, 296, 525, 1884, 702]} +``` + +#### 自定义数据集 + +如果想加载自定义数据集完成迁移学习，详细参见[自定义数据集](../../docs/tutorial/how_to_load_data.md)。 + +### Step3：选择优化策略和运行配置 + +```python +strategy = hub.ULMFiTStrategy( + learning_rate=5e-3, + optimizer_name="adam", + cut_fraction=0.1, + dis_params_layer=module.get_params_layer(), + frz_params_layer=module.get_params_layer()) + +config = hub.RunConfig(use_cuda=True, num_epoch=3, batch_size=32, strategy=strategy) +``` + +#### 优化策略 +由于文本生成任务不是简单拼接全连接层即可完成，它引入了RNN seq2seq结构，带来了较多的新参数。得益于PaddleHub的ULMFiT策略，我们可以用较大的学习率更新Decoder中的参数，同时减缓Encoder中的参数更新速度。实验表明，在本任务中使用ULMFiTStrategy可以取得比AdamWeightDecayStrategy更好的效果。 + +* `learning_rate`: Fine-tune过程中的最大学习率； +* `optimizer_name`： 优化器类别。 +* `cut_fraction`: Slanted triangular策略中学习率上升阶段的比例，如果0.1，则学习率会在前10%训练step的过程中从0慢慢增长到learning_rate, 而后再缓慢衰减，默认为learning_rate/32； +* `dis_params_layer`: 分层学习率策略需要的参数层次信息，如果设置为module.get_params_layer()，预训练模型中各层神经网络的更新速度将逐层衰减，默认每一层的学习率是上一层学习率的1/2.6； +* `frz_params_layer`: 逐层解冻策略需要的参数层次信息，如果设置为module.get_params_layer()，预训练模型中各层神经网络将在训练过程中随着epoch的增大而参与更新，例如epoch=1时只有最上层参数会更新，epoch=2时最上2层参数都会参与更新； + +关于ULMFiT策略的详细说明，请参考[论文](https://arxiv.org/pdf/1801.06146.pdf)。如果您希望将ULMFiT策略与AdamWeightDecay策略进行组合实验，请参考[CombinedStrategy](../../paddlehub/finetune/strategy.py:183) + +#### 运行配置 +`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 +```python +pooled_output = outputs["pooled_output"] +sequence_output = outputs["sequence_output"] + +gen_task = hub.TextGenerationTask( + dataset=dataset, + feature=pooled_output, + token_feature=sequence_output, + max_seq_len=128, + num_classes=dataset.num_labels, + config=config, + metrics_choices=["bleu"]) + +gen_task.finetune_and_eval() +``` +**NOTE:** +1. `outputs["pooled_output"]`返回了Transformer类预训练模型对应的[CLS]向量,可以用于句子或句对的特征表达。这一特征将用于TextGenerationTask Decoder状态初始化。 +2. `outputs["sequence_output"]`返回了ERNIE/BERT模型输入单词的对应输出,可以用于单词的特征表达；这一特征将用于TextGenerationTask Decoder解码。 +3. 当前TextGenerationTask采用如下图所示的seq2seq结构： +

+ + +其中Encoder为hub.Module指定的预训练模型，Decoder为通用的Attention LSTM结构，如果您希望进一步增强Decoder性能，可以尝试修改[generation_task组网代码](../../paddlehub/finetune/task/generation_task.py:156)。 + +#### 自定义迁移任务 + +如果想改变迁移任务组网，详细参见[自定义迁移任务](../../docs/tutorial/how_to_define_task.md)。 + +## 可视化 + +Fine-tune API训练过程中会自动对关键训练指标进行打点，启动程序后执行下面命令： +```bash +$ 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_generation/" +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教程合集](https://aistudio.baidu.com/aistudio/projectdetail/231146)，可使用AI Studio平台提供的GPU算力进行快速尝试。 + + +## 超参优化AutoDL Finetuner + +PaddleHub还提供了超参优化（Hyperparameter Tuning）功能， 自动搜索最优模型超参得到更好的模型效果。详细信息参见[AutoDL Finetuner超参优化功能教程](../../docs/tutorial/autofinetune.md)。 + + +## Fine-tune之后保存的模型转化为PaddleHub Module + +代码详见[finetuned_model_to_module](./finetuned_model_to_module)文件夹下 +Fine-tune之后保存的模型转化为PaddleHub Module[教程](../../docs/tutorial/finetuned_model_to_module.md) diff --git a/docs/reference/dataset.md b/docs/reference/dataset.md index 81e065b9..4b4328b0 100644 --- a/docs/reference/dataset.md +++ b/docs/reference/dataset.md @@ -346,6 +346,25 @@ dataset = hub.dataset.THUCNEWS() 每个字段以“\_!\_”键分隔，第1列表示类别ID，第2列表示类别，第3列表示文本数据。 +### Class `hub.dataset.Couplet` + +Couplet是一个开源对联数据集，来源于https://github.com/v-zich/couplet-clean-dataset。该数据集包含74万条对联数据，已利用敏感词词库过滤、删除了低俗或敏感内容。 + +**示例** + +```python +import paddlehub as hub + +dataset = hub.dataset.Couplet() +``` +数据集样例： + +```text +亲情似日堪融雪 孝意如春可著花 +``` + +上下联中每个字以不可见字符“\002”分隔，上下联之间以tab键分隔。 + ### Class `hub.dataset.DogCatDataset` DOGCAT是由Kaggle提供的数据集，用于图像二分类，其目标是判断一张图片是猫或是狗。 -- GitLab