Skip to content

Commit 3151326

Browse files
committed
Update .gitignore and docs/docs/index.md
1 parent 9d8b37d commit 3151326

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ dist/
88
*.tar
99
*.tar.gz
1010
*.zip
11+
docs/site

docs/docs/index.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
2+
3+
# PaddleSlim
4+
5+
PaddleSlim是PaddlePaddle框架的一个子模块,主要用于压缩图像领域模型。在PaddleSlim中,不仅实现了目前主流的网络剪枝、量化、蒸馏三种压缩策略,还实现了超参数搜索和小模型网络结构搜索功能。在后续版本中,会添加更多的压缩策略,以及完善对NLP领域模型的支持。
6+
7+
## 功能
8+
9+
- 模型剪裁
10+
- 支持通道均匀模型剪裁(uniform pruning)
11+
- 基于敏感度的模型剪裁
12+
- 基于进化算法的自动模型剪裁三种方式
13+
14+
- 量化训练
15+
- 在线量化训练(training aware)
16+
- 离线量化(post training)
17+
- 支持对权重全局量化和Channel-Wise量化
18+
19+
- 蒸馏
20+
21+
- 轻量神经网络结构自动搜索(Light-NAS)
22+
- 支持基于进化算法的轻量神经网络结构自动搜索(Light-NAS)
23+
- 支持 FLOPS / 硬件延时约束
24+
- 支持多平台模型延时评估
25+
26+
27+
## 安装
28+
29+
安装PaddleSlim前,请确认已正确安装Paddle1.6版本或更新版本。Paddle安装请参考:[Paddle安装教程](https://www.paddlepaddle.org.cn/install/quick)
30+
31+
32+
- 安装develop版本
33+
34+
35+
```
36+
git clone https://github.com/PaddlePaddle/PaddleSlim.git
37+
cd PaddleSlim
38+
python setup.py install
39+
```
40+
41+
- 安装官方发布的最新版本
42+
43+
```
44+
pip install paddleslim -i https://pypi.org/simple
45+
```
46+
47+
- 安装历史版本
48+
49+
请点击[pypi.org](https://pypi.org/project/paddleslim/#history)查看可安装历史版本。
50+
51+
## 使用
52+
53+
- [API文档](doc/api_guide.md):API使用介绍,包括[蒸馏]()[剪裁]()[量化]()[模型结构搜索]()
54+
- [示例](doc/demo_guide.md):基于mnist和cifar10等简单分类任务的模型压缩示例,您可以通过该部分快速体验和了解PaddleSlim的功能。
55+
- [实践教程]():经典模型的分析和压缩实验教程。
56+
- [模型库]():经过压缩的分类、检测、语义分割模型,包括权重文件、网络结构文件和性能数据。
57+
- [Paddle检测库]():介绍如何在检测库中使用PaddleSlim。
58+
- [Paddle分割库]():介绍如何在分割库中使用PaddleSlim。
59+
- [PaddleLite]():介绍如何使用预测库PaddleLite部署PaddleSlim产出的模型。
60+
61+
## 贡献与反馈

0 commit comments

Comments
 (0)