Skip to content
Merged
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
2 changes: 1 addition & 1 deletion docs/api/paddle/all_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ all
别名: ``dim``
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。除非 keepdim 为 True,否则输出 Tensor 的维度将比输入 Tensor 小一维,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **out** (Tensor,可选) - 指定输出结果的 `Tensor`,默认值为 None。
- **out** (Tensor,可选) - 指定输出结果的 ``Tensor``,默认值为 None。

返回
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/amp/decorate_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ decorate
- **master_weight** (bool|None,可选) - 是否使用 master weight 策略。支持 master weight 策略的优化器包括 ``adam``、``adamW``、``momentum``,默认值为 None,在 ``O2`` 模式下使用 master weight 策略。
- **save_dtype** (str|None,可选) - 网络存储类型,可为 float16、bfloat16、float32、float64。通过 ``save_dtype`` 可指定通过 ``paddle.save`` 和 ``paddle.jit.save`` 存储的网络参数数据类型。默认为 None,采用现有网络参数类型进行存储。
- **master_grad** (bool, 可选) - 在 ``O2`` 模式下是否使用 float32 类型的权重梯度进行梯度裁剪、权重衰减、权重更新等计算。如果被启用,在反向传播结束后权重的梯度将会是 float32 类型。默认值:False,模型仅保存一份 float16 类型的权重梯度。
- **excluded_layers** (Layer|list of Layer, 可选) - 指定不需要被转换的层,在 ``O2`` 模式下,这些层的权重将始终保持 float32 类型。 `excluded_layers` 可以指定为 Layer 的实例/类型,或 Layer 的实例/类型的列表。默认为 None,整个模型的权重将转换为 float16 或 bfloat16 类型。
- **excluded_layers** (Layer|list of Layer, 可选) - 指定不需要被转换的层,在 ``O2`` 模式下,这些层的权重将始终保持 float32 类型。 ``excluded_layers`` 可以指定为 Layer 的实例/类型,或 Layer 的实例/类型的列表。默认为 None,整个模型的权重将转换为 float16 或 bfloat16 类型。


代码示例
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/argmax_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ argmax
::::::::
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、float32、float64、int16、int32、int64、uint8。
别名: ``input``
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数,``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 `x` 进行平铺展开,返回最大值的索引。
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴,``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数,``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 ``x`` 进行平铺展开,返回最大值的索引。
别名: ``dim``
- **keepdim** (bool,可选) - 是否在输出 Tensor 中保留减小的维度。如果 keepdim 为 True,则输出 Tensor 和 x 具有相同的维度(减少的维度除外,减少的维度的大小为 1),默认值为 False。
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Tensor 的数据类型,可选值为 int32,int64,默认值为 int64,将返回 int64 类型的结果。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/argmin_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ argmin
::::::::
- **x** (Tensor) - 输入的多维 ``Tensor``,支持的数据类型:float16、float32、float64、int16、int32、int64、uint8。
别名: ``input``
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴, ``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数, ``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 `x` 进行平铺展开,返回最小值的索引。
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴, ``axis`` 的有效范围是[-R, R),R 是输入 ``x`` 的维度个数, ``axis`` 为负数时,进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None,将会对输入的 ``x`` 进行平铺展开,返回最小值的索引。
别名: ``dim``
- **keepdim** (bool,可选) - 是否保留进行最小值索引操作的轴,默认值为 False。
- **dtype** (str|paddle.dtype|np.dtype,可选) - 输出 Tensor 的数据类型,可选值为 int32、int64,默认值为'int64',将返回 int64 类型的结果。
Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/bitwise_and_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ bitwise_and
.. _Tensor 介绍: ../../guides/beginner/tensor_cn.html#id7
参数
::::::::::::
- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``other``。
- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``other``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

返回
::::::::::::
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/bitwise_invert_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ bitwise_invert
参数
::::::::::::

- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。
- **out** (Tensor,可选)- 输出的结果 `Tensor`,是与输入数据类型相同的 N-D `Tensor`。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。
- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/bitwise_left_shift__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Inplace 版本的 :ref:`cn_api_paddle_bitwise_left_shift` API,对输入 ``x``
参数
::::::::::::

- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``other``。
- **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,表示算术位移。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/bitwise_left_shift_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ bitwise_left_shift
参数
::::::::::::

- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``other``。
- **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 来保存输出结果。
- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。


Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/bitwise_not_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ bitwise_not

参数
::::::::::::
- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``input``。
- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

返回
::::::::::::
Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/bitwise_or_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ bitwise_or

参数
::::::::::::
- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名: ``input``
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名: ``other``
- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名: ``input``
- **y** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名: ``other``
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

返回
::::::::::::
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/bitwise_right_shift__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Inplace 版本的 :ref:`cn_api_paddle_bitwise_right_shift` API,对输入 ``x``
参数
::::::::::::

- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``other``。
- **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,表示算术位移。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/bitwise_right_shift_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ bitwise_right_shift
参数
::::::::::::

- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:uint8,int8,int16,int32,int64。别名 ``other``。
- **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 来保存输出结果。
- **out** (Tensor,可选)- 输出的结果 ``Tensor``,是与输入数据类型相同的 N-D ``Tensor``。默认值为 None,此时将创建新的 Tensor 来保存输出结果。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
6 changes: 3 additions & 3 deletions docs/api/paddle/bitwise_xor_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ bitwise_xor

