Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refine the doc in detection_output API. #8689

Merged
merged 3 commits into from
Mar 5, 2018
Merged
Changes from 2 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
18 changes: 13 additions & 5 deletions python/paddle/fluid/layers/detection.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,12 @@ def detection_output(loc,
score_threshold=0.01,
nms_eta=1.0):
"""
**Detection Output Layer**
**Detection Output Layer for SSD.**

This layer applies the NMS to the output of network and computes the
predict bounding box location. The output's shape of this layer could
be zero if there is no valid bounding box.
This operation decode the predicted bboxes according to the prior bboxes
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This operation updates bounding boxes by applying multi-class non-maximum suppression (NMS) and re-scoring.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-write the doc. Thanks!

at first, then applying multi-class non maximum suppression (NMS) on the
decoded boxes and scores to get the detected bounding boxed. The output
layout is described as follows.

Args:
loc(Variable): A 3-D Tensor with shape [N, M, 4] represents the
Expand Down Expand Up @@ -91,7 +92,14 @@ class number, M is number of bounding boxes. For each category
nms_eta(float): The parameter for adaptive NMS.

Returns:
The detected bounding boxes which are a Tensor.
Variable: The detection outputs which is a LoDTensor with shape [No, 6].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a comma (,) before "which".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-write the doc. Thanks!

Each row has 6 values: [label, confidence, xmin, ymin, xmax, ymax],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use six instead 6.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Thanks!

No is the total number of detections in this mini-batch. For each
instance, the offsets in first dimension are called LoD, the number
offset is N + 1, N is the batch size. If LoD[i + 1] - LoD[i] == 0,
means there is no detected bboxes for for i-th image. If there is
no detected boxes for all images, all the elements in LoD are 0,
and the Out only contains one value which is -1.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the Out => Out

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Re-write the doc. Thanks!


Examples:
.. code-block:: python
Expand Down