multiclass_nms

paddle.fluid.layers. multiclass_nms ( bboxes, scores, score_threshold, nms_top_k, keep_top_k, nms_threshold=0.3, normalized=True, nms_eta=1.0, background_label=0, name=None )

多分类 NMS

该 OP 用于对边界框（bounding box）和评分（scores）执行多类非极大值抑制（NMS）。

在 NMS 中，如果提供 score_threshold 阈值，则此 OP 贪心地选择所有得分（scores）高于 score_threshold 的检测边界框（bounding box）的子集，如果 nms_top_k 大于-1，则选择最大的 nms_top_k 置信度分数。接着，该 OP 依据 adaptive nms（基于 nms_threshold 和 nms_eta），删除与已选择的框 IOU(交并比)高于 nms_threshold 的重叠框。

在 NMS 步骤后，如果 keep_top_k 大于-1，则每个图像最多保留 keep_top_k 个框（bounding box）。

计算示例： 
如果：
    box1.data = (2.0, 3.0, 7.0, 5.0)  数据格式为 (xmin, ymin, xmax, ymax)
    box1.scores = (0.7, 0.2, 0.4)   其中 (label0.score=0.7, label1.score=0.2, label2.cores=0.4)
    box2.data = (3.0, 4.0, 8.0, 5.0)
    box2.score = (0.3, 0.3, 0.1)
    nms_threshold = 0.3
    background_label = 0
    score_threshold = 0
则：
    iou = 4/11 > 0.3
    out.data = [[1, 0.3, 3.0, 4.0, 8.0, 5.0],
                 [2, 0.4, 2.0, 3.0, 7.0, 5.0]]

    输出数据格式为 (label, confidence, xmin, ymin, xmax, ymax)

参数

  • bboxes (Variable) – 支持两种类型的边界框（bounding box）:

    1. （Tensor）形为[N，M，4 或 8、16、24、32]的 3-DTensor，表示将预测 M 个边界框的预测位置，N 是批大小（batch size）。当边界框(bounding box)大小等于 4 时，每个边界框有四个坐标值，布局为[xmin，ymin，xmax，ymax]。数据类型为 float32 或 float64。

    2. （LoDTensor）形状为[M，C，4] M 是边界框的个数，C 是类别个数。数据类型为 float32 或 float64

  • scores (Variable) – 支持两种类型的分数：

    1. （Tensor）具有形状[N，C，M]的 3-DTensor 表示预测的置信度。N 是批量大小 batch size，C 是种类数目，M 是边界框 bounding box 的数量。对于每个类别，存在对应于 M 个边界框的总 M 个分数。请注意，M 等于 bboxes 的第二维。数据类型为 float32 或 float64。

    2. （LoDTensor）具有形状[M，C]的 2-D LoDTensor。 M 是 bbox 的数量，C 是种类数目。在这种情况下，输入 bboxes 应该是形为[M，C，4]的第二种情况。数据类型为 float32 或 float64。

  • background_label (int) – 背景标签（类别）的索引，如果设置为 0，则忽略背景标签（类别）。如果设置为 -1，则考虑所有类别。默认值：0

  • score_threshold (float) – 过滤掉低置信度分数的边界框的阈值。如果没有提供，请考虑所有边界框。

  • nms_top_k (int) – 基于 score_threshold 的过滤检测后，根据置信度保留的最大检测次数。

  • nms_threshold (float) – 在 NMS 中用于剔除检测框 IOU 的阈值，默认值：0.3 。

  • nms_eta (float) – 在 NMS 中用于调整 nms_threshold 的参数，设为 1 时表示 nms_threshold 不变。默认值：1.0 。

  • keep_top_k (int) – NMS 步骤后每个图像要保留的总 bbox 数。-1 表示在 NMS 步骤之后保留所有 bbox。

  • normalized (bool) – 检测是否已经经过正则化。默认值：True 。

  • name (str，可选) - 具体用法请参见 Name，一般无需设置，默认值为 None。

返回

形为[No，6]的 2-D LoDTensor，表示检测(detections)结果。每行有 6 个值：[标签 label，置信度 confidence，xmin，ymin，xmax，ymax]。或形为[No，10]的 2-D LoDTensor，用来表示检测结果。每行有 10 个值：[标签 label，置信度 confidence，x1，y1，x2，y2，x3，y3，x4，y4]。 No 是检测的总数。如果对所有图像都没有检测到的 box，则 lod 将设置为{1}，而 Out 仅包含一个值-1。 （1.3 版本之后，当未检测到 box 时，lod 从{0}更改为{1}）

返回类型

Variable，数据类型与输入一致。

代码示例

import paddle.fluid as fluid
boxes = fluid.layers.data(name='bboxes', shape=[81, 4],
                          dtype='float32', lod_level=1)
scores = fluid.layers.data(name='scores', shape=[81],
                          dtype='float32', lod_level=1)
out = fluid.layers.multiclass_nms(bboxes=boxes,
                                  scores=scores,
                                  background_label=0,
                                  score_threshold=0.5,
                                  nms_top_k=400,
                                  nms_threshold=0.3,
                                  keep_top_k=200,
                                  normalized=False)