ppvehicle tutorials template (PaddlePaddle#6578)

* ppvehicle tutorials template

* rename pphuman docs

* update quickstart

Author: zhiboniu

README_cn.md

@@ -423,9 +423,9 @@
   - 二次开发教程
     - [目标检测](docs/advanced_tutorials/customization/detection.md)
     - [关键点检测](docs/advanced_tutorials/customization/keypoint_detection.md)
-    - [多目标跟踪](docs/advanced_tutorials/customization/mot.md)
-    - [行为识别](docs/advanced_tutorials/customization/action.md)
-    - [属性识别](docs/advanced_tutorials/customization/attribute.md)
+    - [多目标跟踪](docs/advanced_tutorials/customization/pphuman_mot.md)
+    - [行为识别](docs/advanced_tutorials/customization/pphuman_action.md)
+    - [属性识别](docs/advanced_tutorials/customization/pphuman_attribute.md)
 
 ### 课程专栏
 

README_en.md

@@ -418,9 +418,9 @@ The comparison between COCO mAP and FPS on Qualcomm Snapdragon 865 processor of
   - Custumization
     - [Object detection](docs/advanced_tutorials/customization/detection.md)
     - [Keypoint detection](docs/advanced_tutorials/customization/keypoint_detection.md)
-    - [Multiple object tracking](docs/advanced_tutorials/customization/mot.md)
-    - [Action recognition](docs/advanced_tutorials/customization/action.md)
-    - [Attribute recognition](docs/advanced_tutorials/customization/attribute.md)
+    - [Multiple object tracking](docs/advanced_tutorials/customization/pphuman_mot.md)
+    - [Action recognition](docs/advanced_tutorials/customization/pphuman_action.md)
+    - [Attribute recognition](docs/advanced_tutorials/customization/pphuman_attribute.md)
 
 ### Courses
 

configs/mot/ocsort/README.md

@@ -26,7 +26,7 @@
   - **mix_mot_ch**数据集，是MOT17、CrowdHuman组成的联合数据集，**mix_det**是MOT17、CrowdHuman、Cityscapes、ETHZ组成的联合数据集，数据集整理的格式和目录可以参考[此链接](https://github.com/ifzhang/ByteTrack#data-preparation)，最终放置于`dataset/mot/`目录下。为了验证精度可以都用**MOT17-half val**数据集去评估。
   - OC_SORT的训练是单独的检测器训练MOT数据集，推理是组装跟踪器去评估MOT指标，单独的检测模型也可以评估检测指标。
   - OC_SORT的导出部署，是单独导出检测模型，再组装跟踪器运行的，参照[PP-Tracking](../../../deploy/pptracking/python)。
-  - OC_SORT是PP-Human和PP-Vehicle等Pipeline分析项目跟踪方向的主要方案，具体使用参照[Pipeline](../../../deploy/pipeline)和[MOT](../../../deploy/pipeline/docs/tutorials/mot.md)。
+  - OC_SORT是PP-Human和PP-Vehicle等Pipeline分析项目跟踪方向的主要方案，具体使用参照[Pipeline](../../../deploy/pipeline)和[MOT](../../../deploy/pipeline/docs/tutorials/pphuman_mot.md)。
 
 
 ## 快速开始

configs/pphuman/README.md

@@ -17,7 +17,7 @@ PaddleDetection团队提供了针对行人的基于PP-YOLOE的检测模型，用
 
 
 # PP-YOLOE 香烟检测模型
-基于PP-YOLOE模型的香烟检测模型，是实现PP-Human中的基于检测的行为识别方案的一环，如何在PP-Human中使用该模型进行吸烟行为识别，可参考[PP-Human行为识别模块](../../deploy/pipeline/docs/tutorials/action.md)。该模型检测类别仅包含香烟一类。由于数据来源限制，目前暂无法直接公开训练数据。该模型使用了小目标数据集VisDrone上的权重(参照[visdrone](../visdrone))作为预训练模型，以提升检测效果。
+基于PP-YOLOE模型的香烟检测模型，是实现PP-Human中的基于检测的行为识别方案的一环，如何在PP-Human中使用该模型进行吸烟行为识别，可参考[PP-Human行为识别模块](../../deploy/pipeline/docs/tutorials/pphuman_action.md)。该模型检测类别仅包含香烟一类。由于数据来源限制，目前暂无法直接公开训练数据。该模型使用了小目标数据集VisDrone上的权重(参照[visdrone](../visdrone))作为预训练模型，以提升检测效果。
 
 |    模型   |  数据集  | mAP<sup>val<br>0.5:0.95 |  mAP<sup>val<br>0.5 | 下载  | 配置文件 |
 |:---------|:-------:|:------:|:------:| :----: | :------:|

deploy/pipeline/README.md

@@ -70,19 +70,19 @@ PP-Human支持图片/单镜头视频/多镜头视频多种输入方式，功能
 
 ## 📚 文档教程
 
-### [快速开始](docs/tutorials/QUICK_STARTED.md)
+### [快速开始](docs/tutorials/PPHuman_QUICK_STARTED.md)
 
 ### 行人属性/特征识别
 
-* [快速开始](docs/tutorials/attribute.md)
-* [二次开发教程](../../docs/advanced_tutorials/customization/attribute.md)
+* [快速开始](docs/tutorials/pphuman_attribute.md)
+* [二次开发教程](../../docs/advanced_tutorials/customization/pphuman_attribute.md)
   * 数据准备
   * 模型优化
   * 新增属性
 
 ### 行为识别
 
-* [快速开始](docs/tutorials/action.md)
+* [快速开始](docs/tutorials/pphuman_action.md)
   * 摔倒检测
   * 打架识别
 * [二次开发教程](../../docs/advanced_tutorials/customization/action_recognotion/README.md)
@@ -93,17 +93,17 @@ PP-Human支持图片/单镜头视频/多镜头视频多种输入方式，功能
 
 ### 跨镜跟踪ReID
 
-* [快速开始](docs/tutorials/mtmct.md)
-* [二次开发教程](../../docs/advanced_tutorials/customization/mtmct.md)
+* [快速开始](docs/tutorials/pphuman_mtmct.md)
+* [二次开发教程](../../docs/advanced_tutorials/customization/pphuman_mtmct.md)
   * 数据准备
   * 模型优化
 
 ### 行人跟踪、人流量计数与轨迹记录
 
-* [快速开始](docs/tutorials/mot.md)
+* [快速开始](docs/tutorials/pphuman_mot.md)
   * 行人跟踪
   * 人流量计数与轨迹记录
   * 区域闯入判断和计数
-* [二次开发教程](../../docs/advanced_tutorials/customization/mot.md)
+* [二次开发教程](../../docs/advanced_tutorials/customization/pphuman_mot.md)
   * 数据准备
   * 模型优化

deploy/pipeline/README_en.md

@@ -74,19 +74,19 @@ Click to download the model, then unzip and save it in the `. /output_inference`
 
 ## 📚 Doc Tutorials
 
-### [A Quick Start](docs/tutorials/QUICK_STARTED.md)
+### [A Quick Start](docs/tutorials/PPHuman_QUICK_STARTED.md)
 
 ### Pedestrian attribute/feature recognition
 
-* [A quick start](docs/tutorials/attribute.md)
-* [Customized development tutorials](../../docs/advanced_tutorials/customization/attribute.md)
+* [A quick start](docs/tutorials/pphuman_attribute.md)
+* [Customized development tutorials](../../docs/advanced_tutorials/customization/pphuman_attribute.md)
   * Data Preparation
   * Model Optimization
   * New Attributes
 
 ### Behavior detection
 
-* [A quick start](docs/tutorials/action.md)
+* [A quick start](docs/tutorials/pphuman_action.md)
   * Falling detection
   * Fighting detection
 * [Customized development tutorials](../../docs/advanced_tutorials/customization/action_recognotion/README.md)
@@ -97,17 +97,17 @@ Click to download the model, then unzip and save it in the `. /output_inference`
 
 ### ReID
 
-* [A quick start](docs/tutorials/mtmct.md)
-* [Customized development tutorials](../../docs/advanced_tutorials/customization/mtmct.md)
+* [A quick start](docs/tutorials/pphuman_mtmct.md)
+* [Customized development tutorials](../../docs/advanced_tutorials/customization/pphuman_mtmct.md)
   * Data Preparation
   * Model Optimization
 
 ### Pedestrian tracking, visitor traffic statistics, trace records
 
-* [A quick start](docs/tutorials/mot.md)
+* [A quick start](docs/tutorials/pphuman_mot.md)
   * Pedestrian tracking,
   * Visitor traffic statistics
   * Regional intrusion diagnosis and counting
-* [Customized development tutorials](../../docs/advanced_tutorials/customization/mot.md)
+* [Customized development tutorials](../../docs/advanced_tutorials/customization/pphuman_mot.md)
   * Data Preparation
   * Model Optimization

deploy/pipeline/docs/tutorials/QUICK_STARTED.md renamed to deploy/pipeline/docs/tutorials/PPHuman_QUICK_STARTED.md

@@ -159,29 +159,29 @@ PP-Human v2整体方案如下图所示:
 
 ### 行人检测
 - 采用PP-YOLOE L 作为目标检测模型
-- 详细文档参考[PP-YOLOE](../../../../configs/ppyoloe/)和[检测跟踪文档](mot.md)
+- 详细文档参考[PP-YOLOE](../../../../configs/ppyoloe/)和[检测跟踪文档](pphuman_mot.md)
 
 ### 行人跟踪
 - 采用SDE方案完成行人跟踪
 - 检测模型使用PP-YOLOE L(高精度)和S(轻量级)
 - 跟踪模块采用OC-SORT方案
-- 详细文档参考[OC-SORT](../../../../configs/mot/ocsort)和[检测跟踪文档](mot.md)
+- 详细文档参考[OC-SORT](../../../../configs/mot/ocsort)和[检测跟踪文档](pphuman_mot.md)
 
 ### 跨镜行人跟踪
 - 使用PP-YOLOE + OC-SORT得到单镜头多目标跟踪轨迹
 - 使用ReID（StrongBaseline网络）对每一帧的检测结果提取特征
 - 多镜头轨迹特征进行匹配，得到跨镜头跟踪结果
-- 详细文档参考[跨镜跟踪](mtmct.md)
+- 详细文档参考[跨镜跟踪](pphuman_mtmct.md)
 
 ### 属性识别
 - 使用PP-YOLOE + OC-SORT跟踪人体
 - 使用StrongBaseline（多分类模型）完成识别属性，主要属性包括年龄、性别、帽子、眼睛、上衣下衣款式、背包等
-- 详细文档参考[属性识别](attribute.md)
+- 详细文档参考[属性识别](pphuman_attribute.md)
 
 ### 行为识别：
 - 提供四种行为识别方案
 - 1. 基于骨骼点的行为识别，例如摔倒识别
 - 2. 基于图像分类的行为识别，例如打电话识别
 - 3. 基于检测的行为识别，例如吸烟识别
 - 4. 基于视频分类的行为识别，例如打架识别
-- 详细文档参考[行为识别](action.md)
+- 详细文档参考[行为识别](pphuman_action.md)

deploy/pipeline/docs/tutorials/PPVehicle_QUICK_STARTED.md

@@ -0,0 +1,131 @@
+# 快速开始
+
+## 目录
+
+- [环境准备](#环境准备)
+- [模型下载](#模型下载)
+- [配置文件说明](#配置文件说明)
+- [预测部署](#预测部署)
+  - [参数说明](#参数说明)
+- [方案介绍](#方案介绍)
+  - [车辆检测](#车辆检测)
+  - [车辆跟踪](#车辆跟踪)
+  - [车牌识别](#车牌识别)
+  - [属性识别](#属性识别)
+
+
+## 环境准备
+
+环境要求： PaddleDetection版本 >= release/2.4 或 develop版本
+
+PaddlePaddle和PaddleDetection安装
+
+```
+# PaddlePaddle CUDA10.1
+python -m pip install paddlepaddle-gpu==2.2.2.post101 -f https://www.paddlepaddle.org.cn/whl/linux/mkl/avx/stable.html
+
+# PaddlePaddle CPU
+python -m pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple
+
+# 克隆PaddleDetection仓库
+cd <path/to/clone/PaddleDetection>
+git clone https://github.com/PaddlePaddle/PaddleDetection.git
+
+# 安装其他依赖
+cd PaddleDetection
+pip install -r requirements.txt
+```
+
+1. 详细安装文档参考[文档](../../../../docs/tutorials/INSTALL_cn.md)
+2. 如果需要TensorRT推理加速（测速方式），请安装带`TensorRT版本Paddle`。您可以从[Paddle安装包](https://paddleinference.paddlepaddle.org.cn/v2.2/user_guides/download_lib.html#python)下载安装，或者按照[指导文档](https://www.paddlepaddle.org.cn/inference/master/optimize/paddle_trt.html)使用docker或自编译方式准备Paddle环境。
+
+## 模型下载
+
+
+## 配置文件说明
+
+PP-Vehicle相关配置位于```deploy/pipeline/config/infer_cfg_ppvehicle.yml```中，存放模型路径，完成不同功能需要设置不同的任务类型
+
+功能及任务类型对应表单如下：
+
+| 输入类型 | 功能 | 任务类型 | 配置项 |
+|-------|-------|----------|-----|
+| 图片 | 属性识别 | 目标检测 属性识别 | DET ATTR |
+| 单镜头视频 | 属性识别 | 多目标跟踪 属性识别 | MOT ATTR |
+| 单镜头视频 | 属性识别 | 多目标跟踪 属性识别 | MOT VEHICLEPLATE |
+
+例如基于视频输入的属性识别，任务类型包含多目标跟踪和属性识别，具体配置如下：
+
+```
+
+```
+
+**注意：**
+
+- 如果用户需要实现不同任务，可以在配置文件对应enable选项设置为True, 其basemode类型会在代码中开启依赖的基础能力模型，比如跟踪模型。
+- 如果用户仅需要修改模型文件路径，可以在命令行中加入 `--model_dir det=ppyoloe/` 即可，也可以手动修改配置文件中的相应模型路径，详细说明参考下方参数说明文档。
+
+
+## 预测部署
+
+```
+# 车辆检测，指定配置文件路径和测试图片
+python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_ppvehicle.yml --image_file=test_image.jpg --device=gpu [--run_mode trt_fp16]
+
+# 车辆跟踪，指定配置文件路径和测试视频，在配置文件```deploy/pipeline/config/infer_cfg_ppvehicle.yml```中的MOT部分enable设置为```True```
+python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_ppvehicle.yml --video_file=test_video.mp4 --device=gpu [--run_mode trt_fp16]
+
+# 车辆跟踪，指定配置文件路径，模型路径和测试视频，在配置文件```deploy/pipeline/config/infer_cfg_ppvehicle.yml```中的MOT部分enable设置为```True```
+# 命令行中指定的模型路径优先级高于配置文件
+python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_ppvehicle.yml --video_file=test_video.mp4 --device=gpu --model_dir det=ppyoloe/ [--run_mode trt_fp16]
+
+# 车辆属性识别，指定配置文件路径和测试视频，在配置文件```deploy/pipeline/config/infer_cfg_ppvehicle.yml```中的ATTR部分enable设置为```True```
+python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_ppvehicle.yml --video_file=test_video.mp4 --device=gpu [--run_mode trt_fp16]
+
+```
+
+### 参数说明
+
+| 参数 | 是否必须|含义 |
+|-------|-------|----------|
+| --config | Yes | 配置文件路径 |
+| --model_dir | Option | 各任务模型路径，优先级高于配置文件, 例如`--model_dir det=better_det/ attr=better_attr/`|
+| --image_file | Option | 需要预测的图片 |
+| --image_dir  | Option |  要预测的图片文件夹路径   |
+| --video_file | Option | 需要预测的视频 |
+| --camera_id | Option | 用来预测的摄像头ID，默认为-1(表示不使用摄像头预测，可设置为：0 - (摄像头数目-1) )，预测过程中在可视化界面按`q`退出输出预测结果到：output/output.mp4|
+| --device | Option | 运行时的设备，可选择`CPU/GPU/XPU`，默认为`CPU`|
+| --output_dir | Option|可视化结果保存的根目录，默认为output/|
+| --run_mode | Option |使用GPU时，默认为paddle, 可选（paddle/trt_fp32/trt_fp16/trt_int8）|
+| --enable_mkldnn | Option | CPU预测中是否开启MKLDNN加速，默认为False |
+| --cpu_threads | Option| 设置cpu线程数，默认为1 |
+| --trt_calib_mode | Option| TensorRT是否使用校准功能，默认为False。使用TensorRT的int8功能时，需设置为True，使用PaddleSlim量化后的模型时需要设置为False |
+| --do_entrance_counting | Option | 是否统计出入口流量，默认为False |
+| --draw_center_traj | Option | 是否绘制跟踪轨迹，默认为False |
+
+## 方案介绍
+
+PP-Vehicle v2整体方案如下图所示:
+
+<div width="1000" align="center">
+  <img src="../../../../docs/images/ppvehicle.png"/>
+</div>
+
+
+### 车辆检测
+- 采用PP-YOLOE L 作为目标检测模型
+- 详细文档参考[PP-YOLOE](../../../../configs/ppyoloe/)和[检测跟踪文档](ppvehicle_mot.md)
+
+### 车辆跟踪
+- 采用SDE方案完成车辆跟踪
+- 检测模型使用PP-YOLOE L(高精度)和S(轻量级)
+- 跟踪模块采用OC-SORT方案
+- 详细文档参考[OC-SORT](../../../../configs/mot/ocsort)和[检测跟踪文档](ppvehicle_mot.md)
+
+### 属性识别
+- 使用PP-YOLOE + OC-SORT跟踪车辆
+- 详细文档参考[属性识别](ppvehicle_attribute.md)
+
+### 车牌识别
+- 使用PaddleOCR特色模型ch_PP-OCRv3_det+ch_PP-OCRv3_rec模型，识别车牌号码
+- 详细文档参考[属性识别](ppvehicle_plate.md)

deploy/pipeline/docs/tutorials/action.md renamed to deploy/pipeline/docs/tutorials/pphuman_action.md

@@ -1,4 +1,4 @@
-[English](action_en.md) | 简体中文
+[English](pphuman_action_en.md) | 简体中文
 
 # PP-Human行为识别模块
 
@@ -68,7 +68,7 @@ python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_pph
                                                    --device=gpu \
                                                    --model_dir kpt=./dark_hrnet_w32_256x192 action=./STGCN
 ```
-4. 启动命令中的完整参数说明，请参考[参数说明](./QUICK_STARTED.md)。
+4. 启动命令中的完整参数说明，请参考[参数说明](./PPHuman_QUICK_STARTED.md)。
 
 
 ### 方案说明
@@ -127,7 +127,7 @@ python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_pph
                                                    --video_file=test_video.mp4 \
                                                    --device=gpu
 ```
-4. 启动命令中的完整参数说明，请参考[参数说明](./QUICK_STARTED.md)。
+4. 启动命令中的完整参数说明，请参考[参数说明](./PPHuman_QUICK_STARTED.md)。
 
 ### 方案说明
 1. 使用目标检测与多目标跟踪获取视频输入中的行人检测框及跟踪ID序号，模型方案为PP-YOLOE，详细文档参考[PP-YOLOE](../../../../configs/ppyoloe/README_cn.md)，跟踪方案为OC-SORT，详细文档参考[OC-SORT](../../../../configs/mot/ocsort)。
@@ -183,7 +183,7 @@ python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_pph
                                                    --video_file=test_video.mp4 \
                                                    --device=gpu
 ```
-4. 启动命令中的完整参数说明，请参考[参数说明](./QUICK_STARTED.md)。
+4. 启动命令中的完整参数说明，请参考[参数说明](./PPHuman_QUICK_STARTED.md)。
 
 ### 方案说明
 1. 使用目标检测与多目标跟踪获取视频输入中的行人检测框及跟踪ID序号，模型方案为PP-YOLOE，详细文档参考[PP-YOLOE](../../../../configs/ppyoloe/README_cn.md)，跟踪方案为OC-SORT，详细文档参考[OC-SORT](../../../../configs/mot/ocsort)。
@@ -202,7 +202,7 @@ python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_pph
   <img src="https://user-images.githubusercontent.com/22989727/178769370-03ab1965-cfd1-401b-9902-82620a06e43c.gif" width='1000'/>
 </div>
 
-具体使用请参照[PP-Human检测跟踪模块](mot.md)的`5. 区域闯入判断和计数`。
+具体使用请参照[PP-Human检测跟踪模块](pphuman_mot.md)的`5. 区域闯入判断和计数`。
 
 ### 方案说明
 1. 使用多目标跟踪获取视频输入中的行人检测框及跟踪ID序号，模型方案为PP-YOLOE，详细文档参考[PP-YOLOE](../../../../configs/ppyoloe/README_cn.md)，跟踪方案为OC-SORT，详细文档参考[OC-SORT](../../../../configs/mot/ocsort)。
@@ -255,7 +255,7 @@ python deploy/pipeline/pipeline.py --config deploy/pipeline/config/infer_cfg_pph
                                                    --video_file=test_video.mp4 \
                                                    --device=gpu
 ```
-4. 启动命令中的完整参数说明，请参考[参数说明](./QUICK_STARTED.md)。
+4. 启动命令中的完整参数说明，请参考[参数说明](./PPHuman_QUICK_STARTED.md)。
 
 
 ### 方案说明