Docs fixes (NDabs, Proposal, MultiProposal) (#15185)

* exclude ndabs docs * updated docs
apache · Jun 12, 2019 · 579c5ab · 579c5ab
1 parent 2e20094
commit 579c5ab
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/docs/api/python/optimization/optimization.md b/docs/api/python/optimization/optimization.md
@@ -171,8 +171,11 @@ for examples.
 ```eval_rst
 .. automodule:: mxnet.optimizer
     :members:
+    :exclude-members: NDabs
+
 .. automodule:: mxnet.lr_scheduler
     :members:
+
 .. automodule:: mxnet.initializer
     :members:
 ```

diff --git a/src/operator/contrib/multi_proposal-inl.h b/src/operator/contrib/multi_proposal-inl.h
@@ -64,10 +64,9 @@ struct MultiProposalParam : public dmlc::Parameter<MultiProposalParam> {
   DMLC_DECLARE_PARAMETER(MultiProposalParam) {
     float tmp[] = {0, 0, 0, 0};
     DMLC_DECLARE_FIELD(rpn_pre_nms_top_n).set_default(6000)
-    .describe("Number of top scoring boxes to keep after applying NMS to RPN proposals");
+    .describe("Number of top scoring boxes to keep before applying NMS to RPN proposals");
     DMLC_DECLARE_FIELD(rpn_post_nms_top_n).set_default(300)
-    .describe("Overlap threshold used for non-maximum"
-              "suppresion(suppress boxes with IoU >= this threshold");
+    .describe("Number of top scoring boxes to keep after applying NMS to RPN proposals");
     DMLC_DECLARE_FIELD(threshold).set_default(0.7)
     .describe("NMS value, below which to suppress.");
     DMLC_DECLARE_FIELD(rpn_min_size).set_default(16)

diff --git a/src/operator/contrib/proposal-inl.h b/src/operator/contrib/proposal-inl.h
@@ -62,10 +62,9 @@ struct ProposalParam : public dmlc::Parameter<ProposalParam> {
   DMLC_DECLARE_PARAMETER(ProposalParam) {
     float tmp[] = {0, 0, 0, 0};
     DMLC_DECLARE_FIELD(rpn_pre_nms_top_n).set_default(6000)
-    .describe("Number of top scoring boxes to keep after applying NMS to RPN proposals");
+    .describe("Number of top scoring boxes to keep before applying NMS to RPN proposals");
     DMLC_DECLARE_FIELD(rpn_post_nms_top_n).set_default(300)
-    .describe("Overlap threshold used for non-maximum"
-              "suppresion(suppress boxes with IoU >= this threshold");
+    .describe("Number of top scoring boxes to keep after applying NMS to RPN proposals");
     DMLC_DECLARE_FIELD(threshold).set_default(0.7)
     .describe("NMS value, below which to suppress.");
     DMLC_DECLARE_FIELD(rpn_min_size).set_default(16)