diff --git a/docs/zh_CN/PULC/PULC_person_exists.md b/docs/zh_CN/PULC/PULC_person_exists.md index 766fe1a7e..a5804e183 100644 --- a/docs/zh_CN/PULC/PULC_person_exists.md +++ b/docs/zh_CN/PULC/PULC_person_exists.md @@ -1,57 +1,49 @@ # PULC 有人/无人分类模型 -此处提供了用户使用 PaddleClas 的 超轻量图像分类方案(PULC, Practical Ultra Lightweight Classification) 快速构建轻量级、高精度、可落地的有人/无人的分类模型教程，主要基于有人/无人场景的数据，融合了轻量级骨干网络 PPLCNet、SSLD 预训练权重、EDA 数据增强策略、SKL-UGI 知识蒸馏策略、SHAS 超参数搜索策略，得到精度高、速度快、易于部署的二分类模型。 - ------ ## 目录 -- [1. 应用场景介绍](#1) +- [1. 模型和应用场景介绍](#1) - [2. 模型快速体验](#2) - - [2.1 PULC 有人/无人分类模型介绍](#2.1) - - [2.2 环境配置](#2.2) - - [2.3 模型推理预测](#2.3) - - [2.3.1 下载模型](#2.3.1) - - [2.3.2 模型推理预测](#2.3.2) - - [2.3.2.1 预测单张图像](#2.3.2.1) - - [2.3.2.2 基于文件夹的批量预测](#2.3.2.2) -- [3.PULC 有人/无人分类模型训练](#3) + - [2.1 环境配置](#2.1) + - [2.2 三行命令快速体验](#2.2) +- [3. 模型训练、评估和预测](#3) - [3.1 数据准备](#3.1) - [3.1.1 数据集来源](#3.1.1) - [3.1.2 数据集获取](#3.1.2) - [3.2 模型训练](#3.2) - - [3.2.1 基于默认超参数训练轻量级模型](#3.2.1) - - [3.2.2 基于默认超参数训练教师模型](#3.2.2) - - [3.2.3 基于默认超参数进行蒸馏训练](#3.2.3) -- [4. 模型评估与推理部署](#4) - - [4.1 模型评估](#4.1) - - [4.2 模型预测](#4.2) - - [4.3 使用 inference 模型进行推理](#4.3) - - [4.3.1 导出 inference 模型](#4.3.1) - - [4.3.2 基于 inference 模型 python 推理预测](#4.3.2) - - [4.3.3 基于 inference 模型 C++ 推理预测](#4.3.3) - - [4.4 基于 Paddle Serving 完成模型服务化部署](#4.4) - - [4.5 基于 Paddle Lite 完成模型端侧部署](#4.5) - + - [3.3 模型评估](#3.3) + - [3.4 模型预测](#3.4) +- [4. 模型压缩](#4) + - [4.1 知识蒸馏](#4.1) + - [4.1.1 教师模型训练](#4.1.1) + - [4.1.2 SKL-UGI知识蒸馏](#4.1.2) + - [4.2 模型量化](#4.2) +- [5. 超参搜索](#5) +- [6. 模型推理部署](#6) + - [6.1 推理模型准备](#6.1) + - [6.1.1 导出 inference 模型](#6.1.1) + - [6.1.2 直接下载 inference 模型](#6.1.2) + - [6.2 基于 Python 预测引擎推理](#6.2) + - [6.2.1 预测单张图像](#6.2.1) + - [6.2.2 基于文件夹的批量预测](#6.2.2) + - [6.3 基于 C++ 预测引擎推理](#6.3) + - [6.4 服务化部署](#6.4) + - [6.5 端侧部署](#6.5) + - [6.6 Paddle2ONNX模型转换与预测](#6.6) + -## 1. 应用场景介绍 +## 1. 模型和应用场景介绍 该案例提供了可以产出超轻量级二分类模型的方法。使用该方法训练得到的模型可以快速判断图片中是否有人，该模型可以广泛应用于如监控场景、人员进出管控场景、海量数据过滤场景等。 - +下表列出了判断图片中是否有人的二分类模型的相关指标，前两行展现了使用 SwinTranformer_tiny 和 MobileNetV3_large_x1_0 作为 backbone 训练得到的模型的相关指标，第三行至第六行依次展现了替换 backbone 为 PPLCNet_x1_0、使用 SSLD 预训练模型、使用 SSLD 预训练模型 + EDA 策略、使用 SSLD 预训练模型 + EDA 策略 + SKL-UGI 知识蒸馏策略训练得到的模型的相关指标。其中，最后一行的模型融合了前边的所有的训练策略, 即为通过 PULC 策略训练得到的模型，该模型与其他较大的模型相比，相同推理速度下拥有更高的精度，相同推理速度下拥有更高的精度。比如，与 SwinTransformer-tiny 相比，PULC 得到的模型在相同精度下，速度快 70+ 倍。训练方法和推理部署方法将在下面详细介绍。 -## 2. 模型快速体验 - - - -### 2.1 PULC 有人/无人分类模型介绍 - -下表列出了判断图片中是否有人的二分类模型的相关指标，其中，最后一行是根据 PULC 策略训练得到的模型，该模型与其他较大的模型相比，相同推理速度下拥有更高的精度，相同推理速度下拥有更高的精度。比如，与 SwinTransformer-tiny 相比，PULC 得到的模型相同在精度下，速度快 70+ 倍。训练方法和推理部署方法将在下面详细介绍。 - -| 模型 | 精度（%） | 延时（ms） | 存储（M） | 策略 | +| 模型 | Tpr（%） | 延时（ms） | 存储（M） | 策略 | |-------|-----------|----------|---------------|---------------| | SwinTranformer_tiny | 95.69 | 175.52 | 107 | 使用ImageNet预训练模型 | | MobileNetV3_large_x1_0 | 91.97 | 4.70 | 17 | 使用ImageNet预训练模型 | @@ -59,102 +51,33 @@ | PPLCNet_x1_0 | 92.10 | 2.36 | 6.5 | 使用SSLD预训练模型 | | PPLCNet_x1_0 | 93.43 | 2.36 | 6.5 | 使用SSLD预训练模型+EDA策略| | PPLCNet_x1_0 | 95.60 | 2.36 | 6.5 | 使用SSLD预训练模型+EDA策略+SKL-UGI知识蒸馏策略| + -**备注：** 关于PPLCNet的介绍可以参考[PPLCNet介绍](../models/PP-LCNet.md)，相关论文可以查阅[PPLCNet paper](https://arxiv.org/abs/2109.15099)。 +**备注：** + +* `Tpr`指标的介绍可以参考 [3.2 小节](#3.2)的备注部分，延时是基于 Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz 测试得到，测试过程开启了 MKLDNN 加速策略，线程数为 10。 +* 关于PPLCNet的介绍可以参考[PPLCNet介绍](../models/PP-LCNet.md)，相关论文可以查阅[PPLCNet paper](https://arxiv.org/abs/2109.15099)。 - -### 2.2 环境配置 + + +## 2. 模型快速体验 + + + +### 2.1 环境配置 * 安装：请先参考 [Paddle 安装教程](../installation/install_paddle.md) 以及 [PaddleClas 安装教程](../installation/install_paddleclas.md) 配置 PaddleClas 运行环境。 - + -### 2.3 模型推理预测 +### 2.2 三行命令快速体验 - - -#### 2.3.1 下载模型 - -* 进入 `deploy` 运行目录。 - -``` -cd deploy -``` - -下载有人/无人分类的推理模型。 - -``` -mkdir models -cd models -# 下载 inference 模型并解压 -wget https://paddleclas.bj.bcebos.com/models/PULC/person_exists_infer.tar && tar -xf person_exists_infer.tar -``` - -解压完毕后，`models` 文件夹下应有如下文件结构： - -``` -├── person_exists_infer -│ ├── inference.pdiparams -│ ├── inference.pdiparams.info -│ └── inference.pdmodel -``` - - - -#### 2.3.2 模型推理预测 - - - -##### 2.3.2.1 预测单张图像 - -返回 `deploy` 目录： - -``` -cd ../ -``` - -运行下面的命令，对图像 `./images/PULC/person_exists/objects365_02035329.jpg` 进行有人/无人分类。 - -```shell -# 使用下面的命令使用 GPU 进行预测 -python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o PostProcess.ThreshOutput.threshold=0.9794 -# 使用下面的命令使用 CPU 进行预测 -python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o PostProcess.ThreshOutput.threshold=0.9794 -o Global.use_gpu=False -``` - -输出结果如下。 - -``` -objects365_02035329.jpg: class id(s): [1], score(s): [1.00], label_name(s): ['someone'] -``` - - -**备注：** 真实场景中往往需要在假正类率（Fpr）小于某一个指标下求真正类率（Tpr），该场景中的 `val` 数据集在千分之一 Fpr 下得到的最佳 Tpr 所得到的阈值为 `0.9794`，故此处的 `threshold` 为 `0.9794`。该阈值的确定方法可以参考[3.2.1节](#3.2.1)备注部分。 - - - -#### 2.3.2.2 基于文件夹的批量预测 - -如果希望预测文件夹内的图像，可以直接修改配置文件中的 `Global.infer_imgs` 字段，也可以通过下面的 `-o` 参数修改对应的配置。 - -```shell -# 使用下面的命令使用 GPU 进行预测，如果希望使用 CPU 预测，可以在命令后面添加 -o Global.use_gpu=False -python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o Global.infer_imgs="./images/PULC/person_exists/" -``` - -终端中会输出该文件夹内所有图像的分类结果，如下所示。 - -``` -objects365_01780782.jpg: class id(s): [0], score(s): [1.00], label_name(s): ['nobody'] -objects365_02035329.jpg: class id(s): [1], score(s): [1.00], label_name(s): ['someone'] -``` - -其中，`someone` 表示该图里存在人，`nobody` 表示该图里不存在人。 +（pip方式，待补充） -## 3.PULC 有人/无人分类模型训练 +## 3. 模型训练、评估和预测 @@ -226,11 +149,8 @@ cd ../ -### 3.2 模型训练 +### 3.2 模型训练 - - -#### 3.2.1 基于默认超参数训练轻量级模型 在 `ppcls/configs/PULC/person_exists/PPLCNet_x1_0.yaml` 中提供了基于该场景的训练配置，可以通过如下脚本启动训练： @@ -250,65 +170,23 @@ python3 -m paddle.distributed.launch \ * 在eval时，会打印出来当前最佳的 TprAtFpr 指标，具体地，其会打印当前的 `Fpr`、`Tpr` 值，以及当前的 `threshold`值，`Tpr` 值反映了在当前 `Fpr` 值下的召回率，该值越高，代表模型越好。`threshold` 表示当前最佳 `Fpr` 所对应的分类阈值，可用于后续模型部署落地等。 - + -#### 3.2.2 基于默认超参数训练教师模型 - -复用 `ppcls/configs/PULC/person_exists/PPLCNet/PPLCNet_x1_0.yaml` 中的超参数，训练教师模型，训练脚本如下： - -```shell -export CUDA_VISIBLE_DEVICES=0,1,2,3 -python3 -m paddle.distributed.launch \ - --gpus="0,1,2,3" \ - tools/train.py \ - -c ./ppcls/configs/PULC/person_exists/PPLCNet/PPLCNet_x1_0.yaml \ - -o Arch.name=ResNet101_vd -``` - -验证集的最佳指标为 `0.96-0.98` 之间，当前教师模型最好的权重保存在 `output/ResNet101_vd/best_model.pdparams`。 - - - -#### 3.2.3 基于默认超参数进行蒸馏训练 - -配置文件`ppcls/configs/PULC/person_exists/PPLCNet_x1_0_distillation.yaml`提供了`SKL-UGI知识蒸馏策略`的配置。该配置将`ResNet101_vd`当作教师模型，`PPLCNet_x1_0`当作学生模型，使用ImageNet数据集的验证集作为新增的无标签数据。训练脚本如下： - -```shell -export CUDA_VISIBLE_DEVICES=0,1,2,3 -python3 -m paddle.distributed.launch \ - --gpus="0,1,2,3" \ - tools/train.py \ - -c ./ppcls/configs/PULC/person_exists/PPLCNet_x1_0_distillation.yaml \ - -o Arch.models.0.Teacher.pretrained=output/ResNet101_vd/best_model -``` - -验证集的最佳指标为 `0.95-0.97` 之间，当前模型最好的权重保存在 `output/DistillationModel/best_model_student.pdparams`。 - - -**备注：** - -* 此时的默认超参数是经过`SHAS超参数搜索策略`得到的，关于此部分内容，可以参考[SHAS 超参数搜索策略](#TODO待添加链接)。 - - - - -## 4. 模型评估与推理部署 - - - -### 4.1 模型评估 +### 3.3 模型评估 训练好模型之后，可以通过以下命令实现对模型指标的评估。 ```bash python3 tools/eval.py \ -c ./ppcls/configs/PULC/person_exists/PPLCNet_x1_0.yaml \ - -o Global.pretrained_model="output/DistillationModel/best_model_student" + -o Global.pretrained_model="output/DPPLCNet_x1_0/best_model" ``` - +其中 `-o Global.pretrained_model="output/PPLCNet_x1_0/best_model"` 指定了当前最佳权重所在的路径，如果指定其他权重，只需替换对应的路径即可。 -### 4.2 模型预测 + + +### 3.4 模型预测 模型训练完成之后，可以加载训练得到的预训练模型，进行模型预测。在模型库的 `tools/infer.py` 中提供了完整的示例，只需执行下述命令即可完成模型预测： @@ -326,21 +204,84 @@ python3 tools/infer.py \ ``` **备注：** + +* 这里`-o Global.pretrained_model="output/PPLCNet_x1_0/best_model"` 指定了当前最佳权重所在的路径，如果指定其他权重，只需替换对应的路径即可。 * 默认是对 `deploy/images/PULC/person_exists/objects365_02035329.jpg` 进行预测，此处也可以通过增加字段 `-o Infer.infer_imgs=xxx` 对其他图片预测。 * 这里的 `Infer.PostProcess.threshold` 的值需要根据实际场景来确定，此处的 `0.9794` 是在该场景中的 `val` 数据集在千分之一 Fpr 下得到的最佳 Tpr 所得到的。 - + -### 4.3 使用 inference 模型进行推理 +## 4. 模型压缩 - + -### 4.3.1 导出 inference 模型 +### 4.1 知识蒸馏 -通过导出 inference 模型，PaddlePaddle 支持使用预测引擎进行预测推理。接下来介绍如何用预测引擎进行推理： -首先，对训练好的模型进行转换： + + +#### 4.1.1 教师模型训练 + +复用 `ppcls/configs/PULC/person_exists/PPLCNet/PPLCNet_x1_0.yaml` 中的超参数，训练教师模型，训练脚本如下： + +```shell +export CUDA_VISIBLE_DEVICES=0,1,2,3 +python3 -m paddle.distributed.launch \ + --gpus="0,1,2,3" \ + tools/train.py \ + -c ./ppcls/configs/PULC/person_exists/PPLCNet/PPLCNet_x1_0.yaml \ + -o Arch.name=ResNet101_vd +``` + +验证集的最佳指标为 `0.96-0.98` 之间，当前教师模型最好的权重保存在 `output/ResNet101_vd/best_model.pdparams`。 + + + +#### 4.1.2 SKL-UGI知识蒸馏 + +配置文件`ppcls/configs/PULC/person_exists/PPLCNet_x1_0_distillation.yaml`提供了`SKL-UGI知识蒸馏策略`的配置。该配置将`ResNet101_vd`当作教师模型，`PPLCNet_x1_0`当作学生模型，使用ImageNet数据集的验证集作为新增的无标签数据。训练脚本如下： + +```shell +export CUDA_VISIBLE_DEVICES=0,1,2,3 +python3 -m paddle.distributed.launch \ + --gpus="0,1,2,3" \ + tools/train.py \ + -c ./ppcls/configs/PULC/person_exists/PPLCNet_x1_0_distillation.yaml \ + -o Arch.models.0.Teacher.pretrained=output/ResNet101_vd/best_model +``` + +验证集的最佳指标为 `0.95-0.97` 之间，当前模型最好的权重保存在 `output/DistillationModel/best_model_student.pdparams`。 + + + +### 4.2 模型量化 + +PaddleClas 提供了基于 [PaddleSlim](https://github.com/PaddlePaddle/PaddleSlim) 的模型量化示例，量化后的模型体积更小、推理速度更快。您可以参考[模型量化教程](#TODO)来完成该模型的量化。 + + + +## 5. 超参搜索 + +在 [3.2 节](#3.1)和 [4.1](#4.1) 节所使用的超参数是根据PaddleClas提供的 `SHAS超参数搜索策略` 搜索得到的，如果希望在自己的数据集上得到更好的结果，可以参考[SHAS超参数搜索策略](#TODO)来获得更好的训练超参数。 + +**备注：** 此部分内容是可选内容，搜索过程需要较长的时间，您可以根据自己的硬件情况来选择执行。如果没有更换数据集，可以忽略此节内容。 + + + +## 6. 模型推理部署 + + + +### 6.1 推理模型准备 + +PaddlePaddle 支持使用预测引擎对 inference 模型进行预测推理。本节提供了两种得到 inference 模型的方法，如果希望得到和文档相同的结果，请选择直接下载 inference 模型的方式。 + + + +### 6.1.1 导出 inference 模型 + +此处，我们提供了将权重和模型转换的脚本，执行该脚本可以得到对应的 inference 模型： ```bash python3 tools/export_model.py \ @@ -348,38 +289,113 @@ python3 tools/export_model.py \ -o Global.pretrained_model=output/DistillationModel/best_model_student \ -o Global.save_inference_dir=deploy/models/PPLCNet_x1_0_person_exists_infer ``` -执行完该脚本后会在 `deploy/models/` 下生成 `PPLCNet_x1_0_person_exists_infer` 文件夹，该文件夹中的模型与 [2.3 节](#2.3)下载的推理预测模型格式一致。 - - - -### 4.3.2 基于 inference 模型 python 推理预测 - -推理预测的脚本为： +执行完该脚本后会在 `deploy/models/` 下生成 `PPLCNet_x1_0_person_exists_infer` 文件夹，`models` 文件夹下应有如下文件结构： ``` -python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o Global.inference_model_dir="models/PPLCNet_x1_0_person_exists_infer" -o PostProcess.ThreshOutput.threshold=0.9794 +├── PPLCNet_x1_0_person_exists_infer +│ ├── inference.pdiparams +│ ├── inference.pdiparams.info +│ └── inference.pdmodel ``` -**备注：** +**备注：** 此处的最佳权重是经过知识蒸馏后的权重路径，如果没有执行知识蒸馏的步骤，最佳模型保存在`output/PPLCNet_x1_0/best_model.pdparams`中。 -- 此处的 `PostProcess.ThreshOutput.threshold` 由eval时的最佳 `threshold` 来确定。 -- 更多关于推理的细节，可以参考[2.3节](#2.3)。 + - +### 6.1.2 直接下载 inference 模型 -### 4.3.3 基于 inference 模型 C++ 推理预测 +[6.1.1 小节](#6.1.1)提供了导出 inference 模型的方法，此处也提供了该场景可以下载的 inference 模型，可以直接下载体验。 -PaddleClas 提供了 C++ 推理预测的示例，您可以参考[服务器端 C++ 预测](../inference_deployment/cpp_deploy.md)来完成相应的推理部署。如果您使用的是Windows平台，可以参考[基于 Visual Studio 2019 Community CMake 编译指南](inference_deployment/cpp_deploy_on_windows.md)完成相应的预测库编译和模型预测工作。 +``` +cd deploy/models +# 下载 inference 模型并解压 +wget https://paddleclas.bj.bcebos.com/models/PULC/person_exists_infer.tar && tar -xf person_exists_infer.tar +``` - +解压完毕后，`models` 文件夹下应有如下文件结构： -### 4.4 基于 Paddle Serving 完成模型服务化部署 +``` +├── person_exists_infer +│ ├── inference.pdiparams +│ ├── inference.pdiparams.info +│ └── inference.pdmodel +``` + + + +### 6.2 基于 Python 预测引擎推理 + + + + +#### 6.2.1 预测单张图像 + +返回 `deploy` 目录： + +``` +cd ../ +``` + +运行下面的命令，对图像 `./images/PULC/person_exists/objects365_02035329.jpg` 进行有人/无人分类。 + +```shell +# 使用下面的命令使用 GPU 进行预测 +python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o PostProcess.ThreshOutput.threshold=0.9794 +# 使用下面的命令使用 CPU 进行预测 +python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o PostProcess.ThreshOutput.threshold=0.9794 -o Global.use_gpu=False +``` + +输出结果如下。 + +``` +objects365_02035329.jpg: class id(s): [1], score(s): [1.00], label_name(s): ['someone'] +``` + + +**备注：** 真实场景中往往需要在假正类率（Fpr）小于某一个指标下求真正类率（Tpr），该场景中的 `val` 数据集在千分之一 Fpr 下得到的最佳 Tpr 所得到的阈值为 `0.9794`，故此处的 `threshold` 为 `0.9794`。该阈值的确定方法可以参考[3.2节](#3.2)备注部分。 + + + +#### 6.2.2 基于文件夹的批量预测 + +如果希望预测文件夹内的图像，可以直接修改配置文件中的 `Global.infer_imgs` 字段，也可以通过下面的 `-o` 参数修改对应的配置。 + +```shell +# 使用下面的命令使用 GPU 进行预测，如果希望使用 CPU 预测，可以在命令后面添加 -o Global.use_gpu=False +python3.7 python/predict_cls.py -c configs/PULC/person_exists/inference_person_exists.yaml -o Global.infer_imgs="./images/PULC/person_exists/" +``` + +终端中会输出该文件夹内所有图像的分类结果，如下所示。 + +``` +objects365_01780782.jpg: class id(s): [0], score(s): [1.00], label_name(s): ['nobody'] +objects365_02035329.jpg: class id(s): [1], score(s): [1.00], label_name(s): ['someone'] +``` + +其中，`someone` 表示该图里存在人，`nobody` 表示该图里不存在人。 + + + +### 6.3 基于 C++ 预测引擎推理 + +PaddleClas 提供了基于 C++ 预测引擎推理的示例，您可以参考[服务器端 C++ 预测](../inference_deployment/cpp_deploy.md)来完成相应的推理部署。如果您使用的是 Windows 平台，可以参考[基于 Visual Studio 2019 Community CMake 编译指南](inference_deployment/cpp_deploy_on_windows.md)完成相应的预测库编译和模型预测工作。 + + + +### 6.4 服务化部署 PaddleClas 提供了基于 Paddle Serving 来完成模型服务化部署的示例，您可以参考[模型服务化部署](../inference_deployment/paddle_serving_deploy.md)来完成相应的部署工作。 - + -### 4.5 基于 Paddle Lite 完成模型端侧部署 +### 6.5 端侧部署 PaddleClas 提供了基于 Paddle Lite 来完成模型端侧部署的示例，您可以参考[端侧部署](../inference_deployment/paddle_lite_deploy.md)来 完成相应的部署工作。 + + + +### 6.6 Paddle2ONNX模型转换与预测 + +PaddleClas 提供了基于 Paddle2ONNX 来完成 inference 模型转换 ONNX 模型并做推理预测的示例，您可以参考[Paddle2ONNX模型转换与预测](@shuilong)来 +完成相应的部署工作。