add docs

dmlc · Jerryzcn · Jul 8, 2020 · May 6, 2020 · May 6, 2020 · May 6, 2020
commit 8207c937585b87d1317f19479a62ddc3cf99ed66
diff --git a/gluoncv/model_zoo/rcnn/faster_rcnn/data_parallel.py b/gluoncv/model_zoo/rcnn/faster_rcnn/data_parallel.py
@@ -7,7 +7,27 @@
 
 
 class ForwardBackwardTask(Parallelizable):
-    """ Faster R-CNN tarining task that can be scheduled concurrently using Parallel."""
+    """ Faster R-CNN training task that can be scheduled concurrently using Parallel.
+    Parameters
+    ----------
+    net : gluon.HybridBlock
+        Faster R-CNN network.
+    optimizer : gluon.Trainer
+        Optimizer for the training.
+    rpn_cls_loss : gluon.loss
+        RPN box classification loss.
+    rpn_box_loss : gluon.loss
+        RPN box regression loss.
+    rcnn_cls_loss : gluon.loss
+        R-CNN box head classification loss.
+    rcnn_box_loss : gluon.loss
+        R-CNN box head regression loss.
+    mix_ratio : int
+        Object detection mixup ratio.
+    amp_enabled : bool
+        Whether to enable Automatic Mixed Precision.
+    """
+
     def __init__(self, net, optimizer, rpn_cls_loss, rpn_box_loss, rcnn_cls_loss, rcnn_box_loss,
                  mix_ratio, amp_enabled):
         super(ForwardBackwardTask, self).__init__()

diff --git a/gluoncv/model_zoo/rcnn/mask_rcnn/data_parallel.py b/gluoncv/model_zoo/rcnn/mask_rcnn/data_parallel.py
@@ -8,7 +8,26 @@
 
 
 class ForwardBackwardTask(Parallelizable):
-    """ Mask R-CNN tarining task that can be scheduled concurrently using Parallel."""
+    """ Mask R-CNN training task that can be scheduled concurrently using Parallel.
+    Parameters
+    ----------
+    net : gluon.HybridBlock
+        Faster R-CNN network.
+    optimizer : gluon.Trainer
+        Optimizer for the training.
+    rpn_cls_loss : gluon.loss
+        RPN box classification loss.
+    rpn_box_loss : gluon.loss
+        RPN box regression loss.
+    rcnn_cls_loss : gluon.loss
+        R-CNN box head classification loss.
+    rcnn_box_loss : gluon.loss
+        R-CNN box head regression loss.
+    rcnn_mask_loss : gluon.loss
+        R-CNN mask head segmentation loss.
+    amp_enabled : bool
+        Whether to enable Automatic Mixed Precision.
+    """
     def __init__(self, net, optimizer, rpn_cls_loss, rpn_box_loss, rcnn_cls_loss, rcnn_box_loss,
                  rcnn_mask_loss, amp_enabled):
         super(ForwardBackwardTask, self).__init__()