README.md 5.4 KB
Newer Older
Z
Zeyu Chen 已提交
1 2
# PaddleHub

W
wuzewu 已提交
3 4
[![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)
Z
Zeyu Chen 已提交
5
[![Version](https://img.shields.io/github/release/PaddlePaddle/PaddleHub.svg)](https://github.com/PaddlePaddle/PaddleHub/releases)
W
wuzewu 已提交
6

W
wuzewu 已提交
7
PaddleHub是基于PaddlePaddle生态下的预训练模型管理和迁移学习工具,可以结合预训练模型更便捷地开展迁移学习工作。通过PaddleHub,您可以:
Z
Zeyu Chen 已提交
8

Z
Zeyu Chen 已提交
9 10 11
* 便捷地获取PaddlePaddle生态下的所有预训练模型,涵盖了图像分类、目标检测、词法分析、语义模型、情感分析、语言模型、视频分类、图像生成八类主流模型。
  * 更多详情可查看官网:http://hub.paddlepaddle.org.cn 
* 通过PaddleHub Fine-tune API,结合少量代码即可完成**大规模预训练模型**的迁移学习,具体Demo可参考以下链接:
W
wuzewu 已提交
12 13 14 15
  * [文本分类](https://github.com/PaddlePaddle/PaddleHub/tree/release/v1.0.0/demo/text-classification)
  * [序列标注](https://github.com/PaddlePaddle/PaddleHub/tree/release/v1.0.0/demo/sequence-labeling)
  * [多标签分类](https://github.com/PaddlePaddle/PaddleHub/tree/release/v1.0.0/demo/multi-label-classification)
  * [图像分类](https://github.com/PaddlePaddle/PaddleHub/tree/release/v1.0.0/demo/image-classification)
S
Steffy-zxf 已提交
16
  * [检索式问答任务](https://github.com/PaddlePaddle/PaddleHub/tree/release/v1.0.0/demo/qa_classification)
Z
Zeyu Chen 已提交
17
* PaddleHub引入『**模型即软件**』的设计理念,支持通过Python API或者命令行工具,一键完成预训练模型地预测,更方便的应用PaddlePaddle模型库。
W
wuzewu 已提交
18
  * [PaddleHub命令行工具介绍](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7)
Z
Zeyu Chen 已提交
19

W
wuzewu 已提交
20
## 环境依赖
W
wuzewu 已提交
21
* Python==2.7 or Python>=3.5
Z
Zeyu Chen 已提交
22
* PaddlePaddle>=1.4.0
Z
Zeyu Chen 已提交
23

W
wuzewu 已提交
24 25 26
除上述依赖外,PaddleHub的预训练模型和预置数据集需要连接服务端进行下载,请确保机器可以正常访问网络

## 安装
Z
Zeyu Chen 已提交
27
pip安装方式如下:
Z
Zeyu Chen 已提交
28

Z
Zeyu Chen 已提交
29
```shell
Z
Zeyu Chen 已提交
30
$ pip install paddlehub
Z
Zeyu Chen 已提交
31
```
W
wuzewu 已提交
32

Z
Zeyu Chen 已提交
33
## 快速体验
Z
Zeyu Chen 已提交
34
安装成功后,执行下面的命令,可以快速体验PaddleHub无需代码、一键预测的命令行功能:
Z
Zeyu Chen 已提交
35

W
wuzewu 已提交
36 37 38
`示例一`

使用[词法分析](http://www.paddlepaddle.org.cn/hub?filter=category&value=LexicalAnalysis)模型LAC进行分词
Z
Zeyu Chen 已提交
39
```shell
Z
Zeyu Chen 已提交
40
$ hub run lac --input_text "今天是个好日子"
W
wuzewu 已提交
41 42
[{'word': ['今天', '是', '个', '好日子'], 'tag': ['TIME', 'v', 'q', 'n']}]
```
Z
Zeyu Chen 已提交
43

W
wuzewu 已提交
44
`示例二`
Z
Zeyu Chen 已提交
45

W
wuzewu 已提交
46 47 48 49
使用[情感分析](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}]
W
wuzewu 已提交
50
```
Z
Zeyu Chen 已提交
51

W
wuzewu 已提交
52
`示例三`
Z
Zeyu Chen 已提交
53

W
wuzewu 已提交
54
使用[目标检测](http://www.paddlepaddle.org.cn/hub?filter=category&value=ObjectDetection)模型 SSD/YOLO v3/Faster RCNN 对图片进行目标检测
Z
Zeyu Chen 已提交
55
```shell
W
wuzewu 已提交
56 57
$ 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
W
wuzewu 已提交
58 59
$ hub run yolov3_coco2017 --input_path test_object_detection.jpg
$ hub run faster_rcnn_coco2017 --input_path test_object_detection.jpg
Z
Zeyu Chen 已提交
60
```
W
wuzewu 已提交
61 62
![SSD检测结果](https://raw.githubusercontent.com/PaddlePaddle/PaddleHub/release/v1.0.0/docs/imgs/object_detection_result.png)

Z
Zeyu Chen 已提交
63
除了上述三类模型外,PaddleHub还发布了语言模型、语义模型、图像分类、生成模型、视频分类等业界主流模型,更多PaddleHub已经发布的模型,请前往 http://hub.paddlepaddle.org.cn 查看
W
wuzewu 已提交
64 65 66 67 68 69 70

## 教程

[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)

W
wuzewu 已提交
71
[自定义迁移任务](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub:-%E8%87%AA%E5%AE%9A%E4%B9%89Task)
W
wuzewu 已提交
72

W
wuzewu 已提交
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
## 在线体验
我们在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)

Z
Zeyu Chen 已提交
91 92
## 答疑

Z
Zeyu Chen 已提交
93
当安装或者使用遇到问题时,可以通过[FAQ](https://github.com/PaddlePaddle/PaddleHub/wiki/PaddleHub-FAQ)查找解决方案。
W
wuzewu 已提交
94
如果在FAQ中没有找到解决方案,欢迎您将问题和bug报告以[Github Issues](https://github.com/PaddlePaddle/PaddleHub/issues)的形式提交给我们,我们会第一时间进行跟进
Z
Zeyu Chen 已提交
95 96

## 版权和许可证
Z
Zeyu Chen 已提交
97
PaddleHub由[Apache-2.0 license](LICENSE)提供