【Hackathon2 No.56 57 58 59 Hackathon3 No.23】add doc of paddle.incubate.sparse.add subtract multiply divide is_same_shape

docs/api/paddle/incubate/sparse/Overview_cn.rst

@@ -19,6 +19,7 @@ paddle.incubate.sparse 目录包含飞桨框架支持稀疏数据存储和计算
 
     " :ref:`paddle.incubate.sparse.sparse_coo_tensor <cn_api_paddle_incubate_sparse_coo_tensor>` ", "创建一个 COO 格式的 SparseTensor"
     " :ref:`paddle.incubate.sparse.sparse_csr_tensor <cn_api_paddle_incubate_sparse_csr_tensor>` ", "创建一个 CSR 格式的 SparseTensor"
+    " :ref:`paddle.incubate.sparse.is_same_shape <cn_api_paddle_incubate_sparse_is_same_shape>` ", "判断两个 Tensor 的形状是否相同, 支持 DenseTensor 与 SparseTensor 相互比较"
 
 
 .. _about_sparse_math:
@@ -34,6 +35,10 @@ paddle.incubate.sparse 目录包含飞桨框架支持稀疏数据存储和计算
     " :ref:`paddle.incubate.sparse.asin` ", "arcsine 函数"
     " :ref:`paddle.incubate.sparse.asinh` ", "反双曲正弦函数"
     " :ref:`paddle.incubate.sparse.atan` ", "反双曲正切函数"
+    " :ref:`paddle.incubate.sparse.add <cn_api_paddle_incubate_sparse_add>` ", "逐元素加法"
+    " :ref:`paddle.incubate.sparse.subtract <cn_api_paddle_incubate_sparse_subtract>` ", "逐元素减法"
+    " :ref:`paddle.incubate.sparse.multiply <cn_api_paddle_incubate_sparse_multiply>` ", "逐元素乘法"
+    " :ref:`paddle.incubate.sparse.divide <cn_api_paddle_incubate_sparse_divide>` ", "逐元素除法"
 
 
 .. _about_sparse_nn:

docs/api/paddle/incubate/sparse/add_cn.rst

@@ -0,0 +1,36 @@
+.. _cn_api_paddle_incubate_sparse_add:
+
+add
+-------------------------------
+
+.. py:function:: paddle.incubate.sparse.add(x, y, name=None)
+
+
+
+输入 :attr:`x` 与输入 :attr:`y` 逐元素相加，并将各个位置的输出元素保存到返回结果中。
+
+输入 :attr:`x` 与输入 :attr:`y` 必须为相同形状且为相同稀疏压缩格式（同为 `SparseCooTensor` 或同为 `SparseCsrTensor`），如果同为 `SparseCooTensor` 则 `sparse_dim` 也需要相同。
+
+等式为：
+
+.. math::
+        Out = X + Y
+
+- :math:`X`：多维稀疏 Tensor。
+- :math:`Y`：多维稀疏 Tensor。
+
+参数
+:::::::::
+    - **x** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **y** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+返回
+:::::::::
+多维稀疏 Tensor, 数据类型和压缩格式与 :attr:`x` 相同 。
+
+
+代码示例
+:::::::::
+
+COPY-FROM: paddle.incubate.sparse.add

docs/api/paddle/incubate/sparse/divide_cn.rst

@@ -0,0 +1,36 @@
+.. _cn_api_paddle_incubate_sparse_divide:
+
+divide
+-------------------------------
+
+.. py:function:: paddle.incubate.sparse.divide(x, y, name=None)
+
+
+
+输入 :attr:`x` 与输入 :attr:`y` 逐元素相除，并将各个位置的输出元素保存到返回结果中。
+
+输入 :attr:`x` 与输入 :attr:`y` 必须为相同形状且为相同稀疏压缩格式（同为 `SparseCooTensor` 或同为 `SparseCsrTensor`），如果同为 `SparseCooTensor` 则 `sparse_dim` 也需要相同。
+
+等式为：
+
+.. math::
+        Out = X / Y
+
+- :math:`X`：多维稀疏 Tensor。
+- :math:`Y`：多维稀疏 Tensor。
+
+参数
+:::::::::
+    - **x** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **y** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+返回
+:::::::::
+多维稀疏 Tensor, 数据类型和压缩格式与 :attr:`x` 相同，如果是整数相除则返回数据类型为 `float32`。
+
+
+代码示例
+:::::::::
+
+COPY-FROM: paddle.incubate.sparse.divide

