【doc】Add divide, floor_divide, remainder doc (#2437)

doc/fluid/api/tensor/math.rst

@@ -10,7 +10,11 @@ math
     math/addmm.rst
     math/atan.rst
     math/clamp.rst
-    math/div.rst
+    math/divide.rst
+    math/floor_divide.rst
+    math/remainder.rst
+    math/floor_mod.rst
+    math/mod.rst
     math/elementwise_sum.rst
     math/log1p.rst
     math/logsumexp.rst

doc/fluid/api/tensor/math/divide.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_tensor_math_divide:
+
+divide
+------
+
+..  autofunction:: paddle.tensor.math.divide
+    :noindex:
+

doc/fluid/api/tensor/math/floor_divide.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_tensor_math_floor_divide:
+
+floor_divide
+------------
+
+..  autofunction:: paddle.tensor.math.floor_divide
+    :noindex:
+

doc/fluid/api/tensor/math/floor_mod.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_tensor_math_floor_mod:
+
+floor_mod
+---------
+
+..  autofunction:: paddle.tensor.math.floor_mod
+    :noindex:
+

doc/fluid/api/tensor/math/mod.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_tensor_math_mod:
+
+mod
+---
+
+..  autofunction:: paddle.tensor.math.mod
+    :noindex:
+

doc/fluid/api/tensor/math/remainder.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_tensor_math_remainder:
+
+remainder
+---------
+
+..  autofunction:: paddle.tensor.math.remainder
+    :noindex:
+

doc/fluid/api_cn/tensor_cn.rst

@@ -33,7 +33,11 @@ paddle.tensor
     tensor_cn/cumsum_cn.rst
     tensor_cn/diag_cn.rst
     tensor_cn/dist_cn.rst
-    tensor_cn/div_cn.rst
+    tensor_cn/divide_cn.rst
+    tensor_cn/floor_divide_cn.rst
+    tensor_cn/remainder_cn.rst
+    tensor_cn/mod_cn.rst
+    tensor_cn/floor_mod_cn.rst
     tensor_cn/dot_cn.rst
     tensor_cn/einsum_cn.rst
     tensor_cn/elementwise_add_cn.rst

doc/fluid/api_cn/tensor_cn/div_cn.rst

-.. _cn_api_tensor_div:
-
-div
--------------------------------
-
-.. py:function:: paddle.div(x, y, out=None, name=None)
-
-:alias_main: paddle.div
-:alias: paddle.div,paddle.tensor.div,paddle.tensor.math.div
-:update_api: paddle.fluid.layers.elementwise_div
-
-
-
-该OP是逐元素相除算子，输入 ``x`` 与输入 ``y`` 逐元素相除，并将各个位置的输出元素保存到返回结果中。
-
-等式是：
-
-.. math::
-        Out = X / Y
-
-- :math:`X` ：多维Tensor。
-- :math:`Y` ：维度必须小于等于X维度的Tensor。
-
-对于这个运算算子有2种情况：
-        1. :math:`Y` 的 ``shape`` 与 :math:`X` 相同。
-        2. :math:`Y` 的 ``shape`` 是 :math:`X` 的连续子序列。
-
-对于情况2:
-        1. 用 :math:`Y` 匹配 :math:`X` 的形状（shape），其中 ``axis`` 是 :math:`Y` 在 :math:`X` 上的起始维度的位置。
-        2. 如果 ``axis`` 为-1（默认值），则 :math:`axis= rank(X)-rank(Y)` 。
-        3. 考虑到子序列， :math:`Y` 的大小为1的尾部维度将被忽略，例如shape（Y）=（2,1）=>（2）。
-
-例如：
-
-..  code-block:: text
-
-        shape(X) = (2, 3, 4, 5), shape(Y) = (,)
-        shape(X) = (2, 3, 4, 5), shape(Y) = (5,)
-        shape(X) = (2, 3, 4, 5), shape(Y) = (4, 5), with axis=-1(default) or axis=2
-        shape(X) = (2, 3, 4, 5), shape(Y) = (3, 4), with axis=1
-        shape(X) = (2, 3, 4, 5), shape(Y) = (2), with axis=0
-        shape(X) = (2, 3, 4, 5), shape(Y) = (2, 1), with axis=0
-
-参数：
-        - **x** （Variable）- 多维 ``Tensor`` 或 ``LoDTensor`` 。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或  ``int64``。
-        - **y** （Variable）- 多维 ``Tensor`` 或 ``LoDTensor`` 。数据类型为 ``float32`` 、 ``float64`` 、 ``int32`` 或  ``int64``。
-        - **out** （Variable，可选）-  指定存储运算结果的 ``Tensor`` 。如果设置为None或者不设置，将创建新的 ``Tensor`` 存储运算结果，默认值为None。
-        - **name** （str，可选）- 输出的名字。默认值为None。该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` 。
-
-
-返回：        多维 ``Tensor`` 或 ``LoDTensor`` ， 维度和数据类型都与 ``x`` 相同。
-
-返回类型：        Variable
-
-**代码示例 1**
-
-..  code-block:: python
-
-
-    import paddle
-    import paddle.fluid as fluid
-    import numpy as np
-
-    def gen_data():
-        return {
-            "x": np.array([2, 3, 4]).astype('float32'),
-            "y": np.array([1, 5, 2]).astype('float32')
-        }
-
-    x = fluid.data(name="x", shape=[3], dtype='float32')
-    y = fluid.data(name="y", shape=[3], dtype='float32')
-    z = paddle.div(x, y)
-    # z = x / y
-
-    place = fluid.CPUPlace()
-    exe = fluid.Executor(place)
-    z_value = exe.run(feed=gen_data(),
-                        fetch_list=[z.name])
-
-    print(z_value) # [2., 0.6, 2.]
-
-
-**代码示例 2**
-
-.. code-block:: python
-
-    import paddle
-    import paddle.fluid as fluid
-    import numpy as np
-
-    def gen_data():
-        return {
-            "x": np.ones((2, 3, 4, 5)).astype('float32'),
-            "y": np.zeros((4, 5)).astype('float32')
-        }
-
-    x = fluid.data(name="x", shape=[2, 3, 4, 5], dtype='float32')
-    y = fluid.data(name="y", shape=[4, 5], dtype='float32')
-    z = paddle.div(x, y, name='z')
-    # z = x / y
-
-    place = fluid.CPUPlace()
-    exe = fluid.Executor(place)
-
-    z_value = exe.run(feed=gen_data(),
-                        fetch_list=[z.name])
-
-    print(z_value[0])
-    print(z_value[0].shape) # z.shape=[2,3,4,5]
-
-
-**代码示例 3**
-
-..  code-block:: python
-
-    import paddle
-    import paddle.fluid as fluid
-    import numpy as np
-
-    def gen_data():
-        return {
-            "x": np.random.randint(1, 5, size=[2, 3, 4, 5]).astype('float32'),
-            "y": np.random.randint(1, 5, size=[5]).astype('float32')
-        }
-
-    x = fluid.data(name="x", shape=[2,3,4,5], dtype='float32')
-    y = fluid.data(name="y", shape=[5], dtype='float32')
-    output = fluid.data(name="output", shape=[2,3,4,5], dtype="float32")
-    z = paddle.div(x, y, out=output)
-    # z = x / y
-
-    place = fluid.CPUPlace()
-    exe = fluid.Executor(place)
-
-    z_value = exe.run(feed=gen_data(),
-                        fetch_list=[z.name])
-    print(z_value[0])
-    print(z_value[0].shape) # z.shape=[2,3,4,5]
-
-
-**代码示例 4（动态图）**
-
-..  code-block:: python
-
-    import paddle
-    import paddle.fluid as fluid
-    import numpy as np
-
-    with fluid.dygraph.guard(fluid.CPUPlace()):
-        np_x = np.array([2, 3, 4]).astype('float64')
-        np_y = np.array([1, 5, 2]).astype('float64')
-        x = fluid.dygraph.to_variable(np_x)
-        y = fluid.dygraph.to_variable(np_y)
-        z = paddle.div(x, y)
-        np_z = z.numpy()
-        print(np_z)  # [2., 0.6, 2.]
-
-
-
-

doc/fluid/api_cn/tensor_cn/divide_cn.rst

+.. _cn_api_tensor_divide:
+
+divide
+-------------------------------
+
+.. py:function:: paddle.divide(x, y, name=None)
+
+该OP是逐元素相除算子，输入 ``x`` 与输入 ``y`` 逐元素相除，并将各个位置的输出元素保存到返回结果中。
+输入 ``x`` 与输入 ``y`` 必须可以广播为相同形状, 关于广播规则，请参考 :ref:`use_guide_broadcasting`
+
+等式为：
+
+.. 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，可选）- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
+
+
+返回：   多维 Tensor， 数据类型与 ``x`` 相同，维度为广播后的形状。
+
+返回类型：        Tensor
+
+
+**代码示例**
+
+..  code-block:: python
+
+        import paddle
+        import numpy as np
+
+        paddle.disable_static()
+        np_x = np.array([2, 3, 4]).astype('float64')
+        np_y = np.array([1, 5, 2]).astype('float64')
+        x = paddle.to_tensor(np_x)
+        y = paddle.to_tensor(np_y)
+        z = paddle.divide(x, y)
+        print(z.numpy())  # [2., 0.6, 2.]

doc/fluid/api_cn/tensor_cn/floor_divide_cn.rst

+.. _cn_api_tensor_floor_divide:
+
+floor_divide
+-------------------------------
+
+.. py:function:: paddle.floor_divide(x, y, name=None)
+
+该OP是逐元素整除算子，输入 ``x`` 与输入 ``y`` 逐元素整除，并将各个位置的输出元素保存到返回结果中。
+输入 ``x`` 与输入 ``y`` 必须可以广播为相同形状, 关于广播规则，请参考 :ref:`use_guide_broadcasting`
+
+等式为：
+
+.. math::
+        Out = X // Y
+
+- :math:`X` ：多维Tensor。
+- :math:`Y` ：多维Tensor。
+
+参数：
+        - x（Tensor）- 多维Tensor。数据类型为int32或int64。
+        - y（Tensor）- 多维Tensor。数据类型为int32或int64。
+        - name（str，可选）- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
+
+
+返回：   多维 Tensor， 数据类型与 ``x`` 相同，维度为广播后的形状。
+
+返回类型：        Tensor
+
+
+**代码示例**
+
+..  code-block:: python
+
+        import paddle
+        import numpy as np
+
+        paddle.disable_static()
+        np_x = np.array([2, 3, 8, 7])
+        np_y = np.array([1, 5, 3, 3])
+        x = paddle.to_tensor(np_x)
+        y = paddle.to_tensor(np_y)
+        z = paddle.floor_divide(x, y)
+        print(z.numpy())  # [2, 0, 2, 2]
\ No newline at end of file

doc/fluid/api_cn/tensor_cn/floor_mod_cn.rst

+.. _cn_api_tensor_cn_floor_mod:
+
+floor_mod
+-------------------------------
+:doc_source: paddle.tensor.remainder
+
+

doc/fluid/api_cn/tensor_cn/mod_cn.rst

+.. _cn_api_tensor_cn_mod:
+
+mod
+-------------------------------
+:doc_source: paddle.tensor.remainder
+
+

doc/fluid/api_cn/tensor_cn/remainder_cn.rst

+.. _cn_api_tensor_remainder:
+
+remainder
+-------------------------------
+
+.. py:function:: paddle.remainder(x, y, name=None)
+
+该OP是逐元素取模算子，输入 ``x`` 与输入 ``y`` 逐元素取模，并将各个位置的输出元素保存到返回结果中。
+输入 ``x`` 与输入 ``y`` 必须可以广播为相同形状, 关于广播规则，请参考 :ref:`use_guide_broadcasting`
+
+等式为：
+
+.. 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，可选）- 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
+
+
+返回：   多维 Tensor， 数据类型与 ``x`` 相同，维度为广播后的形状。
+
+返回类型：        Tensor
+
+
+**代码示例**
+
+..  code-block:: python
+
+        import paddle
+        import numpy as np
+        paddle.disable_static()
+        np_x = np.array([2, 3, 8, 7])
+        np_y = np.array([1, 5, 3, 3])
+        x = paddle.to_tensor(np_x)
+        y = paddle.to_tensor(np_y)
+        z = paddle.remainder(x, y)
+        print(z.numpy())  # [0, 3, 2, 1]
\ No newline at end of file