From c5a19cd88858d4034c1f2a55b0ee7205d40a5cbf Mon Sep 17 00:00:00 2001 From: zhouwei25 Date: Thu, 4 Jun 2026 10:21:05 +0000 Subject: [PATCH 1/3] [API Compatibility] addmv/addr/erf_/expm1_/fix/histc/select_scatter/sgn/signbit/slice_scatter/square_/take/tensordot/tril_indices/triu_indices/trunc/vander/logaddexp/logspace/moveaxis/nan_to_num/nanmean/nansum Edit By AI Agent Co-Authored-By: Claude Opus 4.6 --- docs/api/paddle/addmv_cn.rst | 32 +++++++++++++++++++++++++++ docs/api/paddle/addr_cn.rst | 32 +++++++++++++++++++++++++++ docs/api/paddle/erf__cn.rst | 4 ++++ docs/api/paddle/expm1__cn.rst | 4 ++++ docs/api/paddle/fix_cn.rst | 26 ++++++++++++++++++++++ docs/api/paddle/histc_cn.rst | 31 ++++++++++++++++++++++++++ docs/api/paddle/logaddexp_cn.rst | 10 ++++++--- docs/api/paddle/logspace_cn.rst | 12 +++++++--- docs/api/paddle/moveaxis_cn.rst | 2 +- docs/api/paddle/nan_to_num_cn.rst | 8 +++++-- docs/api/paddle/nanmean_cn.rst | 11 ++++++--- docs/api/paddle/nansum_cn.rst | 15 ++++++++++--- docs/api/paddle/select_scatter_cn.rst | 4 ++-- docs/api/paddle/sgn_cn.rst | 8 +++++-- docs/api/paddle/signbit_cn.rst | 8 +++++-- docs/api/paddle/slice_scatter_cn.rst | 15 ++++++------- docs/api/paddle/square__cn.rst | 4 ++++ docs/api/paddle/take_cn.rst | 2 +- docs/api/paddle/tensordot_cn.rst | 6 ++--- docs/api/paddle/tril_indices_cn.rst | 6 ++++- docs/api/paddle/triu_indices_cn.rst | 6 ++++- docs/api/paddle/trunc_cn.rst | 8 +++++-- docs/api/paddle/vander_cn.rst | 2 +- 23 files changed, 218 insertions(+), 38 deletions(-) create mode 100644 docs/api/paddle/addmv_cn.rst create mode 100644 docs/api/paddle/addr_cn.rst create mode 100644 docs/api/paddle/fix_cn.rst create mode 100644 docs/api/paddle/histc_cn.rst diff --git a/docs/api/paddle/addmv_cn.rst b/docs/api/paddle/addmv_cn.rst new file mode 100644 index 00000000000..924d005eb91 --- /dev/null +++ b/docs/api/paddle/addmv_cn.rst @@ -0,0 +1,32 @@ +.. _cn_api_paddle_addmv: + +addmv +------------------------------- + +.. py:function:: paddle.addmv(input, mat, vec, beta=1, alpha=1, name=None, *, out=None) + +执行矩阵 ``mat`` 和向量 ``vec`` 的矩阵-向量乘法，并将其加到输入 Tensor 上。 + +公式为：out = beta * input + alpha * (mat @ vec) + +参数 +::::::::: + - **input** (Tensor) - 待加的输入 Tensor。 + - **mat** (Tensor) - 待乘的矩阵。 + - **vec** (Tensor) - 待乘的向量。 + - **beta** (float，可选) - input 的乘数，默认值为 1。 + - **alpha** (float，可选) - mat @ vec 的乘数，默认值为 1。 + - **name** (str，可选) - 操作名称，默认值为 None。 + +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + +返回 +::::::::: +Tensor：计算结果 Tensor。 + +代码示例 +::::::::: + +COPY-FROM: paddle.addmv diff --git a/docs/api/paddle/addr_cn.rst b/docs/api/paddle/addr_cn.rst new file mode 100644 index 00000000000..e7d781d63ec --- /dev/null +++ b/docs/api/paddle/addr_cn.rst @@ -0,0 +1,32 @@ +.. _cn_api_paddle_addr: + +addr +------------------------------- + +.. py:function:: paddle.addr(input, vec1, vec2, beta=1, alpha=1, name=None, *, out=None) + +执行向量 ``vec1`` 和向量 ``vec2`` 的外积，并将其加到输入矩阵上。 + +公式为：out = beta * input + alpha * (vec1 outer vec2) + +参数 +::::::::: + - **input** (Tensor) - 待加的输入 Tensor。 + - **vec1** (Tensor) - 第一个向量。 + - **vec2** (Tensor) - 第二个向量。 + - **beta** (float，可选) - input 的乘数，默认值为 1。 + - **alpha** (float，可选) - 外积的乘数，默认值为 1。 + - **name** (str，可选) - 操作名称，默认值为 None。 + +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + +返回 +::::::::: +Tensor：计算结果 Tensor。 + +代码示例 +::::::::: + +COPY-FROM: paddle.addr diff --git a/docs/api/paddle/erf__cn.rst b/docs/api/paddle/erf__cn.rst index 6e6a56c459f..d5278ceb2d7 100644 --- a/docs/api/paddle/erf__cn.rst +++ b/docs/api/paddle/erf__cn.rst @@ -10,3 +10,7 @@ Inplace 版本的 :ref:`cn_api_paddle_erf` 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 + +.. note:: + + 别名支持：参数名 ``input`` 可替代 ``x``，如 ``erf_(input=tensor_x)`` 等价于 ``erf_(x=tensor_x)``。 diff --git a/docs/api/paddle/expm1__cn.rst b/docs/api/paddle/expm1__cn.rst index c33d1b873f5..6aca66bb753 100644 --- a/docs/api/paddle/expm1__cn.rst +++ b/docs/api/paddle/expm1__cn.rst @@ -10,3 +10,7 @@ Inplace 版本的 :ref:`cn_api_paddle_expm1` API，对输入 ``x`` 采用 Inplac 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 .. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3 + +.. note:: + + 别名支持：参数名 ``input`` 可替代 ``x``，如 ``expm1_(input=tensor_x)`` 等价于 ``expm1_(x=tensor_x)``。 diff --git a/docs/api/paddle/fix_cn.rst b/docs/api/paddle/fix_cn.rst new file mode 100644 index 00000000000..1636c9f7bb8 --- /dev/null +++ b/docs/api/paddle/fix_cn.rst @@ -0,0 +1,26 @@ +.. _cn_api_paddle_fix: + +fix +------------------------------- + +.. py:function:: paddle.fix(input, name=None, *, out=None) + +返回输入 Tensor 的截断整数值。与 ``paddle.trunc`` 功能相同。 + +参数 +::::::::: + - **input** (Tensor) - 输入 Tensor，数据类型为 int32、int64、float32、float64。别名 ``x``。 + - **name** (str，可选) - 操作名称，默认值为 None。 + +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + +返回 +::::::::: +Tensor：截断后的 Tensor。 + +代码示例 +::::::::: + +COPY-FROM: paddle.fix diff --git a/docs/api/paddle/histc_cn.rst b/docs/api/paddle/histc_cn.rst new file mode 100644 index 00000000000..95cc8cdc54a --- /dev/null +++ b/docs/api/paddle/histc_cn.rst @@ -0,0 +1,31 @@ +.. _cn_api_paddle_histc: + +histc +------------------------------- + +.. py:function:: paddle.histc(input, bins=100, min=0.0, max=0.0, name=None, *, out=None) + +计算 Tensor 的直方图。 + +元素被分配到 min 和 max 之间的等宽区间中。如果 min 和 max 都为零，则使用数据的最小值和最大值。 + +参数 +::::::::: + - **input** (Tensor) - 输入 Tensor。 + - **bins** (int，可选) - 直方图区间数，默认值为 100。 + - **min** (float，可选) - 范围的下端（包含），默认值为 0.0。 + - **max** (float，可选) - 范围的上端（包含），默认值为 0.0。 + - **name** (str，可选) - 操作名称，默认值为 None。 + +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + +返回 +::::::::: +Tensor：直方图 Tensor，数据类型为 float32。 + +代码示例 +::::::::: + +COPY-FROM: paddle.histc diff --git a/docs/api/paddle/logaddexp_cn.rst b/docs/api/paddle/logaddexp_cn.rst index f40785948bc..3f98ee6af78 100755 --- a/docs/api/paddle/logaddexp_cn.rst +++ b/docs/api/paddle/logaddexp_cn.rst @@ -3,7 +3,7 @@ logaddexp ------------------------------- -.. py:function:: paddle.logaddexp(x, y, name=None) +.. py:function:: paddle.logaddexp(x, y, name=None, *, out=None) 计算 ``x`` 和 ``y`` 的以 e 为底的指数的和的自然对数。计算公式如下： @@ -12,10 +12,14 @@ logaddexp 参数 :::::::::: - - **x** (Tensor) - 输入的 Tensor，数据类型为：int32，int64，bfloat16，float16，float32、float64。 - - **y** (Tensor) - 输入的 Tensor，数据类型为：int32，int64，bfloat16，float16，float32、float64。 + - **x** (Tensor) - 输入的 Tensor，数据类型为：int32，int64，bfloat16，float16，float32、float64。别名 ``input``。 + - **y** (Tensor) - 输入的 Tensor，数据类型为：int32，int64，bfloat16，float16，float32、float64。别名 ``other``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 :::::::::: ``Tensor``，根据上述公式计算的 logaddexp(x) 结果 diff --git a/docs/api/paddle/logspace_cn.rst b/docs/api/paddle/logspace_cn.rst index 280007b0454..be5de1a53ea 100644 --- a/docs/api/paddle/logspace_cn.rst +++ b/docs/api/paddle/logspace_cn.rst @@ -3,7 +3,7 @@ logspace ------------------------------- -.. py:function:: paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None) +.. py:function:: paddle.logspace(start, stop, num, base=10.0, dtype=None, name=None, *, out=None, device=None, requires_grad=False) 返回一个 Tensor，Tensor 的值为在区间 :math:`[base^{start}, base^{stop}]` 上按对数均匀间隔的 :math:`num` 个值，输出 Tensor 的长度为 num。 @@ -14,12 +14,18 @@ logspace :::::::::::: - **start** (int|float|Tensor) – ``start`` 是区间开始值以 ``base`` 为底的指数，可以是一个标量，或是一个 shape 为 [] 的 0-D Tensor，该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。 - - **stop** (int|float|Tensor) – ``stop`` 是区间结束值以 ``base`` 为底的指数，可以是一个标量，或是一个 shape 为 [] 的 0-D Tensor，该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。 - - **num** (int|Tensor) – ``num`` 是给定区间内需要划分的区间数，可以是一个整型标量，或是一个 shape 为 [] 的 0-D Tensor，该 Tensor 的数据类型需为 int32。 + - **stop** (int|float|Tensor) – ``stop`` 是区间结束值以 ``base`` 为底的指数，可以是一个标量，或是一个 shape 为 [] 的 0-D Tensor，该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。别名 ``end``。 + - **num** (int|Tensor) – ``num`` 是给定区间内需要划分的区间数，可以是一个整型标量，或是一个 shape 为 [] 的 0-D Tensor，该 Tensor 的数据类型需为 int32。别名 ``steps``。 - **base** (int|float|Tensor) – ``base`` 是对数函数的底数，可以是一个标量，或是一个 shape 为 [] 的 0-D Tensor，该 Tensor 的数据类型可以是 float32、float64、int32 或者 int64。 - **dtype** (str|paddle.dtype|np.dtype，可选) – 输出 Tensor 的数据类型，可以是 float32、float64、int32 或者 int64。如果 dtype 的数据类型为 None，输出 Tensor 数据类型为 float32。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + - **device** (PlaceLike，可选) - 输出 Tensor 的设备，默认值为 ``None``。 + - **requires_grad** (bool，可选) - 是否计算梯度，默认值为 ``False``。 + 返回 :::::::::::: diff --git a/docs/api/paddle/moveaxis_cn.rst b/docs/api/paddle/moveaxis_cn.rst index f8794e2af3d..fe9b7b306e6 100644 --- a/docs/api/paddle/moveaxis_cn.rst +++ b/docs/api/paddle/moveaxis_cn.rst @@ -13,7 +13,7 @@ moveaxis :width: 600 参数 ::::::::: - - **x** (Tensor) - 输入的 N-D Tensor，数据类型为：bool、int32、int64、float32、float64、complex64、complex128。 + - **x** (Tensor) - 输入的 N-D Tensor，数据类型为：bool、int32、int64、float32、float64、complex64、complex128。别名 ``input``。 - **source** (int|tuple|list) - 将被移动的轴的位置，其每个元素必须为不同的整数。 - **destination** (int|tuple|list) - 轴被移动后的目标位置，其每个元素必须为不同的整数。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nan_to_num_cn.rst b/docs/api/paddle/nan_to_num_cn.rst index c43f31efa0f..ccd75933c87 100644 --- a/docs/api/paddle/nan_to_num_cn.rst +++ b/docs/api/paddle/nan_to_num_cn.rst @@ -3,18 +3,22 @@ nan_to_num ------------------------------- -.. py:function:: paddle.nan_to_num(x, nan=0.0, posinf=None, neginf=None, name=None) +.. py:function:: paddle.nan_to_num(x, nan=0.0, posinf=None, neginf=None, name=None, *, out=None) 替换 x 中的 NaN、+inf、-inf 为指定值。 参数 ::::::::: - - **x** (Tensor) - 输入变量，类型为 Tensor， 支持 float32、float64 数据类型。 + - **x** (Tensor) - 输入变量，类型为 Tensor， 支持 float32、float64 数据类型。别名 ``input``。 - **nan** (float，可选) - NaN 的替换值，默认为 0。 - **posinf** (float，可选) - +inf 的替换值，默认为 None，表示使用输入 Tensor 的数据类型所能表示的最大值作为 +inf 的替换值。 - **neginf** (float，可选) - -inf 的替换值，默认为 None，表示使用输入 Tensor 的数据类型所能表示的最小值作为 -inf 的替换值。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为 None。 +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 ::::::::: - Tensor (Tensor)，将输入 Tensor 中的 NaN、+inf、-inf 替换后的结果。 diff --git a/docs/api/paddle/nanmean_cn.rst b/docs/api/paddle/nanmean_cn.rst index 56a9d5d7755..d9fe61f878e 100644 --- a/docs/api/paddle/nanmean_cn.rst +++ b/docs/api/paddle/nanmean_cn.rst @@ -3,7 +3,7 @@ nanmean ------------------------------- -.. py:function:: paddle.nanmean(x, axis=None, keepdim=False, name=None) +.. py:function:: paddle.nanmean(x, axis=None, keepdim=False, name=None, *, dtype=None, out=None) @@ -11,11 +11,16 @@ nanmean 参数 :::::::::: - - **x** (Tensor) - 输入的 Tensor，数据类型为：bfloat16、float16、float32、float64。 - - **axis** (int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度，则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内，D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0，则等价于 :math:`axis + D`。如果 ``axis`` 是 None，则对 ``x`` 的全部元素计算平均值。默认值为 None。 + - **x** (Tensor) - 输入的 Tensor，数据类型为：bfloat16、float16、float32、float64。别名 ``input``。 + - **axis** (int|list|tuple，可选) - 指定对 ``x`` 进行计算的轴。``axis`` 可以是 int、list(int)、tuple(int)。如果 ``axis`` 包含多个维度，则沿着 ``axis`` 中的所有轴进行计算。``axis`` 或者其中的元素值应该在范围[-D, D)内，D 是 ``x`` 的维度。如果 ``axis`` 或者其中的元素值小于 0，则等价于 :math:`axis + D`。如果 ``axis`` 是 None，则对 ``x`` 的全部元素计算平均值。默认值为 None。别名 ``dim``。 - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True，则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为 1)。否则，输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::: + - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出变量的数据类型。若参数为空，则输出变量的数据类型和输入变量相同，默认值为 None。 + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 :::::::::: ``Tensor``，沿着 ``axis`` 进行平均值计算的结果且忽略掉 ``NaNs`` 值，数据类型和 ``x`` 相同。 diff --git a/docs/api/paddle/nansum_cn.rst b/docs/api/paddle/nansum_cn.rst index cdd6cd7f632..12038889212 100644 --- a/docs/api/paddle/nansum_cn.rst +++ b/docs/api/paddle/nansum_cn.rst @@ -3,18 +3,27 @@ nansum ------------------------------- -.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None) +.. py:function:: paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None, *, out=None) 计算给定轴上的元素之和，并将非数字元素（NaNs）视为 0。 +.. note:: + 此 API 有两种调用方式： + 1. ``paddle.nansum(x, axis=None, dtype=None, keepdim=False, name=None, *, out=None)`` (Paddle 风格) + 2. ``paddle.nansum(input, dim=None, keepdim=False, *, dtype=None, out=None)`` (PyTorch 风格) + 参数 ::::::::: - - **x** (Tensor) - 输入的 Tensor，数据类型为：bfloat16、float16、float32、float64、int32 或 int64。 - - **axis** (int|list|tuple，可选) - 求和运算的维度。如果为 None，则计算所有元素的和并返回包含单个元素的 Tensor 变量，否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`，则维度将变为 :math:`rank+axis[i]`，默认值为 None。 + - **x** (Tensor) - 输入的 Tensor，数据类型为：bfloat16、float16、float32、float64、int32 或 int64。别名 ``input``。 + - **axis** (int|list|tuple，可选) - 求和运算的维度。如果为 None，则计算所有元素的和并返回包含单个元素的 Tensor 变量，否则必须在 :math:`[−rank(x),rank(x)]` 范围内。如果 :math:`axis [i] <0`，则维度将变为 :math:`rank+axis[i]`，默认值为 None。别名 ``dim``。 - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出变量的数据类型。若参数为空，则输出变量的数据类型和输入变量相同，默认值为 None。 - **keepdim** (bool) - 是否在输出 Tensor 中保留减小的维度。如 keepdim 为 True，否则结果 Tensor 的维度将比输入 Tensor 小，默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 ::::::::: ``Tensor``，在指定维度上进行求和运算的 Tensor，数据类型和输入数据类型一致。 diff --git a/docs/api/paddle/select_scatter_cn.rst b/docs/api/paddle/select_scatter_cn.rst index c9b73e2e728..d9aaec7c917 100644 --- a/docs/api/paddle/select_scatter_cn.rst +++ b/docs/api/paddle/select_scatter_cn.rst @@ -3,7 +3,8 @@ select_scatter ------------------------------- -.. py:function:: paddle.select_scatter(x, values, axis, index, name=None) +.. py:function:: paddle.select_scatter(x, values, axis, index) + 将 ``values`` 矩阵的值嵌入到 ``x`` 矩阵的第 ``axis`` 维的 ``index`` 列 参数 @@ -12,7 +13,6 @@ select_scatter - **values** (Tensor) - 需要插入的值，形状需要与 ``x`` 矩阵除去第 ``axis`` 维后的形状一致，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。 - **axis** (int) - 指定沿着哪个维度嵌入对应的值，数据类型为：int。别名 ``dim``。 - **index** (int) - 指定沿着 ``axis`` 维的哪一列嵌入对应的值，数据类型为：int。 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 ::::::::: diff --git a/docs/api/paddle/sgn_cn.rst b/docs/api/paddle/sgn_cn.rst index 528efe9369e..61b45d60f0a 100644 --- a/docs/api/paddle/sgn_cn.rst +++ b/docs/api/paddle/sgn_cn.rst @@ -3,7 +3,7 @@ sgn ------------------------------- -.. py:function:: paddle.sgn(x, name=None) +.. py:function:: paddle.sgn(x, name=None, *, out=None) 对于复数 Tensor，此函数返回一个新的 Tensor，其元素与 input 元素的角度相同且绝对值为 1。 @@ -11,9 +11,13 @@ sgn 参数 :::::::::::: - - **x** (Tensor) – 输入 Tensor，数据类型为 float16、float32、float64、complex64 或 complex128。 + - **x** (Tensor) – 输入 Tensor，数据类型为 float16、float32、float64、complex64 或 complex128。别名 ``input``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 :::::::::::: Tensor，输出正负号或复数的单位向量，数据的 shape 大小及数据类型和输入 ``x`` 一致。 diff --git a/docs/api/paddle/signbit_cn.rst b/docs/api/paddle/signbit_cn.rst index 32d193663e7..f51780e5d00 100644 --- a/docs/api/paddle/signbit_cn.rst +++ b/docs/api/paddle/signbit_cn.rst @@ -3,15 +3,19 @@ signbit ------------------------------- -.. py:function:: paddle.signbit(x, name=None) +.. py:function:: paddle.signbit(x, name=None, *, out=None) 对输入参数 ``x`` 的每个元素判断是否设置了其符号位，并输出判断值。若存在符号位，则输出 True，否则输出 False。 参数 :::::::::::: - - **x** (Tensor) – 进行符号位判断的多维 Tensor，数据类型为 uint8，int8，int16，int32，int64，bfloat16，float16，float32 或 float64。 + - **x** (Tensor) – 进行符号位判断的多维 Tensor，数据类型为 uint8，int8，int16，int32，int64，bfloat16，float16，float32 或 float64。别名 ``input``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 :::::::::::: Tensor，输出掩码，数据的 shape 大小及数据类型和输入 ``x`` 一致。 diff --git a/docs/api/paddle/slice_scatter_cn.rst b/docs/api/paddle/slice_scatter_cn.rst index 7ebc4ae80db..f345780fedd 100644 --- a/docs/api/paddle/slice_scatter_cn.rst +++ b/docs/api/paddle/slice_scatter_cn.rst @@ -3,7 +3,7 @@ slice_scatter ------------------------------- -.. py:function:: paddle.slice_scatter(x, value, axes, starts, ends, strides, name=None) +.. py:function:: paddle.slice_scatter(x, value, axes, starts, ends, strides) 沿着 ``axes`` 将 ``value`` 矩阵的值嵌入到 ``x`` 矩阵。返回一个新的 Tensor 而不是视图。 ``axes`` 需要与 ``starts``, ``ends`` 和 ``strides`` 尺寸一致。 @@ -16,13 +16,12 @@ slice_scatter 参数 ::::::::: - - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。 - - **value** (Tensor) - 需要插入的值，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。 - - **axes** (list|tuple) - 指定沿着哪几个维度嵌入对应的值。 - - **starts** (list|tuple) - 嵌入的起始索引。 - - **ends** (list|tuple) - 嵌入的截止索引。 - - **strides** (list|tuple) - 嵌入的步长。 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 ``None``。 + - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``input``。 + - **value** (Tensor) - 需要插入的值，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。 + - **axes** (list|tuple) - 指定沿着哪几个维度嵌入对应的值。别名 ``dim``。 + - **starts** (list|tuple) - 嵌入的起始索引。别名 ``start``。 + - **ends** (list|tuple) - 嵌入的截止索引。别名 ``end``。 + - **strides** (list|tuple) - 嵌入的步长。别名 ``step``。 返回 ::::::::: diff --git a/docs/api/paddle/square__cn.rst b/docs/api/paddle/square__cn.rst index 61862702740..e704312553f 100644 --- a/docs/api/paddle/square__cn.rst +++ b/docs/api/paddle/square__cn.rst @@ -10,3 +10,7 @@ Inplace 版本的 :ref:`cn_api_paddle_square` API，对输入 ``x`` 采用 Inpla 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 .. _3.1.3 原位（Inplace）操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3 + +.. note:: + + 别名支持：参数名 ``input`` 可替代 ``x``，如 ``square_(input=tensor_x)`` 等价于 ``square_(x=tensor_x)``。 diff --git a/docs/api/paddle/take_cn.rst b/docs/api/paddle/take_cn.rst index 02c3739960c..9697f55fb69 100644 --- a/docs/api/paddle/take_cn.rst +++ b/docs/api/paddle/take_cn.rst @@ -11,7 +11,7 @@ take 参数 ::::::::: - - **x** (Tensor) - 输入的 Tensor，支持 int32、int64、float32、float64 数据类型。 + - **x** (Tensor) - 输入的 Tensor，支持 int32、int64、float32、float64 数据类型。别名 ``input``。 - **index** (Tensor) - 索引矩阵，支持 int32、int64 数据类型。 - **mode** (str，可选) - 索引越界处理，可选 ``'raise'``，``'wrap'``，``'clip'``，默认为 ``'raise'``。 diff --git a/docs/api/paddle/tensordot_cn.rst b/docs/api/paddle/tensordot_cn.rst index da2ddb2dcb6..5ebf3576197 100644 --- a/docs/api/paddle/tensordot_cn.rst +++ b/docs/api/paddle/tensordot_cn.rst @@ -20,9 +20,9 @@ shape = [2,2,3]的 ``res`` 张量为 a,b 两个张量沿着 a 张量的最后一 参数 :::::::::::: - - **x** （Tensor）- 缩并运算操作的左 Tensor，数据类型为 ``float16`` 或 ``float32`` 或 ``float64``。 - - **y** （Tensor）- 缩并运算操作的右 Tensor，与 ``x`` 具有相同的数据类型。 - - **axes** （int|tuple|list|Tensor）- 指定对 ``x`` 和 ``y`` 做缩并运算的轴，默认值为整数 2。 + - **x** （Tensor）- 缩并运算操作的左 Tensor，数据类型为 ``float16`` 或 ``float32`` 或 ``float64``。别名 ``a``。 + - **y** （Tensor）- 缩并运算操作的右 Tensor，与 ``x`` 具有相同的数据类型。别名 ``b``。 + - **axes** （int|tuple|list|Tensor）- 指定对 ``x`` 和 ``y`` 做缩并运算的轴，默认值为整数 2。别名 ``dims``。 1. ``axes`` 可以是一个非负整数。若输入的是一个整数 ``n``，则表示对 ``x`` 的后 ``n`` 个轴和对 ``y`` 的前 ``n`` 个轴进行缩并运算。 diff --git a/docs/api/paddle/tril_indices_cn.rst b/docs/api/paddle/tril_indices_cn.rst index b83874ca329..a5c218d4d55 100644 --- a/docs/api/paddle/tril_indices_cn.rst +++ b/docs/api/paddle/tril_indices_cn.rst @@ -3,7 +3,7 @@ tril_indices -------------------------------- -.. py:function:: paddle.tril_indices(row, col, offset=0, dtype='int64') +.. py:function:: paddle.tril_indices(row, col, offset=0, dtype='int64', *, device=None) 返回行数和列数已知的二维矩阵中下三角矩阵元素的行列坐标，其中下三角矩阵为原始矩阵某一对角线左下部分元素的子矩阵。 @@ -19,6 +19,10 @@ tril_indices - **dtype** (int，可选) - 指定输出 Tensor 的数据类型，默认值为 int64。 +关键字参数 +::::::::: + - **device** (Place，可选) - 输出 Tensor 的设备，默认值为 ``None``。 + 返回 ::::::::: Tensor，二维矩阵的下三角矩阵行坐标和列坐标。数据类型和参数 dtype 一致。 diff --git a/docs/api/paddle/triu_indices_cn.rst b/docs/api/paddle/triu_indices_cn.rst index d1896487ab6..321636e86ec 100644 --- a/docs/api/paddle/triu_indices_cn.rst +++ b/docs/api/paddle/triu_indices_cn.rst @@ -3,7 +3,7 @@ triu_indices -------------------------------- -.. py:function:: paddle.triu_indices(row, col=None, offset=0, dtype='int64') +.. py:function:: paddle.triu_indices(row, col=None, offset=0, dtype='int64', *, device=None) 返回行数和列数已知的二维矩阵中上三角矩阵元素的行列坐标，坐标的顺序首先按照行号排列，其次按照列号排列，所述上三角矩阵为原始矩阵某一对角线右上部分元素的子矩阵。 @@ -19,6 +19,10 @@ triu_indices - **dtype** (str|np.dtype|paddle.dtype，可选) - 指定输出 Tensor 的数据类型，可以是 int32，int64，默认值为 int64。 +关键字参数 +::::::::: + - **device** (Place，可选) - 输出 Tensor 的设备，默认值为 ``None``。 + 返回 ::::::::: Tensor，返回 row*col 大小矩阵的上三角元素的坐标，其中第一行包含行坐标，第二行包含列坐标 diff --git a/docs/api/paddle/trunc_cn.rst b/docs/api/paddle/trunc_cn.rst index 6a9cfbf301e..29cb1887bde 100644 --- a/docs/api/paddle/trunc_cn.rst +++ b/docs/api/paddle/trunc_cn.rst @@ -3,7 +3,7 @@ trunc ------------------------------- -.. py:function:: paddle.trunc(input, name=None) +.. py:function:: paddle.trunc(input, name=None, *, out=None) 将输入 ``Tensor`` 的小数部分置 0，返回置 0 后的 ``Tensor``，如果输入 ``Tensor`` 的数据类型为整数，则不做处理。 @@ -11,9 +11,13 @@ trunc 参数 ::::::::: - - **input** (Tensor)：输入变量，类型为 Tensor，支持 int32、int64、float32、float64 数据类型。 + - **input** (Tensor)：输入变量，类型为 Tensor，支持 int32、int64、float32、float64 数据类型。别名 ``x``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +::::::::: + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 + 返回 ::::::::: - Tensor (Tensor)，矩阵截断后的结果。 diff --git a/docs/api/paddle/vander_cn.rst b/docs/api/paddle/vander_cn.rst index 5844caebf45..56376c611bd 100644 --- a/docs/api/paddle/vander_cn.rst +++ b/docs/api/paddle/vander_cn.rst @@ -11,7 +11,7 @@ vander 参数 :::::::::: - **x** (Tensor) - 输入的 Tensor，必须是 1-D Tensor, 支持的数据类型：int32、int64、float32、float64、complex64、complex128。 - - **n** (int，可选) - 输出中的列数。如果未指定 n，则返回一个方阵(n = len(x))。 + - **n** (int，可选) - 输出中的列数。如果未指定 n，则返回一个方阵(n = len(x))。别名 ``N``。 - **increasing** (bool，可选) - 列的幂次顺序。如果为 True，则幂次从左到右增加，如果为 False（默认值），则幂次顺序相反。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 From ff832475248937cb5e5334009e788ef852ea47d5 Mon Sep 17 00:00:00 2001 From: zhouwei25 Date: Thu, 4 Jun 2026 10:28:38 +0000 Subject: [PATCH 2/3] [API Compatibility] slice_scatter Edit By AI Agent Co-Authored-By: Claude Opus 4.6 --- docs/api/paddle/slice_scatter_cn.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/api/paddle/slice_scatter_cn.rst b/docs/api/paddle/slice_scatter_cn.rst index f345780fedd..6a67b0198a0 100644 --- a/docs/api/paddle/slice_scatter_cn.rst +++ b/docs/api/paddle/slice_scatter_cn.rst @@ -3,10 +3,15 @@ slice_scatter ------------------------------- -.. py:function:: paddle.slice_scatter(x, value, axes, starts, ends, strides) +.. py:function:: paddle.slice_scatter(x, value, axes=None, starts=None, ends=None, strides=None) 沿着 ``axes`` 将 ``value`` 矩阵的值嵌入到 ``x`` 矩阵。返回一个新的 Tensor 而不是视图。 ``axes`` 需要与 ``starts``, ``ends`` 和 ``strides`` 尺寸一致。 +.. note:: + 此 API 有两种调用方式： + 1. ``paddle.slice_scatter(x, value, axes=None, starts=None, ends=None, strides=None)`` (Paddle 风格)：沿多个维度嵌入 value 张量 + 2. ``paddle.slice_scatter(input, src, dim=0, start=None, end=None, step=1)`` (PyTorch 风格)：沿单个维度嵌入 src 张量 + 图示展示了示例二 ——一个形状为 [3, 9] 的张量 x，在 axis 1 上使用 slice scatter 操作，将 [3, 1] 的 value 张量嵌入到指定的范围内。图中显示了原始张量、value 张量以及操作后的结果。 .. image:: ../../images/api_legend/slice_scatter.png @@ -18,10 +23,10 @@ slice_scatter ::::::::: - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``input``。 - **value** (Tensor) - 需要插入的值，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。 - - **axes** (list|tuple) - 指定沿着哪几个维度嵌入对应的值。别名 ``dim``。 - - **starts** (list|tuple) - 嵌入的起始索引。别名 ``start``。 - - **ends** (list|tuple) - 嵌入的截止索引。别名 ``end``。 - - **strides** (list|tuple) - 嵌入的步长。别名 ``step``。 + - **axes** (list|tuple，可选) - 指定沿着哪几个维度嵌入对应的值。别名 ``dim``。 + - **starts** (list|tuple，可选) - 嵌入的起始索引。别名 ``start``。 + - **ends** (list|tuple，可选) - 嵌入的截止索引。别名 ``end``。 + - **strides** (list|tuple，可选) - 嵌入的步长。别名 ``step``。 返回 ::::::::: From 210c0f0c74697527c6144c8d6370ccbd8b0dfe76 Mon Sep 17 00:00:00 2001 From: zhouwei25 Date: Fri, 5 Jun 2026 12:31:58 +0000 Subject: [PATCH 3/3] [Skill Update] Update CLAUDE.md and add-compatibility-test SKILL.md Co-Authored-By: Claude Opus 4.6 --- .../dev_guides/coding_agent/api_compatibility/.claude/CLAUDE.md | 2 +- .../.claude/skills/add-compatibility-test/SKILL.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/dev_guides/coding_agent/api_compatibility/.claude/CLAUDE.md b/docs/dev_guides/coding_agent/api_compatibility/.claude/CLAUDE.md index 27a04b485b9..31c7b763265 100644 --- a/docs/dev_guides/coding_agent/api_compatibility/.claude/CLAUDE.md +++ b/docs/dev_guides/coding_agent/api_compatibility/.claude/CLAUDE.md @@ -135,5 +135,5 @@ void AtanKernel(const Context& dev_ctx, const DenseTensor& x, DenseTensor* out) - 代码自解释，最小化注释；注释应有实际价值（提醒非显而易见的全局背景） - 不要为只使用一次的简短逻辑创建辅助函数，除非能显著提升可读性 - 与现有代码风格保持一致 -- 新增注释仅使用 ASCII 字符（不引入 Unicode）；未改动的注释保持原样 +- 新增注释仅使用 ASCII 字符（不引入 Unicode，不能使用中文）；未改动的注释保持原样 - 不确定时，选择更简单的实现 diff --git a/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/add-compatibility-test/SKILL.md b/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/add-compatibility-test/SKILL.md index 399c2717e11..abe3ac01bc3 100644 --- a/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/add-compatibility-test/SKILL.md +++ b/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/add-compatibility-test/SKILL.md @@ -182,6 +182,7 @@ self.dtype = np.float32 3. 不要新建测试文件，直接在已有的 `test_api_compatibility[1-9]\\.py` 中添加 4. 测试类命名遵循 `TestAPI` 格式，如 `TestArgmaxAPI` 5. 确保测试覆盖所有新增的参数别名和参数用法 +6. 代码测试覆盖率要求：务必要确保新增所有代码行数都能够在单测中跑到，否则无法通过 CI 检查 # 四、异常回退原则