Commit e0b082ed authored by Kaushik Shivakumar's avatar Kaushik Shivakumar
Browse files

fix documentation for box coder

parent 4f7965fb
...@@ -37,16 +37,10 @@ EPSILON = 1e-8 ...@@ -37,16 +37,10 @@ EPSILON = 1e-8
class DETRBoxCoder(box_coder.BoxCoder): class DETRBoxCoder(box_coder.BoxCoder):
"""Faster RCNN box coder.""" """DETR box coder."""
def __init__(self): def __init__(self):
"""Constructor for DETRBoxCoder. """Constructor for DETRBoxCoder."""
Args:
scale_factors: List of 4 positive scalars to scale ty, tx, th and tw.
If set to None, does not perform scaling. For Faster RCNN,
the open-source implementation recommends using [10.0, 10.0, 5.0, 5.0].
"""
pass pass
@property @property
...@@ -58,10 +52,10 @@ class DETRBoxCoder(box_coder.BoxCoder): ...@@ -58,10 +52,10 @@ class DETRBoxCoder(box_coder.BoxCoder):
Args: Args:
boxes: BoxList holding N boxes to be encoded. boxes: BoxList holding N boxes to be encoded.
anchors: BoxList of anchors. anchors: BoxList of anchors, ignored for DETR.
Returns: Returns:
a tensor representing N anchor-encoded boxes of the format a tensor representing N encoded boxes of the format
[ty, tx, th, tw]. [ty, tx, th, tw].
""" """
# Convert anchors to the center coordinate representation. # Convert anchors to the center coordinate representation.
...@@ -72,8 +66,8 @@ class DETRBoxCoder(box_coder.BoxCoder): ...@@ -72,8 +66,8 @@ class DETRBoxCoder(box_coder.BoxCoder):
"""Decode relative codes to boxes. """Decode relative codes to boxes.
Args: Args:
rel_codes: a tensor representing N anchor-encoded boxes. rel_codes: a tensor representing N encoded boxes.
anchors: BoxList of anchors. anchors: BoxList of anchors, ignored for DETR.
Returns: Returns:
boxes: BoxList holding N bounding boxes. boxes: BoxList holding N bounding boxes.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment