Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/api/paddle/abs_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
abs
-------------------------------

.. py:function:: paddle.abs(x, name=None)
.. py:function:: paddle.abs(x, name=None, *, out=None)



Expand All @@ -15,9 +15,13 @@ abs

参数
:::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float16、float32、float64、complex64、complex128。
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float16、float32、float64、complex64、complex128。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
:::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
:::::::::
输出 Tensor,与 ``x`` 维度相同、数据类型相同。
Expand Down
3 changes: 1 addition & 2 deletions docs/api/paddle/addmv_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
addmv
-------------------------------

.. py:function:: paddle.addmv(input, mat, vec, beta=1, alpha=1, name=None, *, out=None)
.. py:function:: paddle.addmv(input, mat, vec, beta=1, alpha=1, *, out=None)

执行矩阵 ``mat`` 和向量 ``vec`` 的矩阵-向量乘法,并将其加到输入 Tensor 上。

Expand All @@ -16,7 +16,6 @@ addmv
- **vec** (Tensor) - 待乘的向量。
- **beta** (float,可选) - input 的乘数,默认值为 1。
- **alpha** (float,可选) - mat @ vec 的乘数,默认值为 1。
- **name** (str,可选) - 操作名称,默认值为 None。

关键字参数
:::::::::
Expand Down
3 changes: 1 addition & 2 deletions docs/api/paddle/addr_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
addr
-------------------------------

.. py:function:: paddle.addr(input, vec1, vec2, beta=1, alpha=1, name=None, *, out=None)
.. py:function:: paddle.addr(input, vec1, vec2, beta=1, alpha=1, *, out=None)

执行向量 ``vec1`` 和向量 ``vec2`` 的外积,并将其加到输入矩阵上。

Expand All @@ -16,7 +16,6 @@ addr
- **vec2** (Tensor) - 第二个向量。
- **beta** (float,可选) - input 的乘数,默认值为 1。
- **alpha** (float,可选) - 外积的乘数,默认值为 1。
- **name** (str,可选) - 操作名称,默认值为 None。

关键字参数
:::::::::
Expand Down
11 changes: 8 additions & 3 deletions docs/api/paddle/bitwise_left_shift_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
bitwise_left_shift
-------------------------------

.. py:function:: paddle.bitwise_left_shift(x, y, is_arithmetic=True, out=None, name=None)
.. py:function:: paddle.bitwise_left_shift(x, y, is_arithmetic=True, name=None, *, out=None)

对 Tensor ``x`` 和 ``y`` 逐元素进行 ``按位算术(或逻辑)左移`` 运算。

Expand Down Expand Up @@ -45,15 +45,20 @@ bitwise_left_shift
``paddle.bitwise_left_shift`` 遵守 broadcasting,如您想了解更多,请参见 `Tensor 介绍`_ .

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

参数
::::::::::::

- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:uint8,int8,int16,int32,int64。别名 ``other``。
- **is_arithmetic** (bool) - 用于表明是否执行算术位移,True 表示算术位移,False 表示逻辑位移。默认值为 True,表示算术位移。
- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
- **is_arithmetic** (bool,可选) - 用于表明是否执行算术位移,True 表示算术位移,False 表示逻辑位移。默认值为 True,表示算术位移。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。


返回
::::::::::::
Expand Down
11 changes: 8 additions & 3 deletions docs/api/paddle/bitwise_right_shift_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
bitwise_right_shift
-------------------------------

.. py:function:: paddle.bitwise_right_shift(x, y, is_arithmetic=True, out=None, name=None)
.. py:function:: paddle.bitwise_right_shift(x, y, is_arithmetic=True, name=None, *, out=None)

对 Tensor ``x`` 和 ``y`` 逐元素进行 ``按位算术(或逻辑)右移`` 运算。

Expand All @@ -14,15 +14,20 @@ bitwise_right_shift
``paddle.bitwise_right_shift`` 遵守 broadcasting,如您想了解更多,请参见 `Tensor 介绍`_ .

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

参数
::::::::::::

- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:uint8,int8,int16,int32,int64。别名 ``other``。
- **is_arithmetic** (bool) - 用于表明是否执行算术位移,True 表示算术位移,False 表示逻辑位移。默认值为 True,表示算术位移。
- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
- **is_arithmetic** (bool,可选) - 用于表明是否执行算术位移,True 表示算术位移,False 表示逻辑位移。默认值为 True,表示算术位移。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。

返回
::::::::::::
``按位算术(逻辑)右移`` 运算后的结果 ``Tensor``,数据类型与 ``x`` 相同。
Expand Down
9 changes: 5 additions & 4 deletions docs/api/paddle/bmm_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
bmm
-------------------------------

.. py:function:: paddle.bmm(x, y, name=None, *, out=None)
.. py:function:: paddle.bmm(x, y, out_dtype=None, name=None, *, out=None)



Expand All @@ -17,8 +17,9 @@ bmm
参数
:::::::::

- **x** (Tensor) - 输入变量,类型为 Tensor。别名 ``input``。
- **y** (Tensor) - 输入变量,类型为 Tensor。别名 ``other``。
- **x** (Tensor) - 第一个输入 Tensor。别名 ``input``。
- **y** (Tensor) - 第二个输入 Tensor。别名 ``mat2``。
- **out_dtype** (paddle.dtype|None,可选) - 输出的数据类型。目前仅支持在动态图中将 CUDA 上数据类型为 float16 或 bfloat16 的输入转换为 ``paddle.float32`` 输出,两个输入 Tensor 的数据类型必须相同。为保持向后兼容性,当恰好传入三个位置参数且第三个参数为字符串时,该参数会被视为 ``name``。如需以位置参数传入 ``out_dtype``,请使用 ``paddle.float32`` 等数据类型对象;若使用字符串数据类型,请通过 ``out_dtype="float32"`` 传入。当第 4 个位置参数提供 ``name`` 时,字符串数据类型也可作为第 3 个位置参数传入,例如 ``paddle.bmm(x, y, "float32", "my_name")``。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
Expand All @@ -28,7 +29,7 @@ bmm

返回
:::::::::
Tensor,矩阵相乘后的结果
Tensor,批量矩阵相乘后的结果。未指定 ``out_dtype`` 时,输出的数据类型与输入相同

代码示例
:::::::::
Expand Down
10 changes: 7 additions & 3 deletions docs/api/paddle/bucketize_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
bucketize
-------------------------------

.. py:function:: paddle.bucketize(x, sorted_sequence, out_int32=False, right=False, name=None)
.. py:function:: paddle.bucketize(x, sorted_sequence, out_int32=False, right=False, name=None, *, out=None)

将根据给定的一维 Tensor ``sorted_sequence`` 返回输入 ``x`` 对应的桶索引。

参数
::::::::::
- **x** (Tensor) - 输入的 N 维 Tensor,支持的数据类型:int32、int64、float32、float64。
- **sorted_sequence** (Tensor) - 输入的一维 Tensor,支持的数据类型:int32、int64、float32、float64。该 Tensor 的数值在其最后一个维度递增。
- **x** (Tensor) - 输入的 N 维 Tensor,支持的数据类型:int32、int64、float32、float64。别名 ``input``。
- **sorted_sequence** (Tensor) - 输入的一维 Tensor,支持的数据类型:int32、int64、float32、float64。该 Tensor 的数值在其最后一个维度递增。别名 ``boundaries``。
- **out_int32** (bool,可选) - 输出的数据类型支持 int32、int64。默认值为 False,表示默认的输出数据类型为 int64。
- **right** (bool,可选) - 根据给定 ``x`` 在 ``sorted_sequence`` 查找对应的上边界或下边界。如果 ``sorted_sequence`` 的值为 nan 或 inf,则返回最内层维度的大小。默认值为 False,表示在 ``sorted_sequence`` 的查找给定 ``x`` 的下边界。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
:::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::
Tensor(与 ``x`` 维度相同),如果参数 ``out_int32`` 为 False,则返回数据类型为 int64 的 Tensor,否则将返回 int32 的 Tensor。
Expand Down
15 changes: 7 additions & 8 deletions docs/api/paddle/ceil_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
ceil
-------------------------------

.. py:function:: paddle.ceil(x, name=None)
.. py:function:: paddle.ceil(x, name=None, *, out=None)



Expand All @@ -14,20 +14,19 @@ ceil
out = \left \lceil x \right \rceil


.. note::
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``input=tensor_x`` 等价于 ``x=tensor_x``。

