From 3a8af1da888f4756298ed375c4ecf64a2e331916 Mon Sep 17 00:00:00 2001 From: algorithm1832 <737634857@qq.com> Date: Tue, 23 Dec 2025 15:41:23 +0800 Subject: [PATCH 1/2] add arg out and alias note for diag --- docs/api/paddle/diag_cn.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/api/paddle/diag_cn.rst b/docs/api/paddle/diag_cn.rst index f03105b580f..40f9e8d7bcc 100644 --- a/docs/api/paddle/diag_cn.rst +++ b/docs/api/paddle/diag_cn.rst @@ -3,7 +3,7 @@ diag ------------------------------- -.. py:function:: paddle.diag(x, offset=0, padding_value=0, name=None) +.. py:function:: paddle.diag(x, offset=0, padding_value=0, name=None, *, out=None) 如果 ``x`` 是向量（1-D Tensor），则返回带有 ``x`` 元素作为对角线的 2-D 方阵。 @@ -16,12 +16,17 @@ diag - 如果 ``offset`` > 0，则为上对角线。 - 如果 ``offset`` < 0，则为下对角线。 +.. note:: + + 别名支持: 参数名 ``input`` 可替代 ``x``， ``diagonal`` 可替代 ``offset`` + 参数 ::::::::: - **x** (Tensor) - 输入的 `Tensor`。它的形状可以是一维或二维。其数据类型应为 float16、float32、float64、int32、int64、complex64、complex128。 - **offset** (int，可选) - 对角线偏移量。正值表示上对角线，0 表示主对角线，负值表示下对角线。默认值为 0。 - **padding_value** (int|float，可选) -使用此值来填充指定对角线以外的区域。仅在输入为一维 Tensor 时生效。默认值为 0。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + - **out** (Tensor，可选)- 输出的结果。该参数为仅关键字参数，默认值为 None。 返回 ::::::::: From 8fcb1aeac7048bba905f3c0c1a3a11548a15d2f9 Mon Sep 17 00:00:00 2001 From: algorithm1832 <737634857@qq.com> Date: Sat, 27 Dec 2025 22:52:05 +0800 Subject: [PATCH 2/2] format enhancement --- docs/api/paddle/diag_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/diag_cn.rst b/docs/api/paddle/diag_cn.rst index 40f9e8d7bcc..1fdcd625d7a 100644 --- a/docs/api/paddle/diag_cn.rst +++ b/docs/api/paddle/diag_cn.rst @@ -18,7 +18,7 @@ diag .. note:: - 别名支持: 参数名 ``input`` 可替代 ``x``， ``diagonal`` 可替代 ``offset`` + 别名支持：参数名 ``input`` 可替代 ``x`` ， ``diagonal`` 可替代 ``offset`` 参数 ::::::::: @@ -26,7 +26,7 @@ diag - **offset** (int，可选) - 对角线偏移量。正值表示上对角线，0 表示主对角线，负值表示下对角线。默认值为 0。 - **padding_value** (int|float，可选) -使用此值来填充指定对角线以外的区域。仅在输入为一维 Tensor 时生效。默认值为 0。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - - **out** (Tensor，可选)- 输出的结果。该参数为仅关键字参数，默认值为 None。 + - **out** (Tensor，可选) - 输出的结果。该参数为仅关键字参数，默认值为 None。 返回 :::::::::