docs/api/paddle/incubate/sparse/is_same_shape_cn.rst

@@ -0,0 +1,26 @@
+.. _cn_api_paddle_incubate_sparse_is_same_shape:
+
+is_same_shape
+-------------------------------
+
+
+
+.. py:function:: paddle.incubate.sparse.is_same_shape(x, y)
+
+返回两个 Tensor 形状比较的结果，判断输入 :attr:`x` 与输入 :attr:`y` 的形状是否相同，支持 DenseTensor、SparseCsrTensor 与 SparseCooTensor 之间任意两种的形状比较。
+
+参数
+:::::::::
+    - **x** (Tensor) - 输入的 Tensor，类型为 DenseTensor、SparseCsrTensor 与 SparseCooTensor 之一。
+    - **y** (Tensor) - 输入的 Tensor，类型为 DenseTensor、SparseCsrTensor 与 SparseCooTensor 之一。
+
+返回
+:::::::::
+
+bool，两个 Tensor 形状比较的结果，相同为 True，不同为 False。
+
+
+代码示例
+:::::::::
+
+COPY-FROM: paddle.incubate.sparse.is_same_shape

docs/api/paddle/incubate/sparse/multiply_cn.rst

@@ -0,0 +1,36 @@
+.. _cn_api_paddle_incubate_sparse_multiply:
+
+multiply
+-------------------------------
+
+.. py:function:: paddle.incubate.sparse.multiply(x, y, name=None)
+
+
+
+输入 :attr:`x` 与输入 :attr:`y` 逐元素相乘，并将各个位置的输出元素保存到返回结果中。
+
+输入 :attr:`x` 与输入 :attr:`y` 必须为相同形状且为相同稀疏压缩格式（同为 `SparseCooTensor` 或同为 `SparseCsrTensor`），如果同为 `SparseCooTensor` 则 `sparse_dim` 也需要相同。
+
+等式为：
+
+.. math::
+        Out = X \odot Y
+
+- :math:`X`：多维稀疏 Tensor。
+- :math:`Y`：多维稀疏 Tensor。
+
+参数
+:::::::::
+    - **x** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **y** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+返回
+:::::::::
+多维稀疏 Tensor, 数据类型和压缩格式与 :attr:`x` 相同。
+
+
+代码示例
+:::::::::
+
+COPY-FROM: paddle.incubate.sparse.multiply

docs/api/paddle/incubate/sparse/subtract_cn.rst

@@ -0,0 +1,36 @@
+.. _cn_api_paddle_incubate_sparse_subtract:
+
+subtract
+-------------------------------
+
+.. py:function:: paddle.incubate.sparse.subtract(x, y, name=None)
+
+
+
+输入 :attr:`x` 与输入 :attr:`y` 逐元素相减，并将各个位置的输出元素保存到返回结果中。
+
+输入 :attr:`x` 与输入 :attr:`y` 必须为相同形状且为相同稀疏压缩格式（同为 `SparseCooTensor` 或同为 `SparseCsrTensor`），如果同为 `SparseCooTensor` 则 `sparse_dim` 也需要相同。
+
+等式为：
+
+.. math::
+        Out = X - Y
+
+- :math:`X`：多维稀疏 Tensor。
+- :math:`Y`：多维稀疏 Tensor。
+
+参数
+:::::::::
+    - **x** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **y** (Tensor) - 输入的 Tensor，数据类型为 float32、float64、int32 或 int64。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+返回
+:::::::::
+多维稀疏 Tensor, 数据类型和压缩格式与 :attr:`x` 相同 。
+
+
+代码示例
+:::::::::
+
+COPY-FROM: paddle.incubate.sparse.subtract