参数
::::::::::::

- **x** (Tensor) - 输入的 Tensor,数据类型支持 float32, float64, float16, bfloat16, uint8, int8, int16, int32, int64。
别名: ``input``
- **x** (Tensor) - 输入的 Tensor,数据类型支持 float32, float64, float16, bfloat16, uint8, int8, int16, int32, int64。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **out** (Tensor,可选) - 指定输出结果的 ``Tensor``,默认值为 None。

关键字参数
:::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
输出 Tensor,与 ``x`` 维度相同、数据类型相同
输出 Tensor,与 ``x`` 维度相同。若 ``x`` 为整数类型,则自动转换为 float32

代码示例
::::::::::::
Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/column_stack_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
column_stack
-------------------------------

.. py:function:: paddle.column_stack(x, name=None)
.. py:function:: paddle.column_stack(x, name=None, *, out=None)

沿水平轴堆叠输入 ``x`` 中的所有张量。 ``x`` 中的每个张量 ``tensor`` 如果在堆叠之前 ``tensor.ndim < 2`` ,则首先被整形为 ``(tensor.numel(), 1)``。所有张量必须具有相同的数据类型。

Expand All @@ -16,9 +16,13 @@ column_stack
参数
::::::::::::

- **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`` 、 ``int8``、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。别名 ``tensors``
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
:::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
Tensor,与输入数据类型相同的堆叠张量。
Expand Down
9 changes: 6 additions & 3 deletions docs/api/paddle/compat/nanmedian_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
nanmedian
-------------------------------

.. py:function:: paddle.compat.nanmedian(input, *, dim=None, keepdim=False, *, out=None)
.. py:function:: paddle.compat.nanmedian(input, dim=None, keepdim=False, *, out=None)

PyTorch 兼容的 :ref:`cn_api_paddle_nanmedian` 版本,提供完全一致的函数签名与行为:
- 忽略 NaN 元素计算中位数。
Expand All @@ -15,10 +15,13 @@ PyTorch 兼容的 :ref:`cn_api_paddle_nanmedian` 版本,提供完全一致的

参数
::::::::::
- **input** (Tensor) - 输入 N 维 Tensor,支持 bfloat16、float16、float32、float64 数据类型。
- **input** (Tensor) - 输入 N 维 Tensor,支持 bfloat16、float16、float32、float64、int32、int64 数据类型。
- **dim** (int,可选) - 指定计算中位数的维度。为 ``None`` 时计算全局中位数。默认 ``None``。
- **keepdim** (bool,可选) - 是否保留被约简的维度。默认 ``False``。
- **out** (tuple(Tensor, Tensor)|Tensor,可选) - 关键字参数。当指定 ``dim`` 时,可传入二元组 ``(values, indices)`` 用于原位写回中位数与索引;当未指定 ``dim`` 时,可传入单个 ``Tensor`` 用于写回标量结果。默认 ``None``。

关键字参数
::::::::::
- **out** (tuple(Tensor, Tensor)|Tensor,可选) - 当指定 ``dim`` 时,可传入二元组 ``(values, indices)`` 用于原位写回中位数与索引;当未指定 ``dim`` 时,可传入单个 ``Tensor`` 用于写回标量结果。默认 ``None``。

返回
::::::::::
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/compat/nn/Linear_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Linear
-------------------------------

.. py:class:: paddle.compat.nn.Linear(in_features, out_features, bias, device=None, dtype=None)
.. py:class:: paddle.compat.nn.Linear(in_features, out_features, bias=True, device=None, dtype=None)

PyTorch 兼容的 :ref:`cn_api_paddle_nn_Linear` 版本:

Expand All @@ -15,7 +15,7 @@ PyTorch 兼容的 :ref:`cn_api_paddle_nn_Linear` 版本:

其中 :math:`W` 是权重张量, :math:`b` 是偏置张量, :math:`X` 是输入张量

- 与 PyTorch 一致的默认可视化方法: Kaiming normal 用于权重初始化,平均分布用于偏置初始化
- 与 PyTorch 一致的默认可视化方法:权重与偏置均使用均匀分布初始化
- 支持设定 ``Linear`` 的数据类型以及运行设备

