Skip to content

Commit 54941df

Browse files
[API Compatiblity] update matmul、multiply doc (#7412)
* add alias and out * fix * fix * fix * fix * fix * fix * Apply suggestion from @sunzhongkai588 Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Apply suggestion from @sunzhongkai588 Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * Apply suggestion from @sunzhongkai588 Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com> * fix * format --------- Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>
1 parent d249598 commit 54941df

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

docs/api/paddle/matmul_cn.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,16 @@
33
matmul
44
-------------------------------
55

6-
.. py:function:: paddle.matmul(x, y, transpose_x=False, transpose_y=False, name=None)
6+
.. py:function:: paddle.matmul(x, y, transpose_x=False, transpose_y=False, name=None, *, out=None)
77
88
.. note::
99
计算两个 Tensor 的乘积,遵循完整的广播规则,关于广播规则,请参见 `Tensor 介绍`_ .
1010

1111
.. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
1212

13+
.. note::
14+
别名支持: 参数名 ``input`` 可替代 ``x``, ``other`` 可替代 ``y``;
15+
1316
并且其行为与 ``numpy.matmul`` 一致。目前,输入 Tensor 的维数可以是任意数量,``matmul`` 可以用于
1417
实现 ``dot`` , ``matmul`` 和 ``batchmatmul``。实际行为取决于输入 ``x`` 、输入 ``y`` 、 ``transpose_x`` ,
1518
``transpose_y``。具体如下:
@@ -31,10 +34,13 @@ matmul
3134
参数
3235
:::::::::
3336
- **x** (Tensor) - 输入变量,类型为 Tensor,数据类型为 bfloat16, float16, float32, float64。
37+
``别名:input``
3438
- **y** (Tensor) - 输入变量,类型为 Tensor,数据类型为 bfloat16, float16, float32, float64。
39+
``别名:other``
3540
- **transpose_x** (bool,可选) - 相乘前是否转置 x,默认值为 False。
3641
- **transpose_y** (bool,可选) - 相乘前是否转置 y,默认值为 False。
3742
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
43+
- **out** (Tensor,可选)- 输出的结果。该参数为仅关键字参数,默认值为 None。
3844

3945
返回
4046
::::::::::::

docs/api/paddle/multiply_cn.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
multiply
44
-------------------------------
55

6-
.. py:function:: paddle.multiply(x, y, name=None)
7-
6+
.. py:function:: paddle.multiply(x, y, name=None, *, out=None)
87
98
109
@@ -26,12 +25,19 @@ multiply
2625

2726
.. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
2827

28+
.. note::
29+
别名支持: 参数名 ``input`` 可替代 ``x``, ``other`` 可替代 ``y``;
30+
31+
2932
参数
3033
:::::::::
3134

3235
- **x** (Tensor)- 多维 ``Tensor``。数据类型为 ``bfloat16`` 、 ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64``、 ``bool``、 ``complex64`` 或 ``complex128``。
36+
``别名:input``
3337
- **y** (Tensor)- 多维 ``Tensor``。数据类型为 ``bfloat16`` 、 ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64``、 ``bool``、 ``complex64`` 或 ``complex128``。
38+
``别名:other``
3439
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
40+
- **out** (Tensor,可选)- 输出的结果。该参数为仅关键字参数,默认值为 None。
3541

3642

3743
返回

0 commit comments

Comments
 (0)