You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by ha...@apache.org on 2018/05/10 20:35:51 UTC

[incubator-mxnet] branch master updated: fix docs for new broadcast operators (#10887)

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

haibin 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 35fb9ea  fix docs for new broadcast operators (#10887)
35fb9ea is described below

commit 35fb9ea1093bd0006a396b5e493e5949b66ca33e
Author: Hao Jin <ha...@users.noreply.github.com>
AuthorDate: Thu May 10 13:35:45 2018 -0700

    fix docs for new broadcast operators (#10887)
---
 docs/api/python/ndarray/sparse.md                         |  2 ++
 docs/api/python/symbol/sparse.md                          |  4 ++++
 src/operator/tensor/elemwise_binary_broadcast_op_basic.cc | 10 ++++++++++
 3 files changed, 16 insertions(+)

diff --git a/docs/api/python/ndarray/sparse.md b/docs/api/python/ndarray/sparse.md
index 1f67e82..28fb386 100644
--- a/docs/api/python/ndarray/sparse.md
+++ b/docs/api/python/ndarray/sparse.md
@@ -386,6 +386,8 @@ We summarize the interface for each class in the following sections.
     elemwise_add
     elemwise_sub
     elemwise_mul
+    broadcast_add
+    broadcast_sub
     broadcast_mul
     broadcast_div
     negative
diff --git a/docs/api/python/symbol/sparse.md b/docs/api/python/symbol/sparse.md
index a44ff15..c4c8e92 100644
--- a/docs/api/python/symbol/sparse.md
+++ b/docs/api/python/symbol/sparse.md
@@ -97,6 +97,10 @@ In the rest of this document, we list sparse related routines provided by the
     elemwise_add
     elemwise_sub
     elemwise_mul
+    broadcast_add
+    broadcast_sub
+    broadcast_mul
+    broadcast_div
     negative
     dot
     add_n
diff --git a/src/operator/tensor/elemwise_binary_broadcast_op_basic.cc b/src/operator/tensor/elemwise_binary_broadcast_op_basic.cc
index 78b2d45..61bc94e 100644
--- a/src/operator/tensor/elemwise_binary_broadcast_op_basic.cc
+++ b/src/operator/tensor/elemwise_binary_broadcast_op_basic.cc
@@ -29,6 +29,8 @@
 namespace mxnet {
 namespace op {
 MXNET_OPERATOR_REGISTER_BINARY_BROADCAST(broadcast_add)
+MXNET_ADD_SPARSE_OP_ALIAS(broadcast_add)
+MXNET_ADD_SPARSE_OP_ALIAS(broadcast_plus)
 .add_alias("broadcast_plus")
 .describe(R"code(Returns element-wise sum of the input arrays with broadcasting.
 
@@ -49,6 +51,7 @@ Example::
                            [ 2.,  2.,  2.]]
 
 Supported sparse operations:
+
    broadcast_add(csr, dense(1D)) = dense
    broadcast_add(dense(1D), csr) = dense
 
@@ -74,6 +77,8 @@ NNVM_REGISTER_OP(_backward_broadcast_add)
                                                                 mshadow_op::identity>);
 
 MXNET_OPERATOR_REGISTER_BINARY_BROADCAST(broadcast_sub)
+MXNET_ADD_SPARSE_OP_ALIAS(broadcast_sub)
+MXNET_ADD_SPARSE_OP_ALIAS(broadcast_minus)
 .add_alias("broadcast_minus")
 .describe(R"code(Returns element-wise difference of the input arrays with broadcasting.
 
@@ -94,6 +99,7 @@ Example::
                             [ 0.,  0.,  0.]]
 
 Supported sparse operations:
+
    broadcast_sub/minus(csr, dense(1D)) = dense
    broadcast_sub/minus(dense(1D), csr) = dense
 
@@ -119,6 +125,7 @@ NNVM_REGISTER_OP(_backward_broadcast_sub)
                                                                 mshadow_op::negation>);
 
 MXNET_OPERATOR_REGISTER_BINARY_BROADCAST(broadcast_mul)
+MXNET_ADD_SPARSE_OP_ALIAS(broadcast_mul)
 .describe(R"code(Returns element-wise product of the input arrays with broadcasting.
 
 Example::
@@ -133,6 +140,7 @@ Example::
                           [ 1.,  1.,  1.]]
 
 Supported sparse operations:
+
    broadcast_mul(csr, dense(1D)) = csr (CPU only)
 
 )code" ADD_FILELINE)
@@ -158,6 +166,7 @@ NNVM_REGISTER_OP(_backward_broadcast_mul)
                                                               mshadow_op::left>);
 
 MXNET_OPERATOR_REGISTER_BINARY_BROADCAST(broadcast_div)
+MXNET_ADD_SPARSE_OP_ALIAS(broadcast_div)
 .describe(R"code(Returns element-wise division of the input arrays with broadcasting.
 
 Example::
@@ -172,6 +181,7 @@ Example::
                           [ 2.,  2.,  2.]]
 
 Supported sparse operations:
+
    broadcast_div(csr, dense(1D)) = csr (CPU only)
 
 )code" ADD_FILELINE)

-- 
To stop receiving notification emails like this one, please contact
haibin@apache.org.