update auto compression docs (PaddlePaddle#1104)

* update auto compression docs

* fix readme

* fix title

Author: yghstill

demo/auto_compression/README.md

@@ -1,126 +1,62 @@
-# 使用预测模型进行量化训练示例
+# 自动压缩工具ACT（Auto Compression Tookit）
 
-预测模型保存接口：
-动态图使用``paddle.jit.save``保存；
-静态图使用``paddle.static.save_inference_model``保存。
+## 简介
+PaddleSlim推出全新自动压缩工具（ACT），旨在通过Source-Free的方式，自动对预测模型进行压缩，压缩后模型可直接部署应用。ACT自动压缩工具主要特性如下：
+- **『更便捷』**：开发者无需了解或修改模型源码，直接使用导出的预测模型进行压缩；
+- **『更智能』**：开发者简单配置即可启动压缩，ACT工具会自动优化得到最好预测模型；
+- **『更丰富』**：ACT中提供了量化训练、蒸馏、结构化剪枝、非结构化剪枝、多种离线量化方法及超参搜索等等，可任意搭配使用。
 
-本示例将介绍如何使用预测模型进行蒸馏量化训练，
-首先使用接口``paddleslim.quant.quant_aware_with_infermodel``训练量化模型，
-训练完成后，使用接口``paddleslim.quant.export_quant_infermodel``将训好的量化模型导出为预测模型。
 
-## 分类模型量化训练流程
+## 环境准备
 
-### 1. 准备数据
+- 安装PaddlePaddle >= 2.3版本 （从[Paddle官网](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/pip/linux-pip.html)下载安装）
+- 安装PaddleSlim >= 2.3 或者适当develop版本
 
-在``demo``文件夹下创建``data``文件夹，将``ImageNet``数据集解压在``data``文件夹下，解压后``data/ILSVRC2012``文件夹下应包含以下文件：
-- ``'train'``文件夹，训练图片
-- ``'train_list.txt'``文件
-- ``'val'``文件夹，验证图片
-- ``'val_list.txt'``文件
+## 快速上手
 
-### 2. 准备需要量化的模型
-
-飞桨图像识别套件PaddleClas是飞桨为工业界和学术界所准备的一个图像识别任务的工具集，本示例使用该套件产出imagenet分类模型。
-#### 2.1 下载PaddleClas release/2.3分支代码
-<https://github.com/PaddlePaddle/PaddleClas/archive/refs/heads/release/2.3.zip>
-解压后，进入PaddleClas目录
-```
-cd PaddleClas-release-2.3
-```
-#### 2.2 下载MobileNetV2预训练模型
-在PaddleClas根目录创建``pretrained``文件夹：
-```
-mkdir pretrained
+```python
+# 导入依赖包
+from paddleslim.auto_compression.config_helpers import load_config
+from paddleslim.auto_compression import AutoCompression
+from paddleslim.common.imagenet_reader import reader
+# 加载配置文件
+compress_config, train_config = load_slim_config("./image_classification/mobilenetv1_qat_dis.yaml")
+# 定义DataLoader
+train_loader = reader(mode='test') # DataLoader
+# 开始自动压缩
+ac = AutoCompression(
+    model_dir="./mobilenetv1_infer",
+    model_filename="model.pdmodel",
+    params_filename="model.pdiparams",
+    save_dir="output",
+    strategy_config=compress_config,
+    train_config=train_config,
+    train_dataloader=train_loader,
+    eval_callback=None)  # eval_function to verify accuracy
+ac.compress()
 ```
 
-下载预训练模型
-分类预训练模型库地址 <https://github.com/PaddlePaddle/PaddleClas/blob/release/2.3/docs/zh_CN/algorithm_introduction/ImageNet_models.md>
-MobileNetV2预训练模型地址 <https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/MobileNetV2_pretrained.pdparams>
-执行下载命令：
-```
-wget https://paddle-imagenet-models-name.bj.bcebos.com/dygraph/MobileNetV2_pretrained.pdparams -O ./pretrained/MobileNetV2_pretrained.pdparams
-```
+**提示：**
+- DataLoader传入的数据集是待压缩模型所用的数据集，DataLoader继承自`paddle.io.DataLoader`。
+- 如无需验证自动压缩过程中模型的精度，`eval_callback`可不传入function，程序会自动根据损失来选择最优模型。
+- 自动压缩Config中定义量化、蒸馏、剪枝等压缩算法会合并执行，压缩策略有：量化+蒸馏，剪枝+蒸馏等等。
 
-#### 2.3 导出预测模型
-PaddleClas代码库根目录执行如下命令，导出预测模型
-```
-python tools/export_model.py \
-    -c ppcls/configs/ImageNet/MobileNetV2/MobileNetV2.yaml \
-    -o Global.pretrained_model=pretrained/MobileNetV2_pretrained \
-    -o Global.save_inference_dir=infermodel_mobilenetv2
-```
-#### 2.4 测试模型精度
-拷贝``infermodel_mobilenetv2``文件夹到``PaddleSlim/demo/auto_compression/``文件夹。
-```
-cd PaddleSlim/demo/auto_compression/
-```
-使用[eval.py](../quant/quant_post/eval.py)脚本得到模型的分类精度，压缩后的模型也可以使用同一个脚本测试精度：
-```
-python ../quant/quant_post/eval.py --model_path infermodel_mobilenetv2 --model_name inference.pdmodel --params_name inference.pdiparams
-```
-精度输出为:
-```
-top1_acc/top5_acc= [0.71918 0.90568]
-```
+## 应用示例
 
-### 3. 进行多策略融合压缩
+#### [图像分类](./image_classification)
 
-每一个小章节代表一种多策略融合压缩，不代表需要串行执行。
+#### [目标检测](./detection)
 
-### 3.1 进行量化蒸馏压缩
-蒸馏量化训练示例脚本为[demo_imagenet.py](./demo_imagenet.py)，使用接口``paddleslim.auto_compression.AutoCompression``对模型进行量化训练。运行命令为：
-```
-python demo_imagenet.py \
-    --model_dir='infermodel_mobilenetv2' \
-    --model_filename='inference.pdmodel' \
-    --params_filename='./inference.pdiparams' \
-    --save_dir='./save_qat_mbv2/' \
-    --devices='gpu' \
-    --batch_size=64 \
-    --data_dir='../data/ILSVRC2012/' \
-    --config_path='./configs/CV/mbv2_qat_dis.yaml'
-```
+#### [语义分割](./semantic_segmentation)
 
-### 3.2 进行离线量化超参搜索压缩
-离线量化超参搜索压缩示例脚本为[demo_imagenet.py](./demo_imagenet.py)，使用接口``paddleslim.auto_compression.AutoCompression``对模型进行压缩。运行命令为：
-```
-python demo_imagenet.py \
-    --model_dir='infermodel_mobilenetv2' \
-    --model_filename='inference.pdmodel' \
-    --params_filename='./inference.pdiparams' \
-    --save_dir='./save_ptq_mbv2/' \
-    --devices='gpu' \
-    --batch_size=64 \
-    --data_dir='../data/ILSVRC2012/' \
-    --config_path='./configs/CV/mbv2_ptq_hpo.yaml'
-```
+#### [NLP](./nlp)
 
-### 3.3 进行剪枝蒸馏策略融合压缩
-注意：本示例为对BERT模型进行ASP稀疏。
-首先参考[脚本](https://github.com/PaddlePaddle/PaddleNLP/tree/develop/examples/language_model/bert#%E9%A2%84%E6%B5%8B)得到可部署的模型，或者下载SST-2数据集上的示例模型[SST-2-BERT](https://paddle-qa.bj.bcebos.com/PaddleSlim_datasets/static_bert_models.tar.gz)。
-剪枝蒸馏压缩示例脚本为[demo_glue.py](./demo_glue.py)，使用接口``paddleslim.auto_compression.AutoCompression``对模型进行压缩。运行命令为：
-```
-python demo_glue.py \
-    --model_dir='./static_bert_models/' \
-    --model_filename='bert.pdmodel' \
-    --params_filename='bert.pdiparams' \
-    --save_dir='./save_asp_bert/' \
-    --devices='gpu' \
-    --batch_size=32 \
-    --task='sst-2' \
-    --config_path='./configs/NLP/bert_asp_dis.yaml'
-```
+#### 即将发布
+- [ ] 更多自动压缩应用示例
+- [ ] X2Paddle模型自动压缩示例
 
-### 3.4 进行非结构化稀疏蒸馏策略融合压缩
-非结构化稀疏蒸馏压缩示例脚本为[demo_imagenet.py](./demo_imagenet.py)，使用接口``paddleslim.auto_compression.AutoCompression``对模型进行压缩。运行命令为：
-```
-python demo_imagenet.py \
-    --model_dir='infermodel_mobilenetv2' \
-    --model_filename='inference.pdmodel' \
-    --params_filename='./inference.pdiparams' \
-    --save_dir='./save_asp_mbv2/' \
-    --devices='gpu' \
-    --batch_size=64 \
-    --data_dir='../data/ILSVRC2012/' \
-    --config_path='./configs/CV/xxx.yaml'
-```
+## 其他
+
+- ACT可以自动处理常见的预测模型，如果有更特殊的改造需求，可以参考[ACT超参配置教程](./hyperparameter_tutorial.md)来进行单独配置压缩策略。
+
+- 如果你发现任何关于ACT自动压缩工具的问题或者是建议, 欢迎通过[GitHub Issues](https://github.com/PaddlePaddle/PaddleSlim/issues)给我们提issues。同时欢迎贡献更多优秀模型，共建开源生态。