---
comments: true
---
# 行人检测模块使用教程
## 一、概述
行人检测是目标检测的一个分支任务，指使用计算机视觉技术来判断图像或视频中是否存在行人，并给出每个行人的具体位置信息。这些信息对于智能视频监控、人体行为分析、智能驾驶、智能机器人等多种应用至关重要。
## 二、支持模型列表
> 推理耗时仅包含模型推理耗时，不包含前后处理耗时。
| 模型 | 模型下载链接 |
mAP(0.5:0.95) |
mAP(0.5) |
GPU推理耗时（ms）
[常规模式 / 高性能模式] |
CPU推理耗时（ms）
[常规模式 / 高性能模式] |
模型存储大小（MB） |
介绍 |
| PP-YOLOE-L_human |
推理模型/训练模型 |
48.0 |
81.9 |
30.59 / 26.64 |
180.05 / 112.70 |
196.02 |
基于PP-YOLOE的行人检测模型 |
| PP-YOLOE-S_human |
推理模型/训练模型 |
42.5 |
77.9 |
10.26 / 6.66 |
54.01 / 23.48 |
28.79 |
测试环境说明:
- 性能测试环境
- 测试数据集：CrowdHuman数据集 mAP(0.5:0.95)。
- 硬件配置：
- GPU：NVIDIA Tesla T4
- CPU：Intel Xeon Gold 6271C @ 2.60GHz
- 软件环境：
- Ubuntu 20.04 / CUDA 11.8 / cuDNN 8.9 / TensorRT 8.6.1.6
- paddlepaddle 3.0.0 / paddlex 3.0.3
- 推理模式说明
| 模式 |
GPU配置 |
CPU配置 |
加速技术组合 |
| 常规模式 |
FP32精度 / 无TRT加速 |
FP32精度 / 8线程 |
PaddleInference |
| 高性能模式 |
选择先验精度类型和加速策略的最优组合 |
FP32精度 / 8线程 |
选择先验最优后端（Paddle/OpenVINO/TRT等） |
## 三、快速集成
> ❗ 在快速集成前，请先安装 PaddleX 的 wheel 包，详细请参考 [PaddleX本地安装教程](../../../installation/installation.md)
完成wheel包的安装后，几行代码即可完成行人检测模块的推理，可以任意切换该模块下的模型，您也可以将行人检测的模块中的模型推理集成到您的项目中。运行以下代码前，请您下载[示例图片](https://paddle-model-ecology.bj.bcebos.com/paddlex/imgs/demo_image/human_detection.jpg)到本地。
```python
from paddlex import create_model
model = create_model(model_name="PP-YOLOE-S_human")
output = model.predict(input="human_detection.jpg", batch_size=1)
for res in output:
res.print()
res.save_to_img("./output/")
res.save_to_json("./output/res.json")
```
运行后，得到的结果为：
```bash
{'res': "{'input_path': 'human_detection.jpg', 'page_index': None, 'boxes': [{'cls_id': 0, 'label': 'pedestrian', 'score': 0.9085694551467896, 'coordinate': [259.53326, 342.86493, 307.43408, 464.22394]}, {'cls_id': 0, 'label': 'pedestrian', 'score': 0.8818504810333252, 'coordinate': [170.22249, 317.11432, 260.24777, 470.12704]}, {'cls_id': 0, 'label': 'pedestrian', 'score': 0.8622929453849792, 'coordinate': [402.17957, 345.1815, 458.4271, 479.91724]}, {'cls_id': 0, 'label': 'pedestrian', 'score': 0.8577917218208313, 'coordinate': [522.5973, 360.11118, 614.3201, 480]}, {'cls_id': 0, 'label': 'pedestrian', 'score': 0.8485967516899109, 'coordinate': [25.010237, 338.83722, 57.340042, 426.11932]}, ... ]}"}
```
运行结果参数含义如下：
- `input_path`: 表示输入待预测图像的路径
- `page_index`: 如果输入是PDF文件，则表示当前是PDF的第几页，否则为 `None`
- `boxes`: 每个预测出的object的信息
- `cls_id`: 类别ID
- `label`: 类别名称
- `score`: 预测得分
- `coordinate`: 预测框的坐标，格式为[xmin, ymin, xmax, ymax]
可视化图片如下：
相关方法、参数等说明如下：
* `create_model`实例化行人检测模型（此处以`PP-YOLOE-S_human`为例），具体说明如下：
| 参数 |
参数说明 |
参数类型 |
可选项 |
默认值 |
model_name |
模型名称 |
str |
无 |
无 |
model_dir |
模型存储路径 |
str |
无 |
无 |
device |
模型推理设备 |
str |
支持指定GPU具体卡号，如“gpu:0”，其他硬件具体卡号，如“npu:0”，CPU如“cpu”。 |
gpu:0 |
threshold |
低分object过滤阈值 |
float/None/dict[int, float] |
无 |
None |
use_hpip |
是否启用高性能推理插件 |
bool |
无 |
False |
hpi_config |
高性能推理配置 |
dict | None |
无 |
None |
* 其中，`model_name` 必须指定，指定 `model_name` 后，默认使用 PaddleX 内置的模型参数，在此基础上，指定 `model_dir` 时，使用用户自定义的模型。
* `threshold`为低分object过滤阈值，默认为None，表示使用上一层设置，参数设置的优先级从高到低为：`predict参数传入 > create_model初始化传入 > yaml配置文件设置`。目前支持float和dict两种阈值设置方式：
* `float`, 对于所有的类别使用同一个阈值。
* `dict[int, float]`, key为类别ID，value为阈值，对于不同的类别使用不同的阈值。行人检测为单类别检测，无需此设置。
* 调用行人检测模型的 `predict()` 方法进行推理预测，`predict()` 方法参数有 `input` 、 `batch_size` 和 `threshold`，具体说明如下：
| 参数 |
参数说明 |
参数类型 |
可选项 |
默认值 |
input |
待预测数据，支持多种输入类型 |
Python Var/str/list |
- Python变量，如
numpy.ndarray表示的图像数据
- 文件路径，如图像文件的本地路径：
/root/data/img.jpg
- URL链接，如图像文件的网络URL：示例
- 本地目录，该目录下需包含待预测数据文件，如本地路径：
/root/data/
- 列表，列表元素需为上述类型数据，如
[numpy.ndarray, numpy.ndarray]，[\"/root/data/img1.jpg\", \"/root/data/img2.jpg\"]，[\"/root/data1\", \"/root/data2\"]
|
无 |
batch_size |
批大小 |
int |
任意整数 |
1 |
threshold |
低分object过滤阈值 |
float/dict[int, float]/None |
- None，表示沿用上一层设置, 参数设置优先级从高到低为:
predict参数传入 > create_model初始化传入 > yaml配置文件设置
- float，对于所有的类别使用同一个阈值。如0.5，表示推理时使用0.5作为所有类别的低分object过滤阈值
- dict[int, float]，如
{0: 0.5, 1: 0.35}，表示推理时对类别0使用0.5低分过滤阈值，对类别1使用0.35低分过滤阈值。行人检测为单类别检测，无需此设置。
|
None |
* 对预测结果进行处理，每个样本的预测结果均为对应的Result对象，且支持打印、保存为图片、保存为`json`文件的操作:
| 方法 |
方法说明 |
参数 |
参数类型 |
参数说明 |
默认值 |
print() |
打印结果到终端 |
format_json |
bool |
是否对输出内容进行使用 JSON 缩进格式化 |
True |
indent |
int |
指定缩进级别，以美化输出的 JSON 数据，使其更具可读性，仅当 format_json 为 True 时有效 |
4 |
ensure_ascii |
bool |
控制是否将非 ASCII 字符转义为 Unicode。设置为 True 时，所有非 ASCII 字符将被转义；False 则保留原始字符，仅当format_json为True时有效 |
False |
save_to_json() |
将结果保存为json格式的文件 |
save_path |
str |
保存的文件路径，当为目录时，保存文件命名与输入文件类型命名一致 |
无 |
indent |
int |
指定缩进级别，以美化输出的 JSON 数据，使其更具可读性，仅当 format_json 为 True 时有效 |
4 |
ensure_ascii |
bool |
控制是否将非 ASCII 字符转义为 Unicode。设置为 True 时，所有非 ASCII 字符将被转义；False 则保留原始字符，仅当format_json为True时有效 |
False |
save_to_img() |
将结果保存为图像格式的文件 |
save_path |
str |
保存的文件路径，当为目录时，保存文件命名与输入文件类型命名一致 |
无 |
* 此外，也支持通过属性获取带结果的可视化图像和预测结果，具体如下：
| 属性 |
属性说明 |
json |
获取预测的json格式的结果 |
img |
获取格式为dict的可视化图像 |
关于更多 PaddleX 的单模型推理的 API 的使用方法，可以参考[PaddleX单模型Python脚本使用说明](../../instructions/model_python_API.md)。
## 四、二次开发
如果你追求更高精度的现有模型，可以使用PaddleX的二次开发能力，开发更好的行人检测模型。在使用PaddleX开发行人检测模型之前，请务必安装PaddleX的PaddleDetection插件，安装过程可以参考 [PaddleX本地安装教程](../../../installation/installation.md)。
### 4.1 数据准备
在进行模型训练前，需要准备相应任务模块的数据集。PaddleX 针对每一个模块提供了数据校验功能，只有通过数据校验的数据才可以进行模型训练。此外，PaddleX为每一个模块都提供了demo数据集，您可以基于官方提供的 Demo 数据完成后续的开发。若您希望用私有数据集进行后续的模型训练，可以参考[PaddleX目标检测任务模块数据标注教程](../../../data_annotations/cv_modules/object_detection.md)。
#### 4.1.1 Demo 数据下载
您可以参考下面的命令将 Demo 数据集下载到指定文件夹：
```bash
cd /path/to/paddlex
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/widerperson_coco_examples.tar -P ./dataset
tar -xf ./dataset/widerperson_coco_examples.tar -C ./dataset/
```
#### 4.1.2 数据校验
一行命令即可完成数据校验：
```bash
python main.py -c paddlex/configs/modules/human_detection/PP-YOLOE-S_human.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/widerperson_coco_examples
```
执行上述命令后，PaddleX 会对数据集进行校验，并统计数据集的基本信息，命令运行成功后会在log中打印出`Check dataset passed !`信息。校验结果文件保存在`./output/check_dataset_result.json`，同时相关产出会保存在当前目录的`./output/check_dataset`目录下，产出目录中包括可视化的示例样本图片和样本分布直方图。
👉 校验结果详情（点击展开）
校验结果文件具体内容为：
{
"done_flag": true,
"check_pass": true,
"attributes": {
"num_classes": 1,
"train_samples": 500,
"train_sample_paths": [
"check_dataset/demo_img/000041.jpg",
"check_dataset/demo_img/000042.jpg",
"check_dataset/demo_img/000044.jpg"
],
"val_samples": 100,
"val_sample_paths": [
"check_dataset/demo_img/001138.jpg",
"check_dataset/demo_img/001140.jpg",
"check_dataset/demo_img/001141.jpg"
]
},
"analysis": {
"histogram": "check_dataset/histogram.png"
},
"dataset_path": "widerperson_coco_examples",
"show_type": "image",
"dataset_type": "COCODetDataset"
}
上述校验结果中，check_pass 为 True 表示数据集格式符合要求，其他部分指标的说明如下：
attributes.num_classes：该数据集类别数为 1；attributes.train_samples：该数据集训练集样本数量为500；attributes.val_samples：该数据集验证集样本数量为 100；attributes.train_sample_paths：该数据集训练集样本可视化图片相对路径列表；attributes.val_sample_paths：该数据集验证集样本可视化图片相对路径列表；
数据集校验还对数据集中所有类别的样本数量分布情况进行了分析，并绘制了分布直方图（histogram.png）：
👉 格式转换/数据集划分详情（点击展开）
（1）数据集格式转换
行人检测不支持数据格式转换。
（2）数据集划分
数据集划分的参数可以通过修改配置文件中 CheckDataset 下的字段进行设置，配置文件中部分参数的示例说明如下：
CheckDataset:split:enable: 是否进行重新划分数据集，为 True 时进行数据集格式转换，默认为 False；train_percent: 如果重新划分数据集，则需要设置训练集的百分比，类型为0-100之间的任意整数，需要保证与 val_percent 的值之和为100；
例如，您想重新划分数据集为 训练集占比90%、验证集占比10%，则需将配置文件修改为：
......
CheckDataset:
......
split:
enable: True
train_percent: 90
val_percent: 10
......
随后执行命令：
python main.py -c paddlex/configs/modules/human_detection/PP-YOLOE-S_human.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/widerperson_coco_examples
数据划分执行之后，原有标注文件会被在原路径下重命名为 xxx.bak。
以上参数同样支持通过追加命令行参数的方式进行设置：
python main.py -c paddlex/configs/modules/human_detection/PP-YOLOE-S_human.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/widerperson_coco_examples \
-o CheckDataset.split.enable=True \
-o CheckDataset.split.train_percent=90 \
-o CheckDataset.split.val_percent=10
👉 更多说明（点击展开）
👉 更多说明（点击展开）
在模型评估时，需要指定模型权重文件路径，每个配置文件中都内置了默认的权重保存路径，如需要改变，只需要通过追加命令行参数的形式进行设置即可，如-o Evaluate.weight_path=./output/best_model/best_model/model.pdparams。
在完成模型评估后，会产出evaluate_result.json，其记录了评估的结果，具体来说，记录了评估任务是否正常完成，以及模型的评估指标，包含 AP；