参数
::::::::::::
- **x** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D `Tensor`,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``other``。
- **x** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``input``。
- **y** (Tensor)- 输入的 N-D ``Tensor``,数据类型为:bool,uint8,int8,int16,int32,int64。别名 ``other``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

返回
::::::::::::
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/callbacks/ReduceLROnPlateau_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ ReduceLROnPlateau
::::::::::::

- **monitor** (str,可选) - 监视的指标名称。默认值:'loss'。
- **factor** (float,可选) - 学习率减小的因子。`new_lr = lr * factor`。默认值:0.1。
- **factor** (float,可选) - 学习率减小的因子。``new_lr = lr * factor``。默认值:0.1。
- **patience** (int,可选) - 多少个 epoch 监视的指标没有提升后就减小学习率。默认值:10。
- **verbose** (int,可选) - 可视化的模式。0 表示不打印任何信息,1 表示打印信息。默认值:1。
- **mode** (int,可选) - 必须是 `{'auto', 'min', 'max'}` 中的值。`'min'` 表示学习率会减少当监视的指标不再下降。`'max'` 表示学习率会减少当监视的指标不再上升。`'auto'` 会根据监视指标的名字来推理是使用 min 还是 max 模式,如果名字中包含 acc 则使用 max 模式,否则使用 min 模式。默认值:'auto'。
- **mode** (int,可选) - 必须是 ``{'auto', 'min', 'max'}`` 中的值。``'min'`` 表示学习率会减少当监视的指标不再下降。``'max'`` 表示学习率会减少当监视的指标不再上升。``'auto'`` 会根据监视指标的名字来推理是使用 min 还是 max 模式,如果名字中包含 acc 则使用 max 模式,否则使用 min 模式。默认值:'auto'。
- **min_delta** (float,可选) - 评判指标增大或减小的阈值。默认值:0。
- **cooldown** (int,可选) - 学习率减少后至少经过多少个 epoch 在进行正常的减少策略。默认值:0。
- **min_lr** (int,可选) - 学习率减小后的下限。默认值:0。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/ceil_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ ceil
- **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。

返回
::::::::::::
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/compat/nn/functional/softmax_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ softmax

- **input** (Tensor) - 输入的 ``Tensor``,数据类型为 bfloat16 、 float16 、 float32 或 float64。
- **dim** (int,可选) - 指定对输入 :attr:`input` 进行运算的轴。:attr:`dim` 的有效范围是 :math:`[-D, D)`,:math:`D` 是输入 :attr:`input` 的维度,:attr:`dim` 为负值时与 :math:`dim + D` 等价。默认值为 None。
- **dtype** (str,可选) - 输出 `Tensor` 的数据类型,支持 bfloat16、 float16、 float32、float64。
- **out** (Tensor,可选) - 指定输出结果的 `Tensor`,默认值为 None。
- **dtype** (str,可选) - 输出 ``Tensor`` 的数据类型,支持 bfloat16、 float16、 float32、float64。
- **out** (Tensor,可选) - 指定输出结果的 ``Tensor``,默认值为 None。

返回
::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/cuda/mem_get_info_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ mem_get_info
参数
::::::::::::

- **device** (DeviceLike) - 指定要查询的设备,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 `paddle.CUDAPlace(0)` 之类的设备实例。如果为 None(默认值)或未指定设备索引,则返回由 ``paddle.device.get_device()`` 给出的当前设备的统计信息。
- **device** (DeviceLike) - 指定要查询的设备,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 ``paddle.CUDAPlace(0)`` 之类的设备实例。如果为 None(默认值)或未指定设备索引,则返回由 ``paddle.device.get_device()`` 给出的当前设备的统计信息。

返回
:::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/cuda/memory_allocated_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ memory_allocated
参数
::::::::::::

- **device** (DeviceLike) - 指定要查询的设备,可以是 "int" 用来表示设备 id,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 `paddle.CUDAPlace(0)` 之类的设备实例。如果为 None(默认值)或未指定设备索引,则返回由 ``paddle.device.get_device()`` 给出的当前设备的统计信息。
- **device** (DeviceLike) - 指定要查询的设备,可以是 "int" 用来表示设备 id,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 ``paddle.CUDAPlace(0)`` 之类的设备实例。如果为 None(默认值)或未指定设备索引,则返回由 ``paddle.device.get_device()`` 给出的当前设备的统计信息。

返回
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/cuda/memory_reserved_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ memory_reserved
参数
::::::::::::

- **device** (DeviceLike) - 指定要查询的设备,可以是 "int" 用来表示设备 id,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 `paddle.CUDAPlace(0)` 之类的设备实例。如果为 None(默认值)或未指定设备索引,则返回由 ``paddle.device.get_device()`` 给出的当前设备的统计信息。
- **device** (DeviceLike) - 指定要查询的设备,可以是 "int" 用来表示设备 id,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 ``paddle.CUDAPlace(0)`` 之类的设备实例。如果为 None(默认值)或未指定设备索引,则返回由 ``paddle.device.get_device()`` 给出的当前设备的统计信息。

返回
::::::::::::
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/cuda/set_device_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ set_device
参数
::::::::::::

- **device** (DeviceLike) - 要设置的设备,可以是 "int" 用来表示设备 id,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 `paddle.CUDAPlace(0)` 之类的设备实例。
- **device** (DeviceLike) - 要设置的设备,可以是 "int" 用来表示设备 id,可以是形如 "gpu:0" 之类的设备描述字符串,也可以是 ``paddle.CUDAPlace(0)`` 之类的设备实例。

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