Skip to content

Commit

Permalink
Refine index of docs (PaddlePaddle#658)
Browse files Browse the repository at this point in the history
  • Loading branch information
wanghaoshuang authored Feb 9, 2021
1 parent 95160fc commit a3888f3
Show file tree
Hide file tree
Showing 84 changed files with 560 additions and 1,396 deletions.
101 changes: 72 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# PaddleSlim

中文 | [English](README_en.md)

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


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

安装指定版本:
```bash
pip install paddleslim=1.2.0 -i https://pypi.tuna.tsinghua.edu.cn/simple
pip install paddleslim=2.0.0 -i https://pypi.tuna.tsinghua.edu.cn/simple
```

## 最近更新

2021.2.5: 发布V2.0.0版本,新增支持动态图,新增OFA压缩功能,优化剪枝功能。
2020.9.16: 发布V1.2.0版本,新增PACT量化训练功能,新增DML(互蒸馏功能),修复部分剪裁bug,加强对depthwise_conv2d的剪裁能力,优化剪裁和量化API的易用性和灵活性。

更多信息请参考:[release note](https://github.com/PaddlePaddle/PaddleSlim/releases)

## 功能概览

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

## 文档教程

### 快速上手
### 快速开始

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

### 进阶教程

#### 压缩功能详解
- 通道剪裁
- [四种剪裁策略效果对比与应用方法](docs/zh_cn/tutorials/pruning/overview.md)
- [L1NormFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#l1normfilterpruner)
- [FPGMFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#fpgmfilterpruner)
- [SlimFilterFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#slimfilterpruner)
- [OptSlimFilterPruner](docs/zh_cn/tutorials/pruning/overview.md#optslimfilterpruner)
- 剪裁功能详解: [动态图](docs/zh_cn/tutorials/pruning/dygraph/filter_pruning.md) | [静态图](docs/zh_cn/tutorials/pruning/static/image_classification_sensitivity_analysis_tutorial.md)
- 自定义剪裁策略:[动态图](docs/zh_cn/tutorials/pruning/dygraph/self_defined_filter_pruning.md)

- 低比特量化
- [三种量化方法介绍与应用](docs/zh_cn/tutorials/quant/overview.md)
- 量化训练:[动态图](docs/zh_cn/tutorials/quant/dygraph/quant_aware_training_tutorial.md) | [静态图](docs/zh_cn/quick_start/static/quant_aware_tutorial.md)
- 离线量化:[动态图](docs/zh_cn/tutorials/quant/dygraph/dygraph_quant_post_tutorial.md) | [静态图](docs/zh_cn/tutorials/quant/static/quant_post_tutorial.md)
- embedding量化:[静态图](docs/zh_cn/tutorials/quant/static/embedding_quant_tutorial.md)

- NAS
- [四种NAS策略介绍和应用](docs/zh_cn/tutorials/nas/overview.md)

- 蒸馏
- [知识蒸馏示例](demo/distillation)

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

#### 推理部署

- [概述]()
- [PaddleInference量化部署]()
- [Intel CPU量化部署]()
- [GPU量化部署]()
- [PaddleLite量化部署]()
- [Intel CPU量化部署](demo/mkldnn_quant/README.md)
- [Nvidia GPU量化部署](demo/quant/deploy/TensorRT/README.md)
- [PaddleLite量化部署](docs/zh_cn/deploy/deploy_cls_model_on_mobile_device.md)

### CV模型压缩

- [检测模型压缩(基于PaddleDetection)]()
- YOLOv3 3.5倍加速方案
- 检测模型压缩(基于PaddleDetection)
- 压缩方案
- YOLOv3 3.5倍加速方案: 文档整理中...
- 方法应用-静态图
- [在COCO和VOC上蒸馏MobileNetV1-YOLOv3](docs/zh_cn/cv/detection/static/paddledetection_slim_distillation_tutorial.md)
- [MobileNetV1-YOLOv3低比特量化训练](docs/zh_cn/cv/detection/static/paddledetection_slim_quantization_tutorial.md)
- [人脸检测模型小模型结构搜索](docs/zh_cn/cv/detection/static/paddledetection_slim_nas_tutorial.md)
- [剪枝](docs/zh_cn/cv/detection/static/paddledetection_slim_pruing_tutorial.md)
- [剪枝与蒸馏的结合使用](docs/zh_cn/cv/detection/static/paddledetection_slim_prune_dist_tutorial.md)
- [卷积层敏感度分析](docs/zh_cn/cv/detection/static/paddledetection_slim_sensitivy_tutorial.md)
- 方法应用-动态图
- 文档整理中...

- 分割模型压缩(基于PaddleSeg)

- 压缩方案
- 方案建设中...

- [分割模型压缩(基于PaddleSeg)]()
- 方法应用-静态图
- 文档整理中...

- 方法应用-动态图
- 文档整理中...

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

### NLP模型压缩
- 压缩方案
- 3.5M模型压缩方案: 文档整理中...

- 方法应用-静态图
- [低比特量化训练](https://github.com/PaddlePaddle/PaddleOCR/tree/release/1.1/deploy/slim/quantization)
- [剪枝](https://github.com/PaddlePaddle/PaddleOCR/tree/release/1.1/deploy/slim/prune)

- [BERT]()
- [ERNIE]()
- 方法应用-动态图
- 文档整理中...

### 通用轻量级模型

- 人脸模型(SlimfaceNet)
- 图像分类模型(SlimMobileNet)
### NLP模型压缩

- [BERT](docs/zh_cn/nlp/paddlenlp_slim_ofa_tutorial.md)
- [ERNIE](docs/zh_cn/nlp/ernie_slim_ofa_tutorial.md)

### API文档

- 动态图
- 静态图
- [动态图](docs/zh_cn/api_cn/dygraph)
- [静态图](docs/zh_cn/api_cn/static)

### [FAQ]()

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

## 欢迎加入PaddleSlim技术交流群

请添加微信公众号"AIDigest",备注“压缩”,飞桨同学会拉您进入微信交流群。
2 changes: 1 addition & 1 deletion demo/mkldnn_quant/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PaddleSlim INT8量化模型在CPU上的部署和预测
# Intel CPU量化部署

## 概述

Expand Down
2 changes: 1 addition & 1 deletion demo/quant/deploy/TensorRT/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PaddleSlim INT8量化模型使用TensorRT的部署和预测
# Nvidia GPU量化部署

## 概述
NVIDIA TensorRT 是一个高性能的深度学习预测库,适用于Nvidia GPU,可为深度学习推理应用程序提供低延迟和高吞吐量。PaddlePaddle 采用子图的形式对TensorRT进行了集成,即我们可以使用该模块来提升Paddle模型的预测性能。本教程将介绍如何使用TensortRT部署PaddleSlim量化得到的模型,无论是量化训练(QAT)还是离线量化(PTQ)模型均可支持。对于常见图像分类模型,INT8模型的推理速度通常是FP32模型的3.2-6.7倍。
Expand Down
Binary file removed docs/images/algo/ofa_bert.jpg
Binary file not shown.
18 changes: 16 additions & 2 deletions docs/zh_cn/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

## 最新版本信息

### v2.0.0(02/2020)

- 新增支持动态图剪枝、量化
- 新增OFA压缩策略
- 修复若干剪枝相关问题

## 历史版本信息

### v1.2.0

- 新增PACT量化训练功能,提升PaddleSlim在图像目标检测、图像语义分割、OCR等模型上的量化训练效果。
- 新增DML(互蒸馏功能),提升部分模型的蒸馏效果。
- 修复部分剪裁bug,加强对depthwise_conv2d的剪裁能力。
- 优化剪裁和量化API的易用性和灵活性。


### v1.1.0(05/2020)

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


## 历史版本信息

### v1.0.1

- 拆分PaddleSlim为独立repo。
Expand Down
Loading

0 comments on commit a3888f3

Please sign in to comment.