使用前请详细参考:`【仅参数名不一致】torch.nn.Linear`_ 以确定是否使用此模块。
Expand Down
8 changes: 2 additions & 6 deletions docs/api/paddle/conj_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,17 @@
conj
-------------------------------

.. py:function:: paddle.conj(x, name=None, *, out=None)
.. py:function:: paddle.conj(x, name=None)


是逐元素计算 Tensor 的共轭运算。

参数
::::::::::::

- **x** (Tensor) - 输入的复数值的 Tensor,数据类型为:complex64、complex128、bfloat16、float16、float32、float64、int32 或 int64。
- **x** (Tensor) - 输入的复数值的 Tensor,数据类型为:complex64、complex128、bfloat16、float16、float32、float64、int32 或 int64。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 ``None``。

关键字参数
:::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::

Expand Down
8 changes: 4 additions & 4 deletions docs/api/paddle/cuda/Stream_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
Stream
------

.. py:class:: paddle.cuda.Stream(device=None, priority=0, blocking=False)
.. py:class:: paddle.cuda.Stream(device=None, priority=2, stream_base=None)

CUDA 流类,用于管理异步操作。

参数
::::::::::::
- **device** (int|paddle.Place|str|int|None) - 设备 ID 或设备对象
- **priority** (int, 可选) - 流的优先级,默认为 None; 可以是 1 或-1(高优先级)或 0 或 2(低优先级)。默认情况下,流具有优先级 0
- **blocking** (bool|None,可选) - stream 是否同步执行。默认值为 False
- **device** (int|paddle.Place|str|int|None,可选) - 设备 ID 或设备对象
- **priority** (int, 可选) - 流的优先级,可以是 1 或 -1(高优先级)或 0 或 2(低优先级)。默认值为 2
- **stream_base** (_InitStreamBase|None,可选) - 用于初始化流的底层 StreamBase 对象。默认值为 None

代码示例
::::::::::::
Expand Down
10 changes: 7 additions & 3 deletions docs/api/paddle/cumprod_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
cumprod
-------------------------------

.. py:function:: paddle.cumprod(x, dim=None, dtype=None, name=None)
.. py:function:: paddle.cumprod(x, dim=None, dtype=None, name=None, *, out=None)



Expand All @@ -14,11 +14,15 @@ cumprod

参数
:::::::::
- **x** (Tensor) - 累乘的输入,需要进行累乘操作的 tensor。
- **dim** (int,可选) - 指明需要累乘的维度,取值范围需在[-x.rank,x.rank)之间,其中 x.rank 表示输入 tensor x 的维度,-1 代表最后一维。
- **x** (Tensor) - 累乘的输入,需要进行累乘操作的 tensor。别名 ``input``。
- **dim** (int,可选) - 指明需要累乘的维度,取值范围需在[-x.rank,x.rank)之间或为 None,其中 x.rank 表示输入 tensor x 的维度,-1 代表最后一维。默认值为 None,此时对展平后的数组计算累乘
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 tensor 的数据类型,支持 int32、int64、bfloat16、float16、float32、float64、complex64、complex128。如果指定了,那么在执行操作之前,输入的 tensor 将被转换为 dtype 类型。这对于防止数据类型溢出非常有用。默认为:None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
:::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
:::::::::
``Tensor``,累乘操作的结果。
Expand Down
9 changes: 6 additions & 3 deletions docs/api/paddle/device/Event_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@
Event
-------------------------------

.. py:class:: paddle.device.Event(device=None, enable_timing=False, blocking=False, interprocess=False)
.. py:class:: paddle.device.Event(enable_timing=False, blocking=False, interprocess=False)

event 的句柄。

参数
::::::::::::

- **device** (paddle.CUDAPlace|paddle.CustomPlace|str) - 希望分配 event 的设备或设备类型。如果为 None,则为当前期望的 place。默认值为 None。
- **enable_timing** (bool,可选) - event 是否需要统计时间。默认值为 False。
- **blocking** (bool,可选) - wait()函数是否被阻塞。默认值为 False。
- **interprocess** (bool,可选) - event 是否能在进程间共享。默认值为 False。

返回
::::::::::::
None
``Event`` 对象。

.. note::

``device`` 参数已移除,Event 始终使用当前设备上下文。``paddle.device.Event`` 与 ``paddle.cuda.Event`` 等价。

代码示例
::::::::::::
Expand Down
Loading