From c05f484bd657f3f31b1acb71c81a3a7c754a6e78 Mon Sep 17 00:00:00 2001 From: Steffy-zxf <48793257+Steffy-zxf@users.noreply.github.com> Date: Fri, 17 Jan 2020 16:30:32 +0800 Subject: [PATCH] Fix docs (#324) * update docs --- README.md | 8 ++++---- demo/README.md | 2 +- demo/autofinetune_image_classification/README.md | 2 +- demo/autofinetune_text_classification/README.md | 4 ++-- demo/image_classification/README.md | 4 ++-- demo/sequence_labeling/README.md | 4 ---- demo/text_classification/README.md | 2 +- 7 files changed, 11 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a8473361..df84d21b 100644 --- a/README.md +++ b/README.md @@ -100,11 +100,11 @@ PaddleHub同时支持安装、卸载、查看模型信息等命令行功能， * 示例合集 -PaddleHub提供了使用Finetune-API和预训练模型完成[文本分类](./demo/text_classification)、[序列标注](./demo/sequence_labeling)、[多标签分类](./demo/multi_label_classification)、[图像分类](./demo/image_classification)、[检索式问答任务](./demo/qa_classification)、[回归任务](./demo/regression)、[句子语义相似度计算](./demo/sentence_similarity)、[阅读理解任务](./demo/reading_comprehension)等迁移任务的使用示例，详细参见[demo](./demo)。 + PaddleHub提供了使用Finetune-API和预训练模型完成[文本分类](./demo/text_classification)、[序列标注](./demo/sequence_labeling)、[多标签分类](./demo/multi_label_classification)、[图像分类](./demo/image_classification)、[检索式问答任务](./demo/qa_classification)、[回归任务](./demo/regression)、[句子语义相似度计算](./demo/sentence_similarity)、[阅读理解任务](./demo/reading_comprehension)等迁移任务的使用示例，详细参见[demo](./demo)。 * 场景化使用 -PaddleHub在AI Studio上提供了IPython NoteBook形式的demo。用户可以直接在平台上在线体验，链接如下： + PaddleHub在AI Studio上提供了IPython NoteBook形式的demo。用户可以直接在平台上在线体验，链接如下： |预训练模型|任务类型|数据集|AIStudio链接|备注| |-|-|-|-|-| @@ -153,13 +153,13 @@ $ hub serving start --config config.json config.json文件包含待部署模型信息等， -关于PaddleHub Serving详细信息参考[PaddleHub Serving一键服务化部署](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-Serving%E4%B8%80%E9%94%AE%E6%9C%8D%E5%8A%A1%E9%83%A8%E7%BD%B2)。 +关于PaddleHub Serving详细信息参考[PaddleHub Serving一键服务化部署](./tutorial/serving.md)。 ### 超参优化AutoDL Finetuner 深度学习模型往往包含许多的超参数，而这些超参数的取值对模型性能起着至关重要的作用。因为模型参数空间大，目前超参调整都是通过手动，依赖人工经验或者不断尝试，且不同模型、样本数据和场景下不尽相同，所以需要大量尝试，时间成本和资源成本非常浪费。PaddleHub AutoDL Finetuner可以实现自动调整超参数，使得模型性能达到最优水平。它通过多种调优的算法来搜索最优超参。 -AutoDL Finetuner详细信息参见[PaddleHub超参优化](./tutorial/autofinetune.md) +AutoDL Finetuner详细信息参见[PaddleHub超参优化](./tutorial/autofinetune.md)。 ## FAQ diff --git a/demo/README.md b/demo/README.md index b220ac7d..cad45b20 100644 --- a/demo/README.md +++ b/demo/README.md @@ -42,7 +42,7 @@ 该样例文件夹下展示了服务化部署Hub Serving如何使用，将PaddleHub支持的可预测Module如何服务化部署。 **NOTE:** -以上任务示例均是利用PaddleHub提供的数据集，若您想在自定义数据集上完成相应任务，请查看[PaddleHub适配自定义数据完成FineTune](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) +以上任务示例均是利用PaddleHub提供的数据集，若您想在自定义数据集上完成相应任务，请查看[PaddleHub适配自定义数据完成Fine-tune](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)。 ## 在线体验 diff --git a/demo/autofinetune_image_classification/README.md b/demo/autofinetune_image_classification/README.md index 664a4ed4..8f789058 100644 --- a/demo/autofinetune_image_classification/README.md +++ b/demo/autofinetune_image_classification/README.md @@ -33,7 +33,7 @@ param_list: ## Step2:改动模型代码 -img_cls.py以mobilenet为预训练模型，在flowers数据集上进行Fine-tune。PaddleHub如何完成Finetune可以参考[图像分类迁移学习示例](../image_classification) +img_cls.py以mobilenet为预训练模型，在flowers数据集上进行Fine-tune。PaddleHub如何完成Finetune可以参考[图像分类迁移学习示例](../image_classification)。 * import paddlehub diff --git a/demo/autofinetune_text_classification/README.md b/demo/autofinetune_text_classification/README.md index 4797f479..883582e5 100644 --- a/demo/autofinetune_text_classification/README.md +++ b/demo/autofinetune_text_classification/README.md @@ -43,7 +43,7 @@ param_list: ## Step2:改动模型代码 -text_cls.py以ernie为预训练模型，在ChnSentiCorp数据集上进行Fine-tune。PaddleHub如何完成Finetune可以参考[文本分类迁移学习示例](../text_classification) +text_cls.py以ernie为预训练模型，在ChnSentiCorp数据集上进行Fine-tune。PaddleHub如何完成Finetune可以参考[文本分类迁移学习示例](../text_classification)。 * import paddlehub @@ -73,4 +73,4 @@ text_cls.py以ernie为预训练模型，在ChnSentiCorp数据集上进行Fine-tu 在完成安装PaddlePaddle与PaddleHub后，通过执行脚本`sh run_autofinetune.sh`即可开始使用超参优化功能。 -**NOTE:** 关于PaddleHub超参优化详情参考[教程](../../tutorial/autofinetune.md) +**NOTE:** 关于PaddleHub超参优化详情参考[教程](../../tutorial/autofinetune.md)。 diff --git a/demo/image_classification/README.md b/demo/image_classification/README.md index 3e7ef91d..f6dd8096 100644 --- a/demo/image_classification/README.md +++ b/demo/image_classification/README.md @@ -20,7 +20,7 @@ ## 代码步骤 -使用PaddleHub Fine-tune API进行Fine-tune可以分为4个步骤 +使用PaddleHub Fine-tune API进行Fine-tune可以分为4个步骤。 ### Step1: 加载预训练模型 @@ -29,7 +29,7 @@ module = hub.Module(name="resnet_v2_50_imagenet") inputs, outputs, program = module.context(trainable=True) ``` -PaddleHub提供许多图像分类预训练模型，如xception、mobilenet、efficientnet等，详细信息参见[图像分类模型](https://www.paddlepaddle.org.cn/hub?filter=en_category&value=ImageClassification) +PaddleHub提供许多图像分类预训练模型，如xception、mobilenet、efficientnet等，详细信息参见[图像分类模型](https://www.paddlepaddle.org.cn/hub?filter=en_category&value=ImageClassification)。 如果想尝试efficientnet模型，只需要更换Module中的`name`参数即可. ```python diff --git a/demo/sequence_labeling/README.md b/demo/sequence_labeling/README.md index 06787afb..4552eec0 100644 --- a/demo/sequence_labeling/README.md +++ b/demo/sequence_labeling/README.md @@ -160,10 +160,6 @@ seq_label_task.finetune_and_eval() 如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)。 -#### 自定义迁移任务 - -如果想改变迁移任务组网，详细参见[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task) - ## 可视化 Fine-tune API训练过程中会自动对关键训练指标进行打点，启动程序后执行下面命令： diff --git a/demo/text_classification/README.md b/demo/text_classification/README.md index 4e75b13a..d1620081 100644 --- a/demo/text_classification/README.md +++ b/demo/text_classification/README.md @@ -21,7 +21,7 @@ ## 代码步骤 -使用PaddleHub Fine-tune API进行Fine-tune可以分为4个步骤； +使用PaddleHub Fine-tune API进行Fine-tune可以分为4个步骤。 ### Step1: 加载预训练模型 -- GitLab