From 029db7142a1645b1540ed9b2ee12ede678fee8b7 Mon Sep 17 00:00:00 2001 From: youge325 Date: Wed, 31 Dec 2025 18:38:37 +0800 Subject: [PATCH 1/2] =?UTF-8?q?[API=20Compatibility=20No.2=E3=80=8135]=20a?= =?UTF-8?q?dd=20doc=20for=20baddbmm?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/paddle/baddbmm_cn.rst | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/docs/api/paddle/baddbmm_cn.rst b/docs/api/paddle/baddbmm_cn.rst index d23c8dadd9e..e085a1cd248 100644 --- a/docs/api/paddle/baddbmm_cn.rst +++ b/docs/api/paddle/baddbmm_cn.rst @@ -3,7 +3,7 @@ baddbmm ------------------------------- -.. py:function:: paddle.baddbmm(input, x, y, alpha=1.0, beta=1.0, name=None) +.. py:function:: paddle.baddbmm(input, x, y, beta=1.0, alpha=1.0, out_dtype=None, name=None, out=None) @@ -13,17 +13,25 @@ baddbmm 计算过程的公式为： .. math:: - out = alpha * x * y + beta * input + out = \beta \times input + \alpha \times x \times y +其中 :math:`\beta` 和 :math:`\alpha` 是缩放因子。 + +.. note:: + 别名支持: 参数名 ``batch1`` 可替代 ``x``，参数名 ``batch2`` 可替代 ``y`` ，如 ``baddbmm(input=tensor_input, batch1=tensor_x, batch2=tensor_y, ...)`` 等价于 ``baddbmm(input=tensor_input, x=tensor_x, y=tensor_y, ...)`` 。 参数 :::::::::::: - - **input** (Tensor) - 输入 Tensor input，数据类型支持 bfloat16、float16、float32、float64。 - - **x** (Tensor) - 输入 Tensor x，数据类型支持 bfloat16、float16、float32、float64。 - - **y** (Tensor) - 输入 Tensor y，数据类型支持 bfloat16、float16、float32、float64。 - - **alpha** (float，可选) - 乘以 x*y 的标量，数据类型支持 float，默认值为 1.0。 + - **input** (Tensor) - 输入 Tensor input，必须是一个 2 维或 3 维张量，数据类型支持 bfloat16、float16、float32、float64。 + - **x** (Tensor) - 输入 Tensor x，必须是一个形状为 [b, n, p] 的 3 维张量，数据类型支持 bfloat16、float16、float32、float64。 + 别名：**batch1**。 + - **y** (Tensor) - 输入 Tensor y，必须是一个形状为 [b, p, m] 的 3 维张量，数据类型支持 bfloat16、float16、float32、float64。 + 别名：**batch2**。 - **beta** (float，可选) - 乘以 input 的标量，数据类型支持 float，默认值为 1.0。 + - **alpha** (float，可选) - 乘以 x*y 的标量，数据类型支持 float，默认值为 1.0。 + - **out_dtype** (paddle.dtype, 可选) - 输出数据类型，默认值为 None，表示输出数据类型与输入 input 数据类型一致。支持设置为以下数据类型：float16、bfloat16、float32、float64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + - **out** (Tensor, 可选) - 用于存储输出结果的 Tensor，必须是一个形状为 [b, n, m] 的 3 维张量，默认值为 None。若指定该参数，输出结果将存储在该 Tensor 中。 返回 :::::::::::: From ec2ef9d96d6679701f755dd649c42c740ed23746 Mon Sep 17 00:00:00 2001 From: youge325 Date: Wed, 31 Dec 2025 19:54:46 +0800 Subject: [PATCH 2/2] fix doc --- docs/api/paddle/baddbmm_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/baddbmm_cn.rst b/docs/api/paddle/baddbmm_cn.rst index e085a1cd248..b59e473a284 100644 --- a/docs/api/paddle/baddbmm_cn.rst +++ b/docs/api/paddle/baddbmm_cn.rst @@ -24,9 +24,9 @@ baddbmm - **input** (Tensor) - 输入 Tensor input，必须是一个 2 维或 3 维张量，数据类型支持 bfloat16、float16、float32、float64。 - **x** (Tensor) - 输入 Tensor x，必须是一个形状为 [b, n, p] 的 3 维张量，数据类型支持 bfloat16、float16、float32、float64。 - 别名：**batch1**。 + ``别名：batch1`` - **y** (Tensor) - 输入 Tensor y，必须是一个形状为 [b, p, m] 的 3 维张量，数据类型支持 bfloat16、float16、float32、float64。 - 别名：**batch2**。 + ``别名：batch2`` - **beta** (float，可选) - 乘以 input 的标量，数据类型支持 float，默认值为 1.0。 - **alpha** (float，可选) - 乘以 x*y 的标量，数据类型支持 float，默认值为 1.0。 - **out_dtype** (paddle.dtype, 可选) - 输出数据类型，默认值为 None，表示输出数据类型与输入 input 数据类型一致。支持设置为以下数据类型：float16、bfloat16、float32、float64。