diff --git a/README.md b/README.md index 8a4e67e7c957c700a197048a74b293ae45a8509f..5cb4233cf6038de8e86de611a3b48a14b1152f21 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,15 @@ [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE) [![Version](https://img.shields.io/github/release/PaddlePaddle/PaddleHub.svg)](https://github.com/PaddlePaddle/PaddleHub/releases) -PaddleHub是基于PaddlePaddle开发的预训练模型管理工具,可以借助预训练模型更便捷地开展迁移学习工作。 +PaddleHub是基于PaddlePaddle生态下的预训练模型管理和迁移学习工具,可以结合预训练模型更便捷地开展迁移学习工作。通过PaddleHub,您可以: -## 特性 +1. 便捷地获取PaddlePaddle生态下的所有预训练模型,涵盖了图像分类、目标检测、词法分析、语义模型、情感分析、语言模型、视频分类、图像生成等主流模型 +2. 借助PaddleHub Finetune API,结合Paddle的预训练模型,使用少量代码完成迁移学习 +3. 借助PaddleHub Python API或者命令行,一键使用预训练模型进行预测 -通过PaddleHub,您可以: - -1. 通过命令行,无需编写代码,一键使用预训练模型进行预测; -2. 通过hub download命令,快速地获取PaddlePaddle生态下的所有预训练模型; -3. 借助PaddleHub Finetune API,使用少量代码完成迁移学习; - - 更多Demo可参考 [ERNIE文本分类](https://github.com/PaddlePaddle/PaddleHub/tree/develop/demo/text-classification) [图像分类迁移](https://github.com/PaddlePaddle/PaddleHub/tree/develop/demo/image-classification) - - 完整教程可参考 [文本分类迁移教程](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E6%96%87%E6%9C%AC%E5%88%86%E7%B1%BB%E8%BF%81%E7%A7%BB%E6%95%99%E7%A8%8B) [图像分类迁移教程](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E5%9B%BE%E5%83%8F%E5%88%86%E7%B1%BB%E8%BF%81%E7%A7%BB%E6%95%99%E7%A8%8B) +[**PaddleHub官方网站**](http://www.paddlepaddle.org.cn/hub) ## 安装 - **环境依赖** * Python==2.7 or Python>=3.5 * PaddlePaddle>=1.4.0 @@ -27,40 +22,60 @@ pip安装方式如下: ```shell $ pip install paddlehub ``` - ## 快速体验 - 安装成功后,执行下面的命令,可以快速体验PaddleHub无需代码、一键预测的命令行功能: +`示例一` + +使用[词法分析](http://www.paddlepaddle.org.cn/hub?filter=category&value=LexicalAnalysis)模型LAC进行分词 ```shell -# 使用百度LAC词法分析工具进行分词 $ hub run lac --input_text "今天是个好日子" +[{'word': ['今天', '是', '个', '好日子'], 'tag': ['TIME', 'v', 'q', 'n']}] +``` -# 使用百度Senta情感分析模型对句子进行预测 -$ hub run senta_bilstm --input_text "今天是个好日子" +`示例二` -# 使用SSD检测模型对图片进行目标检测,检测结果如下图所示 -$ wget --no-check-certificate https://paddlehub.bj.bcebos.com/resources/test_img_bird.jpg -$ hub run ssd_mobilenet_v1_pascal --input_path test_img_bird.jpg +使用[情感分析](http://www.paddlepaddle.org.cn/hub?filter=category&value=SentimentAnalysis)模型Senta对句子进行情感预测 +```shell +$ hub run senta_bilstm --input_text "今天是个好日子" +[{'text': '今天是个好日子', 'sentiment_label': 2, 'sentiment_key': 'positive', 'positive_probs': 0.6065, 'negative_probs': 0.3935}] ``` -![SSD检测结果](https://raw.githubusercontent.com/PaddlePaddle/PaddleHub/develop/docs/imgs/test_img_bird_output.jpg) -想了解更多PaddleHub已经发布的模型,请使用`hub search`命令查看所有已发布的模型。 +`示例三` +使用[目标检测](http://www.paddlepaddle.org.cn/hub?filter=category&value=ObjectDetection)模型 SSD/YOLO v3/Faster RCNN 对图片进行目标检测 ```shell -$ hub search +$ wget --no-check-certificate https://paddlehub.bj.bcebos.com/resources/test_object_detection.jpg +$ hub run ssd_mobilenet_v1_pascal --input_path test_object_detection.jpg +$ hub run yolov3 --input_path test_object_detection.jpg +$ hub run faster_rcnn --input_path test_object_detection.jpg ``` +![SSD检测结果](https://raw.githubusercontent.com/PaddlePaddle/PaddleHub/release/v1.0.0/docs/imgs/object_detection_result.png) + +除了上述三大类模型外,PaddleHub还发布了语言模型、语义模型、图像分类与特征提取、生成模型等业界主流模型,更多PaddleHub已经发布的模型,请前往[官网](http://www.paddlepaddle.org.cn/hub)查看 + +## 教程 + +[API](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-Finetune-API) + +[迁移学习](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E4%B8%8E%E8%BF%81%E7%A7%BB%E5%AD%A6%E4%B9%A0) + +[自定义Task](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-API自定义Task) + +[命令行工具](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7) + +## 在线体验 + +我们与百度AIPE部门合作,提供了Finetune demo的在线运行环境,您可以在上面快速体验如何使用PaddleHub进行迁移学习 -## 深入了解PaddleHub -* [PaddleHub Wiki](https://github.com/PaddlePaddle/PaddleHub/wiki) -* [命令行工具](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7) -* [Finetune API与迁移学习](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E4%B8%8E%E8%BF%81%E7%A7%BB%E5%AD%A6%E4%B9%A0) -* [API](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-Finetune-API) +* 基于ERNIE模型的文本分类任务 [ernie_text_cls]() +* 基于ERNIE模型的序列标注任务 [ernie_seq_label]() +* 基于ResNet50的图像分类任务 [resnet_img_cls]() ## 答疑 当安装或者使用遇到问题时,可以通过[FAQ](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-FAQ)查找解决方案。 -如果在FAQ中没有找到解决方案,欢迎您将问题和bug报告以[Github Issues](https://github.com/PaddlePaddle/PaddleHub/issues)的形式提交 +如果在FAQ中没有找到解决方案,欢迎您将问题和bug报告以[Github Issues](https://github.com/PaddlePaddle/PaddleHub/issues)的形式提交给我们,我们会第一时间进行跟进 ## 版权和许可证 PaddleHub由[Apache-2.0 license](LICENSE)提供 diff --git a/docs/imgs/object_detection_result.png b/docs/imgs/object_detection_result.png new file mode 100644 index 0000000000000000000000000000000000000000..ce3ffaa08b27a9b8ae6315be1c761f652c5f16e4 Binary files /dev/null and b/docs/imgs/object_detection_result.png differ