[incubator-mxnet] branch master updated: Docs fixes (NDabs, Proposal, MultiProposal) (#15185)

[aaronmarkham]

This is an automated email from the ASF dual-hosted git repository.

aaronmarkham pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new 579c5ab  Docs fixes (NDabs, Proposal, MultiProposal) (#15185)
579c5ab is described below

commit 579c5abb9dd3f4a650db526d31a9ba8fb5920697
Author: Aaron Markham <markh...@amazon.com>
AuthorDate: Wed Jun 12 10:32:48 2019 -0700

    Docs fixes (NDabs, Proposal, MultiProposal) (#15185)
    
    * exclude ndabs docs
    
    * updated docs
---
 docs/api/python/optimization/optimization.md | 3 +++
 src/operator/contrib/multi_proposal-inl.h    | 5 ++---
 src/operator/contrib/proposal-inl.h          | 5 ++---
 3 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/docs/api/python/optimization/optimization.md 
b/docs/api/python/optimization/optimization.md
index 0344812..47f99f3 100644
--- 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
index 7010dad..919e902 100644
--- 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
index 10f1f86..b68822d 100644
--- 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)