主体检测模块使用教程¶

一、概述¶

主体检测任务是目标检测中的一项基本任务，旨在从图像、视频中识别并提取出特定的目标物体、人、实体的位置和大小。主体检测任务通过构建深度神经网络模型，学习图像主体的特征表示，实现高效准确的主体检测。

二、支持模型列表¶

模型	模型下载链接	mAP(0.5:0.95)	mAP(0.5)	GPU推理耗时（ms） [常规模式 / 高性能模式]	CPU推理耗时（ms） [常规模式 / 高性能模式]	模型存储大小（M）	介绍
PP-ShiTuV2_det	推理模型/训练模型	41.5	62.0	12.79 / 4.51	44.14 / 44.14	27.54	基于PicoDet_LCNet_x2_5的主体检测模型，模型可能会同时检测出多个常见主体。

测试环境说明：

性能测试环境
测试数据集：PaddleClas主体检测数据集。
硬件配置：
- GPU：NVIDIA Tesla T4
- CPU：Intel Xeon Gold 6271C @ 2.60GHz
- 其他环境：Ubuntu 20.04 / cuDNN 8.6 / TensorRT 8.5.2.2
推理模式说明

模式	GPU配置	CPU配置	加速技术组合
常规模式	FP32精度 / 无TRT加速	FP32精度 / 8线程	PaddleInference
高性能模式	选择先验精度类型和加速策略的最优组合	FP32精度 / 8线程	选择先验最优后端（Paddle/OpenVINO/TRT等）

三、快速集成¶

❗ 在快速集成前，请先安装 PaddleX 的 wheel 包，详细请参考 PaddleX本地安装教程

完成whl包的安装后，几行代码即可完成主体检测模块的推理，可以任意切换该模块下的模型，您也可以将主体检测的模块中的模型推理集成到您的项目中。运行以下代码前，请您下载示例图片到本地。

from paddlex import create_model
model = create_model(model_name="PP-ShiTuV2_det")
output = model.predict(input="general_object_detection_002.png", batch_size=1)
for res in output:
    res.print()
    res.save_to_img("./output/")
    res.save_to_json("./output/res.json")

运行后，得到的结果为：

{'res': "{'input_path': 'general_object_detection_002.png', 'page_index': None, 'boxes': [{'cls_id': 0, 'label': 'mainbody', 'score': 0.8161919713020325, 'coordinate': [76.07117, 272.83017, 329.5627, 519.48236]}, {'cls_id': 0, 'label': 'mainbody', 'score': 0.8071584701538086, 'coordinate': [662.7539, 92.804276, 874.7139, 308.21216]}, {'cls_id': 0, 'label': 'mainbody', 'score': 0.754974365234375, 'coordinate': [284.4833, 93.76895, 476.6789, 297.27588]}, {'cls_id': 0, 'label': 'mainbody', 'score': 0.6657832860946655, 'coordinate': [732.1591, 0, 1035.9547, 168.45923]}, {'cls_id': 0, 'label': 'mainbody', 'score': 0.614763081073761, 'coordinate': [763.9127, 280.74258, 925.48065, 439.444]}, ... ]}"}

运行结果参数含义如下： - input_path: 表示输入待预测图像的路径 - page_index: 如果输入是PDF文件，则表示当前是PDF的第几页，否则为 None - boxes: 每个预测出的object的信息 - cls_id: 类别ID - label: 类别名称 - score: 预测得分 - coordinate: 预测框的坐标，格式为[xmin, ymin, xmax, ymax]

可视化图片如下：

相关方法、参数等说明如下：

create_model实例化主体检测模型（此处以PP-ShiTuV2_det为例），具体说明如下：

参数	参数说明	参数类型	可选项	默认值
`model_name`	模型名称	`str`	无	`无`
`model_dir`	模型存储路径	`str`	无	无
`threshold`	低分object过滤阈值	`float/None/dict[int, float]`	无	None
`use_hpip`	是否启用高性能推理	`bool`	无	`False`

其中，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脚本使用说明。

四、二次开发¶

如果你追求更高精度的现有模型，可以使用PaddleX的二次开发能力，开发更好的主体检测模型。在使用PaddleX开发主体检测模型之前，请务必安装PaddleX的PaddleDetection插件，安装过程可以参考PaddleX本地安装教程。

