Add doc #3125
Merged
Add doc #3125
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
hellock
reviewed
Jun 25, 2020
Closed
hellock
reviewed
Jun 26, 2020
mmdet/core/mask/structures.py
Outdated
| Returns: | ||
| BitmapMasks: the rescaled masks | ||
| """ | ||
| """See `BaseInstanceMasks.rescale()`.""" |
There was a problem hiding this comment.
:func:`BaseInstanceMasks.rescale()`
hellock
reviewed
Jun 26, 2020
|
|
||
| Args: | ||
| feats (Tensor): Features of a single scale level with shape | ||
| (N, C, H, W). |
hellock
reviewed
Jun 26, 2020
| image in [tl_x, tl_y, br_x, br_y] format. | ||
| gt_labels (list[Tensor]): class indices corresponding to each box | ||
| img_metas (list[dict]): Size / scale info for each image | ||
| gt_bboxes_ignore (None | list[Tensor]): specify which bounding |
hellock
reviewed
Jun 26, 2020
| img_metas (list[dict]): Size / scale info for each image | ||
| cfg (mmcv.Config): Test / postprocessing configuration, | ||
| if None, test_cfg would be used | ||
| rescale (bool): If True, return boxes in original image space |
hellock
reviewed
Jun 26, 2020
| level with shape (N, num_anchors * 1, H, W) | ||
| img_metas (list[dict]): Size / scale info for each image | ||
| cfg (mmcv.Config): Test / postprocessing configuration, | ||
| if None, test_cfg would be used |
hellock
reviewed
Jun 26, 2020
hellock
reviewed
Jun 26, 2020
| @@ -252,6 +321,28 @@ def get_bboxes(self, | |||
| img_metas, | |||
| cfg=None, | |||
| rescale=False): | |||
| """Transform network output for a batch into labeled boxes. | |||
There was a problem hiding this comment.
labeled boxes -> bbox predictions.
hellock
reviewed
Jun 26, 2020
| rescale (bool): If True, return boxes in original image space. | ||
|
|
||
| Returns: | ||
| Tensor: Labeled boxes in shape (n, 5), where the first 4 columns |
hellock
reviewed
Jun 26, 2020
| The first item is an (n, 5) tensor, where the first 4 columns | ||
| are bounding box positions (tl_x, tl_y, br_x, br_y) and the | ||
| 5-th column is a score between 0 and 1. The second item is a | ||
| (n,) tensor where each item is the class index of the |
There was a problem hiding this comment.
class index -> predicted class label
hellock
reviewed
Jun 26, 2020
| image with shape (N, 4). | ||
| bbox_weights (Tensor): BBox weights of all anchors in the | ||
| image with shape (N, 4) | ||
| pos_inds (Tensor): Inds of postive anchor with shape |
hellock
reviewed
Jun 26, 2020
| level with shape (N, num_points * 4, H, W). | ||
| centernesses (list[Tensor]): Centerss for each scale level with | ||
| shape (N, num_points * 1, H, W). | ||
| gt_bboxes (list[Tensor]): each item are the truth boxes for each |
There was a problem hiding this comment.
gt_bboxes (list[Tensor]): Ground truth bboxes for each image with shape (num_gts, 4) in [tl_x, tl_y, br_x, br_y] format.
hellock
reviewed
Jun 26, 2020
| gt_bboxes (list[Tensor]): each item are the truth boxes for each | ||
| image in [tl_x, tl_y, br_x, br_y] format. | ||
| gt_labels (list[Tensor]): class indices corresponding to each box | ||
| img_metas (list[dict]): Size / scale info for each image |
There was a problem hiding this comment.
Meta information of each image, e.g., image size, scaling factor, etc.
hellock
reviewed
Jun 26, 2020
| Returns: | ||
| tuple: | ||
| concat_lvl_labels: Labels of each level | ||
| concat_lvl_bbox_targets: BBox targets of each level |
hellock
reviewed
Jun 26, 2020
| Args: | ||
| points (list[Tensor]): Points of each fpn level. | ||
| gt_bboxes_list (list[Tensor]): Ground truth bboxes of each image. | ||
| gt_labels_list (list[Tensor]): Ground truth labels of each box. |
hellock
reviewed
Jun 26, 2020
| bbox_thr: The threshold of the saturated linear function. It is | ||
| usually the same with the IoU threshold used in NMS. | ||
| gamma (float): Gamma parameter in focal loss. | ||
| alpha: Alpha parameter in focal loss. |
hellock
reviewed
Jun 26, 2020
hellock
reviewed
Jun 26, 2020
| """Compute negative bag loss. | ||
|
|
||
| Args: | ||
| cls_prob (Tensor): Cls prob, in shape |
There was a problem hiding this comment.
Avoid abbreviation in docstrings.
hellock
reviewed
Jun 26, 2020
| """Forward feature map of a single scale level. | ||
|
|
||
| Args: | ||
| x: Feature map of a single scale level. |
hellock
reviewed
Jun 26, 2020
|
|
||
| Returns: | ||
| tuple: scores for each class, bbox predictions | ||
| predictions of input feature map. |
hellock
reviewed
Jun 26, 2020
|
|
||
| Args: | ||
| x (tuple[Tensor]): Features from the upstream, usually have 5 | ||
| scales, each has shape (N, C, H, W). |
There was a problem hiding this comment.
The 5 feature maps have different shapes instead of all (N, C, H, W)
hellock
reviewed
Jun 26, 2020
mmdet/models/dense_heads/ssd_head.py
Outdated
|
|
||
| Args: | ||
| feats (tuple[Tensor]): Features from the upstream network, each has | ||
| shape (N, C, H, W). |
hellock
approved these changes
Jun 26, 2020
mike112223
pushed a commit
to mike112223/mmdetection
that referenced
this pull request
Aug 25, 2020
* add doc * fix some typos * fix some doc * fix property doc * update doc * complete free anchor doc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.