实例分割模块使用教程¶
一、概述¶
实例分割模块是计算机视觉系统中的关键组成部分,负责在图像或视频中确定并标记出包含特定对象实例的像素。该模块的性能直接影响到整个计算机视觉系统的准确性和效率。实例分割模块通常会输出每个目标实例的像素级别的掩模(masks),这些掩模将作为输入传递给对象识别模块进行后续处理。
二、支持模型列表¶
模型 | 模型下载链接 | Mask AP | GPU推理耗时(ms) [常规模式 / 高性能模式] |
CPU推理耗时(ms) [常规模式 / 高性能模式] |
模型存储大小(M) | 介绍 |
---|---|---|---|---|---|---|
Mask-RT-DETR-H | 推理模型/训练模型 | 50.6 | 172.36 / 172.36 | 1615.75 / 1615.75 | 449.9 M | Mask-RT-DETR 是一种基于RT-DETR的实例分割模型,通过采用最优性能的更好的PP-HGNetV2作为骨干网络,构建了MaskHybridEncoder编码器,引入了IOU-aware Query Selection 技术,使其在相同推理耗时上取得了SOTA实例分割精度。 |
Mask-RT-DETR-L | 推理模型/训练模型 | 45.7 | 88.18 / 88.18 | 1090.84 / 1090.84 | 113.6 M |
❗ 以上列出的是实例分割模块重点支持的2个核心模型,该模块总共支持15个模型,完整的模型列表如下:
👉模型列表详情
模型 | 模型下载链接 | Mask AP | GPU推理耗时(ms) [常规模式 / 高性能模式] |
CPU推理耗时(ms) [常规模式 / 高性能模式] |
模型存储大小(M) | 介绍 |
---|---|---|---|---|---|---|
Cascade-MaskRCNN-ResNet50-FPN | 推理模型/训练模型 | 36.3 | 141.69 / 141.69 | 254.8 M | Cascade-MaskRCNN 是一种改进的Mask RCNN实例分割模型,通过级联多个检测器,利用不同IOU阈值优化分割结果,解决检测与推理阶段的mismatch问题,提高了实例分割的准确性。 | |
Cascade-MaskRCNN-ResNet50-vd-SSLDv2-FPN | 推理模型/训练模型 | 39.1 | 147.62 / 147.62 | 254.7 M | ||
Mask-RT-DETR-H | 推理模型/训练模型 | 50.6 | 172.36 / 172.36 | 1615.75 / 1615.75 | 449.9 M | Mask-RT-DETR 是一种基于RT-DETR的实例分割模型,通过采用最优性能的更好的PP-HGNetV2作为骨干网络,构建了MaskHybridEncoder编码器,引入了IOU-aware Query Selection 技术,使其在相同推理耗时上取得了SOTA实例分割精度。 |
Mask-RT-DETR-L | 推理模型/训练模型 | 45.7 | 88.18 / 88.18 | 1090.84 / 1090.84 | 113.6 M | |
Mask-RT-DETR-M | 推理模型/训练模型 | 42.7 | 78.69 / 78.69 | 66.6 M | ||
Mask-RT-DETR-S | 推理模型/训练模型 | 41.0 | 33.5007 | - | 51.8 M | |
Mask-RT-DETR-X | 推理模型/训练模型 | 47.5 | 114.16 / 114.16 | 1240.92 / 1240.92 | 237.5 M | |
MaskRCNN-ResNet50-FPN | 推理模型/训练模型 | 35.6 | 118.30 / 118.30 | 157.5 M | Mask R-CNN是由华盛顿首例即现投影卡的一个全任务深度学习模型,能够在一个模型中完成图片实例的分类和定位,并结合图像级的遮罩(Mask)来完成分割任务。 | |
MaskRCNN-ResNet50-vd-FPN | 推理模型/训练模型 | 36.4 | 118.34 / 118.34 | 157.5 M | ||
MaskRCNN-ResNet50 | 推理模型/训练模型 | 32.8 | 228.83 / 228.83 | 128.7 M | ||
MaskRCNN-ResNet101-FPN | 推理模型/训练模型 | 36.6 | 148.14 / 148.14 | 225.4 M | ||
MaskRCNN-ResNet101-vd-FPN | 推理模型/训练模型 | 38.1 | 151.12 / 151.12 | 225.1 M | ||
MaskRCNN-ResNeXt101-vd-FPN | 推理模型/训练模型 | 39.5 | 237.55 / 237.55 | 370.0 M | ||
PP-YOLOE_seg-S | 推理模型/训练模型 | 32.5 | - | - | 31.5 M | PP-YOLOE_seg 是一种基于PP-YOLOE的实例分割模型。该模型沿用了PP-YOLOE的backbone和head,通过设计PP-YOLOE实例分割头,大幅提升了实例分割的性能和推理速度。 |
SOLOv2 | 推理模型/训练模型 | 35.5 | - | - | 179.1 M | SOLOv2 是一种按位置分割物体的实时实例分割算法。该模型是SOLO的改进版本,通过引入掩码学习和掩码NMS,实现了精度和速度上取得良好平衡。 |
三、快速集成¶
❗ 在快速集成前,请先安装 PaddleX 的 wheel 包,详细请参考 PaddleX本地安装教程
完成 wheel 包的安装后,几行代码即可完成实例分割模块的推理,可以任意切换该模块下的模型,您也可以将实例分割的模块中的模型推理集成到您的项目中。运行以下代码前,请您下载示例图片到本地。
from paddlex import create_model
model = create_model(model_name="Mask-RT-DETR-L")
output = model.predict(input="general_instance_segmentation_004.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_instance_segmentation_004.png', 'page_index': None, 'boxes': [{'cls_id': 0, 'label': 'person', 'score': 0.897335946559906, 'coordinate': [0, 0.46382904052734375, 195.22256469726562, 572.8294067382812]}, {'cls_id': 0, 'label': 'person', 'score': 0.8606418967247009, 'coordinate': [341.30389404296875, 0, 640.4802856445312, 575.7348022460938]}, {'cls_id': 0, 'label': 'person', 'score': 0.6397128105163574, 'coordinate': [520.0907592773438, 23.334789276123047, 767.5140380859375, 574.5650634765625]}, {'cls_id': 0, 'label': 'person', 'score': 0.6008261442184448, 'coordinate': [91.02522277832031, 112.34088897705078, 405.4962158203125, 574.1039428710938]}, {'cls_id': 0, 'label': 'person', 'score': 0.5031726360321045, 'coordinate': [200.81265258789062, 58.161617279052734, 272.8892517089844, 140.88356018066406]}], 'masks': '...'}}
input_path
: 表示输入待预测图像的路径
- page_index
: 如果输入是PDF文件,则表示当前是PDF的第几页,否则为 None
- boxes
: 每个预测出的object的信息
- cls_id
: 类别ID
- label
: 类别名称
- score
: 预测得分
- coordinate
: 预测框的坐标,格式为[xmin, ymin, xmax, ymax]
- masks
: 实例分割模型实际预测的mask,由于数据过大不便于直接print,所以此处用...
替换,可以通过res.save_to_img()
将预测结果保存为图片,通过res.save_to_json()
将预测结果保存为json文件。
可视化图片如下:
相关方法、参数等说明如下:
create_model
实例化通用实例分割模型(此处以Mask-RT-DETR-L
为例),具体说明如下:
参数 | 参数说明 | 参数类型 | 可选项 | 默认值 |
---|---|---|---|---|
model_name |
模型名称 | str |
无 | 无 |
model_dir |
模型存储路径 | str |
无 | 无 |
threshold |
低分object过滤阈值 | float/None |
无 | None |
- 其中,
model_name
必须指定,指定model_name
后,默认使用 PaddleX 内置的模型参数,在此基础上,指定model_dir
时,使用用户自定义的模型。 -
threshold
为低分object过滤阈值,默认为None,表示使用上一层设置,参数设置的优先级从高到低为:predict参数传入 > create_model初始化传入 > yaml配置文件设置
。 -
调用通用实例分割模型的
predict()
方法进行推理预测,predict()
方法参数有input
、batch_size
和threshold
,具体说明如下:
参数 | 参数说明 | 参数类型 | 可选项 | 默认值 |
---|---|---|---|---|
input |
待预测数据,支持多种输入类型 | Python Var /str /list |
|
无 |
batch_size |
批大小 | int |
任意整数 | 1 |
threshold |
低分object过滤阈值 | float /None |
|
None |
use_hpip |
是否启用高性能推理 | bool |
无 | False |
- 对预测结果进行处理,每个样本的预测结果均为对应的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 的 分割 相关模型训练插件,安装过程可以参考PaddleX本地安装教程中的二次开发部分。
4.1 数据准备¶
在进行模型训练前,需要准备相应任务模块的数据集。PaddleX 针对每一个模块提供了数据校验功能,只有通过数据校验的数据才可以进行模型训练。此外,PaddleX 为每一个模块都提供了 Demo 数据集,您可以基于官方提供的 Demo 数据完成后续的开发。若您希望用私有数据集进行后续的模型训练,可以参考PaddleX实例分割任务模块数据标注教程。
4.1.1 Demo 数据下载¶
您可以参考下面的命令将 Demo 数据集下载到指定文件夹:
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/instance_seg_coco_examples.tar -P ./dataset
tar -xf ./dataset/instance_seg_coco_examples.tar -C ./dataset/
4.1.2 数据校验¶
一行命令即可完成数据校验:
python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/instance_seg_coco_examples
Check dataset passed !
信息。校验结果文件保存在./output/check_dataset_result.json
,同时相关产出会保存在当前目录的./output/check_dataset
目录下,产出目录中包括可视化的示例样本图片和样本分布直方图。
👉 校验结果详情(点击展开)
校验结果文件具体内容为:
{
"done_flag": true,
"check_pass": true,
"attributes": {
"num_classes": 2,
"train_samples": 79,
"train_sample_paths": [
"check_dataset/demo_img/pexels-photo-634007.jpeg",
"check_dataset/demo_img/pexels-photo-59576.png"
],
"val_samples": 19,
"val_sample_paths": [
"check_dataset/demo_img/peasant-farmer-farmer-romania-botiza-47862.jpeg",
"check_dataset/demo_img/pexels-photo-715546.png"
]
},
"analysis": {
"histogram": "check_dataset/histogram.png"
},
"dataset_path": "instance_seg_coco_examples",
"show_type": "image",
"dataset_type": "COCOInstSegDataset"
}
上述校验结果中,check_pass 为 True 表示数据集格式符合要求,其他部分指标的说明如下:
attributes.num_classes
:该数据集类别数为 2;attributes.train_samples
:该数据集训练集样本数量为 79;attributes.val_samples
:该数据集验证集样本数量为 19;attributes.train_sample_paths
:该数据集训练集样本可视化图片相对路径列表;attributes.val_sample_paths
:该数据集验证集样本可视化图片相对路径列表; 另外,数据集校验还对数据集中所有类别的样本数量分布情况进行了分析,并绘制了分布直方图(histogram.png):
4.1.3 数据集格式转换/数据集划分(可选)¶
在您完成数据校验之后,可以通过修改配置文件或是追加超参数的方式对数据集的格式进行转换,也可以对数据集的训练/验证比例进行重新划分。
👉 格式转换/数据集划分详情(点击展开)
(1)数据集格式转换
实例分割任务支持LabelMe
格式转换为COCO
格式,数据集格式转换的参数可以通过修改配置文件中 CheckDataset
下的字段进行设置,配置文件中部分参数的示例说明如下:
CheckDataset
:convert
:enable
: 是否进行数据集格式转换,为True
时进行数据集格式转换,默认为False
;src_dataset_type
: 如果进行数据集格式转换,则需设置源数据集格式,数据可选源格式为LabelMe
; 例如,您想将LabelMe
的数据集转换为COCO
格式,则需将配置文件修改为:
cd /path/to/paddlex
wget https://paddle-model-ecology.bj.bcebos.com/paddlex/data/instance_seg_labelme_examples.tar -P ./dataset
tar -xf ./dataset/instance_seg_labelme_examples.tar -C ./dataset/
......
CheckDataset:
......
convert:
enable: True
src_dataset_type: LabelMe
......
随后执行命令:
python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.yaml\
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/instance_seg_labelme_examples
数据转换执行之后,原有标注文件会被在原路径下重命名为 xxx.bak
。
以上参数同样支持通过追加命令行参数的方式进行设置:
python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.yaml\
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/instance_seg_labelme_examples \
-o CheckDataset.convert.enable=True \
-o CheckDataset.convert.src_dataset_type=LabelMe
(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/instance_segmentation/Mask-RT-DETR-L.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/instance_seg_labelme_examples
数据划分执行之后,原有标注文件会被在原路径下重命名为 xxx.bak
。
以上参数同样支持通过追加命令行参数的方式进行设置:
python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.yaml \
-o Global.mode=check_dataset \
-o Global.dataset_dir=./dataset/instance_seg_labelme_examples \
-o CheckDataset.split.enable=True \
-o CheckDataset.split.train_percent=90 \
-o CheckDataset.split.val_percent=10
4.2 模型训练¶
一条命令即可完成模型的训练,以此处实例分割模型 Mask-RT-DETR-L 的训练为例:
python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.yaml \
-o Global.mode=train \
-o Global.dataset_dir=./dataset/instance_seg_coco_examples
- 指定模型的
.yaml
配置文件路径(此处为Mask-RT-DETR-L.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/instance_segmentation/Mask-RT-DETR-L.yaml \
-o Global.mode=evaluate \
-o Global.dataset_dir=./dataset/instance_seg_coco_examples
- 指定模型的
.yaml
配置文件路径(此处为Mask-RT-DETR-L.yaml
) - 指定模式为模型评估:
-o Global.mode=evaluate
- 指定验证数据集路径:
-o Global.dataset_dir
其他相关参数均可通过修改.yaml
配置文件中的Global
和Evaluate
下的字段来进行设置,详细请参考PaddleX通用模型配置文件参数说明。
👉 更多说明(点击展开)
在模型评估时,需要指定模型权重文件路径,每个配置文件中都内置了默认的权重保存路径,如需要改变,只需要通过追加命令行参数的形式进行设置即可,如-o Evaluate.weight_path=./output/best_model/best_model.pdparams
在完成模型评估后,会产出evaluate_result.json,其记录了
评估的结果,具体来说,记录了评估任务是否正常完成,以及模型的评估指标,包含 AP;
4.4 模型推理和模型集成¶
在完成模型的训练和评估后,即可使用训练好的模型权重进行推理预测或者进行Python集成。
4.4.1 模型推理¶
通过命令行的方式进行推理预测,只需如下一条命令。运行以下代码前,请您下载示例图片到本地。
python main.py -c paddlex/configs/modules/instance_segmentation/Mask-RT-DETR-L.yaml \
-o Global.mode=predict \
-o Predict.model_dir="./output/best_model/inference" \
-o Predict.input="general_instance_segmentation_004.png"
- 指定模型的
.yaml
配置文件路径(此处为Mask-RT-DETR-L.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产线有通用实例分割产线,只需要替换模型路径即可完成相关产线的实例分割模块的模型更新。
2.模块集成 您产出的权重可以直接集成到实例分割模块中,可以参考快速集成的 Python 示例代码,只需要将模型替换为你训练的到的模型路径即可。
您也可以利用 PaddleX 高性能推理插件来优化您模型的推理过程,进一步提升效率,详细的流程请参考PaddleX高性能推理指南。