4.1 数据准备¶

在进行模型训练前，需要准备相应任务模块的数据集。PaddleX 针对每一个模块提供了数据校验功能，只有通过数据校验的数据才可以进行模型训练。此外，PaddleX为每一个模块都提供了demo数据集，您可以基于官方提供的 Demo 数据完成后续的开发。若您希望用私有数据集进行后续的模型训练，可以参考PaddleX目标检测任务模块数据标注教程。

4.1.1 Demo 数据下载¶

您可以参考下面的命令将 Demo 数据集下载到指定文件夹：

cd /path/to/paddlex
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/mainbody_det_examples.tar -P ./dataset
tar -xf ./dataset/mainbody_det_examples.tar -C ./dataset/

4.1.2 数据校验¶

一行命令即可完成数据校验：

python main.py -c paddlex/configs/modules/mainbody_detection/PP-ShiTuV2_det.yaml \
    -o Global.mode=check_dataset \
    -o Global.dataset_dir=./dataset/mainbody_det_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": 701,
    "train_sample_paths": [
      "check_dataset/demo_img/road839.png",
      "check_dataset/demo_img/road363.png",
      "check_dataset/demo_img/road148.png"
    ],
    "val_samples": 176,
    "val_sample_paths": [
      "check_dataset/demo_img/road218.png",
      "check_dataset/demo_img/road681.png",
      "check_dataset/demo_img/road138.png"
    ]
  },
  "analysis": {
    "histogram": "check_dataset/histogram.png"
  },
  "dataset_path": "mainbody_det_examples",
  "show_type": "image",
  "dataset_type": "COCODetDataset"
}

上述校验结果中，check_pass 为 True 表示数据集格式符合要求，其他部分指标的说明如下：

attributes.num_classes：该数据集类别数为 1；
attributes.train_samples：该数据集训练集样本数量为 701；
attributes.val_samples：该数据集验证集样本数量为 176；
attributes.train_sample_paths：该数据集训练集样本可视化图片相对路径列表；
attributes.val_sample_paths：该数据集验证集样本可视化图片相对路径列表；

数据集校验还对数据集中所有类别的样本数量分布情况进行了分析，并绘制了分布直方图（histogram.png）：

4.1.3 数据集格式转换/数据集划分（可选）¶

在您完成数据校验之后，可以通过修改配置文件或是追加超参数的方式对数据集的格式进行转换，也可以对数据集的训练/验证比例进行重新划分。

👉 格式转换/数据集划分详情（点击展开）

（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/mainbody_detection/PP-ShiTuV2_det.yaml \
    -o Global.mode=check_dataset \
    -o Global.dataset_dir=./dataset/mainbody_det_examples

数据划分执行之后，原有标注文件会被在原路径下重命名为 xxx.bak。

以上参数同样支持通过追加命令行参数的方式进行设置：

python main.py -c paddlex/configs/modules/mainbody_detection/PP-ShiTuV2_det.yaml  \
    -o Global.mode=check_dataset \
    -o Global.dataset_dir=./dataset/mainbody_det_examples \
    -o CheckDataset.split.enable=True \
    -o CheckDataset.split.train_percent=90 \
    -o CheckDataset.split.val_percent=10

4.2 模型训练¶

一条命令即可完成模型的训练，以此处PP-ShiTuV2_det的训练为例：

python main.py -c paddlex/configs/modules/mainbody_detection/PP-ShiTuV2_det.yaml \
    -o Global.mode=train \
    -o Global.dataset_dir=./dataset/mainbody_det_examples

需要如下几步：

指定模型的.yaml 配置文件路径（此处为PP-ShiTuV2_det.yaml，训练其他模型时，需要的指定相应的配置文件，模型和配置的文件的对应关系，可以查阅PaddleX模型列表（CPU/GPU））
指定模式为模型训练：-o Global.mode=train
指定训练数据集路径：-o Global.dataset_dir 其他相关参数均可通过修改.yaml配置文件中的Global和Train下的字段来进行设置，也可以通过在命令行中追加参数来进行调整。如指定前 2 卡 gpu 训练：-o Global.device=gpu:0,1；设置训练轮次数为 10：-o Train.epochs_iters=10。更多可修改的参数及其详细解释，可以查阅模型对应任务模块的配置文件说明PaddleX通用模型配置文件参数说明。

