diff --git a/docs/api/paddle/all_cn.rst b/docs/api/paddle/all_cn.rst index 2d884316d59..a838a7a390d 100644 --- a/docs/api/paddle/all_cn.rst +++ b/docs/api/paddle/all_cn.rst @@ -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。 返回 ::::::::: diff --git a/docs/api/paddle/amp/decorate_cn.rst b/docs/api/paddle/amp/decorate_cn.rst index c50248ce10e..85e7ba843e3 100644 --- a/docs/api/paddle/amp/decorate_cn.rst +++ b/docs/api/paddle/amp/decorate_cn.rst @@ -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 类型。 代码示例 diff --git a/docs/api/paddle/argmax_cn.rst b/docs/api/paddle/argmax_cn.rst index 5f8755ddebc..34e3d1a0723 100644 --- a/docs/api/paddle/argmax_cn.rst +++ b/docs/api/paddle/argmax_cn.rst @@ -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 类型的结果。 diff --git a/docs/api/paddle/argmin_cn.rst b/docs/api/paddle/argmin_cn.rst index 81b0c347802..05c58479179 100644 --- a/docs/api/paddle/argmin_cn.rst +++ b/docs/api/paddle/argmin_cn.rst @@ -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 类型的结果。 diff --git a/docs/api/paddle/bitwise_and_cn.rst b/docs/api/paddle/bitwise_and_cn.rst index 26f32597d20..72489db73c3 100644 --- a/docs/api/paddle/bitwise_and_cn.rst +++ b/docs/api/paddle/bitwise_and_cn.rst @@ -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 来保存输出结果。 返回 :::::::::::: diff --git a/docs/api/paddle/bitwise_invert_cn.rst b/docs/api/paddle/bitwise_invert_cn.rst index 101720248ee..553368310ac 100644 --- a/docs/api/paddle/bitwise_invert_cn.rst +++ b/docs/api/paddle/bitwise_invert_cn.rst @@ -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。 返回 diff --git a/docs/api/paddle/bitwise_left_shift__cn.rst b/docs/api/paddle/bitwise_left_shift__cn.rst index 7e516028104..63ae295b60b 100644 --- a/docs/api/paddle/bitwise_left_shift__cn.rst +++ b/docs/api/paddle/bitwise_left_shift__cn.rst @@ -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。 diff --git a/docs/api/paddle/bitwise_left_shift_cn.rst b/docs/api/paddle/bitwise_left_shift_cn.rst index 28e9845fa4f..7d92b7c5ac0 100644 --- a/docs/api/paddle/bitwise_left_shift_cn.rst +++ b/docs/api/paddle/bitwise_left_shift_cn.rst @@ -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。 diff --git a/docs/api/paddle/bitwise_not_cn.rst b/docs/api/paddle/bitwise_not_cn.rst index d1d50d9166f..88eaa5f070f 100644 --- a/docs/api/paddle/bitwise_not_cn.rst +++ b/docs/api/paddle/bitwise_not_cn.rst @@ -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 来保存输出结果。 返回 :::::::::::: diff --git a/docs/api/paddle/bitwise_or_cn.rst b/docs/api/paddle/bitwise_or_cn.rst index 69e6788e9e4..4020d9aefa0 100644 --- a/docs/api/paddle/bitwise_or_cn.rst +++ b/docs/api/paddle/bitwise_or_cn.rst @@ -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 来保存输出结果。 返回 :::::::::::: diff --git a/docs/api/paddle/bitwise_right_shift__cn.rst b/docs/api/paddle/bitwise_right_shift__cn.rst index 1929b965fa6..c7b83963b47 100644 --- a/docs/api/paddle/bitwise_right_shift__cn.rst +++ b/docs/api/paddle/bitwise_right_shift__cn.rst @@ -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。 diff --git a/docs/api/paddle/bitwise_right_shift_cn.rst b/docs/api/paddle/bitwise_right_shift_cn.rst index b986312fa17..c76150d23f6 100644 --- a/docs/api/paddle/bitwise_right_shift_cn.rst +++ b/docs/api/paddle/bitwise_right_shift_cn.rst @@ -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。 返回 diff --git a/docs/api/paddle/bitwise_xor_cn.rst b/docs/api/paddle/bitwise_xor_cn.rst index 11cab4afc6d..10d383730d7 100644 --- a/docs/api/paddle/bitwise_xor_cn.rst +++ b/docs/api/paddle/bitwise_xor_cn.rst @@ -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 来保存输出结果。 返回 :::::::::::: diff --git a/docs/api/paddle/callbacks/ReduceLROnPlateau_cn.rst b/docs/api/paddle/callbacks/ReduceLROnPlateau_cn.rst index 438d28c8463..e053f1c92c1 100644 --- a/docs/api/paddle/callbacks/ReduceLROnPlateau_cn.rst +++ b/docs/api/paddle/callbacks/ReduceLROnPlateau_cn.rst @@ -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。 diff --git a/docs/api/paddle/ceil_cn.rst b/docs/api/paddle/ceil_cn.rst index 6bb5df9ee4e..28d2d923e04 100644 --- a/docs/api/paddle/ceil_cn.rst +++ b/docs/api/paddle/ceil_cn.rst @@ -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。 返回 :::::::::::: diff --git a/docs/api/paddle/compat/nn/functional/softmax_cn.rst b/docs/api/paddle/compat/nn/functional/softmax_cn.rst index 31bfe3d9aff..20e31f4a3d1 100644 --- a/docs/api/paddle/compat/nn/functional/softmax_cn.rst +++ b/docs/api/paddle/compat/nn/functional/softmax_cn.rst @@ -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。 返回 :::::::::: diff --git a/docs/api/paddle/cuda/mem_get_info_cn.rst b/docs/api/paddle/cuda/mem_get_info_cn.rst index 2688777241b..a6151544cd7 100644 --- a/docs/api/paddle/cuda/mem_get_info_cn.rst +++ b/docs/api/paddle/cuda/mem_get_info_cn.rst @@ -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()`` 给出的当前设备的统计信息。 返回 ::::::::: diff --git a/docs/api/paddle/cuda/memory_allocated_cn.rst b/docs/api/paddle/cuda/memory_allocated_cn.rst index 56547704641..d5cb655614e 100644 --- a/docs/api/paddle/cuda/memory_allocated_cn.rst +++ b/docs/api/paddle/cuda/memory_allocated_cn.rst @@ -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()`` 给出的当前设备的统计信息。 返回 :::::::::::: diff --git a/docs/api/paddle/cuda/memory_reserved_cn.rst b/docs/api/paddle/cuda/memory_reserved_cn.rst index 1fbb7da12bf..c10a84161ac 100644 --- a/docs/api/paddle/cuda/memory_reserved_cn.rst +++ b/docs/api/paddle/cuda/memory_reserved_cn.rst @@ -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()`` 给出的当前设备的统计信息。 返回 :::::::::::: diff --git a/docs/api/paddle/cuda/set_device_cn.rst b/docs/api/paddle/cuda/set_device_cn.rst index b0cf1a0caca..a092c3de602 100644 --- a/docs/api/paddle/cuda/set_device_cn.rst +++ b/docs/api/paddle/cuda/set_device_cn.rst @@ -10,7 +10,7 @@ set_device 参数 :::::::::::: - - **device** (DeviceLike) - 要设置的设备，可以是 "int" 用来表示设备 id，可以是形如 "gpu:0" 之类的设备描述字符串，也可以是 `paddle.CUDAPlace(0)` 之类的设备实例。 + - **device** (DeviceLike) - 要设置的设备，可以是 "int" 用来表示设备 id，可以是形如 "gpu:0" 之类的设备描述字符串，也可以是 ``paddle.CUDAPlace(0)`` 之类的设备实例。 代码示例 :::::::::::: diff --git a/docs/api/paddle/cumsum_cn.rst b/docs/api/paddle/cumsum_cn.rst index 770ff62b70a..51d07911c06 100644 --- a/docs/api/paddle/cumsum_cn.rst +++ b/docs/api/paddle/cumsum_cn.rst @@ -18,7 +18,7 @@ cumsum ::::::::: - **x** (Tensor) - 累加的输入，需要进行累加操作的 Tensor。别名 ``input``。 - **axis** (int，可选) - 指明需要累加的维度。-1 代表最后一维。默认：None，将输入展开为一维变量再进行累加计算。别名 ``dim``。 - - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出 Tensor 的数据类型，支持 int32、int64、bfloat16、float16、float32、float64、complex64、complex128。当输入 `x` 的类型是 int8/int16/int32 时，默认值是 int64；否则默认值是 None。如果不为 None，那么在执行操作之前，输入 Tensor 将被转换为 dtype。这对于防止数据类型溢出非常有用。 + - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出 Tensor 的数据类型，支持 int32、int64、bfloat16、float16、float32、float64、complex64、complex128。当输入 ``x`` 的类型是 int8/int16/int32 时，默认值是 int64；否则默认值是 None。如果不为 None，那么在执行操作之前，输入 Tensor 将被转换为 dtype。这对于防止数据类型溢出非常有用。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 关键字参数 diff --git a/docs/api/paddle/cumulative_trapezoid_cn.rst b/docs/api/paddle/cumulative_trapezoid_cn.rst index e0ab39f05f6..02641aa962c 100644 --- a/docs/api/paddle/cumulative_trapezoid_cn.rst +++ b/docs/api/paddle/cumulative_trapezoid_cn.rst @@ -12,7 +12,7 @@ cumulative_trapezoid ::::::::: - **y** (Tensor) - 输入多维 Tensor，可选的数据类型为 float16、float32、float64。 - - **x** (Tensor，可选) - ``y`` 中数值对应的浮点数所组成的 Tensor，类型与 ``y`` 相同，形状与 ``y`` 的形状相匹配；若 ``x`` 有输入，已知 ``y`` 的尺寸为 `[d_1, d_2, ... , d_n]` 且 `axis=k`，则 ``x`` 的尺寸只能为 `[d_k]` 或 `[d_1, d_2, ... , d_n]`；如果 ``x`` 为 None，则假定采样点均匀分布 ``dx``。 + - **x** (Tensor，可选) - ``y`` 中数值对应的浮点数所组成的 Tensor，类型与 ``y`` 相同，形状与 ``y`` 的形状相匹配；若 ``x`` 有输入，已知 ``y`` 的尺寸为 ``[d_1, d_2, ... , d_n]`` 且 ``axis=k``，则 ``x`` 的尺寸只能为 ``[d_k]`` 或 ``[d_1, d_2, ... , d_n]``；如果 ``x`` 为 None，则假定采样点均匀分布 ``dx``。 - **dx** (float，可选) - 相邻采样点之间的常数间隔；当 ``x`` 和 ``dx`` 均未指定时，``dx`` 默认为 1.0。 - **axis** (int，可选) - 计算 trapezoid rule 时 ``y`` 的维度。默认值 -1。别名 ``dim``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/device/device_guard_cn.rst b/docs/api/paddle/device/device_guard_cn.rst index 37adfaaeb5c..4bf6fd52230 100644 --- a/docs/api/paddle/device/device_guard_cn.rst +++ b/docs/api/paddle/device/device_guard_cn.rst @@ -13,7 +13,7 @@ device_guard 参数 :::::::::::: - - **device** (PlaceLike) - 指定的 device，可以是形如 "cpu", "gpu:0" 之类的设备描述字符串，也可以是 `paddle.CUDAPlace(0)`, `paddle.CPUPlace()` 之类的设备实例。 + - **device** (PlaceLike) - 指定的 device，可以是形如 "cpu", "gpu:0" 之类的设备描述字符串，也可以是 ``paddle.CUDAPlace(0)``, ``paddle.CPUPlace()`` 之类的设备实例。 代码示例 :::::::::::: diff --git a/docs/api/paddle/diag_cn.rst b/docs/api/paddle/diag_cn.rst index 751e85fbba9..34ca5362330 100644 --- a/docs/api/paddle/diag_cn.rst +++ b/docs/api/paddle/diag_cn.rst @@ -18,7 +18,7 @@ diag 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor`。它的形状可以是一维或二维。其数据类型应为 float16、float32、float64、int32、int64、complex64、complex128。别名 ``input`` 。 + - **x** (Tensor) - 输入的 ``Tensor``。它的形状可以是一维或二维。其数据类型应为 float16、float32、float64、int32、int64、complex64、complex128。别名 ``input`` 。 - **offset** (int，可选) - 对角线偏移量。正值表示上对角线，0 表示主对角线，负值表示下对角线。默认值为 0。别名 ``diagonal`` 。 - **padding_value** (int|float，可选) - 使用此值来填充指定对角线以外的区域。仅在输入为一维 Tensor 时生效。默认值为 0。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/distributed/fleet/utils/HDFSClient_cn.rst b/docs/api/paddle/distributed/fleet/utils/HDFSClient_cn.rst index c3ca1285b3c..ada42af945a 100644 --- a/docs/api/paddle/distributed/fleet/utils/HDFSClient_cn.rst +++ b/docs/api/paddle/distributed/fleet/utils/HDFSClient_cn.rst @@ -10,7 +10,7 @@ HDFSClient :::::::::::: - **hadoop_home** (str)：HADOOP HOME 地址。 - - **configs** (dict): HADOOP 文件系统配置。需包含 `fs.default.name` 和 `hadoop.job.ugi` 这两个字段。 + - **configs** (dict): HADOOP 文件系统配置。需包含 ``fs.default.name`` 和 ``hadoop.job.ugi`` 这两个字段。 代码示例 :::::::::::: diff --git a/docs/api/paddle/distributed/shard_layer_cn.rst b/docs/api/paddle/distributed/shard_layer_cn.rst index 356d354e577..9edf2e99402 100644 --- a/docs/api/paddle/distributed/shard_layer_cn.rst +++ b/docs/api/paddle/distributed/shard_layer_cn.rst @@ -17,11 +17,11 @@ shard_layer 参数 ::::::::: - - **layer** (paddle.nn.Layer) - 需要被切分的 `Layer` 对象。 - - **process_mesh** (paddle.distributed.ProcessMesh) - 执行当前 `Layer` 的 `ProcessMesh` 信息。 - - **shard_fn** (Callable) - 用于切分当前 `Layer` 参数的函数。如果没有指定，默认地我们将在当前 `ProcessMesh` 上复制所有的参数。 - - **input_fn** (Callable) - 指定如何切分 `Layer` 的输入。`input_fn` 函数将被注册为 `Layer` 的一个 `forward pre-hook`。默认我们将不会切分 `Layer` 的输入。 - - **output_fn** (Callable) - 指定如何切分 `Layer` 的输出，或者将 `Layer` 的输出转回不带分布式切分信息的 `Tensor`。`output_fn` 函数将被注册为 `Layer` 的一个 `forward post-hook`。默认我们将不会切分或者转换 `Layer` 的输出。 + - **layer** (paddle.nn.Layer) - 需要被切分的 ``Layer`` 对象。 + - **process_mesh** (paddle.distributed.ProcessMesh) - 执行当前 ``Layer`` 的 ``ProcessMesh`` 信息。 + - **shard_fn** (Callable) - 用于切分当前 ``Layer`` 参数的函数。如果没有指定，默认地我们将在当前 ``ProcessMesh`` 上复制所有的参数。 + - **input_fn** (Callable) - 指定如何切分 ``Layer`` 的输入。``input_fn`` 函数将被注册为 ``Layer`` 的一个 ``forward pre-hook``。默认我们将不会切分 ``Layer`` 的输入。 + - **output_fn** (Callable) - 指定如何切分 ``Layer`` 的输出，或者将 ``Layer`` 的输出转回不带分布式切分信息的 ``Tensor``。``output_fn`` 函数将被注册为 ``Layer`` 的一个 ``forward post-hook``。默认我们将不会切分或者转换 ``Layer`` 的输出。 返回 ::::::::: diff --git a/docs/api/paddle/distributed/shard_scaler_cn.rst b/docs/api/paddle/distributed/shard_scaler_cn.rst index e4786c6aaea..eef3d8992a7 100644 --- a/docs/api/paddle/distributed/shard_scaler_cn.rst +++ b/docs/api/paddle/distributed/shard_scaler_cn.rst @@ -11,7 +11,7 @@ shard_scaler 参数 ::::::::: - - **scaler** (paddle.amp.GradScaler) - 单卡视角下的 `GradScaler`。 + - **scaler** (paddle.amp.GradScaler) - 单卡视角下的 ``GradScaler``。 返回 ::::::::: GradScaler：一个具有分布式视角的 ``GradScaler`` 对象。 diff --git a/docs/api/paddle/distribution/ContinuousBernoulli_cn.rst b/docs/api/paddle/distribution/ContinuousBernoulli_cn.rst index a1bd5ce6306..3633a348ec1 100644 --- a/docs/api/paddle/distribution/ContinuousBernoulli_cn.rst +++ b/docs/api/paddle/distribution/ContinuousBernoulli_cn.rst @@ -35,7 +35,7 @@ ContinuousBernoulli 是一种定义在 [0，1] 区间上的连续型概率分布 ::::::::: - **probs** (int|float|Tensor) - 即上述公式中 :math:`\lambda` 参数，在 [0, 1] 内，刻画 ContinuousBernoulli 分布的 - 概率密度函数的形状。如果 :attr:`probs` 的输入数据类型是 `int` 或 `float` ，则会被转换为数据类型为 paddle 全局默认数据类型的 1-D Tensor。 + 概率密度函数的形状。如果 :attr:`probs` 的输入数据类型是 ``int`` 或 ``float`` ，则会被转换为数据类型为 paddle 全局默认数据类型的 1-D Tensor。 - **lims** (tuple，可选) - 表示概率计算非稳定区域的区域宽度，非稳定区域的概率计算使用泰勒展开做近似。默认值为 (0.499, 0.501)。 diff --git a/docs/api/paddle/distribution/LKJCholesky_cn.rst b/docs/api/paddle/distribution/LKJCholesky_cn.rst index 4876995d989..258149deaa7 100644 --- a/docs/api/paddle/distribution/LKJCholesky_cn.rst +++ b/docs/api/paddle/distribution/LKJCholesky_cn.rst @@ -24,7 +24,7 @@ LKJ 分布通常定义为对相关矩阵 :math:`\Omega` 的分布，其密度函 - **dim** (int) - 目标相关矩阵的维度。 - **concentration** (float|Tensor) - 集中参数，这个参数控制了生成的相关矩阵的分布，值必须大于 0。concentration 越大，生成的矩阵越接近单位矩阵。 - - **sample_method** (str) - 不同采样策略，可选项有：`onion` 和 `cvine`. 这两种 sample 方法都在 `Generating random correlation matrices based on vines and extended onion method `_ 中提出，并且在相关矩阵上提供相同的分布。但是它们在如何生成样本方面是不同的。默认为“onion”。 + - **sample_method** (str) - 不同采样策略，可选项有：``onion`` 和 ``cvine``. 这两种 sample 方法都在 `Generating random correlation matrices based on vines and extended onion method `_ 中提出，并且在相关矩阵上提供相同的分布。但是它们在如何生成样本方面是不同的。默认为“onion”。 代码示例 :::::::::::: diff --git a/docs/api/paddle/distribution/MultivariateNormal_cn.rst b/docs/api/paddle/distribution/MultivariateNormal_cn.rst index 5969ea9c8b3..2197b92743f 100644 --- a/docs/api/paddle/distribution/MultivariateNormal_cn.rst +++ b/docs/api/paddle/distribution/MultivariateNormal_cn.rst @@ -25,7 +25,7 @@ MultivariateNormal 是一种定义在实数域上的多元连续型概率分布 参数 ::::::::: - - **loc** (int|float|Tensor) - 即上述公式中 :math:`\mu` 参数，是 MultivariateNormal 的均值向量。如果 :attr:`loc` 的输入数据类型是 `int` 或 `float` 则会被转换为数据类型为 paddle 全局默认数据类型的 1-D Tensor。 + - **loc** (int|float|Tensor) - 即上述公式中 :math:`\mu` 参数，是 MultivariateNormal 的均值向量。如果 :attr:`loc` 的输入数据类型是 ``int`` 或 ``float`` 则会被转换为数据类型为 paddle 全局默认数据类型的 1-D Tensor。 - **covariance_matrix** (Tensor，可选) - 即上述公式中 :math:`\mu` 参数，是 MultivariateNormal 的协方差矩阵。:attr:`covariance_matrix` 的数据类型会被转换为与 :attr:`loc` 相同的类型。默认值为 None。 diff --git a/docs/api/paddle/fft/hfftn_cn.rst b/docs/api/paddle/fft/hfftn_cn.rst index 3ec0456fd4c..2b1d1375713 100644 --- a/docs/api/paddle/fft/hfftn_cn.rst +++ b/docs/api/paddle/fft/hfftn_cn.rst @@ -18,7 +18,7 @@ hfftn 小于 ``s[-1]//2+1``，则输入 Tensor 会被补零； - 对于傅里变换其他每一个轴 ``i``，如果输入 Tensor 的长度大于 ``s[i]``，输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``，则输入 Tensor 会被补零； - - 如果未指定 `s`，则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``，其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度，其余轴为输入 Tensor 在该轴的长度。 + - 如果未指定 ``s``，则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``，其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度，其余轴为输入 Tensor 在该轴的长度。 - **axes** (Sequence[int]，可选) - 计算快速傅里叶变换的轴。如果没有指定，默认是使用最 后 ``len(s)`` 个轴，如果 ``s`` 也没有指定则使用输入数据的全部的轴。 diff --git a/docs/api/paddle/fft/irfftn_cn.rst b/docs/api/paddle/fft/irfftn_cn.rst index e37fe10d6f5..dc9bdfea57b 100644 --- a/docs/api/paddle/fft/irfftn_cn.rst +++ b/docs/api/paddle/fft/irfftn_cn.rst @@ -18,7 +18,7 @@ irfftn - 对于傅里叶变换的最后一个轴，输入长度要求是 ``s[-1]//2+1``，如果输入 Tensor 的长度大于 ``s[-1]//2+1``，输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[-1]//2+1``，则输入 Tensor 会被补零； - 对于傅里变换其他每一个轴 ``i``，如果输入 Tensor 的长度大于 ``s[i]``，输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``s[i]``，则输入 Tensor 会被补零； - - 如果未指定 `s`，则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``，其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度，其余轴为输入 Tensor 在该轴的长度。 + - 如果未指定 ``s``，则 ``s`` 在最后一个傅里叶变换轴取值为 ``2*(m-1)``，其中 ``m`` 是输入 Tensor 在最后一个傅里叶变换轴的长度，其余轴为输入 Tensor 在该轴的长度。 - **axes** (Sequence[int]，可选) - 计算快速傅里叶变换的轴。如果没有指定，默认是使用最后 ``len(s)`` 个轴，如果 ``s`` 也没有指定则使用输入数据的全部的轴。 - **norm** (str，可选) - 指定傅里叶变换的缩放模式，缩放系数由变换的方向和模式同时决定。取值必须是 "forward"，"backward"，"ortho"之一，默认值为 "backward"。三种缩放模式对应的行为如下： diff --git a/docs/api/paddle/floor_divide__cn.rst b/docs/api/paddle/floor_divide__cn.rst index 17e7c9ee451..6173636ced4 100644 --- a/docs/api/paddle/floor_divide__cn.rst +++ b/docs/api/paddle/floor_divide__cn.rst @@ -5,7 +5,7 @@ floor_divide\_ .. py:function:: paddle.floor_divide_(x, y, name=None) -Inplace 版本的 :ref:`cn_api_paddle_floor_divide` API，对输入 `x` 采用 Inplace 策略。 +Inplace 版本的 :ref:`cn_api_paddle_floor_divide` API，对输入 ``x`` 采用 Inplace 策略。 更多关于 inplace 操作的介绍请参考 `3.1.3 原位（Inplace）操作和非原位操作的区别`_ 了解详情。 diff --git a/docs/api/paddle/floor_divide_cn.rst b/docs/api/paddle/floor_divide_cn.rst index 409b7bab405..9edd21e671d 100644 --- a/docs/api/paddle/floor_divide_cn.rst +++ b/docs/api/paddle/floor_divide_cn.rst @@ -31,7 +31,7 @@ floor_divide - **y** (Tensor) - 多维 Tensor。数据类型为 int8 int16 int32 int64 float32 float64 float16 或 bfloat16。 别名： ``other`` - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - - **out** （Tensor，可选） - 指定输出结果的 `Tensor`，默认值为 None。 + - **out** （Tensor，可选） - 指定输出结果的 ``Tensor``，默认值为 None。 返回 diff --git a/docs/api/paddle/from_dlpack_cn.rst b/docs/api/paddle/from_dlpack_cn.rst index dc675018b70..7e3d3ac0140 100644 --- a/docs/api/paddle/from_dlpack_cn.rst +++ b/docs/api/paddle/from_dlpack_cn.rst @@ -13,12 +13,12 @@ from_dlpack 参数 ::::::::: - **dlpack** (SupportDLPack | PyCapsule) - 一个实现了 ``__dlpack__`` 与 ``__dlpack_device__`` 方法的对象，或者是一个带有 dltensor 的 ``PyCapsule`` 对象。 - - **device** (PlaceLike, 可选) - 返回的 Tensor 所在的设备。如果不指定，返回的 Tensor 将与输入的 `dlpack` 位于同一设备上。 + - **device** (PlaceLike, 可选) - 返回的 Tensor 所在的设备。如果不指定，返回的 Tensor 将与输入的 ``dlpack`` 位于同一设备上。 - **copy** (bool, 可选) - 是否复制输入的内容。如果为 True，则输出的 Tensor 总是被复制。如果为 False，则输出的 Tensor 永远不会被复制，如果需要复制则会引发 ``BufferError`` 异常。如果为 None，则在可能的情况下重用现有的内存缓冲区，否则进行复制。默认值为 None。 返回 ::::::::: - - **out** (Tensor) - 从 `dlpack` 中解码得到的 Paddle Tensor，支持的数据类型为： bool，float16，float32，float64，uint8，int8，int16，int32，int64，complex64，complex128，支持的设备类型为： ``CPU``， ``CUDAPlace``， ``CUDAPinnedPlace``。 + - **out** (Tensor) - 从 ``dlpack`` 中解码得到的 Paddle Tensor，支持的数据类型为： bool，float16，float32，float64，uint8，int8，int16，int32，int64，complex64，complex128，支持的设备类型为： ``CPU``， ``CUDAPlace``， ``CUDAPinnedPlace``。 代码示例 1 ::::::::: diff --git a/docs/api/paddle/grad_cn.rst b/docs/api/paddle/grad_cn.rst index fe13c40cfbc..13ee55a2a09 100644 --- a/docs/api/paddle/grad_cn.rst +++ b/docs/api/paddle/grad_cn.rst @@ -15,12 +15,12 @@ grad ::::::::: - **outputs** (Tensor|list(Tensor)|tuple(Tensor)) – 用于计算梯度的图的输出变量，或多个输出变量构成的 list/tuple。 - - **inputs** (Tensor|list(Tensor)|tuple(Tensor)) - 用于计算梯度的图的输入变量，或多个输入变量构成的 list/tuple。该 API 的每个返回值对应每个 `inputs` 的梯度。 - - **grad_outputs** (Tensor|list(Tensor|None)|tuple(Tensor|None)，可选) - `outputs` 变量梯度的初始值。若 `grad_outputs` 为 None，则 `outputs` 梯度的初始值均为全 1 的 Tensor。若 `grad_outputs` 不为 None，它必须与 `outputs` 的长度相等，此时，若 `grad_outputs` 的第 i 个元素为 None，则第 i 个 `outputs` 的梯度初始值为全 1 的 Tensor；若 `grad_outputs` 的第 i 个元素为 Tensor，则第 i 个 `outputs` 的梯度初始值为 `grad_outputs` 的第 i 个元素。默认值为 None。 - - **retain_graph** (bool，可选) - 是否保留计算梯度的前向图。若值为 True，则前向图会保留，用户可对同一张图求两次反向。若值为 False，则前向图会释放。默认值为 None，表示值与 `create_graph` 相等。 + - **inputs** (Tensor|list(Tensor)|tuple(Tensor)) - 用于计算梯度的图的输入变量，或多个输入变量构成的 list/tuple。该 API 的每个返回值对应每个 ``inputs`` 的梯度。 + - **grad_outputs** (Tensor|list(Tensor|None)|tuple(Tensor|None)，可选) - ``outputs`` 变量梯度的初始值。若 ``grad_outputs`` 为 None，则 ``outputs`` 梯度的初始值均为全 1 的 Tensor。若 ``grad_outputs`` 不为 None，它必须与 ``outputs`` 的长度相等，此时，若 ``grad_outputs`` 的第 i 个元素为 None，则第 i 个 ``outputs`` 的梯度初始值为全 1 的 Tensor；若 ``grad_outputs`` 的第 i 个元素为 Tensor，则第 i 个 ``outputs`` 的梯度初始值为 ``grad_outputs`` 的第 i 个元素。默认值为 None。 + - **retain_graph** (bool，可选) - 是否保留计算梯度的前向图。若值为 True，则前向图会保留，用户可对同一张图求两次反向。若值为 False，则前向图会释放。默认值为 None，表示值与 ``create_graph`` 相等。 - **create_graph** (bool，可选) - 是否创建计算过程中的反向图。若值为 True，则可支持计算高阶导数。若值为 False，则计算过程中的反向图会释放。默认值为 False。 - - **only_inputs** (bool，可选) - 是否只计算 `inputs` 的梯度。若值为 False，则图中所有叶节点变量的梯度均会计算，并进行累加。若值为 True，则只会计算 `inputs` 的梯度。默认值为 True。only_inputs=False 功能正在开发中，目前尚不支持。 - - **allow_unused** (bool，可选) - 决定当某些 `inputs` 变量不在计算图中时抛出错误还是返回 None。若某些 `inputs` 变量不在计算图中（即它们的梯度为 None），则当 allowed_unused=False 时会抛出错误，当 allow_unused=True 时会返回 None 作为这些变量的梯度。默认值为 False。 + - **only_inputs** (bool，可选) - 是否只计算 ``inputs`` 的梯度。若值为 False，则图中所有叶节点变量的梯度均会计算，并进行累加。若值为 True，则只会计算 ``inputs`` 的梯度。默认值为 True。only_inputs=False 功能正在开发中，目前尚不支持。 + - **allow_unused** (bool，可选) - 决定当某些 ``inputs`` 变量不在计算图中时抛出错误还是返回 None。若某些 ``inputs`` 变量不在计算图中（即它们的梯度为 None），则当 allowed_unused=False 时会抛出错误，当 allow_unused=True 时会返回 None 作为这些变量的梯度。默认值为 False。 - **no_grad_vars** (Tensor|list(Tensor)|tuple(Tensor)|set(Tensor)，可选) - 指明不需要计算梯度的变量。默认值为 None。 返回 diff --git a/docs/api/paddle/hub/load_state_dict_from_url_cn.rst b/docs/api/paddle/hub/load_state_dict_from_url_cn.rst index 4d877ba5100..0a209bcca8c 100644 --- a/docs/api/paddle/hub/load_state_dict_from_url_cn.rst +++ b/docs/api/paddle/hub/load_state_dict_from_url_cn.rst @@ -13,9 +13,9 @@ load_state_dict_from_url - **url** (str) - 要下载对象的 URL 地址。 - **model_dir** (str，可选) - 保存下载文件的目录。若为 None，则默认保存到 /hub/checkpoints，其中 为 PADDLE_HOME 环境变量的值，若未设置 PADDLE_HOME，则默认保存到 ~/.cache/paddle。 - - **check_hash** (bool，可选) - 是否验证文件的 SHA256 哈希值。若为 True，则 URL 中的文件名部分需遵循命名约定 `filename-.ext`，其中 `` 为文件内容 SHA256 哈希值的前八位或更多，用于确保文件名唯一性并验证文件内容。默认值：False。 + - **check_hash** (bool，可选) - 是否验证文件的 SHA256 哈希值。若为 True，则 URL 中的文件名部分需遵循命名约定 ``filename-.ext``，其中 ```` 为文件内容 SHA256 哈希值的前八位或更多，用于确保文件名唯一性并验证文件内容。默认值：False。 - **file_name** (str，可选) - 下载文件的自定义文件名。如果未设置，将使用 URL 中的文件名。 - - **map_location** (str，可选) - 指定存储位置的映射方式。支持 `"cpu"`, `"gpu"`, `"xpu"`, `"npu"`, `"numpy"`, `"np"` 等。默认值：None。 + - **map_location** (str，可选) - 指定存储位置的映射方式。支持 ``"cpu"``, ``"gpu"``, ``"xpu"``, ``"npu"``, ``"numpy"``, ``"np"`` 等。默认值：None。 返回 ::::::::: diff --git a/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst b/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst index 0677d4313c2..eaf074f8d56 100644 --- a/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst +++ b/docs/api/paddle/incubate/nn/FusedBiasDropoutResidualLayerNorm_cn.rst @@ -25,8 +25,8 @@ forward(x, residual) 参数 :::::::::::: - - **x** (Tensor) - 输入张量。它是一个形状为 `[batch_size, seq_len, embed_dim]` 的张量。数据类型应为 float32 或 float64 。 - - **residual** (Tensor，可选) - 残差张量。它是一个形状为 `[batch_size, value_length, vdim]` 的张量。数据类型应为 float32 或 float64。 + - **x** (Tensor) - 输入张量。它是一个形状为 ``[batch_size, seq_len, embed_dim]`` 的张量。数据类型应为 float32 或 float64 。 + - **residual** (Tensor，可选) - 残差张量。它是一个形状为 ``[batch_size, value_length, vdim]`` 的张量。数据类型应为 float32 或 float64。 返回 :::::::::::: diff --git a/docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst b/docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst index 8decf6bdca4..c787f3bd316 100644 --- a/docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst +++ b/docs/api/paddle/incubate/nn/FusedDropoutAdd_cn.rst @@ -28,7 +28,7 @@ FusedDropoutAdd ::::::::: - x: N-D 张量。 - y: N-D 张量。 - - output: N-D 张量，和 `x` 形状相同。 + - output: N-D 张量，和 ``x`` 形状相同。 代码示例 diff --git a/docs/api/paddle/incubate/nn/FusedTransformerEncoderLayer_cn.rst b/docs/api/paddle/incubate/nn/FusedTransformerEncoderLayer_cn.rst index 1061e356443..ef6c6b2530c 100644 --- a/docs/api/paddle/incubate/nn/FusedTransformerEncoderLayer_cn.rst +++ b/docs/api/paddle/incubate/nn/FusedTransformerEncoderLayer_cn.rst @@ -15,7 +15,7 @@ FusedTransformer 编码器层由两个子层组成：多头自注意力机制和 - **dim_feedforward** (int) - 前馈神经网络中隐藏层的大小。 - **dropout_rate** (float，可选) - 对两个子层的输出进行处理的 dropout 值，置零的概率。默认值：0.1。 - **activation** (str，可选) - 前馈神经网络的激活函数。默认值：``relu``。 - - **attn_dropout_rate** (float，可选) - MHA 中对注意力目标的随机失活率。如果为 `None` 则 ``attn_dropout = dropout``。默认值：``None`` 。 + - **attn_dropout_rate** (float，可选) - MHA 中对注意力目标的随机失活率。如果为 ``None`` 则 ``attn_dropout = dropout``。默认值：``None`` 。 - **act_dropout_rate** (float，可选) - 前馈神经网络的激活函数后的 dropout 置零的概率。如果为 ``None`` 则 ``act_dropout_rate = dropout_rate``。默认值：``None`` 。 - **normalize_before** (bool，可选) - 设置对每个子层的输入输出的处理。如果为 ``True``，则对每个子层的输入进行层标准化（Layer Normalization），否则（即为 ``False`` ），则对每个子层的输入不进行处理，而是在子层的输出前进行标准化。默认值：``False`` 。 - **weight_attr** (ParamAttr|tuple，可选) - 指定权重参数属性的对象。如果是 ``tuple`` ，MHA 的权重参数属性使用 ``weight_attr[0]``，前馈神经网络的权重参数属性使用 ``weight_attr[1]``。如果参数值是 ``ParamAttr``，则 MHA 和前馈神经网络的权重参数属性都使用 ``ParamAttr``。默认值：``None``，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。 diff --git a/docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst b/docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst index 1bb35db4b6c..b2233d7f4af 100644 --- a/docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst +++ b/docs/api/paddle/incubate/nn/functional/fused_bias_dropout_residual_layer_norm_cn.rst @@ -15,11 +15,11 @@ fused_bias_dropout_residual_layer_norm 操作符，包含融合偏置、Dropout 参数 :::::::::::: - - **x** (Tensor) - 输入张量。其形状为 `[*, embed_dim]`。 + - **x** (Tensor) - 输入张量。其形状为 ``[*, embed_dim]``。 - **residual** (Tensor) - 残差张量。其形状与 x 相同。 - - **bias** (Tensor，可选) - 线性的偏置。其形状为 `[embed_dim]`。默认为 None。 - - **ln_scale** (Tensor，可选) - 层归一化的权重张量。其形状为 `[embed_dim]`。默认为 None。 - - **ln_bias** (Tensor，可选) - 层归一化的偏置张量。其形状为 `[embed_dim]`。默认为 None。 + - **bias** (Tensor，可选) - 线性的偏置。其形状为 ``[embed_dim]``。默认为 None。 + - **ln_scale** (Tensor，可选) - 层归一化的权重张量。其形状为 ``[embed_dim]``。默认为 None。 + - **ln_bias** (Tensor，可选) - 层归一化的偏置张量。其形状为 ``[embed_dim]``。默认为 None。 - **dropout_rate** (float，可选) - 在注意力权重上使用的 Dropout 概率，用于在注意力后的 Dropout 过程中丢弃一些注意力目标。0 表示无 Dropout。默认为 0.5 。 - **ln_epsilon** (float，可选) - 在层归一化的分母中添加的小浮点数，用于避免除以零。默认为 1e-5。 - **training** (bool，可选) - 表示是否处于训练阶段的标志。默认为 True。 @@ -38,7 +38,7 @@ fused_bias_dropout_residual_layer_norm 操作符，包含融合偏置、Dropout 返回 :::::::::::: - - Tensor，输出张量，数据类型和形状与 `x` 相同。 + - Tensor，输出张量，数据类型和形状与 ``x`` 相同。 代码示例 diff --git a/docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst b/docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst index 2b1bd763a0d..486483b7987 100644 --- a/docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst +++ b/docs/api/paddle/incubate/nn/functional/fused_dropout_add_cn.rst @@ -30,7 +30,7 @@ fused_dropout_add 返回 ::::::::: - - 融合 dropout 和 add 的张量具有与 `x` 相同的形状和数据类型。 + - 融合 dropout 和 add 的张量具有与 ``x`` 相同的形状和数据类型。 代码示例 diff --git a/docs/api/paddle/incubate/nn/functional/fused_multi_transformer_cn.rst b/docs/api/paddle/incubate/nn/functional/fused_multi_transformer_cn.rst index e26dc58353c..a55cdb79d2c 100644 --- a/docs/api/paddle/incubate/nn/functional/fused_multi_transformer_cn.rst +++ b/docs/api/paddle/incubate/nn/functional/fused_multi_transformer_cn.rst @@ -47,27 +47,27 @@ Transformer 层的功能与以下伪代码一致： 参数 :::::::::::: - - **x** (Tensor) - 输入张量可以是 3-D 张量，输入数据类型可以是 float16 或 float32，形状为`[batch\_size, sequence\_length, d\_model]`。 - - **ln_scales** (list(Tensor)|tuple(Tensor)) - 注意力机制中层归一化层的权重张量，形状为`[d\_model]`。 - - **ln_biases** (list(Tensor)|tuple(Tensor)) - 注意力机制中层归一化层的偏重张量，形状为`[d\_model]`。 - - **qkv_weights** (list(Tensor)|tuple(Tensor)) - 注意力 qkv 计算的权重张量，形状为`[3, num\_head, dim\_head, d\_model]`。 - - **qkv_biases** (list(Tensor)|tuple(Tensor)|None) - 注意力 qkv 计算的偏置张量，形状为`[3, num\_head, dim\_head]`。 - - **linear_weights** (list(Tensor)|tuple(Tensor)) - 注意力机制中线性层的权重张量，形状为`[num\_head * dim\_head, d\_model]`。 - - **linear_biases** (list(Tensor)|tuple(Tensor)|None) - 注意力机制中线性层的的偏置张量，形状为`[d\_model]`。 - - **ffn_ln_scales** (list(Tensor)|tuple(Tensor)) - 前馈层中层归一化层的权重张量，形状为`[d\_model]`。 - - **ffn_ln_biases** (list(Tensor)|tuple(Tensor)) - 前馈层中层归一化层的偏置张量，形状为`[d\_model]`。 - - **ffn1_weights** (list(Tensor)|tuple(Tensor)) - 前馈层中第一个线性变换层的权重张量，形状为`[d\_model, dim\_feedforward]`。 - - **ffn1_biases** (list(Tensor)|tuple(Tensor)|None) - 前馈层中第一个线性变换层的偏置张量，形状为`[dim\_feedforward]`。 - - **ffn2_weights** (list(Tensor)|tuple(Tensor)) - 前馈层中第二线性变换层的权重张量，形状为`[dim\_feedforward, d\_model]`。 - - **ffn2_biases** (list(Tensor)|tuple(Tensor)|None) - 前馈层中第二线性变换层的偏置张量，形状为`[d_model]`。 + - **x** (Tensor) - 输入张量可以是 3-D 张量，输入数据类型可以是 float16 或 float32，形状为 ``[batch\_size, sequence\_length, d\_model]``。 + - **ln_scales** (list(Tensor)|tuple(Tensor)) - 注意力机制中层归一化层的权重张量，形状为 ``[d\_model]``。 + - **ln_biases** (list(Tensor)|tuple(Tensor)) - 注意力机制中层归一化层的偏重张量，形状为 ``[d\_model]``。 + - **qkv_weights** (list(Tensor)|tuple(Tensor)) - 注意力 qkv 计算的权重张量，形状为 ``[3, num\_head, dim\_head, d\_model]``。 + - **qkv_biases** (list(Tensor)|tuple(Tensor)|None) - 注意力 qkv 计算的偏置张量，形状为 ``[3, num\_head, dim\_head]``。 + - **linear_weights** (list(Tensor)|tuple(Tensor)) - 注意力机制中线性层的权重张量，形状为 ``[num\_head * dim\_head, d\_model]``。 + - **linear_biases** (list(Tensor)|tuple(Tensor)|None) - 注意力机制中线性层的的偏置张量，形状为 ``[d\_model]``。 + - **ffn_ln_scales** (list(Tensor)|tuple(Tensor)) - 前馈层中层归一化层的权重张量，形状为 ``[d\_model]``。 + - **ffn_ln_biases** (list(Tensor)|tuple(Tensor)) - 前馈层中层归一化层的偏置张量，形状为 ``[d\_model]``。 + - **ffn1_weights** (list(Tensor)|tuple(Tensor)) - 前馈层中第一个线性变换层的权重张量，形状为 ``[d\_model, dim\_feedforward]``。 + - **ffn1_biases** (list(Tensor)|tuple(Tensor)|None) - 前馈层中第一个线性变换层的偏置张量，形状为 ``[dim\_feedforward]``。 + - **ffn2_weights** (list(Tensor)|tuple(Tensor)) - 前馈层中第二线性变换层的权重张量，形状为 ``[dim\_feedforward, d\_model]``。 + - **ffn2_biases** (list(Tensor)|tuple(Tensor)|None) - 前馈层中第二线性变换层的偏置张量，形状为 ``[d_model]``。 - **pre_layer_norm** (bool，可选) - 是否是 pre_layer_norm（True）或 post_layer_norm（False）。默认为 True。 - **epsilon** (float，可选) - 添加到 layer_norm 的分母中的小浮点值，以避免除以零。默认为 1e-5。 - - **cache_kvs** (list(Tensor)|tuple(Tensor)，可选) - 生成模型的缓存结构张量。形状为`[2, bsz, num\_head, max\_seq\_len, head\_dim]`。默认为 None。 - - **pre_caches** (list(Tensor)|tuple(Tensor)，可选) - 生成模型的前缀缓存。形状为`[2, bsz, num\_head, cache\_len, head\_dim]`。默认为 None。 - - **seq_lens** (Tensor，可选) - 此批次的序列长度。形状为`[bsz]`。默认为 None。 - - **rotary_embs** (Tensor，可选) - 用于旋转计算的 RoPE 嵌入。形状为`[2, bsz, 1, seq\_len, head\_dim]`。默认为 None。 - - **time_step** (Tensor，可选) - 生成模型的时间步张量。用于解码阶段，表示时间步，即 CacheKV 的实际 seq_len。形状为`[1]`，必须位于 CPUPlace。默认为 None。 - - **attn_mask** (Tensor，可选) - 用于多头注意力层中防止对某些不需要的位置（通常是填充或后续位置）进行注意。其形状为`[batch_size, 1, sequence_length, sequence_length]`。默认为 None。 + - **cache_kvs** (list(Tensor)|tuple(Tensor)，可选) - 生成模型的缓存结构张量。形状为 ``[2, bsz, num\_head, max\_seq\_len, head\_dim]``。默认为 None。 + - **pre_caches** (list(Tensor)|tuple(Tensor)，可选) - 生成模型的前缀缓存。形状为 ``[2, bsz, num\_head, cache\_len, head\_dim]``。默认为 None。 + - **seq_lens** (Tensor，可选) - 此批次的序列长度。形状为 ``[bsz]``。默认为 None。 + - **rotary_embs** (Tensor，可选) - 用于旋转计算的 RoPE 嵌入。形状为 ``[2, bsz, 1, seq\_len, head\_dim]``。默认为 None。 + - **time_step** (Tensor，可选) - 生成模型的时间步张量。用于解码阶段，表示时间步，即 CacheKV 的实际 seq_len。形状为 ``[1]``，必须位于 CPUPlace。默认为 None。 + - **attn_mask** (Tensor，可选) - 用于多头注意力层中防止对某些不需要的位置（通常是填充或后续位置）进行注意。其形状为 ``[batch_size, 1, sequence_length, sequence_length]``。默认为 None。 - **dropout_rate** (float，可选) - 将单元设置为零的 dropout 概率。默认为 0.0。 - **rotary_emb_dims** (int，可选) - 旋转计算的 rotary_emb_dims，当 rotary_embs 为 None 时为 0，当 rotary_embs 不为 None 且 pos_extra_ids 为 None 时为 1，当 rotary_embs 和 pos_extra_ids 均不为 None 时为 2。默认为 0。 - **activation** (str，可选) - 激活函数。默认为"gelu"。 @@ -89,7 +89,7 @@ Transformer 层的功能与以下伪代码一致： 返回 :::::::::::: - - Tensor|tuple：如果 ``cache_kvs`` 为 None，则返回与 ``x`` 形状和数据类型相同的张量，代表 Transformer 的输出。如果 ``cache_kvs`` 不为 None，则返回元组（output, cache_kvs），其中 output 是 Transformer 的输出，cache_kvs 与输入`cache_kvs`原地更新。 + - Tensor|tuple：如果 ``cache_kvs`` 为 None，则返回与 ``x`` 形状和数据类型相同的张量，代表 Transformer 的输出。如果 ``cache_kvs`` 不为 None，则返回元组（output, cache_kvs），其中 output 是 Transformer 的输出，cache_kvs 与输入 ``cache_kvs`` 原地更新。 代码示例 diff --git a/docs/api/paddle/incubate/nn/functional/fused_rotary_position_embedding_cn.rst b/docs/api/paddle/incubate/nn/functional/fused_rotary_position_embedding_cn.rst index 22b55806d02..62f0baa1ccf 100644 --- a/docs/api/paddle/incubate/nn/functional/fused_rotary_position_embedding_cn.rst +++ b/docs/api/paddle/incubate/nn/functional/fused_rotary_position_embedding_cn.rst @@ -23,7 +23,7 @@ fused_rotary_position_embedding 返回 :::::::::: - - out_q/out_k/out_v 表示融合旋转位置嵌入的张量，具有与 `q` 相同的形状和数据类型。 + - out_q/out_k/out_v 表示融合旋转位置嵌入的张量，具有与 ``q`` 相同的形状和数据类型。 代码示例 diff --git a/docs/api/paddle/incubate/nn/functional/masked_multihead_attention_cn.rst b/docs/api/paddle/incubate/nn/functional/masked_multihead_attention_cn.rst index 5cf2cbfecbd..1827e0726a8 100644 --- a/docs/api/paddle/incubate/nn/functional/masked_multihead_attention_cn.rst +++ b/docs/api/paddle/incubate/nn/functional/masked_multihead_attention_cn.rst @@ -32,7 +32,7 @@ masked_multihead_attention 返回 :::::::::::: - - Tensor|tuple：如果 "beam_cache_offset_out" 不为 None，则返回元组 (output, cache_kvs_out, beam_cache_offset_out)，其中 output 是蒙版多头注意力层的输出，cache_kvs_out 与输入 `cache_kvs` 原地更新。如果 "beam_cache_offset_out" 为 None，则返回元组 (output, cache_kvs_out)。 + - Tensor|tuple：如果 "beam_cache_offset_out" 不为 None，则返回元组 (output, cache_kvs_out, beam_cache_offset_out)，其中 output 是蒙版多头注意力层的输出，cache_kvs_out 与输入 ``cache_kvs`` 原地更新。如果 "beam_cache_offset_out" 为 None，则返回元组 (output, cache_kvs_out)。 形状 :::::::::::: diff --git a/docs/api/paddle/incubate/segment_min_cn.rst b/docs/api/paddle/incubate/segment_min_cn.rst index e3ab77d6e15..f550ef2910d 100644 --- a/docs/api/paddle/incubate/segment_min_cn.rst +++ b/docs/api/paddle/incubate/segment_min_cn.rst @@ -21,7 +21,7 @@ segment_min 参数 ::::::::: - **data** (Tensor) - Tensor，数据类型为 float32、float64。 - - **segment_ids** (Tensor) - 一维 Tensor，与输入数据`data`的第一维大小相同，表示`data`分段位置，单调非减。合法的数据类型为 int32、int64。 + - **segment_ids** (Tensor) - 一维 Tensor，与输入数据 ``data`` 的第一维大小相同，表示 ``data`` 分段位置，单调非减。合法的数据类型为 int32、int64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/incubate/segment_sum_cn.rst b/docs/api/paddle/incubate/segment_sum_cn.rst index 651d01be984..b1d20c8e4f4 100644 --- a/docs/api/paddle/incubate/segment_sum_cn.rst +++ b/docs/api/paddle/incubate/segment_sum_cn.rst @@ -22,7 +22,7 @@ segment_sum ::::::::: - **data** (Tensor) - Tensor，数据类型为 float32、float64。 - - **segment_ids** (Tensor) - 一维 Tensor，与输入数据`data`的第一维大小相同，表示`data`分段位置，单调非减。合法的数据类型为 int32、int64。 + - **segment_ids** (Tensor) - 一维 Tensor，与输入数据 ``data`` 的第一维大小相同，表示 ``data`` 分段位置，单调非减。合法的数据类型为 int32、int64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/index_select_cn.rst b/docs/api/paddle/index_select_cn.rst index 3d1cf8c1430..fded9a046aa 100644 --- a/docs/api/paddle/index_select_cn.rst +++ b/docs/api/paddle/index_select_cn.rst @@ -27,7 +27,7 @@ index_select 关键字参数 ::::::::: - - **out** （Tensor，可选） - 指定输出结果的 `Tensor`，默认值为 None。 + - **out** （Tensor，可选） - 指定输出结果的 ``Tensor``，默认值为 None。 返回 ::::::::: diff --git a/docs/api/paddle/isclose_cn.rst b/docs/api/paddle/isclose_cn.rst index 75113ce321c..847daf7b329 100644 --- a/docs/api/paddle/isclose_cn.rst +++ b/docs/api/paddle/isclose_cn.rst @@ -15,8 +15,8 @@ isclose 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor`，数据类型为 float16、float32、float64、complex64 或 complex128。 - - **y** (Tensor) - 输入的 `Tensor`，数据类型为 float16、float32、float64、complex64 或 complex128。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为 float16、float32、float64、complex64 或 complex128。 + - **y** (Tensor) - 输入的 ``Tensor``，数据类型为 float16、float32、float64、complex64 或 complex128。 - **rtol** (float，可选) - 相对容忍误差，默认值为 1e-5。 - **atol** (float，可选) - 绝对容忍误差，默认值为 1e-8。 - **equal_nan** (bool，可选) - 如果设置为 True，则两个 NaN 数值将被视为相等，默认值为 False。 diff --git a/docs/api/paddle/isfinite_cn.rst b/docs/api/paddle/isfinite_cn.rst index 6c270005225..3639218b574 100644 --- a/docs/api/paddle/isfinite_cn.rst +++ b/docs/api/paddle/isfinite_cn.rst @@ -12,7 +12,7 @@ isfinite 参数 ::::::::: - - **x** (Tensor)：输入的 `Tensor`，数据类型为：float16、float32、float64、int32、int64、complex64、complex128。 + - **x** (Tensor)：输入的 ``Tensor``，数据类型为：float16、float32、float64、int32、int64、complex64、complex128。 别名： ``input`` - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/isinf_cn.rst b/docs/api/paddle/isinf_cn.rst index 76be80f3dbb..586364f3702 100644 --- a/docs/api/paddle/isinf_cn.rst +++ b/docs/api/paddle/isinf_cn.rst @@ -12,7 +12,7 @@ isinf 参数 ::::::::: - - **x** (Tensor)：输入的 `Tensor`，数据类型为：float16、float32、float64、uint8、int8、int16、int32、int64、complex64、complex128。 + - **x** (Tensor)：输入的 ``Tensor``，数据类型为：float16、float32、float64、uint8、int8、int16、int32、int64、complex64、complex128。 别名： ``input`` - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/isnan_cn.rst b/docs/api/paddle/isnan_cn.rst index c7527ec629a..48dbcaa726e 100644 --- a/docs/api/paddle/isnan_cn.rst +++ b/docs/api/paddle/isnan_cn.rst @@ -12,7 +12,7 @@ isnan 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor`，数据类型为：float16、float32、float64、int32、int64、complex64、complex128。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float16、float32、float64、int32、int64、complex64、complex128。 别名： ``input`` - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/isneginf_cn.rst b/docs/api/paddle/isneginf_cn.rst index 9ff1b9c22fe..5e83b8fe735 100644 --- a/docs/api/paddle/isneginf_cn.rst +++ b/docs/api/paddle/isneginf_cn.rst @@ -9,7 +9,7 @@ isneginf 参数 ::::::::: - - **x** (Tensor)：输入的 `Tensor`，数据类型为：float16、float32、float64、int8、int16、int32、int64、uint8。别名: ``input``。 + - **x** (Tensor)：输入的 ``Tensor``，数据类型为：float16、float32、float64、int8、int16、int32、int64、uint8。别名: ``input``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 关键字参数 diff --git a/docs/api/paddle/isposinf_cn.rst b/docs/api/paddle/isposinf_cn.rst index 74d388a0681..ae5fd9cf1f3 100644 --- a/docs/api/paddle/isposinf_cn.rst +++ b/docs/api/paddle/isposinf_cn.rst @@ -9,7 +9,7 @@ isposinf 参数 ::::::::: - - **x** (Tensor)：输入的 `Tensor`，数据类型为：bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8。别名: ``input``。 + - **x** (Tensor)：输入的 ``Tensor``，数据类型为：bfloat16、float16、float32、float64、int8、int16、int32、int64、uint8。别名: ``input``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 关键字参数 diff --git a/docs/api/paddle/linalg/cholesky_cn.rst b/docs/api/paddle/linalg/cholesky_cn.rst index 7392e33b49d..454b79136d3 100644 --- a/docs/api/paddle/linalg/cholesky_cn.rst +++ b/docs/api/paddle/linalg/cholesky_cn.rst @@ -15,7 +15,7 @@ cholesky 参数 :::::::::::: - - **x** （Tensor）- 输入变量为多维 Tensor，它的维度应该为 `[*, M, M]`，其中*为零或更大的批次尺寸，并且最里面的两个维度上的矩阵都应为对称的正定矩阵，支持数据类型为 float32、float64。 + - **x** （Tensor）- 输入变量为多维 Tensor，它的维度应该为 ``[*, M, M]``，其中*为零或更大的批次尺寸，并且最里面的两个维度上的矩阵都应为对称的正定矩阵，支持数据类型为 float32、float64。 - **upper** （bool）- 指示是否返回上三角矩阵或下三角矩阵。默认值：False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/linalg/cholesky_inverse_cn.rst b/docs/api/paddle/linalg/cholesky_inverse_cn.rst index 0aa6f5b1cdf..cf2156a8ef9 100644 --- a/docs/api/paddle/linalg/cholesky_inverse_cn.rst +++ b/docs/api/paddle/linalg/cholesky_inverse_cn.rst @@ -22,8 +22,8 @@ cholesky_inverse 参数 :::::::::::: - - **x** （Tensor）- 输入变量是形状为 `[N, N]` 的对称正定矩阵的下三角或上三角 Cholesky 分解张量。支持数据类型为 float32、float64。 - - **upper** （bool，可选）- 如果 `upper` 是 `False`，则输入为下三角矩阵，否则为上三角矩阵。默认值为 False。 + - **x** （Tensor）- 输入变量是形状为 ``[N, N]`` 的对称正定矩阵的下三角或上三角 Cholesky 分解张量。支持数据类型为 float32、float64。 + - **upper** （bool，可选）- 如果 ``upper`` 是 ``False``，则输入为下三角矩阵，否则为上三角矩阵。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/linalg/cond_cn.rst b/docs/api/paddle/linalg/cond_cn.rst index 8825e408d87..b9d200bf363 100644 --- a/docs/api/paddle/linalg/cond_cn.rst +++ b/docs/api/paddle/linalg/cond_cn.rst @@ -11,8 +11,8 @@ cond 参数 :::::::::::: - - **x** (Tensor)：输入可以是形状为 ``(*, m, n)`` 的矩阵 Tensor， ``*`` 为零或更大的批次维度，此时 ``p`` 为 `2` 或 `-2`；也可以是形状为 ``(*, n, n)`` 的可逆（批）方阵 Tensor，此时 ``p`` 为任意已支持的值。数据类型为 float32 或 float64 。 - - **p** (float|string，可选)：范数种类。目前支持的值为 `fro` 、 `nuc` 、 `1` 、 `-1` 、 `2` 、 `-2` 、 `inf` 、 `-inf`。默认值为 `None`，即范数种类为 `2` 。 + - **x** (Tensor)：输入可以是形状为 ``(*, m, n)`` 的矩阵 Tensor， ``*`` 为零或更大的批次维度，此时 ``p`` 为 ``2`` 或 ``-2``；也可以是形状为 ``(*, n, n)`` 的可逆（批）方阵 Tensor，此时 ``p`` 为任意已支持的值。数据类型为 float32 或 float64 。 + - **p** (float|string，可选)：范数种类。目前支持的值为 ``fro`` 、 ``nuc`` 、 ``1`` 、 ``-1`` 、 ``2`` 、 ``-2`` 、 ``inf`` 、 ``-inf``。默认值为 ``None``，即范数种类为 ``2`` 。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/linalg/householder_product_cn.rst b/docs/api/paddle/linalg/householder_product_cn.rst index 3c8e112e0b5..8ca40075dea 100644 --- a/docs/api/paddle/linalg/householder_product_cn.rst +++ b/docs/api/paddle/linalg/householder_product_cn.rst @@ -19,8 +19,8 @@ householder_product 参数 :::::::::::: - - **x** (Tensor): 形状为 `(*, m, n)` 的张量，其中 * 是零个或多个批量维度。 - - **tau** (Tensor): 形状为 `(*, k)` 的张量，其中 * 是零个或多个批量维度。 + - **x** (Tensor): 形状为 ``(*, m, n)`` 的张量，其中 * 是零个或多个批量维度。 + - **tau** (Tensor): 形状为 ``(*, k)`` 的张量，其中 * 是零个或多个批量维度。 - **name** (str, 可选): 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/linalg/lstsq_cn.rst b/docs/api/paddle/linalg/lstsq_cn.rst index 5359b869ab2..512c4a43f96 100644 --- a/docs/api/paddle/linalg/lstsq_cn.rst +++ b/docs/api/paddle/linalg/lstsq_cn.rst @@ -13,8 +13,8 @@ lstsq - **x** (Tensor)：形状为 ``(*, M, N)`` 的矩阵 Tensor， ``*`` 为零或更大的批次维度。数据类型为 float32 或 float64 。 - **y** (Tensor)：形状为 ``(*, M, K)`` 的矩阵 Tensor， ``*`` 为零或更大的批次维度。数据类型为 float32 或 float64 。 - - **rcond** (float，可选)：默认值为 `None`，用来决定 ``x`` 有效秩的 float 型浮点数。当 ``rcond`` 为 `None` 时，该值会被设为 ``max(M, N)`` 乘 ``x`` 数据类型对应的机器精度。 - - **driver** (str，可选)：默认值为 `None`，用来指定计算使用的 LAPACK 库方法。CPU 下该参数的合法值为 'gels'，'gelsy' (默认)，'gelsd'，'gelss'；CUDA 下该参数的合法值为 'gels' (默认) 。 + - **rcond** (float，可选)：默认值为 ``None``，用来决定 ``x`` 有效秩的 float 型浮点数。当 ``rcond`` 为 ``None`` 时，该值会被设为 ``max(M, N)`` 乘 ``x`` 数据类型对应的机器精度。 + - **driver** (str，可选)：默认值为 ``None``，用来指定计算使用的 LAPACK 库方法。CPU 下该参数的合法值为 'gels'，'gelsy' (默认)，'gelsd'，'gelss'；CUDA 下该参数的合法值为 'gels' (默认) 。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/linalg/matrix_norm_cn.rst b/docs/api/paddle/linalg/matrix_norm_cn.rst index ad9fda839b6..43ccbcadcdb 100644 --- a/docs/api/paddle/linalg/matrix_norm_cn.rst +++ b/docs/api/paddle/linalg/matrix_norm_cn.rst @@ -15,7 +15,7 @@ matrix_norm ::::::::: - **x** (Tensor) - 输入 Tensor。维度为多维，数据类型为 float32 或 float64。 - - **p** (int|float|string，可选) - 范数(ord)的种类。目前支持的值为 `fro`、`nuc`、`inf`、`-inf`、`1`、`2`、`-1`、`-2`。默认值为 `fro` 。 + - **p** (int|float|string，可选) - 范数(ord)的种类。目前支持的值为 ``fro``、``nuc``、``inf``、``-inf``、``1``、``2``、``-1``、``-2``。默认值为 ``fro`` 。 - **axis** (list|tuple，可选) - 使用范数计算的轴。``axis`` 为 [-2,-1],否则 ``axis`` 必须为长度为 2 的 list|tuple。 - **keepdim** (bool，可选) - 是否在输出的 Tensor 中保留和输入一样的维度，默认值为 False。当 :attr:`keepdim` 为 False 时，输出的 Tensor 会比输入 :attr:`input` 的维度少一些。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/linalg/matrix_transpose_cn.rst b/docs/api/paddle/linalg/matrix_transpose_cn.rst index 7559aa8b6ca..0560745dce5 100644 --- a/docs/api/paddle/linalg/matrix_transpose_cn.rst +++ b/docs/api/paddle/linalg/matrix_transpose_cn.rst @@ -19,7 +19,7 @@ matrix_transpose 返回 :::::::::::: - `Tensor`，数据类型与 `x` 相同。 + ``Tensor``，数据类型与 ``x`` 相同。 代码示例 :::::::::::: diff --git a/docs/api/paddle/linalg/norm_cn.rst b/docs/api/paddle/linalg/norm_cn.rst index 21e92ca167f..ae8daf30f7f 100644 --- a/docs/api/paddle/linalg/norm_cn.rst +++ b/docs/api/paddle/linalg/norm_cn.rst @@ -51,13 +51,13 @@ norm - **x** (Tensor) - 输入 Tensor。维度为多维，数据类型为 float32 或 float64。 别名： ``input``, ``A`` - - **p** (int|float|string，可选) - 范数(ord)的种类。目前支持的值为 `fro`、`nuc`、`inf`、`-inf`、`0`、`1`、`2`，和任何实数 p 对应的 p 范数。默认值为 None。 + - **p** (int|float|string，可选) - 范数(ord)的种类。目前支持的值为 ``fro``、``nuc``、``inf``、``-inf``、``0``、``1``、``2``，和任何实数 p 对应的 p 范数。默认值为 None。 别名： ``ord`` - - **axis** (int|list|tuple，可选) - 使用范数计算的轴。如果 ``axis`` 为 None，若 ``p`` 同时为 ``str`` 类型，则会自动补全 ``axis``，否则忽略 input 的维度，将其当做向量来计算。如果 ``axis`` 为 int 或者只有一个元素的 list|tuple，``norm`` API 会计算输入 Tensor 的向量范数。如果 axis 为包含两个元素的 list，API 会计算输入 Tensor 的矩阵范数。当 ``axis < 0`` 时，实际的计算维度为 rank(input) + axis。默认值为 `None` 。 + - **axis** (int|list|tuple，可选) - 使用范数计算的轴。如果 ``axis`` 为 None，若 ``p`` 同时为 ``str`` 类型，则会自动补全 ``axis``，否则忽略 input 的维度，将其当做向量来计算。如果 ``axis`` 为 int 或者只有一个元素的 list|tuple，``norm`` API 会计算输入 Tensor 的向量范数。如果 axis 为包含两个元素的 list，API 会计算输入 Tensor 的矩阵范数。当 ``axis < 0`` 时，实际的计算维度为 rank(input) + axis。默认值为 ``None`` 。 别名： ``dim`` - **keepdim** (bool，可选) - 是否在输出的 Tensor 中保留和输入一样的维度，默认值为 False。当 :attr:`keepdim` 为 False 时，输出的 Tensor 会比输入 :attr:`input` 的维度少一些。 - **out** (Tensor，可选) - 存储输出的 Tensor，当 ``out = None`` 时，该参数无作用。 - - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出的数据类型，如果指定，则执行操作时输入张量将转换为 `dtype`。默认值为 None。 + - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出的数据类型，如果指定，则执行操作时输入张量将转换为 ``dtype``。默认值为 None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/linalg/svd_lowrank_cn.rst b/docs/api/paddle/linalg/svd_lowrank_cn.rst index 8e7d65fd8a4..79ad46997cf 100644 --- a/docs/api/paddle/linalg/svd_lowrank_cn.rst +++ b/docs/api/paddle/linalg/svd_lowrank_cn.rst @@ -24,7 +24,7 @@ svd_lowrank - **x** (Tensor) - 输入的需要进行奇异值分解的一个或一批方阵，类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``，其中 ``*`` 为零或更大的批次维度，数据类型支持 float32， float64。 - **q** (int，可选) - 对输入 :math:`X` 的秩稍微高估的预估值，默认值为 None，代表预估值取 6。 - **niter** (int) - 需要进行的子空间迭代次数。默认值为 2。 - - **M** (Tensor) - 输入矩阵在 `axis=-2` 维上的均值，形状应为 ``[*, 1, N]``，默认为 None。 + - **M** (Tensor) - 输入矩阵在 ``axis=-2`` 维上的均值，形状应为 ``[*, 1, N]``，默认为 None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/linalg/vector_norm_cn.rst b/docs/api/paddle/linalg/vector_norm_cn.rst index 7e8365664cc..2086bfac9e6 100644 --- a/docs/api/paddle/linalg/vector_norm_cn.rst +++ b/docs/api/paddle/linalg/vector_norm_cn.rst @@ -17,7 +17,7 @@ vector_norm - **x** (Tensor) - 输入 Tensor。维度为多维，数据类型为 float32 或 float64。 - **p** (int|float，可选) - 范数(ord)的种类。目前支持的值为任何实数 p 对应的 p 范数。默认值为 2.0 。 ``别名: ord`` - - **axis** (int|list|tuple，可选) - 使用范数计算的轴。如果 ``axis`` 为 None，则忽略 input 的维度，将其当做向量来计算。如果 ``axis`` 为 int 或者 list|tuple，计算 Tensor 对应 axis 上的向量范数。默认值为 `None` 。 + - **axis** (int|list|tuple，可选) - 使用范数计算的轴。如果 ``axis`` 为 None，则忽略 input 的维度，将其当做向量来计算。如果 ``axis`` 为 int 或者 list|tuple，计算 Tensor 对应 axis 上的向量范数。默认值为 ``None`` 。 ``别名: dim`` - **keepdim** (bool，可选) - 是否在输出的 Tensor 中保留和输入一样的维度，默认值为 False。当 :attr:`keepdim` 为 False 时，输出的 Tensor 会比输入 :attr:`input` 的维度少一些。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/logical_and_cn.rst b/docs/api/paddle/logical_and_cn.rst index b4a75964cab..3e77c477117 100644 --- a/docs/api/paddle/logical_and_cn.rst +++ b/docs/api/paddle/logical_and_cn.rst @@ -21,11 +21,11 @@ logical_and 参数 :::::::::::: - - **x** （Tensor） - 输入的 `Tensor`，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 + - **x** （Tensor） - 输入的 ``Tensor``，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 别名： ``input`` - - **y** （Tensor） - 输入的 `Tensor`，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 + - **y** （Tensor） - 输入的 ``Tensor``，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 别名： ``other`` - - **out** （Tensor，可选） - 指定算子输出结果的 `Tensor`，可以是程序中已经创建的任何 Tensor。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 + - **out** （Tensor，可选） - 指定算子输出结果的 ``Tensor``，可以是程序中已经创建的任何 Tensor。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 - **name** （str，可选） - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/logical_or_cn.rst b/docs/api/paddle/logical_or_cn.rst index bb34a3eb553..05199ab5693 100644 --- a/docs/api/paddle/logical_or_cn.rst +++ b/docs/api/paddle/logical_or_cn.rst @@ -21,11 +21,11 @@ logical_or 参数 :::::::::::: - - **x** （Tensor） - 输入的 `Tensor`，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 + - **x** （Tensor） - 输入的 ``Tensor``，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 别名： ``input`` - - **y** （Tensor）- 输入的 `Tensor`，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 + - **y** （Tensor）- 输入的 ``Tensor``，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 别名： ``other`` - - **out** （Tensor，可选） - 指定算子输出结果的 `Tensor`，可以是程序中已经创建的任何 Tensor。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 + - **out** （Tensor，可选） - 指定算子输出结果的 ``Tensor``，可以是程序中已经创建的任何 Tensor。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 - **name** （str，可选） - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/logical_xor_cn.rst b/docs/api/paddle/logical_xor_cn.rst index ccbcbe31e15..5380f1fcac3 100644 --- a/docs/api/paddle/logical_xor_cn.rst +++ b/docs/api/paddle/logical_xor_cn.rst @@ -21,11 +21,11 @@ logical_xor 参数 :::::::::::: - - **x** （Tensor） - 输入的 `Tensor`，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 + - **x** （Tensor） - 输入的 ``Tensor``，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 别名： ``input`` - - **y** （Tensor） - 输入的 `Tensor`，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 + - **y** （Tensor） - 输入的 ``Tensor``，支持的数据类型为 bool, int8, int16, int32, int64, bfloat16, float16, float32, float64, complex64, complex128。 别名： ``other`` - - **out** （Tensor，可选） - 指定算子输出结果的 `Tensor`，可以是程序中已经创建的任何 Tensor。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 + - **out** （Tensor，可选） - 指定算子输出结果的 ``Tensor``，可以是程序中已经创建的任何 Tensor。默认值为 None，此时将创建新的 Tensor 来保存输出结果。 - **name** （str，可选） - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/logsumexp_cn.rst b/docs/api/paddle/logsumexp_cn.rst index 79ccf624e52..015967b1edb 100644 --- a/docs/api/paddle/logsumexp_cn.rst +++ b/docs/api/paddle/logsumexp_cn.rst @@ -21,7 +21,7 @@ logsumexp 别名： ``dim`` - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留减小的维度。如果 ``keepdim`` 为 True，则输出 Tensor 和 ``x`` 具有相同的维度(减少的维度除外，减少的维度的大小为 1)。否则，输出 Tensor 的形状会在 ``axis`` 上进行 squeeze 操作。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - - **out** （Tensor，可选） - 指定输出结果的 `Tensor`，默认值为 None。 + - **out** （Tensor，可选） - 指定输出结果的 ``Tensor``，默认值为 None。 返回 :::::::::: diff --git a/docs/api/paddle/masked_select_cn.rst b/docs/api/paddle/masked_select_cn.rst index 97eaedbb404..551b86a234b 100644 --- a/docs/api/paddle/masked_select_cn.rst +++ b/docs/api/paddle/masked_select_cn.rst @@ -19,7 +19,7 @@ masked_select 别名： ``input`` - **mask** (Tensor) - 用于索引的二进制掩码的 Tensor，数据类型为 bool。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - - **out** （Tensor，可选） - 指定输出结果的 `Tensor`，默认值为 None。 + - **out** （Tensor，可选） - 指定输出结果的 ``Tensor``，默认值为 None。 返回 :::::::::::: diff --git a/docs/api/paddle/matrix_transpose_cn.rst b/docs/api/paddle/matrix_transpose_cn.rst index dd0123ddc4c..833c324c278 100644 --- a/docs/api/paddle/matrix_transpose_cn.rst +++ b/docs/api/paddle/matrix_transpose_cn.rst @@ -19,7 +19,7 @@ matrix_transpose 返回 :::::::::::: - `Tensor`，数据类型与 `x` 相同。 + ``Tensor``，数据类型与 ``x`` 相同。 代码示例 :::::::::::: diff --git a/docs/api/paddle/nn/BCEWithLogitsLoss_cn.rst b/docs/api/paddle/nn/BCEWithLogitsLoss_cn.rst index 03fe7e340f7..9db3505f623 100644 --- a/docs/api/paddle/nn/BCEWithLogitsLoss_cn.rst +++ b/docs/api/paddle/nn/BCEWithLogitsLoss_cn.rst @@ -36,13 +36,13 @@ BCEWithLogitsLoss 参数 ::::::::: - **weight** (Tensor，可选) - 手动指定每个 batch 二值交叉熵的权重。如果指定的话，维度必须是一个 batch 的数据的维度。数据类型是 float32, float64。默认值是：None。 - - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 `BCELoss` 的均值；设置为 ``'sum'`` 时，计算 `BCELoss` 的总和；设置为 ``'none'`` 时，则返回原始 loss。 + - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 ``BCELoss`` 的均值；设置为 ``'sum'`` 时，计算 ``BCELoss`` 的总和；设置为 ``'none'`` 时，则返回原始 loss。 - **pos_weight** (Tensor，可选) - 手动指定正类的权重，必须是与类别数相等长度的向量。数据类型是 float32, float64。默认值是：None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 ::::::::: - - **logit** (Tensor) - 输入的预测值。形状是 :math:`[N, *]`，其中 N 是 batch_size， `*` 是任意其他维度。输入的预测值 ``logit`` 一般是线性层的输出，不需要经过 ``sigmoid`` 层。数据类型是 float32、float64。 + - **logit** (Tensor) - 输入的预测值。形状是 :math:`[N, *]`，其中 N 是 batch_size， ``*`` 是任意其他维度。输入的预测值 ``logit`` 一般是线性层的输出，不需要经过 ``sigmoid`` 层。数据类型是 float32、float64。 - **label** (Tensor) - 标签。 形状是 :math:`[N, *]`，标签 ``label`` 的维度、数据类型与输入的预测值 ``logit`` 相同。 - **output** (Tensor) - 输出的 Tensor。 如果 :attr:`reduction` 是 ``'none'``，则输出的维度为 :math:`[N, *]`，与输入 ``logit`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``，则输出的维度为 :math:`[]` 。 diff --git a/docs/api/paddle/nn/CosineEmbeddingLoss_cn.rst b/docs/api/paddle/nn/CosineEmbeddingLoss_cn.rst index 0a00c554b7f..29e5c86e194 100644 --- a/docs/api/paddle/nn/CosineEmbeddingLoss_cn.rst +++ b/docs/api/paddle/nn/CosineEmbeddingLoss_cn.rst @@ -24,8 +24,8 @@ CosineEmbeddingLoss 参数 ::::::::: - - **margin** (float，可选): - 可以设置的范围为[-1, 1]，建议设置的范围为[0, 0.5]。其默认为 `0`。 - - **reduction** (string，可选): - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 `CosineEmbeddingLoss` 的均值；设置为 ``'sum'`` 时，计算 `CosineEmbeddingLoss` 的总和；设置为 ``'none'`` 时，则返回 `CosineEmbeddingLoss`。数据类型为 string。 + - **margin** (float，可选): - 可以设置的范围为[-1, 1]，建议设置的范围为[0, 0.5]。其默认为 ``0``。 + - **reduction** (string，可选): - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 ``CosineEmbeddingLoss`` 的均值；设置为 ``'sum'`` 时，计算 ``CosineEmbeddingLoss`` 的总和；设置为 ``'none'`` 时，则返回 ``CosineEmbeddingLoss``。数据类型为 string。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 @@ -33,7 +33,7 @@ CosineEmbeddingLoss - **input1** (Tensor): - 输入的 Tensor，维度是[N, M]，其中 N 是 batch size，可为 0，M 是数组长度。数据类型为：float32、float64。 - **input2** (Tensor): - 输入的 Tensor，维度是[N, M]，其中 N 是 batch size，可为 0，M 是数组长度。数据类型为：float32、float64。 - **label** (Tensor): - 标签，维度是[N]，N 是数组长度，数据类型为：float32、float64、int32、int64。 - - **output** (Tensor): - 输入 ``input1`` 、 ``input2`` 和标签 ``label`` 间的 `CosineEmbeddingLoss` 损失。如果 `reduction` 是 ``'none'``，则输出 Loss 的维度为 [N]，与输入 ``input1`` 和 ``input2`` 相同。如果 `reduction` 是 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 + - **output** (Tensor): - 输入 ``input1`` 、 ``input2`` 和标签 ``label`` 间的 ``CosineEmbeddingLoss`` 损失。如果 ``reduction`` 是 ``'none'``，则输出 Loss 的维度为 [N]，与输入 ``input1`` 和 ``input2`` 相同。如果 ``reduction`` 是 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 代码示例 ::::::::: diff --git a/docs/api/paddle/nn/CrossEntropyLoss_cn.rst b/docs/api/paddle/nn/CrossEntropyLoss_cn.rst index 15696a50798..fc9226d1ee4 100644 --- a/docs/api/paddle/nn/CrossEntropyLoss_cn.rst +++ b/docs/api/paddle/nn/CrossEntropyLoss_cn.rst @@ -111,9 +111,9 @@ CrossEntropyLoss 参数 ::::::::: - - **weight** (Tensor，可选) - 指定每个类别的权重。其默认为 `None`。如果提供该参数的话，维度必须为 `C` （类别数）。数据类型为 float32 或 float64。 + - **weight** (Tensor，可选) - 指定每个类别的权重。其默认为 ``None``。如果提供该参数的话，维度必须为 ``C`` （类别数）。数据类型为 float32 或 float64。 - **ignore_index** (int64，可选) - 指定一个忽略的标签值，此标签值不参与计算，负值表示无需忽略任何标签值。仅在 soft_label=False 时有效。默认值为-100。数据类型为 int64。 - - **reduction** (str，可选) - 指定应用于输出结果的计算方式，数据类型为 string，可选值有：`none`, `mean`, `sum`。默认为 `mean`，计算 `mini-batch` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 `none` 时，则返回 loss Tensor。 + - **reduction** (str，可选) - 指定应用于输出结果的计算方式，数据类型为 string，可选值有：``none``, ``mean``, ``sum``。默认为 ``mean``，计算 ``mini-batch`` loss 均值。设置为 ``sum`` 时，计算 ``mini-batch`` loss 的总和。设置为 ``none`` 时，则返回 loss Tensor。 - **soft_label** (bool，可选) – 指明 label 是否为软标签。默认为 False，表示 label 为硬标签；若 soft_label=True 则表示软标签。 - **label_smoothing** （float，可选）- 指定计算损失时的标签平滑度，它应该在 :math:`[0.0，1.0]` 范围内。其中 0.0 表示无平滑。使得平滑后的标签变成原始真实标签和均匀分布的混合，默认值： 0.0。 - **axis** (int，可选) - 进行 softmax 计算的维度索引。它应该在 :math:`[-1，dim-1]` 范围内，而 ``dim`` 是输入 logits 的维度。默认值：-1。 @@ -121,9 +121,9 @@ CrossEntropyLoss - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 ::::::::: - - **input** (Tensor): 输入 `Tensor`，数据类型为 float32 或 float64。其形状为 :math:`[N, C]`，其中 `C` 为类别数。对于多维度的情形下，它的形状为 :math:`[N, d_1, d_2, ..., d_k, C]` ，k >= 1。 + - **input** (Tensor): 输入 ``Tensor``，数据类型为 float32 或 float64。其形状为 :math:`[N, C]`，其中 ``C`` 为类别数。对于多维度的情形下，它的形状为 :math:`[N, d_1, d_2, ..., d_k, C]` ，k >= 1。 - **label** (Tensor): 当 soft_label=False 时，输入 input 对应的标签值，数据类型为 int64。其形状为 :math:`[N]`，每个元素符合条件：0 <= label[i] <= C-1。对于多维度的情形下，它的形状为 :math:`[N, d_1, d_2, ..., d_k]` ，k >= 1；当 soft_label=True 且没有指定 label_smoothing 时，要求 label 的维度、数据类型与 input 相同，每个样本的各标签概率和应为 1；当指定了 label_smoothing (label_smoothing > 0.0) 时， 无论 soft_label 是什么值， label 的维度和数据类型可以是前面两种情况中的任意一种。换句话说，如果 label_smoothing > 0.0， label 可以是独热标签或整数标签。 - - **output** (Tensor): 计算 `CrossEntropyLoss` 交叉熵后的损失值。 + - **output** (Tensor): 计算 ``CrossEntropyLoss`` 交叉熵后的损失值。 代码示例 diff --git a/docs/api/paddle/nn/GaussianNLLLoss_cn.rst b/docs/api/paddle/nn/GaussianNLLLoss_cn.rst index 595dad72487..1599d9b62a9 100644 --- a/docs/api/paddle/nn/GaussianNLLLoss_cn.rst +++ b/docs/api/paddle/nn/GaussianNLLLoss_cn.rst @@ -35,7 +35,7 @@ GaussianNLLLoss 返回 ::::::::: - - **output** (Tensor) - 输入 :attr:`input`、 :attr:`variance` 和 :attr:`label` 间的 `GaussianNLLLoss` 损失。如果 `reduction` 为 `'none'`，则输出 Loss 形状与输入相同为 `(N, *)`。如果 `reduction` 为 `'sum'` 或者 `'mean'`，则输出 Loss 形状为 `'(1)'` 。 + - **output** (Tensor) - 输入 :attr:`input`、 :attr:`variance` 和 :attr:`label` 间的 ``GaussianNLLLoss`` 损失。如果 ``reduction`` 为 ``'none'``，则输出 Loss 形状与输入相同为 ``(N, *)``。如果 ``reduction`` 为 ``'sum'`` 或者 ``'mean'``，则输出 Loss 形状为 ``'(1)'`` 。 代码示例 diff --git a/docs/api/paddle/nn/HingeEmbeddingLoss_cn.rst b/docs/api/paddle/nn/HingeEmbeddingLoss_cn.rst index 461a2f25165..4eca59f2aba 100644 --- a/docs/api/paddle/nn/HingeEmbeddingLoss_cn.rst +++ b/docs/api/paddle/nn/HingeEmbeddingLoss_cn.rst @@ -29,13 +29,13 @@ HingeEmbeddingLoss 参数 ::::::::: - - **margin** (float，可选): - 当 label 为 -1 时，该值决定了小于 `margin` 的 input 才需要纳入 `hinge embedding loss` 的计算。默认为 1.0 。 - - **reduction** (str，可选): - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 `hinge embedding loss` 的均值；设置为 ``'sum'`` 时，计算 `hinge embedding loss` 的总和；设置为 ``'none'`` 时，则返回 `hinge embedding loss`。 + - **margin** (float，可选): - 当 label 为 -1 时，该值决定了小于 ``margin`` 的 input 才需要纳入 ``hinge embedding loss`` 的计算。默认为 1.0 。 + - **reduction** (str，可选): - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 ``hinge embedding loss`` 的均值；设置为 ``'sum'`` 时，计算 ``hinge embedding loss`` 的总和；设置为 ``'none'`` 时，则返回 ``hinge embedding loss``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 输入 ::::::::: - - **input** (Tensor): - 输入 Tensor，维度是 [N, *]，其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64。 + - **input** (Tensor): - 输入 Tensor，维度是 [N, *]，其中 N 是 batch size， ``*`` 是任意数量的额外维度。数据类型为：float32、float64。 - **label** (Tensor): - 标签，维度是 [N, *]，与 ``input`` 相同，Tensor 中的值应该只包含 1 和 -1。数据类型为：float32、float64。 返回 @@ -44,9 +44,9 @@ HingeEmbeddingLoss 形状 ::::::::: - - **input** (Tensor): - 输入的 Tensor，维度是 [N, *]，其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64。 + - **input** (Tensor): - 输入的 Tensor，维度是 [N, *]，其中 N 是 batch size， ``*`` 是任意数量的额外维度。数据类型为：float32、float64。 - **label** (Tensor): - 标签，维度是 [N, *]，与 ``input`` 相同，应该只包含 1 和 -1。数据类型为：float32、float64。 - - **output** (Tensor): - 输入 ``input`` 和标签 ``label`` 间的 `hinge embedding loss` 损失。如果 `reduction` 是 ``'none'``，则输出 Loss 的维度为 [N, *]，与输入 ``input`` 相同。如果 `reduction` 是 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 + - **output** (Tensor): - 输入 ``input`` 和标签 ``label`` 间的 ``hinge embedding loss`` 损失。如果 ``reduction`` 是 ``'none'``，则输出 Loss 的维度为 [N, *]，与输入 ``input`` 相同。如果 ``reduction`` 是 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 代码示例 ::::::::: diff --git a/docs/api/paddle/nn/KLDivLoss_cn.rst b/docs/api/paddle/nn/KLDivLoss_cn.rst index 42b2e8e94db..6d85a1af2af 100644 --- a/docs/api/paddle/nn/KLDivLoss_cn.rst +++ b/docs/api/paddle/nn/KLDivLoss_cn.rst @@ -37,9 +37,9 @@ KLDivLoss 形状 :::::::::::: - - **input** (Tensor)：输入的 Tensor，维度是[N, *]，其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64。 + - **input** (Tensor)：输入的 Tensor，维度是[N, *]，其中 N 是 batch size， ``*`` 是任意数量的额外维度。数据类型为：float32、float64。 - **label** (Tensor)：标签，维度是[N, *]，与 ``input`` 相同。数据类型为：float32、float64。 - - **output** (Tensor)：输入 ``input`` 和标签 ``label`` 间的 kl 散度。如果 `reduction` 是 ``'none'``，则输出 Loss 的维度为 [N, *]，与输入 ``input`` 相同。如果 `reduction` 是 ``'batchmean'`` 、 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 + - **output** (Tensor)：输入 ``input`` 和标签 ``label`` 间的 kl 散度。如果 ``reduction`` 是 ``'none'``，则输出 Loss 的维度为 [N, *]，与输入 ``input`` 相同。如果 ``reduction`` 是 ``'batchmean'`` 、 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 代码示例 :::::::::::: diff --git a/docs/api/paddle/nn/L1Loss_cn.rst b/docs/api/paddle/nn/L1Loss_cn.rst index 59cc17d9d2a..0e469184927 100644 --- a/docs/api/paddle/nn/L1Loss_cn.rst +++ b/docs/api/paddle/nn/L1Loss_cn.rst @@ -27,14 +27,14 @@ L1Loss 参数 ::::::::: - - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 `L1Loss` 的均值；设置为 ``'sum'`` 时，计算 `L1Loss` 的总和；设置为 ``'none'`` 时，则返回 `L1Loss`。 + - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 ``L1Loss`` 的均值；设置为 ``'sum'`` 时，计算 ``L1Loss`` 的总和；设置为 ``'none'`` 时，则返回 ``L1Loss``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 ::::::::: - - **input** (Tensor)：输入的 Tensor，维度是[N, *]，其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64、int32、int64。 + - **input** (Tensor)：输入的 Tensor，维度是[N, *]，其中 N 是 batch size， ``*`` 是任意数量的额外维度。数据类型为：float32、float64、int32、int64。 - **label** (Tensor)：标签，维度是[N, *]，与 ``input`` 相同。数据类型为：float32、float64、int32、int64。 - - **output** (Tensor)：输入 ``input`` 和标签 ``label`` 间的 `L1 loss` 损失。如果 `reduction` 是 ``'none'``，则输出 Loss 的维度为 [N, *]，与输入 ``input`` 相同。如果 `reduction` 是 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 + - **output** (Tensor)：输入 ``input`` 和标签 ``label`` 间的 ``L1 loss`` 损失。如果 ``reduction`` 是 ``'none'``，则输出 Loss 的维度为 [N, *]，与输入 ``input`` 相同。如果 ``reduction`` 是 ``'mean'`` 或 ``'sum'``，则输出 Loss 的维度为 []。 代码示例 ::::::::: diff --git a/docs/api/paddle/nn/LayerDict_cn.rst b/docs/api/paddle/nn/LayerDict_cn.rst index c1e7511a4a2..7b549d1ce06 100644 --- a/docs/api/paddle/nn/LayerDict_cn.rst +++ b/docs/api/paddle/nn/LayerDict_cn.rst @@ -13,7 +13,7 @@ LayerDict 用于保存子层到有序字典中，它包含的子层将被正确 参数 :::::::::::: - - **sublayers** (LayerDict|OrderedDict|list[(key, Layer)]，可选) - 键值对的可迭代对象，值的类型为 `paddle.nn.Layer` 。 + - **sublayers** (LayerDict|OrderedDict|list[(key, Layer)]，可选) - 键值对的可迭代对象，值的类型为 ``paddle.nn.Layer`` 。 代码示例 diff --git a/docs/api/paddle/nn/MaxPool1D_cn.rst b/docs/api/paddle/nn/MaxPool1D_cn.rst index b115d837a94..5fcb3ecd276 100755 --- a/docs/api/paddle/nn/MaxPool1D_cn.rst +++ b/docs/api/paddle/nn/MaxPool1D_cn.rst @@ -18,7 +18,7 @@ MaxPool1D ::::::::: - **kernel_size** (int|list|tuple) - 池化核的尺寸大小。如果 kernel_size 为 list 或 tuple 类型，其必须包含一个整数，最终池化核的大小为该数值。 - **stride** (int|list|tuple，可选) - 池化操作步长。如果 stride 为 list 或 tuple 类型，其必须包含一个整数，最终池化操作的步长为该数值。默认值为 None，这时会使用 kernel_size 作为 stride。 - - **padding** (str|int|list|tuple，可选) - 池化补零的方式。如果 padding 是一个字符串，则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型，若其长度为 1，则会在输入的两端都填充上长度为 padding[0] 的 0，若其长度为 2，则应是 `[pad_before, pad_after]` 形式。如果 padding 是一个非 0 整数，那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple，则其中的每个元素表示在相应维度上的填充长度。注意：在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。 + - **padding** (str|int|list|tuple，可选) - 池化补零的方式。如果 padding 是一个字符串，则必须为 ``SAME`` 或者 ``VALID``。如果是 tuple 或者 list 类型，若其长度为 1，则会在输入的两端都填充上长度为 padding[0] 的 0，若其长度为 2，则应是 ``[pad_before, pad_after]`` 形式。如果 padding 是一个非 0 整数，那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple，则其中的每个元素表示在相应维度上的填充长度。注意：在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。 - **return_mask** (bool，可选) - 是否返回最大值的索引，默认为 False。别名 ``return_indices``。 ``别名：return_indices`` - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出的 height 和 width，如果设置为 False，则使用 floor 函数来计算，默认为 False。 diff --git a/docs/api/paddle/nn/ModuleDict_cn.rst b/docs/api/paddle/nn/ModuleDict_cn.rst index ed872cac923..3b62ffe8f2b 100644 --- a/docs/api/paddle/nn/ModuleDict_cn.rst +++ b/docs/api/paddle/nn/ModuleDict_cn.rst @@ -16,7 +16,7 @@ ModuleDict 用于保存子层到有序字典中，它包含的子层将被正确 参数 :::::::::::: - - **modules** (ModuleDict|OrderedDict|list[(key, Module)]，可选) - 键值对的可迭代对象，值的类型为 `paddle.nn.Module` 。 + - **modules** (ModuleDict|OrderedDict|list[(key, Module)]，可选) - 键值对的可迭代对象，值的类型为 ``paddle.nn.Module`` 。 代码示例 diff --git a/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst b/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst index d75f830b869..2d8a1af325d 100644 --- a/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst +++ b/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst @@ -30,12 +30,12 @@ MultiLabelSoftMarginLoss 输入 ::::::::: - - **input** (Tensor)：输入 Tensor，维度是 [N, *], 其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64。 + - **input** (Tensor)：输入 Tensor，维度是 [N, *], 其中 N 是 batch size， ``*`` 是任意数量的额外维度。数据类型为：float32、float64。 - **label** (Tensor)：标签，维度是 [N, *], 与 ``input`` 相同，Tensor 中的值应该只包含 1 和 -1。数据类型为：float32、float64。 形状 ::::::::: - - **input** (Tensor)： :math:`[N, *]` , 其中 N 是 batch_size， `*` 是任意其他维度。数据类型是 float32、float64。 + - **input** (Tensor)： :math:`[N, *]` , 其中 N 是 batch_size， ``*`` 是任意其他维度。数据类型是 float32、float64。 - **label** (Tensor)： :math:`[N, *]` ，标签 ``label`` 的维度、数据类型与输入 ``input`` 相同。 - **output** (Tensor)： 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``, 则输出的维度为 :math:`[N, *]` , 与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``, 则输出的维度为 :math:`[]` 。 diff --git a/docs/api/paddle/nn/TripletMarginLoss_cn.rst b/docs/api/paddle/nn/TripletMarginLoss_cn.rst index f2df41e93dd..d6c0be49220 100644 --- a/docs/api/paddle/nn/TripletMarginLoss_cn.rst +++ b/docs/api/paddle/nn/TripletMarginLoss_cn.rst @@ -32,7 +32,7 @@ TripletMarginLoss 形状 ::::::::: - - **input** (Tensor) - :math:`[N, *]`，其中 N 是 batch_size， `*` 是任意其他维度。数据类型是 float32、float64。 + - **input** (Tensor) - :math:`[N, *]`，其中 N 是 batch_size， ``*`` 是任意其他维度。数据类型是 float32、float64。 - **positive** (Tensor) - :math:`[N, *]`，标签 ``positive`` 的维度、数据类型与输入 ``input`` 相同。 - **negative** (Tensor) - :math:`[N, *]`，标签 ``negative`` 的维度、数据类型与输入 ``input`` 相同。 - **output** (Tensor) - 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``，则输出的维度为 :math:`[N, *]`，与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``，则输出的维度为 :math:`[]` 。 diff --git a/docs/api/paddle/nn/TripletMarginWithDistanceLoss_cn.rst b/docs/api/paddle/nn/TripletMarginWithDistanceLoss_cn.rst index 59d19efda0f..bfcc79e1144 100644 --- a/docs/api/paddle/nn/TripletMarginWithDistanceLoss_cn.rst +++ b/docs/api/paddle/nn/TripletMarginWithDistanceLoss_cn.rst @@ -34,7 +34,7 @@ TripletMarginWithDistanceLoss 形状 ::::::::: - - **input** (Tensor) - :math:`[N, *]`，其中 N 是 batch_size， `*` 是任意其他维度。数据类型是 float32、float64。 + - **input** (Tensor) - :math:`[N, *]`，其中 N 是 batch_size， ``*`` 是任意其他维度。数据类型是 float32、float64。 - **positive** (Tensor) - :math:`[N, *]`，标签 ``positive`` 的维度、数据类型与输入 ``input`` 相同。 - **negative** (Tensor) - :math:`[N, *]`，标签 ``negative`` 的维度、数据类型与输入 ``input`` 相同。 - **output** (Tensor) - 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``，则输出的维度为 :math:`[N, *]`，与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``，则输出的维度为 :math:`[]` 。 diff --git a/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst b/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst index 28f43f75a09..44b8f9da4b5 100644 --- a/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst +++ b/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst @@ -25,7 +25,7 @@ https://en.wikipedia.org/wiki/Bilinear_interpolation 参数 :::::::::::: - - **size** (int|list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor，形状为为(out_h, out_w)的 2-D Tensor。如果 :code:`size` 是一个整形数，则 `out_h` 和 `out_w` 都为这个数。如果 :code:`size` 是列表，每一个元素可以是整数或者形状为[]的 0-D Tensor。如果 :code:`size` 是 Tensor，则其为 1D Tensor。默认值为 None。 + - **size** (int|list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor，形状为为(out_h, out_w)的 2-D Tensor。如果 :code:`size` 是一个整形数，则 ``out_h`` 和 ``out_w`` 都为这个数。如果 :code:`size` 是列表，每一个元素可以是整数或者形状为[]的 0-D Tensor。如果 :code:`size` 是 Tensor，则其为 1D Tensor。默认值为 None。 - **scale_factor** (float|Tensor|list|tuple|None) - 输入的高度或宽度的乘数因子。``size`` 和 ``scale_factor`` 至少要设置一个。``size`` 的优先级高于 ``scale_factor``。默认值为 None。如果 ``scale_factor`` 是一个 list 或 tuple，它必须与输入的 shape 匹配。 - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 4-D Tensor，支持 NCHW(num_batches, channels, height, width) 或者 NHWC(num_batches, height, width, channels)，默认值：'NCHW'。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/UpsamplingNearest2D_cn.rst b/docs/api/paddle/nn/UpsamplingNearest2D_cn.rst index db2b4f03511..247ac0dea79 100644 --- a/docs/api/paddle/nn/UpsamplingNearest2D_cn.rst +++ b/docs/api/paddle/nn/UpsamplingNearest2D_cn.rst @@ -53,7 +53,7 @@ https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation 参数 :::::::::::: - - **size** (int|list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor，形状为(out_h, out_w)的 2-D Tensor。如果 :code:`size` 是一个整形数，则 `out_h` 和 `out_w` 都为这个数。如果 :code:`size` 是列表，每一个元素可以是整数或者形状为[]的 0-D Tensor。如果 ``size`` 是 Tensor，则其为 1D Tensor。默认值为 None。 + - **size** (int|list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor，形状为(out_h, out_w)的 2-D Tensor。如果 :code:`size` 是一个整形数，则 ``out_h`` 和 ``out_w`` 都为这个数。如果 :code:`size` 是列表，每一个元素可以是整数或者形状为[]的 0-D Tensor。如果 ``size`` 是 Tensor，则其为 1D Tensor。默认值为 None。 - **scale_factor** (float|Tensor|list|None) - 输入的高度或宽度的乘数因子。``size`` 和 ``scale_factor`` 至少要设置一个。``size`` 的优先级高于 ``scale_factor``。默认值为 None。如果 ``scale_factor`` 是一个 list 或 tuple，它必须与输入的 shape 匹配。 - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 4-D Tensor，支持 NCHW(num_batches, channels, height, width) 或者 NHWC(num_batches, height, width, channels)，默认值：'NCHW'。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/ZeroPad1D_cn.rst b/docs/api/paddle/nn/ZeroPad1D_cn.rst index 6773a902436..416b758f20a 100644 --- a/docs/api/paddle/nn/ZeroPad1D_cn.rst +++ b/docs/api/paddle/nn/ZeroPad1D_cn.rst @@ -13,7 +13,7 @@ ZeroPad1D - **padding** (Tensor | List[int] | int) - 如果输入数据类型为 int，则在所有待填充边界使用相同的填充， 否则填充的格式为[pad_left, pad_right]。 - - **data_format** (str) - 指定输入的 format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``，其中 `N` 是 batch size， `C` 是通道数， `L` 输入特征的长度。 + - **data_format** (str) - 指定输入的 format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``，其中 ``N`` 是 batch size， ``C`` 是通道数， ``L`` 输入特征的长度。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/ZeroPad3D_cn.rst b/docs/api/paddle/nn/ZeroPad3D_cn.rst index 9e40c1de5dd..285fa088855 100644 --- a/docs/api/paddle/nn/ZeroPad3D_cn.rst +++ b/docs/api/paddle/nn/ZeroPad3D_cn.rst @@ -13,7 +13,7 @@ ZeroPad3D - **padding** (Tensor | List[int] | int) - 如果输入数据类型为 int，则在所有待填充边界使用相同的填充， 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。 - - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``，其中 `N` 是批尺寸， `C` 是通道数， `D` 是特征层深度， `H` 是特征层高度， `W` 是特征层宽度。。 + - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``，其中 ``N`` 是批尺寸， ``C`` 是通道数， ``D`` 是特征层深度， ``H`` 是特征层高度， ``W`` 是特征层宽度。。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/avg_pool2d_cn.rst b/docs/api/paddle/nn/functional/avg_pool2d_cn.rst index 4dd9cf21237..5833c6bab95 100644 --- a/docs/api/paddle/nn/functional/avg_pool2d_cn.rst +++ b/docs/api/paddle/nn/functional/avg_pool2d_cn.rst @@ -23,13 +23,13 @@ avg_pool2d 参数 ::::::::: - - **x** (Tensor)：形状为 `[N,C,H,W]` 或 `[N,H,W,C]` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32 或 float64。 + - **x** (Tensor)：形状为 ``[N,C,H,W]`` 或 ``[N,H,W,C]`` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32 或 float64。 - **kernel_size** (int|list|tuple)：池化核大小。如果它是一个元组或列表，它必须包含两个整数值，(pool_size_Height, pool_size_Width)。若为一个整数，则它的平方值将作为池化核大小，比如若 pool_size=2，则池化核大小为 2x2。 - **stride** (int|list|tuple)：池化层的步长。如果它是一个元组或列表，它将包含两个整数，(pool_stride_Height, pool_stride_Width)。若为一个整数，则表示 H 和 W 维度上 stride 均为该值。默认值为 kernel_size。 - **padding** (str|int|list|tuple，可选) 池化填充。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 2 个整数值：[pad_height, pad_width]；(2)包含 4 个整数值：[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]；(3)包含 4 个二元组：当 data_format 为"NCHW"时为 [[0,0], [0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NHWC"时为[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 H 和 W 维度上均为该值。默认值：0。 - - **ceil_mode** (bool)：是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。默认为 None - - **exclusive** (bool)：是否在平均池化模式忽略填充值，默认是 `True`。 - - **divisor_override** (int|float)：如果指定，它将用作除数，否则根据`kernel_size`计算除数。默认`None`。 + - **ceil_mode** (bool)：是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 ``ceil`` 计算输出形状的大小。默认为 None + - **exclusive** (bool)：是否在平均池化模式忽略填充值，默认是 ``True``。 + - **divisor_override** (int|float)：如果指定，它将用作除数，否则根据 ``kernel_size`` 计算除数。默认 ``None``。 - **data_format** (str)：输入和输出的数据格式，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW" - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/avg_pool3d_cn.rst b/docs/api/paddle/nn/functional/avg_pool3d_cn.rst index 1e8d3d6f35f..d71c85d179e 100644 --- a/docs/api/paddle/nn/functional/avg_pool3d_cn.rst +++ b/docs/api/paddle/nn/functional/avg_pool3d_cn.rst @@ -30,9 +30,9 @@ avg_pool3d - **kernel_size** (int|list|tuple)：池化核大小。如果它是一个元组或列表，它必须包含三个整数值，(pool_size_Depth, pool_size_Height, pool_size_Width)。若为一个整数，则表示 D，H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为[2,2,2]。 - **stride** (int|list|tuple)：池化层的步长。如果它是一个元组或列表，它将包含两个整数，(pool_stride_Height, pool_stride_Width)。若为一个整数，则表示 H 和 W 维度上 stride 均为该值。默认值为 kernel_size。 - **padding** (string|int|list|tuple) 池化填充。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 3 个整数值：[pad_depth, pad_height, pad_width]；(2)包含 6 个整数值：[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]；(3)包含 5 个二元组：当 data_format 为"NCDHW"时为[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NDHWC"时为[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 D、H 和 W 维度上均为该值。默认值：0。 - - **ceil_mode** (bool)：是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。默认为 False - - **exclusive** (bool)：是否在平均池化模式忽略填充值，默认是 `True`。 - - **divisor_override** (int|float)：如果指定，它将用作除数，否则根据`kernel_size`计算除数。默认`None`。 + - **ceil_mode** (bool)：是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 ``ceil`` 计算输出形状的大小。默认为 False + - **exclusive** (bool)：是否在平均池化模式忽略填充值，默认是 ``True``。 + - **divisor_override** (int|float)：如果指定，它将用作除数，否则根据 ``kernel_size`` 计算除数。默认 ``None``。 - **data_format** (str)：输入和输出的数据格式，可以是"NCDHW"和"NDHWC"。N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度。默认值："NDCHW"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/bilinear_cn.rst b/docs/api/paddle/nn/functional/bilinear_cn.rst index 44ba51739d0..ecec02586a5 100644 --- a/docs/api/paddle/nn/functional/bilinear_cn.rst +++ b/docs/api/paddle/nn/functional/bilinear_cn.rst @@ -11,8 +11,8 @@ bilinear 参数 ::::::::: - - **x1** (int)：第一个输入的 `Tensor`，数据类型为：float32、float64。 - - **x2** (int)：第二个输入的 `Tensor`，数据类型为：float32、float64。 + - **x1** (int)：第一个输入的 ``Tensor``，数据类型为：float32、float64。 + - **x2** (int)：第二个输入的 ``Tensor``，数据类型为：float32、float64。 - **weight** (Parameter)：本层的可学习参数。形状是 [out_features, in1_features, in2_features]。 - **bias** (Parameter，可选)：本层的可学习偏置。形状是 [1, out_features]。默认值为 None，如果被设置成 None，则不会有 bias 加到 output 结果上。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/fractional_max_pool2d_cn.rst b/docs/api/paddle/nn/functional/fractional_max_pool2d_cn.rst index 7a1b95c09a9..7ff9246d325 100644 --- a/docs/api/paddle/nn/functional/fractional_max_pool2d_cn.rst +++ b/docs/api/paddle/nn/functional/fractional_max_pool2d_cn.rst @@ -34,12 +34,12 @@ fractional_max_pool2d 参数 ::::::::: - - **x** (Tensor)：当前算子的输入，其是一个形状为 `[N, C, H, W]` 的 4-D Tensor。其中 `N` 是 batch size, `C` 是通道数， `H` 是输入特征的高度， `W` 是输入特征的宽度。其数据类型为 `float16`, `bfloat16`, `float32`, `float64` 。别名 ``input``。 - - **output_size** (int|list|tuple)：算子输出图的尺寸，其数据类型为 int 或 list，tuple。如果输出为 tuple 或者 list，则必须包含两个元素， `(H, W)` 。 `H` 和 `W` 可以是 `int` ，也可以是 `None` ，表示与输入保持一致。 - - **kernel_size** (int|list|tuple, 可选) - 池化核大小。如果它是一个元组或列表，它必须包含两个整数值，(pool_size_Height, pool_size_Width)。若为一个整数，则表示 H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为 [2,2]。默认为 `None`，表示使用 `disjoint` (`non-overlapping`) 模式。 - - **random_u** (float)：分数阶池化操作的浮点随机数，取值范围为 `(0, 1)` 。默认为 `None` ，由框架随机生成，可以使用 `paddle.seed` 设置随机种子。 - - **return_mask** (bool，可选)：如果设置为 `True` ，则会与输出一起返回最大值的索引，默认为 `False`。别名 ``return_indices``。 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 `None`。 + - **x** (Tensor)：当前算子的输入，其是一个形状为 ``[N, C, H, W]`` 的 4-D Tensor。其中 ``N`` 是 batch size, ``C`` 是通道数， ``H`` 是输入特征的高度， ``W`` 是输入特征的宽度。其数据类型为 ``float16``, ``bfloat16``, ``float32``, ``float64`` 。别名 ``input``。 + - **output_size** (int|list|tuple)：算子输出图的尺寸，其数据类型为 int 或 list，tuple。如果输出为 tuple 或者 list，则必须包含两个元素， ``(H, W)`` 。 ``H`` 和 ``W`` 可以是 ``int`` ，也可以是 ``None`` ，表示与输入保持一致。 + - **kernel_size** (int|list|tuple, 可选) - 池化核大小。如果它是一个元组或列表，它必须包含两个整数值，(pool_size_Height, pool_size_Width)。若为一个整数，则表示 H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为 [2,2]。默认为 ``None``，表示使用 ``disjoint`` (``non-overlapping``) 模式。 + - **random_u** (float)：分数阶池化操作的浮点随机数，取值范围为 ``(0, 1)`` 。默认为 ``None`` ，由框架随机生成，可以使用 ``paddle.seed`` 设置随机种子。 + - **return_mask** (bool，可选)：如果设置为 ``True`` ，则会与输出一起返回最大值的索引，默认为 ``False``。别名 ``return_indices``。 + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 ``None``。 返回 ::::::::: diff --git a/docs/api/paddle/nn/functional/fractional_max_pool3d_cn.rst b/docs/api/paddle/nn/functional/fractional_max_pool3d_cn.rst index 31aaf6d0e98..b138840c138 100644 --- a/docs/api/paddle/nn/functional/fractional_max_pool3d_cn.rst +++ b/docs/api/paddle/nn/functional/fractional_max_pool3d_cn.rst @@ -34,12 +34,12 @@ fractional_max_pool3d 参数 ::::::::: - - **x** (Tensor)：当前算子的输入，其是一个形状为 `[N, C, D, H, W]` 的 5-D Tensor。其中 `N` 是 batch size, `C` 是通道数， `D` 是输入特征的深度， `H` 是输入特征的高度， `W` 是输入特征的宽度。其数据类型为 `float16`, `bfloat16`, `float32`, `float64` 。别名 ``input``。 - - **output_size** (int|list|tuple)：算子输出图的尺寸，其数据类型为 int 或 list，tuple。如果输出为 tuple 或者 list，则必须包含三个元素， `(D, H, W)` 。 `D`, `H` 和 `W` 可以是 `int` ，也可以是 `None` ，表示与输入保持一致。 - - **kernel_size** (int|list|tuple，可选) - 池化核大小。如果它是一个元组或列表，它必须包含三个整数值，(pool_size_Depth，pool_size_Height, pool_size_Width)。若为一个整数，则表示 D，H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为[2,2,2]。默认为 `None`，表示使用 `disjoint` (`non-overlapping`) 模式。 - - **random_u** (float)：分数阶池化操作的浮点随机数，取值范围为 `(0, 1)` 。默认为 `None` ，由框架随机生成，可以使用 `paddle.seed` 设置随机种子。 - - **return_mask** (bool，可选)：如果设置为 `True` ，则会与输出一起返回最大值的索引，默认为 `False`。别名 ``return_indices``。 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 `None`。 + - **x** (Tensor)：当前算子的输入，其是一个形状为 ``[N, C, D, H, W]`` 的 5-D Tensor。其中 ``N`` 是 batch size, ``C`` 是通道数， ``D`` 是输入特征的深度， ``H`` 是输入特征的高度， ``W`` 是输入特征的宽度。其数据类型为 ``float16``, ``bfloat16``, ``float32``, ``float64`` 。别名 ``input``。 + - **output_size** (int|list|tuple)：算子输出图的尺寸，其数据类型为 int 或 list，tuple。如果输出为 tuple 或者 list，则必须包含三个元素， ``(D, H, W)`` 。 ``D``, ``H`` 和 ``W`` 可以是 ``int`` ，也可以是 ``None`` ，表示与输入保持一致。 + - **kernel_size** (int|list|tuple，可选) - 池化核大小。如果它是一个元组或列表，它必须包含三个整数值，(pool_size_Depth，pool_size_Height, pool_size_Width)。若为一个整数，则表示 D，H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为[2,2,2]。默认为 ``None``，表示使用 ``disjoint`` (``non-overlapping``) 模式。 + - **random_u** (float)：分数阶池化操作的浮点随机数，取值范围为 ``(0, 1)`` 。默认为 ``None`` ，由框架随机生成，可以使用 ``paddle.seed`` 设置随机种子。 + - **return_mask** (bool，可选)：如果设置为 ``True`` ，则会与输出一起返回最大值的索引，默认为 ``False``。别名 ``return_indices``。 + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 ``None``。 返回 ::::::::: diff --git a/docs/api/paddle/nn/functional/lp_pool2d_cn.rst b/docs/api/paddle/nn/functional/lp_pool2d_cn.rst index fc17ebfd98b..8c07594242d 100644 --- a/docs/api/paddle/nn/functional/lp_pool2d_cn.rst +++ b/docs/api/paddle/nn/functional/lp_pool2d_cn.rst @@ -30,12 +30,12 @@ lp_pool2d 参数 ::::::::: - - **x** (Tensor)：形状为 `[N,C,H,W]` 或 `[N,H,W,C]` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32 或 float64。 + - **x** (Tensor)：形状为 ``[N,C,H,W]`` 或 ``[N,H,W,C]`` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32 或 float64。 - **norm_type** (int|float)：幂平均池化的指数，不可以为 0。 - **kernel_size** (int|list|tuple)：池化核大小。如果它是一个元组或列表，它必须包含两个整数值，(pool_size_Height, pool_size_Width)。若为一个整数，则它的平方值将作为池化核大小，比如若 pool_size=2，则池化核大小为 2x2。 - **stride** (int|list|tuple)：池化层的步长。如果它是一个元组或列表，它将包含两个整数，(pool_stride_Height, pool_stride_Width)。若为一个整数，则表示 H 和 W 维度上 stride 均为该值。默认值为 kernel_size。 - **padding** (string|int|list|tuple) 池化填充。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 2 个整数值：[pad_height, pad_width]；(2)包含 4 个整数值：[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]；(3)包含 4 个二元组：当 data_format 为"NCHW"时为 [[0,0], [0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NHWC"时为[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 H 和 W 维度上均为该值。默认值：0。 - - **ceil_mode** (bool)：是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。默认为 None + - **ceil_mode** (bool)：是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 ``ceil`` 计算输出形状的大小。默认为 None - **data_format** (str)：输入和输出的数据格式，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW" - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/max_pool2d_cn.rst b/docs/api/paddle/nn/functional/max_pool2d_cn.rst index 253d4dce40b..2750f05743a 100644 --- a/docs/api/paddle/nn/functional/max_pool2d_cn.rst +++ b/docs/api/paddle/nn/functional/max_pool2d_cn.rst @@ -24,12 +24,12 @@ max_pool2d 参数 ::::::::: - - **x** (Tensor) - 形状为 `[N,C,H,W]` 或 `[N,H,W,C]` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32 或 float64。别名 ``input``。 + - **x** (Tensor) - 形状为 ``[N,C,H,W]`` 或 ``[N,H,W,C]`` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32 或 float64。别名 ``input``。 - **kernel_size** (int|list|tuple) - 池化核大小。如果它是一个元组或列表，它必须包含两个整数值，(pool_size_Height, pool_size_Width)。若为一个整数，则它的平方值将作为池化核大小，比如若 pool_size=2，则池化核大小为 2x2。 - **stride** (int|list|tuple) - 池化层的步长。如果它是一个元组或列表，它将包含两个整数，(pool_stride_Height, pool_stride_Width)。若为一个整数，则表示 H 和 W 维度上 stride 均为该值。默认值为 kernel_size。 - **padding** (string|int|list|tuple) - 池化填充。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 2 个整数值：[pad_height, pad_width]；(2)包含 4 个整数值：[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]；(3)包含 4 个二元组：当 data_format 为"NCHW"时为 [[0,0], [0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NHWC"时为[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 H 和 W 维度上均为该值。默认值：0。 - **return_mask** (bool) - 是否返回最大索引和输出。默认为 False。别名 ``return_indices``。 - - **ceil_mode** (bool) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。默认为 False。 + - **ceil_mode** (bool) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 ``ceil`` 计算输出形状的大小。默认为 False。 - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型，其必须包含两个整数：[dilation_height, dilation_width]。若为一个整数，则表示 H 和 W 维度上均为该值。默认值：1。 - **data_format** (str) - 输入和输出的数据格式，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/max_pool3d_cn.rst b/docs/api/paddle/nn/functional/max_pool3d_cn.rst index a3d57d9c580..295590da359 100644 --- a/docs/api/paddle/nn/functional/max_pool3d_cn.rst +++ b/docs/api/paddle/nn/functional/max_pool3d_cn.rst @@ -28,7 +28,7 @@ max_pool3d - **stride** (int|list|tuple) - 池化层的步长。如果它是一个元组或列表，它将包含三个整数，(pool_stride_Depth，pool_stride_Height, pool_stride_Width)。若为一个整数，则表示 D, H 和 W 维度上 stride 均为该值。默认值为 kernel_size。 - **padding** (string|int|list|tuple) - 池化填充。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 3 个整数值：[pad_depth, pad_height, pad_width]；(2)包含 6 个整数值：[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]；(3)包含 5 个二元组：当 data_format 为"NCDHW"时为[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NDHWC"时为[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 D、H 和 W 维度上均为该值。默认值：0。 - **return_mask** (bool) - 是否返回最大索引和输出。默认为 False。别名 ``return_indices``。 - - **ceil_mode** (bool) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。默认为 False。 + - **ceil_mode** (bool) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 ``ceil`` 计算输出形状的大小。默认为 False。 - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型，其必须包含 3 个整数：[dilation_depth, dilation_height, dilation_width]。若为一个整数，则表示 D、H 和 W 维度上均为该值。默认值：1。 - **data_format** (str) - 输入和输出的数据格式，可以是"NCDHW"和"NDHWC"。N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度。默认值："NCDHW"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/max_unpool1d_cn.rst b/docs/api/paddle/nn/functional/max_unpool1d_cn.rst index d2e4f8aa2f1..4beec3e91a0 100644 --- a/docs/api/paddle/nn/functional/max_unpool1d_cn.rst +++ b/docs/api/paddle/nn/functional/max_unpool1d_cn.rst @@ -24,8 +24,8 @@ max_unpool1d 参数 ::::::::: - - **x** (Tensor) - 形状为 `[N,C,L]` 的 3-D Tensor，N 是批尺寸，C 是通道数，L 是特征长度，数据类型为 float32， float64 或 int64。 - - **indices** (Tensor) - 形状为 `[N,C,L]` 的 3-D Tensor，N 是批尺寸，C 是通道数，L 是特征长度，数据类型为 int32 或 int64。 + - **x** (Tensor) - 形状为 ``[N,C,L]`` 的 3-D Tensor，N 是批尺寸，C 是通道数，L 是特征长度，数据类型为 float32， float64 或 int64。 + - **indices** (Tensor) - 形状为 ``[N,C,L]`` 的 3-D Tensor，N 是批尺寸，C 是通道数，L 是特征长度，数据类型为 int32 或 int64。 - **kernel_size** (int|list|tuple) - 反池化的滑动窗口大小。 - **stride** (int|list|tuple，可选) - 池化层的步长。如果它是一个元组或列表，它必须包含一个整数，(pool_stride_Length)，默认值：None。 - **padding** (str|int|list|tuple，可选) - 池化填充，默认值：0。 diff --git a/docs/api/paddle/nn/functional/max_unpool2d_cn.rst b/docs/api/paddle/nn/functional/max_unpool2d_cn.rst index 9ac94cac724..1b6e59de84f 100644 --- a/docs/api/paddle/nn/functional/max_unpool2d_cn.rst +++ b/docs/api/paddle/nn/functional/max_unpool2d_cn.rst @@ -27,8 +27,8 @@ max_unpool2d 参数 ::::::::: - - **x** (Tensor) - 形状为 `[N,C,H,W]` 或 `[N,H,W,C]` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32， float64 或 int64。 - - **indices** (Tensor) - 形状为 `[N,C,H,W]` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 int32 或 int64。 + - **x** (Tensor) - 形状为 ``[N,C,H,W]`` 或 ``[N,H,W,C]`` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 float32， float64 或 int64。 + - **indices** (Tensor) - 形状为 ``[N,C,H,W]`` 的 4-D Tensor，N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度，数据类型为 int32 或 int64。 - **kernel_size** (int|list|tuple) - 反池化的滑动窗口大小。 - **stride** (int|list|tuple，可选) - 池化层的步长。如果它是一个元组或列表，它必须是两个相等的整数，(pool_stride_Height, pool_stride_Width)，默认值：None。 - **padding** (str|int|list|tuple，可选) - 池化填充，默认值：0。 diff --git a/docs/api/paddle/nn/functional/max_unpool3d_cn.rst b/docs/api/paddle/nn/functional/max_unpool3d_cn.rst index e9f7effbd55..487639fe4e8 100644 --- a/docs/api/paddle/nn/functional/max_unpool3d_cn.rst +++ b/docs/api/paddle/nn/functional/max_unpool3d_cn.rst @@ -30,8 +30,8 @@ max_unpool3d 参数 ::::::::: - - **x** (Tensor) - 形状为 `[N,C,D,H,W]` 的 5-D Tensor，N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度，数据类型为 float32， float64 或 int64。 - - **indices** (Tensor) - 形状为 `[N,C,D,H,W]` 的 5-D Tensor，N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度，数据类型为 int32 或 int64。 + - **x** (Tensor) - 形状为 ``[N,C,D,H,W]`` 的 5-D Tensor，N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度，数据类型为 float32， float64 或 int64。 + - **indices** (Tensor) - 形状为 ``[N,C,D,H,W]`` 的 5-D Tensor，N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度，数据类型为 int32 或 int64。 - **kernel_size** (int|list|tuple) - 反池化的滑动窗口大小。 - **stride** (int|list|tuple，可选) - 池化层的步长。如果它是一个元组或列表，它必须是三个相等的整数，(pool_stride_Depth, pool_stride_Height, pool_stride_Width)，默认值：None。 - **padding** (str|int|list|tuple，可选) - 池化填充，默认值：0。 diff --git a/docs/api/paddle/nn/functional/prelu_cn.rst b/docs/api/paddle/nn/functional/prelu_cn.rst index e0127c33321..8a5f421c96a 100644 --- a/docs/api/paddle/nn/functional/prelu_cn.rst +++ b/docs/api/paddle/nn/functional/prelu_cn.rst @@ -16,7 +16,7 @@ prelu 激活层（PRelu Activation Operator）。计算公式如下： 参数 :::::::::: - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 - - **weight** (Tensor) - 可训练参数，数据类型同``x`` 一致，形状支持：[]、[1] 或者 [in]，其中`in`为输入的通道数。 + - **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/nn/functional/rrelu_cn.rst b/docs/api/paddle/nn/functional/rrelu_cn.rst index f1051073f90..0611ad2e89f 100644 --- a/docs/api/paddle/nn/functional/rrelu_cn.rst +++ b/docs/api/paddle/nn/functional/rrelu_cn.rst @@ -38,9 +38,9 @@ rrelu 激活函数，应用随机纠正线性单元对神经元激活，参考 参数 :::::::::: - - **x** (Tensor) - 输入的 `Tensor`，数据类型为：float16、float32、float64。 - - **lower** (float，可选) - 负值斜率的随机值范围下限，`lower` 包含在范围中。支持的数据类型：float。默认值为 0.125。 - - **upper** (float，可选) - 负值斜率的随机值范围上限，`upper` 包含在范围中。支持的数据类型：float。默认值为 0.333。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float16、float32、float64。 + - **lower** (float，可选) - 负值斜率的随机值范围下限，``lower`` 包含在范围中。支持的数据类型：float。默认值为 0.125。 + - **upper** (float，可选) - 负值斜率的随机值范围上限，``upper`` 包含在范围中。支持的数据类型：float。默认值为 0.333。 - **training** (bool，可选) - 标记是否为训练阶段。默认：True。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/softmax_cn.rst b/docs/api/paddle/nn/functional/softmax_cn.rst index 07385cb4731..705615c8cb6 100644 --- a/docs/api/paddle/nn/functional/softmax_cn.rst +++ b/docs/api/paddle/nn/functional/softmax_cn.rst @@ -88,9 +88,9 @@ softmax - **x** (Tensor) - 输入的 ``Tensor``，数据类型为 bfloat16 、 float16 、 float32 或 float64。别名： ``input``。 - **axis** (int，可选) - 指定对输入 :attr:`x` 进行运算的轴。:attr:`axis` 的有效范围是 :math:`[-D, D)`，:math:`D` 是输入 :attr:`x` 的维度，:attr:`axis` 为负值时与 :math:`axis + D` 等价。默认值为 -1。别名： ``dim``。 - - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出 `Tensor` 的数据类型，支持 bfloat16、 float16、 float32、float64。 + - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出 ``Tensor`` 的数据类型，支持 bfloat16、 float16、 float32、float64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - - **out** (Tensor，可选) - 指定输出结果的 `Tensor`，默认值为 None。 + - **out** (Tensor，可选) - 指定输出结果的 ``Tensor``，默认值为 None。 返回 :::::::::: diff --git a/docs/api/paddle/nn/initializer/Dirac_cn.rst b/docs/api/paddle/nn/initializer/Dirac_cn.rst index 20c0d308638..4c0713f32d0 100644 --- a/docs/api/paddle/nn/initializer/Dirac_cn.rst +++ b/docs/api/paddle/nn/initializer/Dirac_cn.rst @@ -21,7 +21,7 @@ Dirac 参数 ::::::::: - - **groups** (int，可选) - 将参数在 0 维上进行等分为 `groups` 份，每一份执行相同的初始化。默认：1。 + - **groups** (int，可选) - 将参数在 0 维上进行等分为 ``groups`` 份，每一份执行相同的初始化。默认：1。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/initializer/calculate_gain_cn.rst b/docs/api/paddle/nn/initializer/calculate_gain_cn.rst index ba65fbfc0db..5be2e589936 100644 --- a/docs/api/paddle/nn/initializer/calculate_gain_cn.rst +++ b/docs/api/paddle/nn/initializer/calculate_gain_cn.rst @@ -9,7 +9,7 @@ calculate_gain 参数 ::::::::: - - **nonlinearity** (str) - 非线性激活函数的名称。如果输入一个线性的函数，例如：`linear/conv1d/conv2d/conv3d/conv1d_transpose/conv2d_transpose/conv3d_transpose`，则返回 1.0。 + - **nonlinearity** (str) - 非线性激活函数的名称。如果输入一个线性的函数，例如：``linear/conv1d/conv2d/conv3d/conv1d_transpose/conv2d_transpose/conv3d_transpose``，则返回 1.0。 - **param** (bool|int|float，可选) - 某些激活函数的参数，目前仅用于 ``leaky_relu`` 中的计算。默认为 ``None``，此时以 0.01 来参与 ``leaky_relu`` 的增益值计算。 返回 diff --git a/docs/api/paddle/nn/quant/weight_quantize_cn.rst b/docs/api/paddle/nn/quant/weight_quantize_cn.rst index 5e79dda5e1a..64f92d86d51 100644 --- a/docs/api/paddle/nn/quant/weight_quantize_cn.rst +++ b/docs/api/paddle/nn/quant/weight_quantize_cn.rst @@ -9,7 +9,7 @@ weight_only 和 llm.int8 权重的量化函数。 参数 :::::::::::: - **x** (Tensor) - 待量化的输入张量，数据类型为 float16 或 bfloat16。 - - **algo** (str) - 应用于 x 的算法，必须是 '`weight_only_int8`'、'`weight_only_int4`' 和 '`llm.int8`' 中的一个，默认为 '`weight_only_int8`'。 + - **algo** (str) - 应用于 x 的算法，必须是 '``weight_only_int8``'、'``weight_only_int4``' 和 '``llm.int8``' 中的一个，默认为 '``weight_only_int8``'。 - **arch** (int) - 针对目标设备的计算架构。例如，A100 为 80，v100 为 70，如果您没有指定架构，我们将从您的设备获取架构，默认为 None。 返回 diff --git a/docs/api/paddle/optimizer/NAdam_cn.rst b/docs/api/paddle/optimizer/NAdam_cn.rst index 12adfe0dfb3..0aee23e3417 100644 --- a/docs/api/paddle/optimizer/NAdam_cn.rst +++ b/docs/api/paddle/optimizer/NAdam_cn.rst @@ -30,7 +30,7 @@ NAdam 参数 :::::::::::: - - **learning_rate** (float|LRScheduler，可选) - 学习率，用于参数更新的计算。可以是一个浮点型值或者一个 `LRScheduler` 类。默认值为 0.002。 + - **learning_rate** (float|LRScheduler，可选) - 学习率，用于参数更新的计算。可以是一个浮点型值或者一个 ``LRScheduler`` 类。默认值为 0.002。 - **parameters** (list，可选) - 指定优化器需要优化的参数。在动态图模式下必须提供该参数；在静态图模式下默认值为 None，这时所有的参数都将被优化。 - **beta1** (float，可选) - 一阶矩估计的指数衰减率，默认值为 0.9。 - **beta2** (float，可选) - 二阶矩估计的指数衰减率，默认值为 0.999。 diff --git a/docs/api/paddle/optimizer/RAdam_cn.rst b/docs/api/paddle/optimizer/RAdam_cn.rst index 4868908f309..6d2629adfa1 100644 --- a/docs/api/paddle/optimizer/RAdam_cn.rst +++ b/docs/api/paddle/optimizer/RAdam_cn.rst @@ -34,7 +34,7 @@ RAdam 参数 :::::::::::: - - **learning_rate** (float|LRScheduler，可选) - 学习率，用于参数更新的计算。可以是一个浮点型值或者一个 `LRScheduler` 类。默认值为 0.001。 + - **learning_rate** (float|LRScheduler，可选) - 学习率，用于参数更新的计算。可以是一个浮点型值或者一个 ``LRScheduler`` 类。默认值为 0.001。 - **parameters** (list，可选) - 指定优化器需要优化的参数。在动态图模式下必须提供该参数；在静态图模式下默认值为 None，这时所有的参数都将被优化。 - **beta1** (float，可选) - 一阶矩估计的指数衰减率，默认值为 0.9。 - **beta2** (float，可选) - 二阶矩估计的指数衰减率，默认值为 0.999。 diff --git a/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst b/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst index 74810402939..639f7894847 100644 --- a/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/CosineAnnealingDecay_cn.rst @@ -30,7 +30,7 @@ CosineAnnealingDecay - **T_max** (float|int) - 训练的上限轮数，是余弦衰减周期的一半。必须是一个正整数。 - **eta_min** (float|int，可选) - 学习率的最小值，即公式中的 :math:`\eta_{min}`。默认值为 0。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst b/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst index 7b3169ff8b6..02205f1bf6e 100644 --- a/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst +++ b/docs/api/paddle/optimizer/lr/CosineAnnealingWarmRestarts_cn.rst @@ -25,7 +25,7 @@ SGDR 的训练方法可以参考论文，相关论文：`SGDR: Stochastic Gradie - **T_mult** (int，可选) - 重启之后 :math:`T_{i}` 乘积增长因子。默认值 1。 - **eta_min** (float，可选) - 最小学习率。默认值 0. - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst b/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst index 7f75e47cd95..65c73a7aff3 100644 --- a/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst +++ b/docs/api/paddle/optimizer/lr/CyclicLR_cn.rst @@ -27,7 +27,7 @@ CyclicLR - **scale_fn** (function，可选) - 一个有且仅有单个参数的函数，且对于任意的输入 x，都必须满足 0 ≤ scale_fn(x) ≤ 1；如果该参数被指定，则会忽略 mode 参数。默认值为 ``False`` 。 - **scale_mode** (str，可选) - cycle 或者 iterations，表示缩放函数使用 cycle 数或 iterations 数作为输入。默认值为 cycle。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst b/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst index 75a25c689e1..0d1fd7da5a6 100644 --- a/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/ExponentialDecay_cn.rst @@ -19,7 +19,7 @@ ExponentialDecay - **learning_rate** (float) - 初始学习率，数据类型为 Python float。 - **gamma** (float) - 衰减率，``new_lr = origin_lr * gamma`` 。gamma 应该在区间 (0.0, 1.0) 内。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst b/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst index a20ae1dcc25..83a0f866801 100644 --- a/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/InverseTimeDecay_cn.rst @@ -21,7 +21,7 @@ InverseTimeDecay - **learning_rate** (float) - 初始学习率，数据类型为 Python float。 - **gamma** (float) - 衰减率，``new_lr = origin_lr * gamma`` 。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst b/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst index de4b4e49940..82545f3906a 100644 --- a/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst +++ b/docs/api/paddle/optimizer/lr/LRScheduler_cn.rst @@ -51,7 +51,7 @@ LRScheduler - **learning_rate** (float，可选) - 初始学习率，数据类型为 Python float。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst b/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst index 99a12d7e52e..8240b5267ac 100644 --- a/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/LambdaDecay_cn.rst @@ -26,7 +26,7 @@ LambdaDecay - **learning_rate** （float） - 初始学习率，数据类型为 Python float。 - **lr_lambda** （function）：lr_lambda 为一个 lambda 函数，其通过 epoch 计算出一个因子，该因子会乘以初始学习率。 - **last_epoch** （int，可选）：上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** （bool，可选）：如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** （bool，可选）：如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/LinearLR_cn.rst b/docs/api/paddle/optimizer/lr/LinearLR_cn.rst index cfe64cc7419..16f366a2eab 100644 --- a/docs/api/paddle/optimizer/lr/LinearLR_cn.rst +++ b/docs/api/paddle/optimizer/lr/LinearLR_cn.rst @@ -14,10 +14,10 @@ LinearLR - **learning_rate** (float) - 基础学习率，用于确定初始学习率和最终学习率。 - **total_steps** (float) - 学习率从初始学习率线性增长到最终学习率所需要的步数。 - - **start_factor** (float) - 初始学习率因子，通过 `learning_rate * start_factor` 确定。 - - **end_factor** (float) - 最终学习率因子，通过 `learning_rate * end_factor` 确定。 + - **start_factor** (float) - 初始学习率因子，通过 ``learning_rate * start_factor`` 确定。 + - **end_factor** (float) - 最终学习率因子，通过 ``learning_rate * end_factor`` 确定。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst b/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst index 70614a1e10b..fbf8754ad37 100644 --- a/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst +++ b/docs/api/paddle/optimizer/lr/LinearWarmup_cn.rst @@ -30,7 +30,7 @@ LinearWarmup - **start_lr** (float) - warm up 的起始学习率。 - **end_lr** (float) - warm up 的最终学习率。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 diff --git a/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst b/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst index 6f96efe2d64..8afefdcd8d7 100644 --- a/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/MultiStepDecay_cn.rst @@ -27,7 +27,7 @@ MultiStepDecay - **milestones** (list) - 轮数下标列表。必须递增。 - **gamma** (float，可选) - 衰减率，``new_lr = origin_lr * gamma``，衰减率必须小于等于 1.0，默认值为 0.1。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 diff --git a/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst b/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst index b4b78368bcc..36478d552ba 100644 --- a/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/MultiplicativeDecay_cn.rst @@ -26,7 +26,7 @@ MultiplicativeDecay - **learning_rate** （float） - 初始学习率，数据类型为 Python float。 - **lr_lambda** （function）- lr_lambda 为一个 lambda 函数，其通过 epoch 计算出一个因子，该因子会乘以当前学习率。 - **last_epoch** （int，可选）- 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** （bool，可选）- 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** （bool，可选）- 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst b/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst index 505750fcc2b..8b521b501bc 100644 --- a/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/NaturalExpDecay_cn.rst @@ -19,7 +19,7 @@ NaturalExpDecay - **learning_rate** (float) - 初始学习率，数据类型为 Python float。 - **gamma** (float) - 衰减率，gamma 应该大于 0.0，才能使学习率衰减。默认值为 0.1。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst b/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst index 4456629d455..375144e0db8 100644 --- a/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/NoamDecay_cn.rst @@ -23,7 +23,7 @@ Noam 衰减的计算方式如下： - **warmup_steps** (int) - 预热步数，为超参数。数据类型为 Python int。 - **learning_rate** (float) - 初始学习率，数据类型为 Python float。默认值为 1.0。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 `True`，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst b/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst index adbdbe2ea06..ed565df4116 100644 --- a/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst +++ b/docs/api/paddle/optimizer/lr/OneCycleLR_cn.rst @@ -26,7 +26,7 @@ OneCycleLR - **anneal_strategy** (str，可选) - 调整学习率的策略。必须是 ( ``cos`` , ``linear`` )其中之一，``cos`` 表示使用余弦退火，``linear`` 表示线性退火。默认值为 ``cos`` 。 - **three_phase** (bool，可选) - 是否使用三阶段调度策略。如果是 ``True``，学习率将先从初始学习率上升到最大学习率，再从最大学习率下降到初始学习率（这两阶段所需要的迭代数是一致的），最后学习率会下降至最小学习率。如果是 ``False``，学习率在上升至最大学习率之后，直接下降至最小学习率。默认值为 ``False`` 。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/PiecewiseDecay_cn.rst b/docs/api/paddle/optimizer/lr/PiecewiseDecay_cn.rst index 58a99d99863..e62a4f2df12 100644 --- a/docs/api/paddle/optimizer/lr/PiecewiseDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/PiecewiseDecay_cn.rst @@ -27,7 +27,7 @@ PiecewiseDecay - **boundaries** (list) - 指定学习率的边界值列表。列表的数据元素为 Python int 类型。 - **values** (list) - 学习率列表。数据元素类型为 Python float 的列表。与边界值列表有对应的关系。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst b/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst index dda6f2780a3..4311a638a9a 100644 --- a/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/PolynomialDecay_cn.rst @@ -34,7 +34,7 @@ PolynomialDecay - **power** (float，可选) - 多项式的幂，power 应该大于 0.0，才能使学习率衰减。默认值为 1.0。 - **cycle** (bool，可选) - 学习率下降后是否重新上升。若为 True，则学习率衰减到最低学习率值时，会重新上升。若为 False，则学习率单调递减。默认值为 False。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 `True`，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/ReduceOnPlateau_cn.rst b/docs/api/paddle/optimizer/lr/ReduceOnPlateau_cn.rst index ddbd14e3678..015f57094cb 100644 --- a/docs/api/paddle/optimizer/lr/ReduceOnPlateau_cn.rst +++ b/docs/api/paddle/optimizer/lr/ReduceOnPlateau_cn.rst @@ -24,7 +24,7 @@ ReduceOnPlateau - **cooldown** (int，可选) - 在学习率每次衰减之后，会进入时长为 ``cooldown`` 个 step 的冷静期。默认：0。 - **min_lr** (float，可选) - 最小的学习率。衰减后的学习率最低下界限。默认：0。 - **epsilon** (float，可选) - 如果新旧学习率间的差异小于 epsilon，则不会更新。默认值：1e-8。 - - **verbose** (bool，可选) - 如果是 `True`，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 :::::::::::: diff --git a/docs/api/paddle/optimizer/lr/StepDecay_cn.rst b/docs/api/paddle/optimizer/lr/StepDecay_cn.rst index 01f2bc3809e..9ba30bdd694 100644 --- a/docs/api/paddle/optimizer/lr/StepDecay_cn.rst +++ b/docs/api/paddle/optimizer/lr/StepDecay_cn.rst @@ -27,7 +27,7 @@ StepDecay - **step_size** (int) - 学习率衰减轮数间隔。 - **gamma** (float，可选) - 衰减率，``new_lr = origin_lr * gamma``，衰减率必须小于等于 1.0，默认值为 0.1。 - **last_epoch** (int，可选) - 上一轮的轮数，重启训练时设置为上一轮的 epoch 数。默认值为 -1，则为初始学习率。 - - **verbose** (bool，可选) - 如果是 `True`，则在每一轮更新时在标准输出 `stdout` 输出一条信息。默认值为 ``False`` 。 + - **verbose** (bool，可选) - 如果是 ``True``，则在每一轮更新时在标准输出 ``stdout`` 输出一条信息。默认值为 ``False`` 。 返回 diff --git a/docs/api/paddle/select_scatter_cn.rst b/docs/api/paddle/select_scatter_cn.rst index c144c1ce253..c9b73e2e728 100644 --- a/docs/api/paddle/select_scatter_cn.rst +++ b/docs/api/paddle/select_scatter_cn.rst @@ -8,8 +8,8 @@ select_scatter 参数 ::::::::: - - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。别名 ``input``。 - - **values** (Tensor) - 需要插入的值，形状需要与 ``x`` 矩阵除去第 ``axis`` 维后的形状一致，数据类型为： `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。别名 ``src``。 + - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``input``。 + - **values** (Tensor) - 需要插入的值，形状需要与 ``x`` 矩阵除去第 ``axis`` 维后的形状一致，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。别名 ``src``。 - **axis** (int) - 指定沿着哪个维度嵌入对应的值，数据类型为：int。别名 ``dim``。 - **index** (int) - 指定沿着 ``axis`` 维的哪一列嵌入对应的值，数据类型为：int。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/slice_scatter_cn.rst b/docs/api/paddle/slice_scatter_cn.rst index 36ca6bb1704..7ebc4ae80db 100644 --- a/docs/api/paddle/slice_scatter_cn.rst +++ b/docs/api/paddle/slice_scatter_cn.rst @@ -16,13 +16,13 @@ slice_scatter 参数 ::::::::: - - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。 - - **value** (Tensor) - 需要插入的值，数据类型为： `bool`、 `float16`、 `float32`、 `float64`、 `uint8`、 `int8`、 `int16`、 `int32`、 `int64`、 `bfloat16`、 `complex64`、 `complex128`。 + - **x** (Tensor) - 输入的 Tensor 作为目标矩阵，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。 + - **value** (Tensor) - 需要插入的值，数据类型为： ``bool``、 ``float16``、 ``float32``、 ``float64``、 ``uint8``、 ``int8``、 ``int16``、 ``int32``、 ``int64``、 ``bfloat16``、 ``complex64``、 ``complex128``。 - **axes** (list|tuple) - 指定沿着哪几个维度嵌入对应的值。 - **starts** (list|tuple) - 嵌入的起始索引。 - **ends** (list|tuple) - 嵌入的截止索引。 - **strides** (list|tuple) - 嵌入的步长。 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 `None`。 + - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 ``None``。 返回 ::::::::: diff --git a/docs/api/paddle/softmax_cn.rst b/docs/api/paddle/softmax_cn.rst index 364d5e565cf..9dc73cdfe7e 100644 --- a/docs/api/paddle/softmax_cn.rst +++ b/docs/api/paddle/softmax_cn.rst @@ -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。 返回 :::::::::: diff --git a/docs/api/paddle/sparse/addmm_cn.rst b/docs/api/paddle/sparse/addmm_cn.rst index 9307f1c80e3..2e0d3d0f8d3 100644 --- a/docs/api/paddle/sparse/addmm_cn.rst +++ b/docs/api/paddle/sparse/addmm_cn.rst @@ -34,8 +34,8 @@ addmm - **input** (SparseTensor|DenseTensor) - 输入 Tensor，可以为 Coo 或 Csr 格式 或 DenseTensor。数据类型为 float32、float64。 - **x** (SparseTensor) - 输入 Tensor，可以为 Coo 或 Csr 格式。数据类型为 float32、float64。 - **y** (SparseTensor|DenseTensor) - 输入 Tensor，可以为 Coo 或 Csr 格式 或 DenseTensor。数据类型为 float32、float64。 - - **beta** (float, 可选) - `input` 的系数。默认：1.0。 - - **alpha** (float, 可选) - `x * y` 的系数。默认：1.0。 + - **beta** (float, 可选) - ``input`` 的系数。默认：1.0。 + - **alpha** (float, 可选) - ``x * y`` 的系数。默认：1.0。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/sparse/nn/MaxPool3D_cn.rst b/docs/api/paddle/sparse/nn/MaxPool3D_cn.rst index 60cd307a090..99391a3e7ff 100644 --- a/docs/api/paddle/sparse/nn/MaxPool3D_cn.rst +++ b/docs/api/paddle/sparse/nn/MaxPool3D_cn.rst @@ -13,7 +13,7 @@ MaxPool3D - **kernel_size** (int|list|tuple) - 池化核大小。如果它是一个元组或列表，它必须包含三个整数值，(pool_size_Depth，pool_size_Height, pool_size_Width)。若为一个整数，则表示 D，H 和 W 维度上均为该值，比如若 kernel_size=2，则池化核大小为[2,2,2]。 - **stride** (int|list|tuple，可选) - 池化层的步长。如果它是一个元组或列表，它将包含三个整数，(pool_stride_Depth，pool_stride_Height, pool_stride_Width)。若为一个整数，则表示 D, H 和 W 维度上 stride 均为该值。默认值为 None ，这时会使用 kernel_size 作为 stride 。 - **padding** (str|int|list|tuple，可选) - 池化填充。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 3 个整数值：[pad_depth, pad_height, pad_width]；(2)包含 6 个整数值：[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]；(3)包含 5 个二元组：当 data_format 为"NCDHW"时为[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NDHWC"时为[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 D、H 和 W 维度上均为该值。默认值：0 。 - - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出高度和宽度。如果是 True ，则使用 `ceil` 计算输出形状的大小。默认为 False 。 + - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出高度和宽度。如果是 True ，则使用 ``ceil`` 计算输出形状的大小。默认为 False 。 - **return_mask** (bool，可选) - 是否返回最大索引和输出。默认为 False 。 - **data_format** (str，可选) - 输入和输出的数据格式，可以是"NCDHW"和"NDHWC"。N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度。当前只支持："NDHWC" 。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为 None 。 diff --git a/docs/api/paddle/sparse/nn/SubmConv2D_cn.rst b/docs/api/paddle/sparse/nn/SubmConv2D_cn.rst index 16e96ffe3c3..f0e21f4775b 100644 --- a/docs/api/paddle/sparse/nn/SubmConv2D_cn.rst +++ b/docs/api/paddle/sparse/nn/SubmConv2D_cn.rst @@ -34,7 +34,7 @@ SubmConv2D - **padding** (int|str|tuple|list, 可选): - 填充大小。应为以下几种格式之一； - (1) 如果它是一个字符串，可以是 "VALID" 或者 "SAME"，计算细节可参考上述 ``padding`` = "SAME" 或 ``padding`` = "VALID" 时的计算公式。 - - (2) 如果它是一个整数, 则代表它每个 Spartial 维度(depth, height, width) 被 `padding` 的大小填充为零。 + - (2) 如果它是一个整数, 则代表它每个 Spartial 维度(depth, height, width) 被 ``padding`` 的大小填充为零。 - (3) 一个 list[int] 或 tuple[int]，其长度是 Spartial 维度的数目，它包含每个 Spartial 维度每侧的填充量。它的形式为 [pad_d1, pad_d2, ...]。 - (4) 一个 list[int] 或 tuple[int]，其长度为 2 * 部分维数。对于所有局部维度，它的形式为 [pad_before, pad_after, pad_before, pad_after, ...]。 - (5) 一个整数对的列表或元组。它的形式为 [[pad_before, pad_after], [pad_before, pad_after], ...]。 diff --git a/docs/api/paddle/sparse/nn/functional/attention_cn.rst b/docs/api/paddle/sparse/nn/functional/attention_cn.rst index 027676a1279..7c900ec8cd8 100644 --- a/docs/api/paddle/sparse/nn/functional/attention_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/attention_cn.rst @@ -18,14 +18,14 @@ attention 参数 :::::::::: - - **query** (DenseTensor) - Attention 模块的 `query` 输入，4D Tensor，数据类型为 float32、float64。 - - **key** (DenseTensor) - Attention 模块的 `key` 输入，4D Tensor，数据类型为 float32、float64。 - - **value** (DenseTensor) - Attention 模块的 `value` 输入，4D Tensor，数据类型为 float32、float64。 - - **sparse_mask** (SparseCsrTensor) - Attention 模块的非 0 元素布局，是一个 3D 的 SparseCsrTensor，shape 为 `[batch_size*num_heads, seq_len, seq_len]` 。 - 同时每个批次的非 0 元素个数均相等。`crows` 和 `cols` 的数据类型为 int64，`value` 的数据类型为 float32、float64。 - - **key_padding_mask** (DenseTensor, 可选) - Attention 模块中的 key padding mask，是一个 2D 的 DenseTensor，shape 为 `[batch_size, seq_len]` 。 + - **query** (DenseTensor) - Attention 模块的 ``query`` 输入，4D Tensor，数据类型为 float32、float64。 + - **key** (DenseTensor) - Attention 模块的 ``key`` 输入，4D Tensor，数据类型为 float32、float64。 + - **value** (DenseTensor) - Attention 模块的 ``value`` 输入，4D Tensor，数据类型为 float32、float64。 + - **sparse_mask** (SparseCsrTensor) - Attention 模块的非 0 元素布局，是一个 3D 的 SparseCsrTensor，shape 为 ``[batch_size*num_heads, seq_len, seq_len]`` 。 + 同时每个批次的非 0 元素个数均相等。``crows`` 和 ``cols`` 的数据类型为 int64，``value`` 的数据类型为 float32、float64。 + - **key_padding_mask** (DenseTensor, 可选) - Attention 模块中的 key padding mask，是一个 2D 的 DenseTensor，shape 为 ``[batch_size, seq_len]`` 。 数据类型为 float32、float64。默认：None，表示无此掩码运算。 - - **attn_mask** (DenseTensor, 可选) - Attention 模块中的 attention mask，是一个 2D 的 DenseTensor，shape 为 `[seq_len, seq_len]` 。 + - **attn_mask** (DenseTensor, 可选) - Attention 模块中的 attention mask，是一个 2D 的 DenseTensor，shape 为 ``[seq_len, seq_len]`` 。 数据类型为 float32、float64。默认：None，表示无此掩码运算。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/sparse/nn/functional/conv2d_cn.rst b/docs/api/paddle/sparse/nn/functional/conv2d_cn.rst index abb2d11596f..eb93744e6c3 100644 --- a/docs/api/paddle/sparse/nn/functional/conv2d_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/conv2d_cn.rst @@ -27,10 +27,10 @@ conv2d - **weight** (Tensor) - 卷积核，形状为 [kH, kW, C/g, M] 的张量，其中 M 是滤波器数（输出通道数），g 是分组数，kD、kH、kW 分别是滤波器的高度和宽度。 - **bias** (Tensor，可选) - 偏置，形状为 [M] 的张量。 - **stride** (int|list|tuple，可选) - 步长大小。指的是卷积中的步长。如果步长是列表/元组，则必须包含两个整数（stride_height, stride_width）。否则，stride_height = stride_width = stride。默认：stride = 1。 - - **padding** (string|int|list|tuple，可选) - 填充大小。指的是每个维度两边的零填充数量。如果 `padding` 是字符串，可以是 'VALID' 或 'SAME'，这是填充算法。如果填充大小是元组或列表，可以是以下三种形式：`[pad_height, pad_width]` 或 `[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]`。当 `data_format` 为 `"NHWC"` 时，`padding` 可以是 `[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]` 的形式。默认：padding = 0。 + - **padding** (string|int|list|tuple，可选) - 填充大小。指的是每个维度两边的零填充数量。如果 ``padding`` 是字符串，可以是 'VALID' 或 'SAME'，这是填充算法。如果填充大小是元组或列表，可以是以下三种形式：``[pad_height, pad_width]`` 或 ``[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]``。当 ``data_format`` 为 ``"NHWC"`` 时，``padding`` 可以是 ``[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]`` 的形式。默认：padding = 0。 - **dilation** (int|list|tuple，可选) - 空洞大小。空洞卷积时会使用该参数，卷积核对输入进行卷积时，感受野里每相邻两个特征点之间的空洞信息。如果空洞大小是列表或元组，则必须包含两个整数（dilation_height, dilation_width）。否则，dilation_height = dilation_width = dilation。默认：dilation = 1。 - **groups** (int，可选) - 二维卷积层的组数。根据 Alex Krizhevsky 的深度卷积神经网络（CNN）论文中的成组卷积：当 group=2 时，滤波器的前半部分只与输入通道的前半部分相连，而滤波器的后半部分只与输入通道的后半部分相连。默认：groups=1。目前，仅支持 groups=1。 - - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入的一致。可选字符串："NHWC"。默认为 "NHWC"。当为 "NHWC" 时，数据按以下顺序存储：`[batch_size, input_height, input_width, input_channels]`。 + - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入的一致。可选字符串："NHWC"。默认为 "NHWC"。当为 "NHWC" 时，数据按以下顺序存储：``[batch_size, input_height, input_width, input_channels]``。 - **name** (str，可选) - 具体用法请参阅 :ref:`api_guide_Name`。通常无需设置名称，默认为 None。 返回 diff --git a/docs/api/paddle/sparse/nn/functional/max_pool3d_cn.rst b/docs/api/paddle/sparse/nn/functional/max_pool3d_cn.rst index 0ee856c8e67..98831cd4a73 100644 --- a/docs/api/paddle/sparse/nn/functional/max_pool3d_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/max_pool3d_cn.rst @@ -17,7 +17,7 @@ max_pool3d - (1)包含 3 个整数值：[pad_depth, pad_height, pad_width]； - (2)包含 6 个整数值：[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right]； - (3)包含 5 个二元组：当 data_format 为"NCDHW"时为[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]]，当 data_format 为"NDHWC"时为[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数，则表示 D、H 和 W 维度上均为该值。默认值：0 - - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。默认为 False + - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 ``ceil`` 计算输出形状的大小。默认为 False - **data_format** (str，可选) - 输入和输出的数据格式，可以是"NCDHW"和"NDHWC"。N 是批尺寸，C 是通道数，D 是特征深度，H 是特征高度，W 是特征宽度。当前只支持："NDHWC"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/sparse/nn/functional/subm_conv2d_cn.rst b/docs/api/paddle/sparse/nn/functional/subm_conv2d_cn.rst index 8d8244fe1af..33d1794b715 100644 --- a/docs/api/paddle/sparse/nn/functional/subm_conv2d_cn.rst +++ b/docs/api/paddle/sparse/nn/functional/subm_conv2d_cn.rst @@ -41,8 +41,8 @@ subm_conv2d - groups (int, optional): 二维卷积层的组号。根据 Alex Krizhevsky 的 Deep CNN 论文中的卷积分组： 当 group=2 时，卷积核的前半部分仅连接到前半部分的输入通道，而卷积核的后半部分仅连接到输入通道的后半部分。 groups 的默认值为 1。目前, 只有 support groups=1。 - - data_format (str, optional): 指定输入的数据格式和输出的数据格式将与输入一致。即 `"NHWC"` 的可选字符串。默认值为 `"NHWC"`。 - 当它是 `"NHWC"` 时, 数据按以下顺序存储：`[batch_size, input_height, input_width, input_channels]`。 + - data_format (str, optional): 指定输入的数据格式和输出的数据格式将与输入一致。即 ``"NHWC"`` 的可选字符串。默认值为 ``"NHWC"``。 + 当它是 ``"NHWC"`` 时, 数据按以下顺序存储：``[batch_size, input_height, input_width, input_channels]``。 - key(str, optional):用于保存或使用相同规则手册的密钥，规则手册的定义和作用是指 https://pdfs.semanticscholar.org/5125/a16039cabc6320c908a4764f32596e018ad3.pdf。默认值为 None。 - name(str, optional):有关详细信息，请参阅到 :ref:`api_guide_Name`。通常名称是不需要设置的, 并且默认情况下为空。 diff --git a/docs/api/paddle/sparse/sum_cn.rst b/docs/api/paddle/sparse/sum_cn.rst index 672d8f5e38d..14a35e3571f 100644 --- a/docs/api/paddle/sparse/sum_cn.rst +++ b/docs/api/paddle/sparse/sum_cn.rst @@ -17,14 +17,14 @@ sum ::::::::: - **x** (Tensor) - 输入的 Tensor，数据类型为 bool、float16、float32、float64、int32 或 int64。 - **axis** (int|list|tuple，可选) - 沿着哪些维度进行求和操作。如果为 :attr:`None`，则对 :attr:`x` 的所有元素进行求和并返回一个只有一个元素的 Tensor；否则必须在 :math:`[-rank(x), rank(x))` 范围内。如果 :math:`axis[i] < 0`，则要减少的维度是 :math:`rank + axis[i]`。 - - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出 Tensor 的数据类型。默认值为 None，表示与输入 Tensor `x` 数据类型一致。 + - **dtype** (str|paddle.dtype|np.dtype，可选) - 输出 Tensor 的数据类型。默认值为 None，表示与输入 Tensor ``x`` 数据类型一致。 - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留减少的维度。如果为 True，则结果 Tensor 的维数比 :attr:`x` 少一维，否则与 :attr:`x` 维数一致。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 :::::::::::: - ``Tensor``，在指定维度上进行求和运算的 Tensor。如果 `x.dtype='bool'` 或 `x.dtype='int32'`，则其数据类型为 `'int64'`，否则数据类型与 `x` 一致。 + ``Tensor``，在指定维度上进行求和运算的 Tensor。如果 ``x.dtype='bool'`` 或 ``x.dtype='int32'``，则其数据类型为 ``'int64'``，否则数据类型与 ``x`` 一致。 代码示例 diff --git a/docs/api/paddle/special/softmax_cn.rst b/docs/api/paddle/special/softmax_cn.rst index d631d5a3bf5..5e3ae8e75e2 100644 --- a/docs/api/paddle/special/softmax_cn.rst +++ b/docs/api/paddle/special/softmax_cn.rst @@ -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。 返回 :::::::::: diff --git a/docs/api/paddle/squeeze_cn.rst b/docs/api/paddle/squeeze_cn.rst index 5b985e25455..745d6122687 100644 --- a/docs/api/paddle/squeeze_cn.rst +++ b/docs/api/paddle/squeeze_cn.rst @@ -55,7 +55,7 @@ squeeze 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor` ，数据类型为：float32、float64、bool、int8、int32、int64。别名： ``input``。 + - **x** (Tensor) - 输入的 ``Tensor`` ，数据类型为：float32、float64、bool、int8、int32、int64。别名： ``input``。 - **axis** (int|list|tuple，可选) - 输入一个或一列整数，代表要压缩的轴。axis 的范围： [−ndim(x), ndim(x)) 。 如果 axis 为负数， 则 axis=axis+ndim(x) 。默认为 None，表示对所有尺寸为 1 的维度进行压缩。别名： ``dim``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/static/Executor_cn.rst b/docs/api/paddle/static/Executor_cn.rst index b86ada1e857..aab66b5227b 100644 --- a/docs/api/paddle/static/Executor_cn.rst +++ b/docs/api/paddle/static/Executor_cn.rst @@ -15,7 +15,7 @@ Executor 支持单 GPU、多 GPU 以及 CPU 运行。 参数 :::::::::::: - - **place** (paddle.CPUPlace()|paddle.CUDAPlace(N)|None) – 该参数表示 Executor 执行所在的设备，这里的 N 为 GPU 对应的 ID。当该参数为 `None` 时，PaddlePaddle 会根据其安装版本设置默认的运行设备。当安装的 Paddle 为 CPU 版时，默认运行设置会设置成 `CPUPlace()`，而当 Paddle 为 GPU 版时，默认运行设备会设置成 `CUDAPlace(0)`。默认值为 None。多卡训练初始化 Executor 时也只用传入一个 Place 或 None，其他 API 会处理使用的多卡，见 `多卡使用方式 `_ + - **place** (paddle.CPUPlace()|paddle.CUDAPlace(N)|None) – 该参数表示 Executor 执行所在的设备，这里的 N 为 GPU 对应的 ID。当该参数为 ``None`` 时，PaddlePaddle 会根据其安装版本设置默认的运行设备。当安装的 Paddle 为 CPU 版时，默认运行设置会设置成 ``CPUPlace()``，而当 Paddle 为 GPU 版时，默认运行设备会设置成 ``CUDAPlace(0)``。默认值为 None。多卡训练初始化 Executor 时也只用传入一个 Place 或 None，其他 API 会处理使用的多卡，见 `多卡使用方式 `_ 返回 :::::::::::: diff --git a/docs/api/paddle/static/WeightNormParamAttr_cn.rst b/docs/api/paddle/static/WeightNormParamAttr_cn.rst index 3450ddf80b0..cbef045145c 100644 --- a/docs/api/paddle/static/WeightNormParamAttr_cn.rst +++ b/docs/api/paddle/static/WeightNormParamAttr_cn.rst @@ -21,7 +21,7 @@ WeightNormParamAttr - **dim** (int，可选) - 进行归一化操作(norm)的切片所在维度，是小于权重 Tensor rank 的非负数。比如卷积的权重 shape 是 :math:`[cout, cin, kh, kw]` , rank 是 4，则 dim 可以选 0,1,2,3；fc 的权重 shape 是 :math:`[cout, cin]` ，rank 是 2，dim 可以选 0，1。 dim 默认为 None，如果为 None 就对所有元素做归一化(norm)。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - - **initializer** (Initializer，可选) - 初始化参数方法，例如 ``initializer = fluid.nn.initializer.Constant(1.0)``。默认为 None，如果为 None 则使用默认初始化函数 `Xavier()` 。 + - **initializer** (Initializer，可选) - 初始化参数方法，例如 ``initializer = fluid.nn.initializer.Constant(1.0)``。默认为 None，如果为 None 则使用默认初始化函数 ``Xavier()`` 。 - **learning_rate** (float32，可选) - 学习率，优化过程 :math:`global\_lr∗parameter\_lr∗scheduler\_factor` 的学习速率，默认为 1.0。 - **regularizer** (WeightDecayRegularizer，可选) - 正则化方法。支持两种正则化策略：:ref:`cn_api_paddle_regularizer_L1Decay` 、 :ref:`cn_api_paddle_regularizer_L2Decay`，如果在 ``optimizer`` (例如 :ref:`cn_api_paddle_optimizer_SGD` ) 中也 diff --git a/docs/api/paddle/static/append_backward_cn.rst b/docs/api/paddle/static/append_backward_cn.rst index f974283ea82..6ea55ee1cb7 100644 --- a/docs/api/paddle/static/append_backward_cn.rst +++ b/docs/api/paddle/static/append_backward_cn.rst @@ -21,7 +21,7 @@ append_backward - **loss** (Tensor) - 表示网络损失的 Tensor 。 - **parameter_list** （list [Tensor|str]，可选）- 指定优化器需要更新的参数或参数名称列表。如果为 ``None``，则将更新所有参数。默认值为 ``None``。 - - **no_grad_set** （set [Tensor|str]，可选）- 在 `block0` ( :ref:`api_guide_Block` ) 中要忽略梯度的 Tensor 的名字的集合。所有的 :ref:`api_guide_Block` 中带有 ``stop_gradient = True`` 的所有 Tensor 的名字都会被自动添加到此集合中。如果该参数不为 ``None``，则会将该参数集合的内容添加到默认的集合中。默认值为 ``None``。 + - **no_grad_set** （set [Tensor|str]，可选）- 在 ``block0`` ( :ref:`api_guide_Block` ) 中要忽略梯度的 Tensor 的名字的集合。所有的 :ref:`api_guide_Block` 中带有 ``stop_gradient = True`` 的所有 Tensor 的名字都会被自动添加到此集合中。如果该参数不为 ``None``，则会将该参数集合的内容添加到默认的集合中。默认值为 ``None``。 - **callbacks** （list [callable object]，可选）- 回调函数列表。用于在反向传播构建中执行一些自定义作业。每次将新的梯度 OP 添加到程序中时，将调用其中的所有可调用对象。可调用对象必须有两个输入参数：:ref:`api_guide_Block` 和 ``context`` 。 :ref:`api_guide_Block` 是将被添加到新梯度算子的块。``context`` 是一个映射，其键是梯度 Tensor 名，值是对应的原始 Tensor。除此之外，``context`` 还有另一个特殊的键值对：键是字符串 ``__ current_op_desc__``，值是刚刚触发可调用对象的梯度 OP 的 ``op_desc``。默认值为 ``None``。 返回 diff --git a/docs/api/paddle/static/gradients_cn.rst b/docs/api/paddle/static/gradients_cn.rst index 9a1ad54e5a3..15caab73f05 100644 --- a/docs/api/paddle/static/gradients_cn.rst +++ b/docs/api/paddle/static/gradients_cn.rst @@ -17,7 +17,7 @@ gradients - **targets** (Tensor|list[Tensor]) – 目标 Tensor 或包含 Tensor 的列表。 - **inputs** (Tensor|list[Tensor]) – 输入 Tensor 或包含 Tensor 的列表。 - **target_gradients** (Tensor|list[Tensor]，可选) – 目标的梯度 Tensor，应与目标 Tensor 的形状相同；如果设置为 None，则以 1 初始化所有梯度 Tensor。 - - **no_grad_set** (set[Tensor|str]，可选) – 在 `block0` ( :ref:`api_guide_Block` ) 中要忽略梯度的 Tensor 的名字的集合。所有的 :ref:`api_guide_Block` 中带有 ``stop_gradient = True`` 的所有 Tensor 的名字都会被自动添加到此集合中。如果该参数不为 ``None``，则会将该参数集合的内容添加到默认的集合中。默认值为 ``None`` 。 + - **no_grad_set** (set[Tensor|str]，可选) – 在 ``block0`` ( :ref:`api_guide_Block` ) 中要忽略梯度的 Tensor 的名字的集合。所有的 :ref:`api_guide_Block` 中带有 ``stop_gradient = True`` 的所有 Tensor 的名字都会被自动添加到此集合中。如果该参数不为 ``None``，则会将该参数集合的内容添加到默认的集合中。默认值为 ``None`` 。 返回 diff --git a/docs/api/paddle/sum_cn.rst b/docs/api/paddle/sum_cn.rst index a603e8dddd0..7a6892643c9 100644 --- a/docs/api/paddle/sum_cn.rst +++ b/docs/api/paddle/sum_cn.rst @@ -24,7 +24,7 @@ sum 返回 :::::::::::: - ``Tensor``，在指定维度上进行求和运算的 Tensor。如果输入的数据类型为 `bool` 或 `int32`， 则返回的数据类型为 `int64` 。除此之外返回的数据类型和输入的数据类型一致。 + ``Tensor``，在指定维度上进行求和运算的 Tensor。如果输入的数据类型为 ``bool`` 或 ``int32``， 则返回的数据类型为 ``int64`` 。除此之外返回的数据类型和输入的数据类型一致。 代码示例 diff --git a/docs/api/paddle/text/Conll05st_cn.rst b/docs/api/paddle/text/Conll05st_cn.rst index 81307916e63..11f24d5aed4 100644 --- a/docs/api/paddle/text/Conll05st_cn.rst +++ b/docs/api/paddle/text/Conll05st_cn.rst @@ -13,12 +13,12 @@ Conll05st 参数 ::::::::: - - **data_file** (str) - 保存数据的路径，如果参数 `download` 设置为 True，可设置为 None。默认为 None。 - - **word_dict_file** (str) - 保存词典的路径。如果参数 `download` 设置为 True，可设置为 None。默认为 None。 - - **verb_dict_file** (str) - 保存动词词典的路径。如果参数 `download` 设置为 True，可设置为 None。默认为 None。 - - **target_dict_file** (str) - 保存目标词典的路径如果参数 `download` 设置为 True，可设置为 None。默认为 None。 - - **emb_file** (str) - 保存词嵌入词典的文件。只有在 `get_embedding` 能被设置为 None 且 `download` 为 True 时使用。 - - **download** (bool) - 如果 `data_file` 、 `word_dict_file` 、 `verb_dict_file` 和 `target_dict_file` 未设置，是否下载数据集。默认为 True。 + - **data_file** (str) - 保存数据的路径，如果参数 ``download`` 设置为 True，可设置为 None。默认为 None。 + - **word_dict_file** (str) - 保存词典的路径。如果参数 ``download`` 设置为 True，可设置为 None。默认为 None。 + - **verb_dict_file** (str) - 保存动词词典的路径。如果参数 ``download`` 设置为 True，可设置为 None。默认为 None。 + - **target_dict_file** (str) - 保存目标词典的路径如果参数 ``download`` 设置为 True，可设置为 None。默认为 None。 + - **emb_file** (str) - 保存词嵌入词典的文件。只有在 ``get_embedding`` 能被设置为 None 且 ``download`` 为 True 时使用。 + - **download** (bool) - 如果 ``data_file`` 、 ``word_dict_file`` 、 ``verb_dict_file`` 和 ``target_dict_file`` 未设置，是否下载数据集。默认为 True。 返回值 ::::::::: diff --git a/docs/api/paddle/tolist_cn.rst b/docs/api/paddle/tolist_cn.rst index a5c1d2e5749..9d8422f5f44 100644 --- a/docs/api/paddle/tolist_cn.rst +++ b/docs/api/paddle/tolist_cn.rst @@ -14,7 +14,7 @@ tolist 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor`，数据类型为：float32、float64、bool、int8、int32、int64。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64、bool、int8、int32、int64。 返回 ::::::::: diff --git a/docs/api/paddle/trapezoid_cn.rst b/docs/api/paddle/trapezoid_cn.rst index bf9690fa291..7913402dfc1 100644 --- a/docs/api/paddle/trapezoid_cn.rst +++ b/docs/api/paddle/trapezoid_cn.rst @@ -12,7 +12,7 @@ trapezoid ::::::::: - **y** (Tensor) - 输入多维 Tensor，可选的数据类型为 float16、float32、float64。 - - **x** (Tensor，可选) - ``y`` 中数值对应的浮点数所组成的 Tensor，类型与 ``y`` 相同，形状与 ``y`` 的形状相匹配；若 ``x`` 有输入，已知 ``y`` 的尺寸为 `[d_1, d_2, ... , d_n]` 且 `axis=k`，则 ``x`` 的尺寸只能为 `[d_k]` 或 `[d_1, d_2, ... , d_n]`；如果 ``x`` 为 None，则假定采样点均匀分布 ``dx``。 + - **x** (Tensor，可选) - ``y`` 中数值对应的浮点数所组成的 Tensor，类型与 ``y`` 相同，形状与 ``y`` 的形状相匹配；若 ``x`` 有输入，已知 ``y`` 的尺寸为 ``[d_1, d_2, ... , d_n]`` 且 ``axis=k``，则 ``x`` 的尺寸只能为 ``[d_k]`` 或 ``[d_1, d_2, ... , d_n]``；如果 ``x`` 为 None，则假定采样点均匀分布 ``dx``。 - **dx** (float，可选) - 相邻采样点之间的常数间隔；当 ``x`` 和 ``dx`` 均未指定时，``dx`` 默认为 1.0。 - **axis** (int，可选) - 计算 trapezoid rule 时 ``y`` 的维度。默认值 -1。别名 ``dim``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/triu_cn.rst b/docs/api/paddle/triu_cn.rst index 4a0478e6a1e..0eb13997fec 100644 --- a/docs/api/paddle/triu_cn.rst +++ b/docs/api/paddle/triu_cn.rst @@ -11,7 +11,7 @@ triu 参数 ::::::::: - - **x** (Tensor)：输入 Tensor x，数据类型支持 `float32`, `float64`, `int32`, `int64`, `complex64`, `complex128`。别名 ``input``。 + - **x** (Tensor)：输入 Tensor x，数据类型支持 ``float32``, ``float64``, ``int32``, ``int64``, ``complex64``, ``complex128``。别名 ``input``。 - **diagonal** (int，可选)：指定的对角线，默认值为 0。如果 diagonal = 0，表示主对角线；如果 diagonal 是正数，表示主对角线之上的对角线；如果 diagonal 是负数，表示主对角线之下的对角线。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/unique_cn.rst b/docs/api/paddle/unique_cn.rst index 2017d71f199..69552fdf696 100644 --- a/docs/api/paddle/unique_cn.rst +++ b/docs/api/paddle/unique_cn.rst @@ -33,7 +33,7 @@ unique 参数 :::::::::::: - - **x** (Tensor) - 输入的 `Tensor` ，数据类型为：float32、float64、int32、int64。 + - **x** (Tensor) - 输入的 ``Tensor`` ，数据类型为：float32、float64、int32、int64。 - **return_index** (bool，可选) - 如果为 True，则还返回独有元素在输入 Tensor 中的索引。 - **return_inverse** (bool，可选) - 如果为 True，则还返回输入 Tensor 的元素对应在独有元素中的索引，该索引可用于重构输入 Tensor。 - **return_counts** (bool，可选) - 如果为 True，则还返回每个独有元素在输入 Tensor 中的个数。 diff --git a/docs/api/paddle/unique_consecutive_cn.rst b/docs/api/paddle/unique_consecutive_cn.rst index 6aba05fdb99..172ced73f81 100644 --- a/docs/api/paddle/unique_consecutive_cn.rst +++ b/docs/api/paddle/unique_consecutive_cn.rst @@ -23,14 +23,14 @@ unique_consecutive 参数 :::::::::::: - - **x** (Tensor) - 输入的 `Tensor`，数据类型为：float32、float64、int32、int64。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64、int32、int64。 别名： ``input`` - **return_inverse** (bool，可选) - 如果为 True，则还返回输入 Tensor 的元素对应在连续不重复元素中的索引，该索引可用于重构输入 Tensor。默认：False。 - **return_counts** (bool，可选) - 如果为 True，则还返回每个连续不重复元素在输入 Tensor 中的个数。默认：False。 - **axis** (int，可选) - 指定选取连续不重复元素的轴。默认值为 None，将输入平铺为 1-D 的 Tensor 后再选取连续不重复元素。默认：None。 别名： ``dim`` - **dim** - ``axis`` 的别名，行为完全一致。 - - **dtype** (str|paddle.dtype|np.dtype，可选) - 用于设置 `inverse` 或者 `counts` 的类型，应该为 int32 或者 int64。默认：int64。 + - **dtype** (str|paddle.dtype|np.dtype，可选) - 用于设置 ``inverse`` 或者 ``counts`` 的类型，应该为 int32 或者 int64。默认：int64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/unsqueeze_cn.rst b/docs/api/paddle/unsqueeze_cn.rst index fb36b305f37..9befb4abe6f 100644 --- a/docs/api/paddle/unsqueeze_cn.rst +++ b/docs/api/paddle/unsqueeze_cn.rst @@ -23,7 +23,7 @@ unsqueeze 参数 ::::::::: - - **x** (Tensor) - 输入的 `Tensor`，数据类型为：bfloat16、float32、float64、bool、int8、int32、int64。别名： ``input``。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：bfloat16、float32、float64、bool、int8、int32、int64。别名： ``input``。 - **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple，它的元素可以是整数或者形状为[]的 0-D Tensor。如果 axis 的类型是 Tensor，则是 1-D Tensor。如果 axis 是负数，则 axis=axis+ndim(x)+1 。别名： ``dim``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/vision/ops/box_coder_cn.rst b/docs/api/paddle/vision/ops/box_coder_cn.rst index 8d66bafbd3a..af50bebd1dc 100644 --- a/docs/api/paddle/vision/ops/box_coder_cn.rst +++ b/docs/api/paddle/vision/ops/box_coder_cn.rst @@ -43,10 +43,10 @@ box_coder :::::::::::: - **prior_box** (Tensor) - 维度为 [M, 4] 的 2-D Tensor ， M 表示存储 M 个框，数据类型为 float32 或 float64 。先验框，每个框代表 [xmin, ymin, xmax, ymax] ， [xmin, ymin] 是先验框的左顶点坐标，如果输入数图像特征图，则接近坐标原点。 [xmax,ymax] 是先验框的右底点坐标。 - **prior_box_var** (List|tuple|Tensor|None) - 支持三种输入类型，一是维度为 [M, 4] 的 2-D Tensor ，存储 M 个先验框的 variance ，数据类型为 float32 或 float64 。另一种是一个长度为 4 的列表，所有先验框共用这个列表中的 variance ，数据类型为 float32 或 float64 。为 None 时不参与计算。 - - **target_box** (Tensor) - 数据类型为 float32 或 float64 的 Tensor ，当 code_type 为 `encode_center_size` ，输入是 2-D Tensor ，维度为 [N, 4] ， N 为目标框的个数，目标框的格式与先验框相同。当 code_type 为 `decode_center_size` ，输入为 3-D Tensor ，维度为 [N, M, 4]。通常 N 表示产生检测框的个数， M 表示类别数。此时目标框为偏移量。 - - **code_type** (str，可选) - 编码类型用目标框，可以是 `encode_center_size` 或 `decode_center_size` ，默认值为 `encode_center_size` 。 + - **target_box** (Tensor) - 数据类型为 float32 或 float64 的 Tensor ，当 code_type 为 ``encode_center_size`` ，输入是 2-D Tensor ，维度为 [N, 4] ， N 为目标框的个数，目标框的格式与先验框相同。当 code_type 为 ``decode_center_size`` ，输入为 3-D Tensor ，维度为 [N, M, 4]。通常 N 表示产生检测框的个数， M 表示类别数。此时目标框为偏移量。 + - **code_type** (str，可选) - 编码类型用目标框，可以是 ``encode_center_size`` 或 ``decode_center_size`` ，默认值为 ``encode_center_size`` 。 - **box_normalized** (bool，可选) - 先验框坐标是否正则化，即是否在 [0, 1] 区间内。默认值为 True 。 - - **axis** (int，可选) - 在 PriorBox 中为 axis 指定的轴 broadcast 以进行框解码，例如，如果 axis 为 0 ， TargetBox 具有形状 [N, M, 4] 且 PriorBox 具有形状 [M, 4] ，则 PriorBox 将 broadcast 到 [N, M, 4] 用于解码。仅在 code_type 为 `decode_center_size` 时有效。默认值为 0 。 + - **axis** (int，可选) - 在 PriorBox 中为 axis 指定的轴 broadcast 以进行框解码，例如，如果 axis 为 0 ， TargetBox 具有形状 [N, M, 4] 且 PriorBox 具有形状 [M, 4] ，则 PriorBox 将 broadcast 到 [N, M, 4] 用于解码。仅在 code_type 为 ``decode_center_size`` 时有效。默认值为 0 。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None 。 diff --git a/docs/api/paddle/vision/transforms/BaseTransform_cn.rst b/docs/api/paddle/vision/transforms/BaseTransform_cn.rst index 4790d7f4aac..60f9c92e83b 100644 --- a/docs/api/paddle/vision/transforms/BaseTransform_cn.rst +++ b/docs/api/paddle/vision/transforms/BaseTransform_cn.rst @@ -21,7 +21,7 @@ BaseTransform 参数 ::::::::: - - **keys** (list[str]|tuple[str]，可选) - 输入的类型。你的输入可以是单一的图像，也可以是包含不同数据结构的元组，``keys`` 可以用来指定输入类型。举个例子，如果你的输入就是一个单一的图像，那么 ``keys`` 可以为 ``None`` 或者 ("image")。如果你的输入是两个图像：``(image, image)``，那么 `keys` 应该设置为 ``("image", "image")``。如果你的输入是 ``(image, boxes)``，那么 ``keys`` 应该为 ``("image", "boxes")``。目前支持的数据类型如下所示： + - **keys** (list[str]|tuple[str]，可选) - 输入的类型。你的输入可以是单一的图像，也可以是包含不同数据结构的元组，``keys`` 可以用来指定输入类型。举个例子，如果你的输入就是一个单一的图像，那么 ``keys`` 可以为 ``None`` 或者 ("image")。如果你的输入是两个图像：``(image, image)``，那么 ``keys`` 应该设置为 ``("image", "image")``。如果你的输入是 ``(image, boxes)``，那么 ``keys`` 应该为 ``("image", "boxes")``。目前支持的数据类型如下所示： - "image"：输入的图像，它的维度为 ``(H, W, C)`` 。 - "coords"：输入的左边，它的维度为 ``(N, 2)`` 。