Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Fix Sphinx errors in box_nms #13261

Merged
merged 1 commit into from
Nov 16, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions src/operator/contrib/bounding_box.cc
Original file line number Diff line number Diff line change
Expand Up @@ -47,22 +47,29 @@ the in_grad will be assigned 0.
In summary, gradients are sticked to its boxes, will either be moved or discarded
according to its original index in input.

Input requirements:
1. Input tensor have at least 2 dimensions, (n, k), any higher dims will be regarded
as batch, e.g. (a, b, c, d, n, k) == (a*b*c*d, n, k)
2. n is the number of boxes in each batch
3. k is the width of each box item.
Input requirements::

1. Input tensor have at least 2 dimensions, (n, k), any higher dims will be regarded
as batch, e.g. (a, b, c, d, n, k) == (a*b*c*d, n, k)
2. n is the number of boxes in each batch
3. k is the width of each box item.

By default, a box is [id, score, xmin, ymin, xmax, ymax, ...],
additional elements are allowed.

- `id_index`: optional, use -1 to ignore, useful if `force_suppress=False`, which means
we will skip highly overlapped boxes if one is `apple` while the other is `car`.
we will skip highly overlapped boxes if one is `apple` while the other is `car`.

- `coord_start`: required, default=2, the starting index of the 4 coordinates.
Two formats are supported:
`corner`: [xmin, ymin, xmax, ymax]
`center`: [x, y, width, height]
Two formats are supported:

- `corner`: [xmin, ymin, xmax, ymax]

- `center`: [x, y, width, height]

- `score_index`: required, default=1, box score/confidence.
When two boxes overlap IOU > `overlap_thresh`, the one with smaller score will be suppressed.
When two boxes overlap IOU > `overlap_thresh`, the one with smaller score will be suppressed.

- `in_format` and `out_format`: default='corner', specify in/out box formats.

Examples::
Expand Down