👉 更多说明（点击展开）

模型训练过程中，PaddleX 会自动保存模型权重文件，默认为output，如需指定保存路径，可通过配置文件中 -o Global.output 字段进行设置。
PaddleX 对您屏蔽了动态图权重和静态图权重的概念。在模型训练的过程中，会同时产出动态图和静态图的权重，在模型推理时，默认选择静态图权重推理。
在完成模型训练后，所有产出保存在指定的输出目录（默认为./output/）下，通常有以下产出：
train_result.json：训练结果记录文件，记录了训练任务是否正常完成，以及产出的权重指标、相关文件路径等；
train.log：训练日志文件，记录了训练过程中的模型指标变化、loss 变化等；
config.yaml：训练配置文件，记录了本次训练的超参数的配置；
.pdparams、.pdema、.pdopt.pdstate、.pdiparams、.pdmodel：模型权重相关文件，包括网络参数、优化器、EMA、静态图网络参数、静态图网络结构等；

4.3 模型评估¶

在完成模型训练后，可以对指定的模型权重文件在验证集上进行评估，验证模型精度。使用 PaddleX 进行模型评估，一条命令即可完成模型的评估：

python main.py -c paddlex/configs/modules/mainbody_detection/PP-ShiTuV2_det.yaml \
    -o Global.mode=evaluate \
    -o Global.dataset_dir=./dataset/mainbody_det_examples

与模型训练类似，需要如下几步：

指定模型的.yaml 配置文件路径（此处为PP-ShiTuV2_det.yaml）
指定模式为模型评估：-o Global.mode=evaluate
指定验证数据集路径：-o Global.dataset_dir 其他相关参数均可通过修改.yaml配置文件中的Global和Evaluate下的字段来进行设置，详细请参考PaddleX通用模型配置文件参数说明。

👉 更多说明（点击展开）

在模型评估时，需要指定模型权重文件路径，每个配置文件中都内置了默认的权重保存路径，如需要改变，只需要通过追加命令行参数的形式进行设置即可，如-o Evaluate.weight_path=``./output/best_model/best_model/model.pdparams。

在完成模型评估后，会产出evaluate_result.json，其记录了评估的结果，具体来说，记录了评估任务是否正常完成，以及模型的评估指标，包含 AP；

4.4 模型推理¶

在完成模型的训练和评估后，即可使用训练好的模型权重进行推理预测。在PaddleX中实现模型推理预测可以通过两种方式：命令行和wheel 包。

4.4.1 模型推理¶

通过命令行的方式进行推理预测，只需如下一条命令。运行以下代码前，请您下载示例图片到本地。

python main.py -c paddlex/configs/modules/mainbody_detection/PP-ShiTuV2_det.yaml \
    -o Global.mode=predict \
    -o Predict.model_dir="./output/best_model/inference" \
    -o Predict.input="general_object_detection_002.png"

与模型训练和评估类似，需要如下几步：

指定模型的.yaml 配置文件路径（此处为PP-ShiTuV2_det.yaml）
指定模式为模型推理预测：-o Global.mode=predict
指定模型权重路径：-o Predict.model_dir="./output/best_model/inference"
指定输入数据路径：-o Predict.input="..." 其他相关参数均可通过修改.yaml配置文件中的Global和Predict下的字段来进行设置，详细请参考PaddleX通用模型配置文件参数说明。

4.4.2 模型集成¶

模型可以直接集成到 PaddleX 产线中，也可以直接集成到您自己的项目中。

1.产线集成

主体检测模块可以集成的PaddleX产线有通用图像识别（comming soon），只需要替换模型路径即可完成相关产线的主体检测模块的模型更新。在产线集成中，你可以使用高性能部署和服务化部署来部署你得到的模型。

2.模块集成

您产出的权重可以直接集成到主体检测模块中，可以参考快速集成的 Python 示例代码，只需要将模型替换为你训练的到的模型路径即可。

您也可以利用 PaddleX 高性能推理插件来优化您模型的推理过程，进一步提升效率，详细的流程请参考PaddleX高性能推理指南。