diff --git a/README.md b/README.md index 0094651e527d532b0290faa52db409d04639aadd..37d7882d96a5b66cbb7ffbdd47b44265f1782b88 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # PaddleHub +## 目录 + +* [简介]() +* [环境依赖]() +* [安装]() +* [快速体验]() +* [教程]() +* [在线体验]() +* [FAQ]() +* [用户交流群]() +* [更新历史]() + +## 简介 + [![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) [![Version](https://img.shields.io/github/release/PaddlePaddle/PaddleHub.svg)](https://github.com/PaddlePaddle/PaddleHub/releases) @@ -17,19 +31,78 @@ PaddleHub是基于PaddlePaddle生态下的预训练模型管理和迁移学习 * PaddleHub引入『**模型即软件**』的设计理念，支持通过Python API或者命令行工具，一键完成预训练模型地预测，更方便的应用PaddlePaddle模型库。 * [PaddleHub命令行工具介绍](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7) -## 用户交流群 - -* 飞桨PaddlePaddle 交流群：432676488（QQ群） -* 飞桨 ERNIE交流群：760439550（QQ群） - - ## 环境依赖 * Python==2.7 or Python>=3.5 * PaddlePaddle>=1.4.0 除上述依赖外，PaddleHub的预训练模型和预置数据集需要连接服务端进行下载，请确保机器可以正常访问网络 -## 常见问题 +## 安装 +pip安装方式如下： + +```shell +$ pip install paddlehub +``` + +## 快速体验 +安装成功后，执行下面的命令，可以快速体验PaddleHub无需代码、一键预测的命令行功能： + +`示例一` + +使用[词法分析](http://www.paddlepaddle.org.cn/hub?filter=category&value=LexicalAnalysis)模型LAC进行分词 +```shell +$ hub run lac --input_text "今天是个好日子" +[{'word': ['今天', '是', '个', '好日子'], 'tag': ['TIME', 'v', 'q', 'n']}] +``` + +`示例二` + +使用[情感分析](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}] +``` + +`示例三` + +使用[目标检测](http://www.paddlepaddle.org.cn/hub?filter=category&value=ObjectDetection)模型 SSD/YOLO v3/Faster RCNN 对图片进行目标检测 +```shell +$ 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_coco2017 --input_path test_object_detection.jpg +$ hub run faster_rcnn_coco2017 --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://hub.paddlepaddle.org.cn 查看 + +## 教程 + +[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) + +[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task) + +## 在线体验 +我们在AI Studio和AIBook上提供了IPython NoteBook形式的demo，您可以直接在平台上在线体验，链接如下： +* ERNIE文本分类: + * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79380) + * [AIBook](https://console.bce.baidu.com/bml/?_=1562072915183#/bml/aibook/ernie_txt_cls) +* ERNIE序列标注: + * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79377) + * [AIBook](https://console.bce.baidu.com/bml/?_=1562072915183#/bml/aibook/ernie_seq_label) +* ELMo文本分类: + * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79400) + * [AIBook](https://console.bce.baidu.com/bml/#/bml/aibook/elmo_txt_cls) +* senta情感分类: + * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79398) + * [AIBook](https://console.bce.baidu.com/bml/#/bml/aibook/senta_bilstm) +* 图像分类: + * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79378) + * [AIBook](https://console.bce.baidu.com/bml/#/bml/aibook/img_cls) + +## FAQ ### 问题一 @@ -95,75 +168,16 @@ PaddleHub 1.1.1版本已支持离线运行Module 参考[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) -## 答疑 +### 更多问题 当安装或者使用遇到问题时，可以通过[FAQ](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-FAQ)查找解决方案。 如果在FAQ中没有找到解决方案，欢迎您将问题和bug报告以[Github Issues](https://github.com/PaddlePaddle/PaddleHub/issues)的形式提交给我们，我们会第一时间进行跟进 -## 安装 -pip安装方式如下： - -```shell -$ pip install paddlehub -``` - -## 快速体验 -安装成功后，执行下面的命令，可以快速体验PaddleHub无需代码、一键预测的命令行功能： - -`示例一` - -使用[词法分析](http://www.paddlepaddle.org.cn/hub?filter=category&value=LexicalAnalysis)模型LAC进行分词 -```shell -$ hub run lac --input_text "今天是个好日子" -[{'word': ['今天', '是', '个', '好日子'], 'tag': ['TIME', 'v', 'q', 'n']}] -``` - -`示例二` - -使用[情感分析](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}] -``` - -`示例三` - -使用[目标检测](http://www.paddlepaddle.org.cn/hub?filter=category&value=ObjectDetection)模型 SSD/YOLO v3/Faster RCNN 对图片进行目标检测 -```shell -$ 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_coco2017 --input_path test_object_detection.jpg -$ hub run faster_rcnn_coco2017 --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://hub.paddlepaddle.org.cn 查看 - -## 教程 - -[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) +* 飞桨PaddlePaddle 交流群：432676488（QQ群） +* 飞桨 ERNIE交流群：760439550（QQ群） -[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task) - -## 在线体验 -我们在AI Studio和AIBook上提供了IPython NoteBook形式的demo，您可以直接在平台上在线体验，链接如下： -* ERNIE文本分类: - * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79380) - * [AIBook](https://console.bce.baidu.com/bml/?_=1562072915183#/bml/aibook/ernie_txt_cls) -* ERNIE序列标注: - * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79377) - * [AIBook](https://console.bce.baidu.com/bml/?_=1562072915183#/bml/aibook/ernie_seq_label) -* ELMo文本分类: - * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79400) - * [AIBook](https://console.bce.baidu.com/bml/#/bml/aibook/elmo_txt_cls) -* senta情感分类: - * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79398) - * [AIBook](https://console.bce.baidu.com/bml/#/bml/aibook/senta_bilstm) -* 图像分类: - * [AI Studio](https://aistudio.baidu.com/aistudio/projectDetail/79378) - * [AIBook](https://console.bce.baidu.com/bml/#/bml/aibook/img_cls) ## 更新历史 @@ -175,8 +189,6 @@ $ hub run faster_rcnn_coco2017 --input_path test_object_detection.jpg ### PaddleHub v1.1.0 * PaddleHub 新增 ERNIE 2.0 - * 升级Reader， 支持自动传送数据给Ernie 1.0/2.0 - * 新增数据集GLUE(MRPC、QQP、SST-2、CoLA、QNLI、RTE、MNLI) ### PaddleHub v1.0.1 @@ -184,27 +196,9 @@ $ hub run faster_rcnn_coco2017 --input_path test_object_detection.jpg ### PaddleHub v1.0.0 -* 全新发布PaddleHub官网，易用性全面提升 - * 新增网站 http://hub.paddlepaddle.org.cn 包含PaddlePaddle生态的预训练模型使用介绍 - * 迁移学习Demo接入AI Studio与AI Book,无需安装即可快速体验 - +* 全新发布[PaddleHub官网](http://hub.paddlepaddle.org.cn)，易用性全面提升 * 新增29个预训练模型，覆盖文本、图像、视频三大领域；目前官方提供40个预训练模型 - * CV预训练模型： - * 新增图像分类预训练模型11个：SE_ResNeXt, GoogleNet, ShuffleNet等 - * 新增目标检测模型Faster-RCNN和YOLOv3 - * 新增图像生成模型CycleGAN - * 新增人脸检测模型Pyramidbox - * 新增视频分类模型4个: TSN, TSM, StNet, Non-Local - * NLP预训练模型 - * 新增语义模型ELMo - * 新增情感分析模型5个: Senta-BOW, Senta-CNN, Senta-GRNN, , Senta-LSTM, EmoTect - * 新增中文语义相似度分析模型SimNet - * 升级LAC词法分析模型，新增词典干预功能，支持用户自定义分词 * Fine-tune API升级，灵活性与性能全面提升 - * 支持多卡并行、PyReader多线程IO，Fine-tune速度提升60% - * 简化finetune、evaluate、predict等使用逻辑，提升易用性 - * 增加事件回调功能，方便用户快速实现自定义迁移学习任务 - * 新增多标签分类Fine-tune任务 ### PaddleHub v0.5.0 @@ -218,5 +212,7 @@ $ hub run faster_rcnn_coco2017 --input_path test_object_detection.jpg * 迁移学习: 提供了基于预训练模型的Finetune API，用户通过少量代码即可完成迁移学习，包括BERT/ERNIE文本分类、序列标注、图像分类迁移等。 + + ## 版权和许可证 PaddleHub由[Apache-2.0 license](LICENSE)提供