From 09f0c271d724f4d7653c097e1dd26cfea4d775a8 Mon Sep 17 00:00:00 2001 From: Tao Luo Date: Fri, 10 Dec 2021 14:29:22 +0800 Subject: [PATCH] refine gcd & lcm docs --- docs/api/paddle/gcd_cn.rst | 37 +++++------------------------------- docs/api/paddle/lcm_cn.rst | 39 ++++++-------------------------------- 2 files changed, 11 insertions(+), 65 deletions(-) diff --git a/docs/api/paddle/gcd_cn.rst b/docs/api/paddle/gcd_cn.rst index bfd9a10f3b0..ce652fc0167 100644 --- a/docs/api/paddle/gcd_cn.rst +++ b/docs/api/paddle/gcd_cn.rst @@ -10,13 +10,14 @@ gcd .. note:: gcd(0,0)=0, gcd(0, y)=|y| + 如果x和y的shape不一致，会对两个shape进行广播操作，得到一致的shape（并作为输出结果的shape）， + 请参见 :ref:`cn_user_guide_broadcasting` 。 参数 ::::::::: -- **x, y** (Tensor) - 输入的Tensor，数据类型为：int8，int16，int32，int64，uint8。 - 如果x和y的shape不一致，会对两个shape进行广播操作，得到一致的shape（并作为输出结果的shape）， - 请参见 :ref:`cn_user_guide_broadcasting` 。 +- **x** (Tensor) - 输入的Tensor，数据类型为：int8，int16，int32，int64，uint8。 +- **y** (Tensor) - 输入的Tensor，数据类型为：int8，int16，int32，int64，uint8。 - **name** (str，可选） - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 返回 @@ -27,32 +28,4 @@ gcd 代码示例 ::::::::: -.. code-block:: python - - import paddle - import numpy as np - - x1 = paddle.to_tensor(12) - x2 = paddle.to_tensor(20) - paddle.gcd(x1, x2) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [4]) - - x3 = paddle.to_tensor(np.arange(6)) - paddle.gcd(x3, x2) - # Tensor(shape=[6], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [20, 1 , 2 , 1 , 4 , 5]) - - x4 = paddle.to_tensor(0) - paddle.gcd(x4, x2) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [20]) - - paddle.gcd(x4, x4) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [0]) - - x5 = paddle.to_tensor(-20) - paddle.gcd(x1, x5) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [4]) +COPY-FROM: paddle.gcd diff --git a/docs/api/paddle/lcm_cn.rst b/docs/api/paddle/lcm_cn.rst index cb1abc012d7..69b65d4e3c9 100644 --- a/docs/api/paddle/lcm_cn.rst +++ b/docs/api/paddle/lcm_cn.rst @@ -5,18 +5,19 @@ lcm .. py:function:: paddle.lcm(x, y, name=None) -计算两个输入的按元素绝对值的最大公约数，输入必须是整型。 +计算两个输入的按元素绝对值的最小公倍数，输入必须是整型。 .. note:: lcm(0,0)=0, lcm(0, y)=0 + 如果x和y的shape不一致，会对两个shape进行广播操作，得到一致的shape（并作为输出结果的shape）， + 请参见 :ref:`cn_user_guide_broadcasting` 。 参数 ::::::::: -- **x, y** (Tensor) - 输入的Tensor，数据类型为：int8，int16，int32，int64，uint8。 - 如果x和y的shape不一致，会对两个shape进行广播操作，得到一致的shape（并作为输出结果的shape）， - 请参见 :ref:`cn_user_guide_broadcasting` 。 +- **x** (Tensor) - 输入的Tensor，数据类型为：int8，int16，int32，int64，uint8。 +- **y** (Tensor) - 输入的Tensor，数据类型为：int8，int16，int32，int64，uint8。 - **name** (str，可选） - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。 返回 @@ -27,32 +28,4 @@ lcm 代码示例 ::::::::: -.. code-block:: python - - import paddle - import numpy as np - - x1 = paddle.to_tensor(12) - x2 = paddle.to_tensor(20) - paddle.lcm(x1, x2) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [60]) - - x3 = paddle.to_tensor(np.arange(6)) - paddle.lcm(x3, x2) - # Tensor(shape=[6], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [0, 20, 20, 60, 20, 20]) - - x4 = paddle.to_tensor(0) - paddle.lcm(x4, x2) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [0]) - - paddle.lcm(x4, x4) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [0]) - - x5 = paddle.to_tensor(-20) - paddle.lcm(x1, x5) - # Tensor(shape=[1], dtype=int64, place=CUDAPlace(0), stop_gradient=True, - # [60]) +COPY-FROM: paddle.lcm