Skip to content

Commit a3888f3

Browse files
Refine index of docs (#658)
1 parent 95160fc commit a3888f3

File tree

84 files changed

+560
-1396
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+560
-1396
lines changed

README.md

+72-29
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# PaddleSlim
22

3-
中文 | [English](README_en.md)
4-
53
[![Documentation Status](https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat)](https://paddleslim.readthedocs.io/en/latest/)
64
[![Documentation Status](https://img.shields.io/badge/中文文档-最新-brightgreen.svg)](https://paddleslim.readthedocs.io/zh_CN/latest/)
75
[![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](LICENSE)
@@ -16,7 +14,7 @@ PaddleSlim是一个专注于深度学习模型压缩的工具库,提供**剪
1614
| :-----------: | :------------: | :------------:| :----------:|
1715
| 1.0.1 | <=1.7 | 2.7 | 支持静态图 |
1816
| 1.1.1 | 1.8 | 2.7 | 支持静态图 |
19-
| 1.2.0 | 2.0Beta/RC | 2.8 | 支持静态图; 新增CPU预测 |
17+
| 1.2.0 | 2.0Beta/RC | 2.8 | 支持静态图 |
2018
| 2.0.0 | 2.0 | 2.8 | 支持动态图和静态图 |
2119

2220

@@ -29,12 +27,15 @@ pip install paddleslim -i https://pypi.tuna.tsinghua.edu.cn/simple
2927

3028
安装指定版本:
3129
```bash
32-
pip install paddleslim=1.2.0 -i https://pypi.tuna.tsinghua.edu.cn/simple
30+
pip install paddleslim=2.0.0 -i https://pypi.tuna.tsinghua.edu.cn/simple
3331
```
3432

3533
## 最近更新
3634

3735
2021.2.5: 发布V2.0.0版本,新增支持动态图,新增OFA压缩功能,优化剪枝功能。
36+
2020.9.16: 发布V1.2.0版本,新增PACT量化训练功能,新增DML(互蒸馏功能),修复部分剪裁bug,加强对depthwise_conv2d的剪裁能力,优化剪裁和量化API的易用性和灵活性。
37+
38+
更多信息请参考:[release note](https://github.com/PaddlePaddle/PaddleSlim/releases)
3839

3940
## 功能概览
4041

@@ -105,52 +106,92 @@ PaddleSlim在典型视觉和自然语言处理任务上做了模型压缩,并
105106

106107
## 文档教程
107108

108-
### 快速上手
109+
### 快速开始
109110

110-
- 量化训练 - [动态图]() | [静态图]()
111-
- 离线量化 - [动态图]() | [静态图]()
112-
- 剪裁 - [动态图]() | [静态图]()
113-
- 蒸馏 - [动态图]() | [静态图]()
114-
- NAS - [动态图]() | [静态图]()
111+
- 量化训练 - [动态图](docs/zh_cn/quick_start/dygraph/dygraph_quant_aware_training_tutorial.md) | [静态图](docs/zh_cn/quick_start/static/quant_aware_tutorial.md)
112+
- 离线量化 - [动态图](docs/zh_cn/quick_start/dygraph/dygraph_quant_post_tutorial.md) | [静态图](docs/zh_cn/quick_start/static/quant_post_static_tutorial.md)
113+
- 剪裁 - [动态图](docs/zh_cn/quick_start/dygraph/dygraph_pruning_tutorial.md) | [静态图](docs/zh_cn/quick_start/static/pruning_tutorial.md)
114+
- 蒸馏 - [静态图](docs/zh_cn/quick_start/static/distillation_tutorial.md)
115+
- NAS - [静态图](docs/zh_cn/quick_start/static/nas_tutorial.md)
115116

116117
### 进阶教程
117118

118-
#### 压缩功能详解
119+
- 通道剪裁
120+
- [四种剪裁策略效果对比与应用方法](docs/zh_cn/tutorials/pruning/overview.md)
121+
- [L1NormFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#l1normfilterpruner)
122+
- [FPGMFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#fpgmfilterpruner)
123+
- [SlimFilterFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#slimfilterpruner)
124+
- [OptSlimFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#optslimfilterpruner)
125+
- 剪裁功能详解: [动态图](docs/zh_cn/tutorials/pruning/dygraph/filter_pruning.md) | [静态图](docs/zh_cn/tutorials/pruning/static/image_classification_sensitivity_analysis_tutorial.md)
126+
- 自定义剪裁策略:[动态图](docs/zh_cn/tutorials/pruning/dygraph/self_defined_filter_pruning.md)
127+
128+
- 低比特量化
129+
- [三种量化方法介绍与应用](docs/zh_cn/tutorials/quant/overview.md)
130+
- 量化训练:[动态图](docs/zh_cn/tutorials/quant/dygraph/quant_aware_training_tutorial.md) | [静态图](docs/zh_cn/quick_start/static/quant_aware_tutorial.md)
131+
- 离线量化:[动态图](docs/zh_cn/tutorials/quant/dygraph/dygraph_quant_post_tutorial.md) | [静态图](docs/zh_cn/tutorials/quant/static/quant_post_tutorial.md)
132+
- embedding量化:[静态图](docs/zh_cn/tutorials/quant/static/embedding_quant_tutorial.md)
133+
134+
- NAS
135+
- [四种NAS策略介绍和应用](docs/zh_cn/tutorials/nas/overview.md)
136+
137+
- 蒸馏
138+
- [知识蒸馏示例](demo/distillation)
119139

120-
[量化训练]() | [离线量化]() | [剪裁]() | [蒸馏]() | [NAS]()
121140

122141
#### 推理部署
123142

124-
- [概述]()
125-
- [PaddleInference量化部署]()
126-
- [Intel CPU量化部署]()
127-
- [GPU量化部署]()
128-
- [PaddleLite量化部署]()
143+
- [Intel CPU量化部署](demo/mkldnn_quant/README.md)
144+
- [Nvidia GPU量化部署](demo/quant/deploy/TensorRT/README.md)
145+
- [PaddleLite量化部署](docs/zh_cn/deploy/deploy_cls_model_on_mobile_device.md)
129146

130147
### CV模型压缩
131148

132-
- [检测模型压缩(基于PaddleDetection)]()
133-
- YOLOv3 3.5倍加速方案
149+
- 检测模型压缩(基于PaddleDetection)
150+
- 压缩方案
151+
- YOLOv3 3.5倍加速方案: 文档整理中...
152+
- 方法应用-静态图
153+
- [在COCO和VOC上蒸馏MobileNetV1-YOLOv3](docs/zh_cn/cv/detection/static/paddledetection_slim_distillation_tutorial.md)
154+
- [MobileNetV1-YOLOv3低比特量化训练](docs/zh_cn/cv/detection/static/paddledetection_slim_quantization_tutorial.md)
155+
- [人脸检测模型小模型结构搜索](docs/zh_cn/cv/detection/static/paddledetection_slim_nas_tutorial.md)
156+
- [剪枝](docs/zh_cn/cv/detection/static/paddledetection_slim_pruing_tutorial.md)
157+
- [剪枝与蒸馏的结合使用](docs/zh_cn/cv/detection/static/paddledetection_slim_prune_dist_tutorial.md)
158+
- [卷积层敏感度分析](docs/zh_cn/cv/detection/static/paddledetection_slim_sensitivy_tutorial.md)
159+
- 方法应用-动态图
160+
- 文档整理中...
161+
162+
- 分割模型压缩(基于PaddleSeg)
163+
164+
- 压缩方案
165+
- 方案建设中...
134166

135-
- [分割模型压缩(基于PaddleSeg)]()
167+
- 方法应用-静态图
168+
- 文档整理中...
169+
170+
- 方法应用-动态图
171+
- 文档整理中...
136172

137173
- [OCR模型压缩(基于PaddleOCR)]()
138-
- [3.5M模型压缩方案]()
139174

140-
### NLP模型压缩
175+
- 压缩方案
176+
- 3.5M模型压缩方案: 文档整理中...
177+
178+
- 方法应用-静态图
179+
- [低比特量化训练](https://github.com/PaddlePaddle/PaddleOCR/tree/release/1.1/deploy/slim/quantization)
180+
- [剪枝](https://github.com/PaddlePaddle/PaddleOCR/tree/release/1.1/deploy/slim/prune)
141181

142-
- [BERT]()
143-
- [ERNIE]()
182+
- 方法应用-动态图
183+
- 文档整理中...
144184

145-
### 通用轻量级模型
146185

147-
- 人脸模型(SlimfaceNet)
148-
- 图像分类模型(SlimMobileNet)
186+
### NLP模型压缩
187+
188+
- [BERT](docs/zh_cn/nlp/paddlenlp_slim_ofa_tutorial.md)
189+
- [ERNIE](docs/zh_cn/nlp/ernie_slim_ofa_tutorial.md)
149190

150191
### API文档
151192

152-
- 动态图
153-
- 静态图
193+
- [动态图](docs/zh_cn/api_cn/dygraph)
194+
- [静态图](docs/zh_cn/api_cn/static)
154195

155196
### [FAQ]()
156197

@@ -163,3 +204,5 @@ PaddleSlim在典型视觉和自然语言处理任务上做了模型压缩,并
163204
我们非常欢迎你可以为PaddleSlim提供代码,也十分感谢你的反馈。
164205

165206
## 欢迎加入PaddleSlim技术交流群
207+
208+
请添加微信公众号"AIDigest",备注“压缩”,飞桨同学会拉您进入微信交流群。

demo/mkldnn_quant/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaddleSlim INT8量化模型在CPU上的部署和预测
1+
# Intel CPU量化部署
22

33
## 概述
44

demo/quant/deploy/TensorRT/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# PaddleSlim INT8量化模型使用TensorRT的部署和预测
1+
# Nvidia GPU量化部署
22

33
## 概述
44
NVIDIA TensorRT 是一个高性能的深度学习预测库,适用于Nvidia GPU,可为深度学习推理应用程序提供低延迟和高吞吐量。PaddlePaddle 采用子图的形式对TensorRT进行了集成,即我们可以使用该模块来提升Paddle模型的预测性能。本教程将介绍如何使用TensortRT部署PaddleSlim量化得到的模型,无论是量化训练(QAT)还是离线量化(PTQ)模型均可支持。对于常见图像分类模型,INT8模型的推理速度通常是FP32模型的3.2-6.7倍。

docs/images/algo/ofa_bert.jpg

-990 KB
Binary file not shown.

docs/zh_cn/CHANGELOG.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
## 最新版本信息
44

5+
### v2.0.0(02/2020)
6+
7+
- 新增支持动态图剪枝、量化
8+
- 新增OFA压缩策略
9+
- 修复若干剪枝相关问题
10+
11+
## 历史版本信息
12+
13+
### v1.2.0
14+
15+
- 新增PACT量化训练功能,提升PaddleSlim在图像目标检测、图像语义分割、OCR等模型上的量化训练效果。
16+
- 新增DML(互蒸馏功能),提升部分模型的蒸馏效果。
17+
- 修复部分剪裁bug,加强对depthwise_conv2d的剪裁能力。
18+
- 优化剪裁和量化API的易用性和灵活性。
19+
20+
521
### v1.1.0(05/2020)
622

723
- 量化
@@ -17,8 +33,6 @@
1733
- 新增一种基于强化学习的模型结构搜索策略,并提供扩展接口,为用户调研实现新策略提供参考。
1834

1935

20-
## 历史版本信息
21-
2236
### v1.0.1
2337

2438
- 拆分PaddleSlim为独立repo。

0 commit comments

Comments
 (0)