diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index e7bbbcc3fbe..5265fcb91b1 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -215,6 +215,7 @@ tensor 数学操作原位(inplace)版本 " :ref:`paddle.put_along_axis_ ` ", "Inplace 版本的 put_along_axis API,对输入 x 采用 Inplace 策略" " :ref:`paddle.cauchy_ ` ", "直接修改输入 x,将所有元素替换为从柯西分布中随机采样的数值" " :ref:`paddle.ceil_ ` ", "Inplace 版本的 ceil API,对输入 x 采用 Inplace 策略" + " :ref:`paddle.clamp_ ` ", "Inplace 版本的 clamp 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/clamp_max_cn.rst b/docs/api/paddle/clamp_max_cn.rst new file mode 100644 index 00000000000..5e153435f85 --- /dev/null +++ b/docs/api/paddle/clamp_max_cn.rst @@ -0,0 +1,31 @@ +.. _cn_api_paddle_clamp_max: + +clamp_max +------------------------------- + +.. py:function:: paddle.clamp_max(input, max=None, *, out=None) + +该 API 将输入中的所有元素进行裁剪,使得输出元素不大于给定的最大值,具体公式如下: + +.. math:: + + Out = MIN(x, max) + +参数 +:::::::::::: + + - **input** (Tensor) - 输入的 Tensor,数据类型为:float16、float32、float64、int32、int64。 + - **max** (float|int|Tensor,可选) - 裁剪的最大值,输入中大于该值的元素将由该元素代替。数据类型可以是 float32 或形状为 [] 的 0-D Tensor,默认值为 None。 + +关键字参数 +:::::::::::: + - **out** (Tensor,可选) - 输出 Tensor。默认值为 None。 + +返回 +:::::::::::: +输出 Tensor,与 ``input`` 维度相同。当 ``input`` 数据类型为 int32 或 int64 且 ``max`` 为 float 类型时,输出 Tensor 的数据类型为 float32,否则与输入 ``input`` 的数据类型相同。 + +代码示例 +:::::::::::: + +COPY-FROM: paddle.clamp_max diff --git a/docs/api/paddle/compat/Overview_cn.rst b/docs/api/paddle/compat/Overview_cn.rst index b084c0395b1..70b54b31a14 100644 --- a/docs/api/paddle/compat/Overview_cn.rst +++ b/docs/api/paddle/compat/Overview_cn.rst @@ -21,6 +21,7 @@ PyTorch 兼容函数 " :ref:`slogdet ` ", "slogdet 函数" " :ref:`sort ` ", "同时返回 values 及 indices 的排序" " :ref:`split ` ", "允许非整除块大小输入的 Tensor 轴向切分" + " :ref:`logical_and_ ` ", "Inplace 版本的逻辑与运算,保留输入 Tensor 数据类型" .. _about_compat_nn: diff --git a/docs/api/paddle/compat/nn/_pair_cn.rst b/docs/api/paddle/compat/nn/_pair_cn.rst new file mode 100644 index 00000000000..f8fe1004e03 --- /dev/null +++ b/docs/api/paddle/compat/nn/_pair_cn.rst @@ -0,0 +1,23 @@ +.. _cn_api_paddle_compat_nn__pair: + +_pair +------------------------------- + +.. py:function:: paddle.compat.nn._pair(x) + +用于将输入转换为包含 2 个元素的元组。当输入为单个整数时,返回包含两个相同整数的元组;当输入为列表或元组时,转换为元组并返回。 + +参数 +::::::::::: + + - **x** (int|list|tuple) - 输入值,可以是整数、包含 2 个元素的列表或元组。 + +返回 +::::::::::: + + tuple:包含 2 个元素的元组。 + +代码示例 +:::::::::::: + +COPY-FROM: paddle.compat.nn._pair diff --git a/docs/api/paddle/cross_cn.rst b/docs/api/paddle/cross_cn.rst index 0356d90752c..d6ff3de7411 100644 --- a/docs/api/paddle/cross_cn.rst +++ b/docs/api/paddle/cross_cn.rst @@ -3,7 +3,7 @@ cross ------------------------------- -.. py:function:: paddle.cross(x, y, axis=9, name=None) +.. py:function:: paddle.cross(x, y, axis=-1, name=None, *, out=None) 计算 Tensor ``x`` 和 ``y`` 在 ``axis`` 维度上的向量积(叉积)。 @@ -14,9 +14,13 @@ cross ::::::::: - **x** (Tensor) - 第一个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。别名 ``input``。 - **y** (Tensor) - 第二个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。别名 ``other``。 - - **axis** (int,可选) - 沿着此维进行向量积操作。别名 ``dim``。默认值是 9,意思是选取第一个长度为 3 的 ``axis`` 。 + - **axis** (int,可选) - 沿着此维进行向量积操作。别名 ``dim``。默认值是 -1,意思是选取第一个长度为 3 的 ``axis`` 。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。 + 返回 ::::::::: 计算后的 Tensor,数据类型与输入 ``x`` 相同。 diff --git a/docs/api/paddle/device/set_default_device_cn.rst b/docs/api/paddle/device/set_default_device_cn.rst new file mode 100644 index 00000000000..d66771354f5 --- /dev/null +++ b/docs/api/paddle/device/set_default_device_cn.rst @@ -0,0 +1,29 @@ +.. _cn_api_paddle_device_set_default_device: + +set_default_device +------------------------------- + +.. py:function:: paddle.device.set_default_device(device=None) + +Paddle 支持在各种类型的设备上运行,包括 CPU、GPU、XPU、NPU 和 IPU。 +该函数可以设置 OP 运行的全局设备。 + +参数 +::::::::: + + - **device** (str|Place|paddle.device|int|None,可选) - 此参数确定特定的运行设备。可以是 ``cpu``、``gpu``、``xpu``、``npu``、``gpu:x``、``xpu:x``、``npu:x`` 和 ``ipu``, + 其中 ``x`` 是 GPU、XPU 或 NPU 的索引。也可以是 ``paddle.device`` 对象或 int 类型的设备索引。如果为 ``None``,则重置为 CPU。 + 默认值为 None。 + +返回 +::::::::: + + 无。 + +代码示例 +::::::::: + +.. code-block:: pycon + + >>> import paddle + >>> paddle.device.set_default_device("cpu") diff --git a/docs/api/paddle/expand_copy_cn.rst b/docs/api/paddle/expand_copy_cn.rst new file mode 100644 index 00000000000..b74d36f6797 --- /dev/null +++ b/docs/api/paddle/expand_copy_cn.rst @@ -0,0 +1,25 @@ +.. _cn_api_paddle_expand_copy: + +expand_copy +------------------------------- + +.. py:function:: paddle.expand_copy(x, shape, name=None) + +根据 ``shape`` 指定的形状扩展 ``x``,扩展后返回一个新的 Tensor,不会修改原 Tensor。 + +这是 :ref:`cn_api_paddle_expand` 的非原位版本。 + +参数 +::::::::::: + - **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float16、float32、float64、int32、int64、uint8、uint16、complex64 或 complex128。别名 ``input``。 + - **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状。若 shape 为 list 或 tuple,其中的元素值应全为整数或 0-D 或 1-D Tensor(数据类型为 int32)。别名 ``size``。 + - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + +返回 +::::::::::: +Tensor,数据类型与 ``x`` 相同。 + +代码示例 +::::::::::: + +COPY-FROM: paddle.expand_copy diff --git a/docs/api/paddle/hstack_cn.rst b/docs/api/paddle/hstack_cn.rst index e6a3b03e539..ab962836851 100644 --- a/docs/api/paddle/hstack_cn.rst +++ b/docs/api/paddle/hstack_cn.rst @@ -3,16 +3,20 @@ hstack ------------------------------- -.. py:function:: paddle.hstack(x, name=None) +.. py:function:: paddle.hstack(x, name=None, *, out=None) 沿水平轴堆叠输入 ``x`` 中的所有张量。所有张量必须具有相同的数据类型。 参数 :::::::::::: - - **x** (list[Tensor]|tuple[Tensor]) - 输入 ``x`` 可以是张量的 list 或 tuple, ``x`` 中张量的数据类型必须相同。支持的数据类型: ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。 + - **x** (list[Tensor]|tuple[Tensor]) - 输入 ``x`` 可以是张量的 list 或 tuple, ``x`` 中张量的数据类型必须相同。支持的数据类型: ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。别名 ``tensors``。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。 + 返回 :::::::::::: Tensor,与输入数据类型相同的堆叠张量。 diff --git a/docs/api/paddle/linalg/cholesky_cn.rst b/docs/api/paddle/linalg/cholesky_cn.rst index 454b79136d3..f58b914e0cd 100644 --- a/docs/api/paddle/linalg/cholesky_cn.rst +++ b/docs/api/paddle/linalg/cholesky_cn.rst @@ -3,7 +3,7 @@ cholesky ------------------------------- -.. py:function:: paddle.linalg.cholesky(x, upper=False, name=None) +.. py:function:: paddle.linalg.cholesky(x, upper=False, name=None, *, out=None) @@ -15,10 +15,14 @@ cholesky 参数 :::::::::::: - - **x** (Tensor)- 输入变量为多维 Tensor,它的维度应该为 ``[*, M, M]``,其中*为零或更大的批次尺寸,并且最里面的两个维度上的矩阵都应为对称的正定矩阵,支持数据类型为 float32、float64。 + - **x** (Tensor)- 输入变量为多维 Tensor,它的维度应该为 ``[*, M, M]``,其中*为零或更大的批次尺寸,并且最里面的两个维度上的矩阵都应为对称的正定矩阵,支持数据类型为 float32、float64。别名 ``input``。 - **upper** (bool)- 指示是否返回上三角矩阵或下三角矩阵。默认值:False。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 +关键字参数 +:::::::::::: + - **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。 + 返回 :::::::::::: Tensor,与 ``x`` 具有相同形状和数据类型。它代表了 Cholesky 分解生成的三角矩阵。 diff --git a/docs/api/paddle/linalg/det_cn.rst b/docs/api/paddle/linalg/det_cn.rst index dcb0e78ef65..c88ce267b94 100644 --- a/docs/api/paddle/linalg/det_cn.rst +++ b/docs/api/paddle/linalg/det_cn.rst @@ -3,13 +3,14 @@ det ------------------------------- -.. py:function:: paddle.linalg.det(x) +.. py:function:: paddle.linalg.det(x, *, out=None) 计算批量矩阵的行列式值。 参数 :::::::::::: - - **x** (Tensor):输入一个或批量矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64。别名 ``input``。 + - **x** (Tensor):输入一个或批量矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64。别名 ``input``、 ``A``。 + - **out** (Tensor,可选):指定输出的存储结果的 Tensor,如果提供,返回值将是 ``out`` 本身。默认值为 ``None``。 返回 :::::::::::: diff --git a/docs/api/paddle/linalg/eigh_cn.rst b/docs/api/paddle/linalg/eigh_cn.rst index 1b21026bc43..7d623053c86 100644 --- a/docs/api/paddle/linalg/eigh_cn.rst +++ b/docs/api/paddle/linalg/eigh_cn.rst @@ -3,16 +3,20 @@ eigh ------------------------------- -.. py:function:: paddle.linalg.eigh(x, UPLO='L', name=None) +.. py:function:: paddle.linalg.eigh(x, UPLO='L', name=None, *, out=None) 计算厄米特矩阵或者实数对称矩阵的特征值和特征向量。 参数 :::::::::::: - - **x** (Tensor):输入一个或一批厄米特矩阵或者实数对称矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64、complex64、complex128。 + - **x** (Tensor):输入一个或一批厄米特矩阵或者实数对称矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64、complex64、complex128。别名 ``input``。 - **UPLO** (str,可选):表示计算上三角或者下三角矩阵,默认值为 'L',表示计算下三角矩阵的特征值和特征向量,'U'表示计算上三角矩阵的特征值和特征向量。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 +关键字参数 +:::::::::::: + - **out** (tuple[Tensor, Tensor],可选) - 输出 Tensor 元组,若不为 ``None``,计算结果将保存在该 Tensor 元组中,默认值为 ``None``。 + 返回 :::::::::::: diff --git a/docs/api/paddle/linalg/qr_cn.rst b/docs/api/paddle/linalg/qr_cn.rst index 3aab06aad47..5a9b46a175e 100644 --- a/docs/api/paddle/linalg/qr_cn.rst +++ b/docs/api/paddle/linalg/qr_cn.rst @@ -3,7 +3,7 @@ qr ------------------------------- -.. py:function:: paddle.linalg.qr(x, mode="reduced", name=None) +.. py:function:: paddle.linalg.qr(x, mode="reduced", name=None, *, out=None) 计算一个或一批矩阵的正交三角分解,也称 QR 分解(暂不支持反向)。 @@ -19,15 +19,23 @@ qr 参数 :::::::::::: - - **x** (Tensor):输入进行正交三角分解的一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。 - - **mode** (str,可选):控制正交三角分解的行为,默认是 ``reduced``,假设 ``x`` 形状应为 ``[*, M, N]`` 和 ``K = min(M, N)``:如果 ``mode = "reduced"``,则 :math:`Q` 形状为 ``[*, M, K]`` 和 :math:`R` 形状为 ``[*, K, N]``;如果 ``mode = "complete"``,则 :math:`Q` 形状为 ``[*, M, M]`` 和 :math:`R` 形状为 ``[*, M, N]``;如果 ``mode = "r"``,则不返回 :math:`Q`,只返回 :math:`R` 且形状为 ``[*, K, N]`` 。 + - **x** (Tensor):输入进行正交三角分解的一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。别名 ``input``, ``A``。 + - **mode** (str,可选):控制正交三角分解的行为,默认是 ``reduced``,假设 ``x`` 形状应为 ``[*, M, N]`` 和 ``K = min(M, N)``: + 如果 ``mode = "reduced"``,则 :math:`Q` 形状为 ``[*, M, K]`` 和 :math:`R` 形状为 ``[*, K, N]``; + 如果 ``mode = "complete"``,则 :math:`Q` 形状为 ``[*, M, M]`` 和 :math:`R` 形状为 ``[*, M, N]``; + 如果 ``mode = "r"``,则**只返回**缩减的 :math:`R`,其形状为 ``[*, K, N]``。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + - **out** (Tensor|tuple,可选) - 指定输出的张量。 + 当 ``mode = "r"`` 时,为一个 Tensor 用于存储 R; + 否则为一个 ``(Q, R)`` 张量元组,默认值为 None。 返回 :::::::::::: - - Tensor Q,正交三角分解的 Q 正交矩阵,需注意如果 ``mode = "reduced"``,则不返回 Q 矩阵,只返回 R 矩阵。 - - Tensor R,正交三角分解的 R 上三角矩阵。 + - 如果 ``mode = "r"``,返回 Tensor R,即缩减的上三角矩阵。 + - 否则返回 ``QrRetType(Q, R)`` 具名元组: + - Tensor Q,正交三角分解的 Q 正交矩阵。 + - Tensor R,正交三角分解的 R 上三角矩阵。 代码示例 :::::::::: diff --git a/docs/api/paddle/logdet_cn.rst b/docs/api/paddle/logdet_cn.rst new file mode 100644 index 00000000000..9c8da415645 --- /dev/null +++ b/docs/api/paddle/logdet_cn.rst @@ -0,0 +1,26 @@ +.. _cn_api_paddle_logdet: + +logdet +------------------------------- + +.. py:function:: paddle.logdet(input, name=None) + +计算一个或一批方阵的行列式的自然对数。 + +如果行列式值为正数,则返回行列式的自然对数;如果行列式值为负数或零,则返回 ``NaN``。 + +参数 +:::::::::::: + + - **input** (Tensor) - 输入一个或批量方阵。``input`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64、complex64、complex128。 + - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + +返回 +:::::::::::: + +Tensor,输出矩阵的行列式的自然对数值。 + +代码示例 +:::::::::::: + +COPY-FROM: paddle.logdet diff --git a/docs/api/paddle/nn/ELU_cn.rst b/docs/api/paddle/nn/ELU_cn.rst index 1c08ca8aa27..b16eb9e008a 100644 --- a/docs/api/paddle/nn/ELU_cn.rst +++ b/docs/api/paddle/nn/ELU_cn.rst @@ -2,7 +2,7 @@ ELU ------------------------------- -.. py:class:: paddle.nn.ELU(alpha=1.0, name=None) +.. py:class:: paddle.nn.ELU(alpha=1.0, inplace=False, name=None) ELU 激活层(ELU Activation Operator) @@ -23,6 +23,7 @@ ELU 激活层(ELU Activation Operator) 参数 :::::::::: - **alpha** (float,可选) - ELU 的 alpha 值,默认值为 1.0。 + - **inplace** (bool,可选) - 是否在不更改变量的内存地址的情况下,直接修改变量的值,默认值为 False。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 形状 diff --git a/docs/api/paddle/nn/functional/elu_cn.rst b/docs/api/paddle/nn/functional/elu_cn.rst index 81118671f3f..e6bda48aee3 100644 --- a/docs/api/paddle/nn/functional/elu_cn.rst +++ b/docs/api/paddle/nn/functional/elu_cn.rst @@ -3,7 +3,7 @@ elu ------------------------------- -.. py:function:: paddle.nn.functional.elu(x, alpha=1.0, name=None) +.. py:function:: paddle.nn.functional.elu(x, alpha=1.0, inplace=False, name=None) elu 激活层(ELU Activation Operator) @@ -23,8 +23,9 @@ elu 激活层(ELU Activation Operator) 参数 :::::::::: - - **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。 + - **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。别名 ``input``。 - **alpha** (float,可选) - elu 的 alpha 值,默认值为 1.0。 + - **inplace** (bool,可选) - 是否在不更改变量的内存地址的情况下,直接修改变量的值,默认值为 False。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/gumbel_softmax_cn.rst b/docs/api/paddle/nn/functional/gumbel_softmax_cn.rst index e62cb84c81e..5291b92547b 100644 --- a/docs/api/paddle/nn/functional/gumbel_softmax_cn.rst +++ b/docs/api/paddle/nn/functional/gumbel_softmax_cn.rst @@ -2,7 +2,7 @@ gumbel_softmax ------------------------------- -.. py:function:: paddle.nn.functional.gumbel_softmax(x, temperature = 1.0, hard = False, axis = -1, name = None) +.. py:function:: paddle.nn.functional.gumbel_softmax(x, temperature = 1.0, hard = False, axis = -1, name = None, eps = None) 实现了按 Gumbel-Softmax 分布进行采样的功能,通过 hard 可选择是否离散化。记 temperature 为 ``t``,涉及到的等式如下: @@ -32,6 +32,7 @@ gumbel_softmax - **hard** (bool,可选) - 如果是 True,返回离散的 one-hot 向量。如果是 False,返回软样本。默认值:False。 - **axis** (int,可选) - 按照维度 axis 计算 softmax。默认值:-1。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + - **eps** (float,可选) - 此参数已被废弃,不产生任何作用。默认值为 None。 返回 :::::::::: diff --git a/docs/api/paddle/nn/functional/instance_norm_cn.rst b/docs/api/paddle/nn/functional/instance_norm_cn.rst index bf0c9570b2c..b54f266378f 100644 --- a/docs/api/paddle/nn/functional/instance_norm_cn.rst +++ b/docs/api/paddle/nn/functional/instance_norm_cn.rst @@ -3,14 +3,19 @@ instance_norm ------------------------------- -.. py:class:: paddle.nn.functional.instance_norm(x, running_mean=None, running_var=None, weight=None, bias=None, use_input_stats=True, momentum=0.9, eps=1e-05, data_format='NCHW', name=None) +.. py:function:: paddle.nn.functional.instance_norm(x, running_mean=None, running_var=None, weight=None, bias=None, use_input_stats=True, momentum=0.9, eps=1e-05, data_format='NCHW', name=None) + +.. note:: + 此 API 有两种调用方式: + 1. ``paddle.nn.functional.instance_norm(x, running_mean=None, running_var=None, weight=None, bias=None, use_input_stats=True, momentum=0.9, eps=1e-05, data_format='NCHW', name=None)`` (Paddle 风格)。 + 2. ``paddle.nn.functional.instance_norm(input, running_mean=None, running_var=None, weight=None, bias=None, use_input_stats=True, momentum=0.1, eps=1e-05)`` (PyTorch 风格)。 推荐使用 :ref:`cn_api_paddle_nn_InstanceNorm1D`,:ref:`cn_api_paddle_nn_InstanceNorm2D`,:ref:`cn_api_paddle_nn_InstanceNorm3D`,由内部调用此方法。 参数 :::::::::::: - - **x** (Tensor) - 输入,数据类型为 float32, float64。 + - **x** (Tensor) - 输入,数据类型为 float32, float64。别名 ``input``。 - **running_mean** (Tensor,可选) - 均值的 Tensor。过时(已被删除,无法使用) - **running_var** (Tensor,可选) - 方差的 Tensor。过时(已被删除,无法使用) - **weight** (Tensor,可选) - 权重的 Tensor。默认值:None. 如果 weight 为 None 则 weight 被初始化为全 1 的 Tensor. diff --git a/docs/api/paddle/nn/functional/prelu_cn.rst b/docs/api/paddle/nn/functional/prelu_cn.rst index 8a5f421c96a..384281cd6f9 100644 --- a/docs/api/paddle/nn/functional/prelu_cn.rst +++ b/docs/api/paddle/nn/functional/prelu_cn.rst @@ -15,7 +15,7 @@ prelu 激活层(PRelu Activation Operator)。计算公式如下: 参数 :::::::::: - - **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。 + - **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。别名 ``input``。 - **weight** (Tensor) - 可训练参数,数据类型同``x`` 一致,形状支持:[]、[1] 或者 [in],其中 ``in`` 为输入的通道数。 - **data_format** (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 diff --git a/docs/api/paddle/true_divide__cn.rst b/docs/api/paddle/true_divide__cn.rst new file mode 100644 index 00000000000..8612efefab3 --- /dev/null +++ b/docs/api/paddle/true_divide__cn.rst @@ -0,0 +1,24 @@ +.. _cn_api_paddle_true_divide_: + +true_divide_ +------------------------------- + +.. py:function:: paddle.true_divide_(input, other, name=None) + +该 API 是 ``true_divide`` 的 inplace 版本,对输入 Tensor 进行原地除法操作。 + +参数 +:::::::::::: + + - **input** (Tensor) - 输入的 Tensor,会被原地修改。 + - **other** (Tensor) - 输入的 Tensor,作为除数。 + - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + +返回 +:::::::::::: +Tensor,与 ``input`` 是同一个 Tensor,包含逐元素除法后的结果。 + +代码示例 +:::::::::::: + +COPY-FROM: paddle.true_divide_ diff --git a/docs/api/paddle/vstack_cn.rst b/docs/api/paddle/vstack_cn.rst index d43b4e7f387..cdc264e9688 100644 --- a/docs/api/paddle/vstack_cn.rst +++ b/docs/api/paddle/vstack_cn.rst @@ -3,7 +3,7 @@ vstack ------------------------------- -.. py:function:: paddle.vstack(x, name=None) +.. py:function:: paddle.vstack(x, name=None, *, out=None) 沿垂直轴堆叠输入 ``x`` 中的所有张量。所有张量必须具有相同的数据类型。 @@ -12,6 +12,7 @@ vstack - **x** (list[Tensor]|tuple[Tensor]) - 输入 ``x`` 可以是张量的 list 或 tuple, ``x`` 中张量的数据类型必须相同。支持的数据类型: ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。 - **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。 + - **out** (Tensor,可选) - 指定输出的存储结果的 Tensor,如果提供,返回值将是 ``out`` 本身。默认值为 ``None``。 返回 :::::::::::: diff --git a/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/cpp-sink/SKILL.md b/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/cpp-sink/SKILL.md index be7ebe28b08..c9bedab9c3a 100644 --- a/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/cpp-sink/SKILL.md +++ b/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/cpp-sink/SKILL.md @@ -36,7 +36,7 @@ disable-model-invocation: false ### Step 2:迁移文档到 `_paddle_docs.py` -使用 `add_doc_and_signature` 函数迁移文档,关键要点: +使用 `add_doc_and_signature` 装饰器迁移文档,关键要点: 1. **Alias 说明格式**:在 Args 部分为有别名的参数添加 `Alias: ``alias_name``` 2. **out 参数处理**:keyword-only 参数放在 `Keyword Args:` 部分,位置参数放在 `Args:` 部分,如下: @@ -58,28 +58,43 @@ Args: **示例**: ```python -add_doc_and_signature( - "log2", - r""" - Calculates the log to the base 2 of the given input tensor, element-wise. - ... - Args: - x (Tensor): Input tensor. Alias: ``input``. - ... - Keyword Args: - out (Tensor, optional): The output tensor. Default: None. - Returns: - ... -""", - """ +@add_doc_and_signature def log2( x: Tensor, name: str | None = None, *, out: Tensor | None = None, -) -> Tensor -""", -) +) -> Tensor: + r""" + Calculates the log to the base 2 of the given input tensor, element-wise. + + .. math:: + + Out = \log_2x + + Args: + x (Tensor): Input tensor must be one of the following types: int32, int64, float16, bfloat16, float32, float64, complex64, complex128. + name (str|None, optional): Name for the operation (optional, default is None). For more information, please refer to :ref:`api_guide_Name`. + out (Tensor, optional): The output Tensor. If set, the result will be stored in this Tensor. Default: None. + + Returns: + Tensor: The log to the base 2 of the input Tensor computed element-wise. + + Examples: + + .. code-block:: pycon + + >>> import paddle + + >>> # example 1: x is a float + >>> x_i = paddle.to_tensor([[1.0], [2.0]]) + >>> res = paddle.log2(x_i) + >>> res + Tensor(shape=[2, 1], dtype=float32, place=Place(cpu), stop_gradient=True, + [[0.], + [1.]]) + """ + ... ``` **注意**: @@ -95,10 +110,10 @@ def log2( 2. 直接**删除**原有的 Python 函数实现 ```python -# 在文件最上方合适位置导入(不要添加注释) +# 在文件最上方合适位置导入 from paddle._C_ops import log2 # noqa: F401 -# 以下内容全部删除(不要添加注释) +# 以下内容全部删除 # def log2(x: Tensor, name: str | None = None) -> Tensor: # ... ``` @@ -234,7 +249,7 @@ Returns: 1. 严格按标准工作流程执行,杜绝自行臆断和跳过步骤 2. 若 Python API 参数顺序与`_C_ops` API 不同,属于特殊情况,Cpp 下沉方案无法实现,需要使用 Python 装饰器方案 3. 代码中不允许提交中文,代码注释采用英文 -4. 若 API 需支持`out`参数,必须修改`add_doc_and_signature`中的字符串,增加 out 参数 +4. 若 API 需支持`out`参数,必须在 API 签名中 out 参数 5. 不要修改`generated_tensor_methods_patch.py`,该文件是自动生成的,修改没有意义,如无法对齐可考虑放弃 C++下沉方案而不是改动该文件 6. 示例代码若涉及多种数据类型,可能触发类型检查误报,添加注释忽略: ```python diff --git a/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/update-docs/SKILL.md b/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/update-docs/SKILL.md index 9c3ea2bd468..d9c3d1c9153 100644 --- a/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/update-docs/SKILL.md +++ b/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/update-docs/SKILL.md @@ -43,6 +43,8 @@ Step 3. **更新中文文档与英文一致** 6. **文档描述原则** - 不要在文档中强调"PyTorch 风格"、"PyTorch 签名"、"PyTorch 适配"等 Pytorch 相关内容 - 参数别名说明只需简单注明"别名 xxx" +7. 无需修改 `${ROOT_DIR}/docs/guides/model_convert/convert_from_pytorch` 目录中的映射文档 + # 四、常见修改模式 diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.true_divide_.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.true_divide_.md index af45e617ed3..a98b75a91e4 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.true_divide_.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.Tensor.true_divide_.md @@ -4,15 +4,16 @@ torch.Tensor.true_divide_(other) ``` -### [paddle.Tensor.divide_]() +### [paddle.Tensor.true\_divide\_]() ```python -paddle.Tensor.divide_(y) +paddle.Tensor.true_divide_(other) ``` +两者功能一致,可直接使用。 两者功能一致且参数用法一致,仅参数名不一致,具体如下: ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | -------- | ------------ | -------------------------------- | -| other | y | 表示输入的 Tensor,仅参数名不一致。 | +| other | other | 表示输入的 Tensor。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.hstack.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.hstack.md index b2a41d312cf..6d603c3c90c 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.hstack.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/args_name_diff/torch.hstack.md @@ -6,7 +6,7 @@ torch.hstack(tensors, *, out=None) ### [paddle.hstack](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/hstack_cn.html#paddle.hstack) ```python -paddle.hstack(x, name=None) +paddle.hstack(x, name=None, *, out=None) ``` 其中 Paddle 相比 PyTorch 仅参数名不一致,具体如下: @@ -16,3 +16,4 @@ paddle.hstack(x, name=None) | PyTorch | PaddlePaddle | 备注 | | ------------- | ------------ | ------------------------------------------------------ | | tensors | x | 表示输入的 Tensor ,仅参数名不一致。 | +| out | out | 表示输出的 Tensor。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.Tensor.H.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.Tensor.H.md index 9294eb72970..d1fe2becfef 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.Tensor.H.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.Tensor.H.md @@ -4,9 +4,8 @@ torch.Tensor.H ``` -Paddle 无此 API,需要组合实现。 -PyTorch 中等于 x.transpose(0, 1).conj(),Paddle 中 transpose 参数 perm 为转换后的维度位置。 -该 API 仅针对 2D。 +Paddle 现已支持该 API,可直接使用。 +该 API 仅针对 2D Tensor。 ### 转写示例 ```python @@ -14,5 +13,5 @@ PyTorch 中等于 x.transpose(0, 1).conj(),Paddle 中 transpose 参数 perm y = x.H # Paddle 写法 -y = x.transpose(perm=[1, 0]).conj() +y = x.H ``` diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.logdet.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.logdet.md index 83922409ec9..8e1ca40afa4 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.logdet.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/composite_implement/torch.logdet.md @@ -3,7 +3,7 @@ ```python torch.logdet(input) ``` -Paddle 无此 API,需要组合实现。 +Paddle 现已支持该 API,可直接使用。 ### 转写示例 ```python @@ -11,5 +11,5 @@ Paddle 无此 API,需要组合实现。 y = torch.logdet(input) # Paddle 写法 -y = paddle.log(paddle.linalg.det(input)) +y = paddle.logdet(input) ``` diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/output_args_type_diff/torch.Tensor.logical_and_.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/output_args_type_diff/torch.Tensor.logical_and_.md index c1aa7db60cb..de9cff18382 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/output_args_type_diff/torch.Tensor.logical_and_.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/output_args_type_diff/torch.Tensor.logical_and_.md @@ -31,3 +31,7 @@ x.logical_and_(tensor_y) # Paddle 写法 _x_dtype_ = x.dtype x.logical_and_(tensor_y).cast(_x_dtype_) + +# 也可使用 Paddle 的兼容 API +paddle.compat.logical_and_(x, y) # 自动处理返回类型 +``` diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.clamp_max.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.clamp_max.md index fbd64e23ec6..a23fa6953f5 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.clamp_max.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.clamp_max.md @@ -8,31 +8,19 @@ torch.clamp_max(input, out=None) ``` -### [paddle.clip](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/clip_cn.html#paddle.clip) +### [paddle.clamp_max](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/clamp_max_cn.html#paddle.clamp_max) ```python -paddle.clip(x, - min=None, +paddle.clamp_max(x, max=None, - name=None) + *, + out=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致,PyTorch 相比 Paddle 支持更多其他参数,具体如下: ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | ------------- | ------------ | ------------------------------------------------------ | | input | x | 表示输入的 Tensor ,仅参数名不一致。 | -| - | min | 表示裁剪的最小值。PyTorch 无此参数, Paddle 保持默认即可。 | | max | max | 表示裁剪的最大值。 | -| out | - | 表示输出的 Tensor , Paddle 无此参数,需要转写。 | - - -### 转写示例 -#### out:指定输出 -```python -# PyTorch 写法 -torch.clamp_max(input, max=0.5, out=y) - -# Paddle 写法 -paddle.assign(paddle.clip(input, max=0.5), y) -``` +| out | out | 表示输出的 Tensor。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cholesky.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cholesky.md index f31da904b59..1dbee54faca 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cholesky.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cholesky.md @@ -6,26 +6,15 @@ torch.linalg.cholesky(input, *, upper=False, out=None) ### [paddle.linalg.cholesky](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/linalg/cholesky_cn.html#paddle.linalg.cholesky) ```python -paddle.linalg.cholesky(x, upper=False, name=None) +paddle.linalg.cholesky(x, upper=False, name=None, *, out=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致。 ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | ------- | ------- | ------- | -| input | x | 表示输入参数为多维 Tensor,它的维度应该为 [*, M, N],其中*为零或更大的批次尺寸,并且最里面的两个维度上的矩阵都应为对称的正定矩阵,仅参数名不一致。 | +| input | x | 表示输入参数为多维 Tensor,它的维度应该为 [*, M, N],其中*为零或更大的批次尺寸,并且最里面的两个维度上的矩阵都应为对称的正定矩阵,仅参数名不一致。 别名 ``input``。 | | upper | upper | 表示是否返回上三角矩阵或下三角矩阵。 | -| out | - | 表示输出的 Tensor ,Paddle 无此参数,需要转写。 | - -### 转写示例 -#### out: 输出的 Tensor -```python -# PyTorch 写法 -torch.linalg.cholesky(x, upper=False, out=output) - - -# Paddle 写法 -paddle.assign(paddle.linalg.cholesky(x, upper=False),output) -``` +| out | out | 表示输出的 Tensor。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cross.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cross.md index 1951b76f63f..4d0a53013b0 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cross.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.cross.md @@ -6,26 +6,16 @@ torch.linalg.cross(input, other, *, dim=- 1, out=None) ### [paddle.cross](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/cross_cn.html#paddle.cross) ```python -paddle.cross(x, y, axis=None, name=None) +paddle.cross(x, y, axis=-1, name=None, *, out=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致。 ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | ----------------------------------- | ------------ | ----------------------------------------------------------------------- | -| input | x | 表示输入的 Tensor ,仅参数名不一致。 | -| other | y | 表示输入的 Tensor ,仅参数名不一致。 | -| dim | axis | 表示进行运算的维度,参数默认值不一致。PyTorch 默认为`-1`,Paddle 默认为 `None`。 | -| out | - | 表示输出的 Tensor , Paddle 无此参数,需要转写。 | - -### 转写示例 -#### out:指定输出 -```python -# PyTorch 写法 -torch.linalg.cross(input, other, dim=1, out=y) - -# Paddle 写法 -paddle.assign(paddle.cross(input, other, axis=1) , y) -``` +| input | x | 表示输入的 Tensor ,仅参数名不一致。 别名 ``input``。 | +| other | y | 表示输入的 Tensor ,仅参数名不一致。 别名 ``other``。 | +| dim | axis | 表示进行运算的维度。别名 ``dim``。 | +| out | out | 表示输出的 Tensor。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.eigh.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.eigh.md index ba6b567831e..1eb341b2af5 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.eigh.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.eigh.md @@ -6,25 +6,15 @@ torch.linalg.eigh(input, UPLO='L', *, out=None) ### [paddle.linalg.eigh](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/linalg/eigh_cn.html#paddle.linalg.eigh) ```python -paddle.linalg.eigh(x, UPLO='L', name=None) +paddle.linalg.eigh(x, UPLO='L', name=None, *, out=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致。 ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | ------- | ------------ | ------------------------------------------------ | -| input | x | 输入 Tensor,仅参数名不一致。 | +| input | x | 输入 Tensor,仅参数名不一致。 别名 ``input``。 | | UPLO | UPLO | 表示计算上三角或者下三角矩阵。 | -| out | - | 表示输出的 Tensor , Paddle 无此参数,需要转写。 | - -### 转写示例 -#### out 参数:输出的 Tensor -```python -# PyTorch 写法: -torch.linalg.eigh(x, out=y) - -# Paddle 写法: -paddle.assign(paddle.linalg.eigh(x), y) -``` +| out | out | 表示输出的 Tensor 元组。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.qr.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.qr.md index 33f52bec59e..572e2c7c882 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.qr.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.linalg.qr.md @@ -6,10 +6,10 @@ torch.linalg.qr(A, mode='reduced', *, out=None) ### [paddle.linalg.qr](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/linalg/qr_cn.html#paddle.linalg.qr) ```python -paddle.linalg.qr(x, mode='reduced', name=None) +paddle.linalg.qr(x, mode='reduced', name=None, *, out=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致,参数名和返回值有差异,具体如下: ### 参数映射 @@ -17,14 +17,37 @@ PyTorch 相比 Paddle 支持更多其他参数,具体如下: | ------- | ------------ | -------------------------------------------------- | | A | x | 输入 Tensor,仅参数名不一致。 | | mode | mode | 控制正交三角分解的行为。 | -| out | - | 表示输出的 Tensor,Paddle 无此参数,需要转写。 | +| out | out | 输出的 Tensor 元组,Paddle 已支持此参数。 | + +### 返回值差异 + +`mode='r'` 时,两者返回值不同: +- **PyTorch**:返回 `(Q, R)` 具名元组,Q 为空张量。 +- **Paddle**:直接返回单个 Tensor **R**(不包含 Q)。 + +因此,对 ``mode='r'`` 的返回值需注意解包方式。 ### 转写示例 -#### out 参数:输出的 Tensor +#### mode='r' 的返回值 ```python # PyTorch 写法: -torch.linalg.qr(x, out=y) +r = torch.linalg.qr(x, mode='r') # 返回 (Q, R) 元组, R 在索引 1 # Paddle 写法: -paddle.assign(paddle.linalg.qr(x), y) +r = paddle.linalg.qr(x, mode='r') # 直接返回 Tensor R +``` + +#### out 参数:输出的 Tensor +```python +# PyTorch 写法 (mode='reduced'): +torch.linalg.qr(x, out=(q, r)) + +# Paddle 写法 (mode='reduced'): +paddle.linalg.qr(x, out=(q, r)) + +# PyTorch 写法 (mode='r',out 为 (Q, R) 元组): +torch.linalg.qr(x, mode='r', out=(q, r)) + +# Paddle 写法 (mode='r',out 为单个 Tensor): +paddle.linalg.qr(x, mode='r', out=r) ``` diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.ELU.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.ELU.md index 6b2cbe52706..7d1fb4c6869 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.ELU.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.ELU.md @@ -8,13 +8,15 @@ torch.nn.ELU(alpha=1.0, ### [paddle.nn.ELU](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/nn/ELU_cn.html#paddle.nn.ELU) ```python paddle.nn.ELU(alpha=1.0, + inplace=False, name=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致。 + ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | ------------- | ------------ | ------------------------------------------------------ | | alpha | alpha | 表示公式中的超参数。 | -| inplace | - | 在不更改变量的内存地址的情况下,直接修改变量的值,Paddle 无此参数,一般对网络训练结果影响不大,可直接删除。 | +| inplace | inplace | 在不更改变量的内存地址的情况下,直接修改变量的值,默认值为 False。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.elu.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.elu.md deleted file mode 100644 index 53db8503b7d..00000000000 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.nn.functional.elu.md +++ /dev/null @@ -1,20 +0,0 @@ -## [ torch 参数更多 ]torch.nn.functional.elu -### [torch.nn.functional.elu](https://docs.pytorch.org/docs/stable/generated/torch.nn.functional.elu.html#torch.nn.functional.elu) -```python -torch.nn.functional.elu(input, alpha=1.0, inplace=False) -``` - -### [paddle.nn.functional.elu](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/nn/functional/elu_cn.html#paddle.nn.functional.elu) -```python -paddle.nn.functional.elu(x, alpha=1.0, name=None) -``` - -PyTorch 相比 Paddle 支持更多其他参数,具体如下: - -### 参数映射 - -| PyTorch | PaddlePaddle | 备注 | -| ------- | ------------ | --------------------------------------------------------------------------------------------------------------- | -| input | x | 输入的 Tensor,仅参数名不一致。 | -| alpha | alpha | alpha 参数。 | -| inplace | - | 表示在不更改变量的内存地址的情况下,直接修改变量的值,Paddle 无此参数,一般对网络训练结果影响不大,可直接删除。 | diff --git a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.qr.md b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.qr.md index a7d5f2b5ba5..fd31cc51b1c 100644 --- a/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.qr.md +++ b/docs/guides/model_convert/convert_from_pytorch/api_difference/torch_more_args/torch.qr.md @@ -4,44 +4,27 @@ torch.qr(input, some=True, *, out=None) ``` -### [paddle.linalg.qr](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/linalg/qr_cn.html#paddle.linalg.qr) +### [paddle.qr](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/qr_cn.html) ```python -paddle.linalg.qr(x, mode='reduced', name=None) +paddle.qr(input, some=True, *, out=None) ``` -PyTorch 相比 Paddle 支持更多其他参数,具体如下: +两者功能一致,参数映射如下: ### 参数映射 | PyTorch | PaddlePaddle | 备注 | | ------------- | ------------ | ------------------------------------------------------ | -| input | x | 表示输入 Tensor,仅参数名不一致。 | -| some | mode | 表示 QR 分解的行为。 需进行转写。 | -| out | - | 表示输出的 Tensor 元组。 Paddle 无此参数,需要转写。 | +| input | input | 表示输入 Tensor。 | +| some | some | 表示 QR 分解的行为。 | +| out | out | 表示输出的 Tensor 元组。 | ### 转写示例 -#### some:控制 QR 分解的行为 +#### 功能一致 ```python -# 当进行完整的 QR 分解时 -# PyTorch 写法 -q, r = torch.qr(x, some=False) - -# Paddle 写法 -q, r = paddle.linalg.qr(x, mode='complete') - -#当进行减少的 QR 分解时 # PyTorch 写法 q, r = torch.qr(x, some=True) # Paddle 写法 -q, r = paddle.linalg.qr(x, mode='reduced') -``` - -#### out:指定输出 -```python -# PyTorch 写法 -torch.qr(x, out = (q, r) ) - -# Paddle 写法 -q, r = paddle.linalg.qr(x) +q, r = paddle.qr(x, some=True) ```