diff --git a/README.md b/README.md index 56bb6501d73eb4d0a4654a0043af68e963dce5d0..7313778a56a90d850089c8885c23ae61b4a93a6e 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,18 @@ [![Build Status](https://travis-ci.org/PaddlePaddle/PaddleHub.svg?branch=develop)](https://travis-ci.org/PaddlePaddle/PaddleHub) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE) -PaddleHub是基于PaddlePaddle框架开发的预训练模型管理工具,可以借助预训练模型更便捷的完成迁移学习工作。 +PaddleHub是基于PaddlePaddle开发的预训练模型管理工具,可以借助预训练模型更便捷地开展迁移学习工作。 ## 特性 通过PaddleHub,您可以: -1. 使用hub run命令,快速使用预训练模型进行预测; +1. 通过命令行,无需编写代码,一键使用预训练模型进行预测; 2. 通过hub download命令,快速地获取PaddlePaddle生态下的所有预训练模型; -3. 使用PaddleHub Finetune API对通过少量代码完成迁移学习; +3. 借助PaddleHub Finetune API,使用少量代码完成迁移学习;更多Demo可参考 [ERNIE文本分类](https://github.com/PaddlePaddle/PaddleHub/tree/develop/demo/ernie-classification) + [图像分类迁移](https://github.com/PaddlePaddle/PaddleHub/tree/develop/demo/image-classification) -想了解PaddleHub已经发布的模型,请查看[模型列表](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/released_module_list.md) ## 安装 @@ -31,7 +31,8 @@ $ pip install paddlehub ## 快速体验 -通过下面的命令,快速体验下PaddleHub的hub run功能 +如果安装成功,执行下面的命令,可以快速体验PaddleHub的一键预测功能 + ```bash # 使用百度LAC词法分析工具进行分词 $ hub run lac --input_text "今天是个好日子" @@ -40,6 +41,12 @@ $ hub run lac --input_text "今天是个好日子" $ hub run senta --input_text "今天是个好日子" ``` +想了解更多PaddleHub已经发布的模型,请使用`hub search`命令查看所有已发布的模型。 + +```bash +$ hub search +``` + ## 深入了解PaddleHub * [命令行功能](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/command_line_introduction.md) * [Finetune API与迁移学习](https://github.com/PaddlePaddle/PaddleHub/tree/develop/docs/transfer_learning_turtorial.md) diff --git a/demo/ernie-classification/README.md b/demo/ernie-classification/README.md index fc043516ac4578c6b8872c2f9b0951a98d0c9ce6..724f58f670ff7336a7ada7243dc2ac8abb66461f 100644 --- a/demo/ernie-classification/README.md +++ b/demo/ernie-classification/README.md @@ -63,7 +63,7 @@ reader = hub.reader.ClassifyReader( vocab_path=module.get_vocab_path(), max_seq_len=128) ``` -`hub.dataset.ChnSentiCorp()` 会自动从网络下载数据集并解压到用户目录下.paddlehub/dataset目录 +`hub.dataset.ChnSentiCorp()` 会自动从网络下载数据集并解压到用户目录下`$HOME/.paddlehub/dataset`目录 `module.get_vaocab_path()` 会返回ERNIE/BERT模型对应的词表 diff --git a/demo/senta/README.md b/demo/senta/README.md index 33dfbd13c2e024a8d61387ec66a0164e931e6526..2f57cf3182283523288551da31ba58bc76878748 100644 --- a/demo/senta/README.md +++ b/demo/senta/README.md @@ -1,11 +1,12 @@ -## 关于senta +## 关于Senta + https://github.com/baidu/Senta ## 创建Module 本目录包含了创建一个基于senta预训练模型的Module的脚本。 通过以下脚本来一键创建一个senta Module ```shell -sh create_module.sh +$ sh create_module.sh ``` NOTE: * 如果进行下面示例的脚本或者代码,请确保执行上述脚本 @@ -17,11 +18,11 @@ NOTE: `infer.sh`给出了使用命令行调用Module预测的示例脚本 通过以下命令试验下效果 ```shell -sh infer.sh +$ sh infer.sh ``` ### 通过python API `infer_by_code.py`给出了使用python API调用Module预测的示例代码 通过以下命令试验下效果 ```shell -python infer_by_code.py +$ python infer_by_code.py ```