From 9abc233a36930267a50aa58583aed04e5ebaa4cf Mon Sep 17 00:00:00 2001 From: Keywennn Date: Fri, 4 Apr 2025 21:41:47 +0800 Subject: [PATCH 1/4] [Docathon][Add Inplace CN Doc No.9] --- docs/api/paddle/Overview_cn.rst | 3 ++- docs/api/paddle/cauchy__cn.rst | 28 ++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/api/paddle/cauchy__cn.rst diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 4ffd46ddb5e..5bff62dc6c7 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -200,7 +200,8 @@ tensor 数学操作原位（inplace）版本 " :ref:`paddle.add_ ` ", "Inplace 版本的 add API，对输入 x 采用 Inplace 策略" " :ref:`paddle.addmm_ ` ", "Inplace 版本的 addmm API，对输入 input 采用 Inplace 策略" " :ref:`paddle.put_along_axis_ ` ", "Inplace 版本的 put_along_axis API，对输入 x 采用 Inplace 策略" - " :ref:`paddle.ceil_ ` ", "Inplace 版本的 ceil API，对输入 x 采用 Inplace 策略" + " :ref:`paddle.cauchy_ ` ", "Inplace 版本的 ceil API，对输入 x 采用 Inplace 策略" + " :ref:`paddle.ceil_ ` ", "Inplace 版本的 cauchy API，对输入 x 采用 Inplace 策略" " :ref:`paddle.clip_ ` ", "Inplace 版本的 clip API，对输入 x 采用 Inplace 策略" " :ref:`paddle.copysign_ ` ", "Inplace 版本的 copysign API，对输入 x 采用 Inplace 策略" " :ref:`paddle.cumprod_ ` ", "Inplace 版本的 cumprod API，对输入 x 采用 Inplace 策略" diff --git a/docs/api/paddle/cauchy__cn.rst b/docs/api/paddle/cauchy__cn.rst new file mode 100644 index 00000000000..ce7d5d74ea2 --- /dev/null +++ b/docs/api/paddle/cauchy__cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_paddle_cauchy_: + +cauchy\_ +------------------------------- + +.. py:function:: paddle.cauchy_(x, loc=0, scale=1, name=None) +该函数将输入 Tensor 填充为从柯西分布（Cauchy distribution）中采样的随机数。 + +参数 +:::::::::::: + + - **x** (Tensor) - 待填充的目标张量，数据类型必须为 float32 或 float64。 + - **loc** (scalar,可选) - 柯西分布的峰值位置，数据类型为 float32 或 float64，默认值为 0。 + - **scale** (scalar,可选) - 柯西分布的半高全宽（HWHM），必须为正数，数据类型为 float32 或 float64，默认值为 1。 + - **name** (str|None,可选) - 操作的名称，一般无需设置，默认值为 None。 + +返回 +:::::::::::: +填充了柯西分布随机数的输入张量 + +返回类型 +:::::::::::: +Tensor + +代码示例 +:::::::::::: + +COPY-FROM: paddle.cauchy_ From 2e106082a9ca3ad0828046b8ff943c55fd2969c8 Mon Sep 17 00:00:00 2001 From: Keywennn Date: Fri, 4 Apr 2025 22:44:48 +0800 Subject: [PATCH 2/4] fix: overview.rst --- docs/api/paddle/Overview_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 5bff62dc6c7..18c4dc71c16 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -200,8 +200,8 @@ tensor 数学操作原位（inplace）版本 " :ref:`paddle.add_ ` ", "Inplace 版本的 add API，对输入 x 采用 Inplace 策略" " :ref:`paddle.addmm_ ` ", "Inplace 版本的 addmm API，对输入 input 采用 Inplace 策略" " :ref:`paddle.put_along_axis_ ` ", "Inplace 版本的 put_along_axis API，对输入 x 采用 Inplace 策略" - " :ref:`paddle.cauchy_ ` ", "Inplace 版本的 ceil API，对输入 x 采用 Inplace 策略" - " :ref:`paddle.ceil_ ` ", "Inplace 版本的 cauchy API，对输入 x 采用 Inplace 策略" + " :ref:`paddle.cauchy_ ` ", "Inplace 版本的 cauchy API，对输入 x 采用 Inplace 策略" + " :ref:`paddle.ceil_ ` ", "Inplace 版本的 ceil API，对输入 x 采用 Inplace 策略" " :ref:`paddle.clip_ ` ", "Inplace 版本的 clip API，对输入 x 采用 Inplace 策略" " :ref:`paddle.copysign_ ` ", "Inplace 版本的 copysign API，对输入 x 采用 Inplace 策略" " :ref:`paddle.cumprod_ ` ", "Inplace 版本的 cumprod API，对输入 x 采用 Inplace 策略" From 13a61ed7f7267e1d719b64c305752484f574fb7d Mon Sep 17 00:00:00 2001 From: Keywennn Date: Fri, 4 Apr 2025 23:27:55 +0800 Subject: [PATCH 3/4] [Docathon][Add Inplace CN Doc No.3-4] --- docs/api/paddle/Overview_cn.rst | 2 ++ docs/api/paddle/bitwise_and__cn.rst | 10 ++++++++++ docs/api/paddle/bitwise_invert__cn.rst | 10 ++++++++++ 3 files changed, 22 insertions(+) create mode 100644 docs/api/paddle/bitwise_and__cn.rst create mode 100644 docs/api/paddle/bitwise_invert__cn.rst diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 18c4dc71c16..cfbc2ea0a08 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -192,6 +192,8 @@ tensor 数学操作原位（inplace）版本 " :ref:`paddle.remainder_ ` ", "Inplace 版本的 remainder API，对输入 x 采用 Inplace 策略" " :ref:`paddle.abs_ ` ", "Inplace 版本的 abs API，对输入 x 采用 Inplace 策略" " :ref:`paddle.baddbmm_ ` ", "Inplace 版本的 baddbmm API，对输入 input 采用 Inplace 策略" + " :ref:`paddle.bitwise_and_ ` ", "Inplace 版本的 bitwise_and API，对输入 x 采用 Inplace 策略" + " :ref:`paddle.bitwise_invert_ ` ", "Inplace 版本的 bitwise_invert API，对输入 x 采用 Inplace 策略" " :ref:`paddle.bernoulli_ ` ", "Inplace 版本的 bernoulli API，对输入 x 采用 Inplace 策略" " :ref:`paddle.bitwise_xor_ ` ", "Inplace 版本的 bitwise_xor API，对输入 x 采用 Inplace 策略" " :ref:`paddle.tanh_ ` ", "Inplace 版本的 tanh API，对输入 x 采用 Inplace 策略" diff --git a/docs/api/paddle/bitwise_and__cn.rst b/docs/api/paddle/bitwise_and__cn.rst new file mode 100644 index 00000000000..c28f26ddba8 --- /dev/null +++ b/docs/api/paddle/bitwise_and__cn.rst @@ -0,0 +1,10 @@ +.. _cn_api_paddle_bitwise_and_: + +bitwise\_and\_ +------------------------------- + +.. py:function:: paddle.bitwise_and_(x, y, name=None) +Inplace 版本的 :ref:`cn_api_paddle_bitwise_and` API，对输入 `x` 采用 Inplace 策略。 +更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 + +.. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3 diff --git a/docs/api/paddle/bitwise_invert__cn.rst b/docs/api/paddle/bitwise_invert__cn.rst new file mode 100644 index 00000000000..ebe7096946f --- /dev/null +++ b/docs/api/paddle/bitwise_invert__cn.rst @@ -0,0 +1,10 @@ +.. _cn_api_paddle_bitwise_invert_: + +bitwise\_invert\_ +------------------------------- + +.. py:function:: paddle.bitwise_invert_(x, name=None) +Inplace 版本的 :ref:`cn_api_paddle_bitwise_invert` API，对输入 `x` 采用 Inplace 策略。 +更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 + +.. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3 From 324f54f127a423e78a96ff2096710e8b05769eb2 Mon Sep 17 00:00:00 2001 From: Keywennn Date: Wed, 16 Apr 2025 21:24:24 +0800 Subject: [PATCH 4/4] fix docs --- docs/api/paddle/bitwise_and__cn.rst | 1 + docs/api/paddle/bitwise_invert__cn.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/api/paddle/bitwise_and__cn.rst b/docs/api/paddle/bitwise_and__cn.rst index c28f26ddba8..862e9ddb34d 100644 --- a/docs/api/paddle/bitwise_and__cn.rst +++ b/docs/api/paddle/bitwise_and__cn.rst @@ -5,6 +5,7 @@ bitwise\_and\_ .. py:function:: paddle.bitwise_and_(x, y, name=None) Inplace 版本的 :ref:`cn_api_paddle_bitwise_and` API，对输入 `x` 采用 Inplace 策略。 + 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 .. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3 diff --git a/docs/api/paddle/bitwise_invert__cn.rst b/docs/api/paddle/bitwise_invert__cn.rst index ebe7096946f..62d852d6b6b 100644 --- a/docs/api/paddle/bitwise_invert__cn.rst +++ b/docs/api/paddle/bitwise_invert__cn.rst @@ -5,6 +5,7 @@ bitwise\_invert\_ .. py:function:: paddle.bitwise_invert_(x, name=None) Inplace 版本的 :ref:`cn_api_paddle_bitwise_invert` API，对输入 `x` 采用 Inplace 策略。 + 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 .. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3