From 9642f90a7476f8aa4db272cb62f5ba25d0cea807 Mon Sep 17 00:00:00 2001 From: enkilee Date: Mon, 26 Jun 2023 17:03:20 +0800 Subject: [PATCH 1/2] fix bracket and wrong english --- docs/api/paddle/Overview_cn.rst | 2 +- docs/api/paddle/Tensor_cn.rst | 24 ++++----- .../amp/debugging/check_numerics_cn.rst | 6 +-- .../paddle/amp/is_bfloat16_supported_cn.rst | 2 +- .../paddle/amp/is_float16_supported_cn.rst | 2 +- docs/api/paddle/argmax_cn.rst | 2 +- docs/api/paddle/atan2_cn.rst | 2 +- .../audio/features/LogMelSpectrogram_cn.rst | 14 ++--- .../functional/compute_fbank_matrix_cn.rst | 10 ++-- docs/api/paddle/autograd/hessian_cn.rst | 2 +- docs/api/paddle/autograd/jacobian_cn.rst | 2 +- docs/api/paddle/deg2rad_cn.rst | 2 +- .../fleet/DistributedStrategy_cn.rst | 18 +++---- .../paddle/distributed/fleet/UtilBase_cn.rst | 8 +-- docs/api/paddle/distribution/Beta_cn.rst | 2 +- docs/api/paddle/empty_cn.rst | 2 +- docs/api/paddle/erfinv_cn.rst | 2 +- docs/api/paddle/fft/Overview_cn.rst | 8 +-- docs/api/paddle/fft/fft_cn.rst | 2 +- docs/api/paddle/fft/fftfreq_cn.rst | 2 +- docs/api/paddle/fft/hfft2_cn.rst | 2 +- docs/api/paddle/fft/hfft_cn.rst | 4 +- docs/api/paddle/fft/hfftn_cn.rst | 2 +- docs/api/paddle/fft/ifft_cn.rst | 4 +- docs/api/paddle/fft/ihfft2_cn.rst | 4 +- docs/api/paddle/fft/ihfft_cn.rst | 2 +- docs/api/paddle/fft/ihfftn_cn.rst | 4 +- docs/api/paddle/fft/irfft2_cn.rst | 4 +- docs/api/paddle/fft/irfft_cn.rst | 4 +- docs/api/paddle/fft/rfft2_cn.rst | 2 +- docs/api/paddle/fft/rfftn_cn.rst | 2 +- .../fluid/dygraph/MultiStepDecay_cn.rst | 8 +-- .../api/paddle/fluid/dygraph/StepDecay_cn.rst | 10 ++-- docs/api/paddle/fluid/require_version_cn.rst | 10 ++-- docs/api/paddle/gcd_cn.rst | 2 +- docs/api/paddle/incubate/ModelAverage_cn.rst | 20 +++---- .../paddle/incubate/autograd/Hessian_cn.rst | 6 +-- .../paddle/incubate/autograd/Jacobian_cn.rst | 4 +- .../paddle/incubate/autograd/Overview_cn.rst | 2 +- docs/api/paddle/io/ComposeDataset_cn.rst | 4 +- docs/api/paddle/io/Dataset_cn.rst | 2 +- docs/api/paddle/jit/to_static_cn.rst | 2 +- docs/api/paddle/lcm_cn.rst | 2 +- docs/api/paddle/linalg/pca_lowrank.rst | 2 +- docs/api/paddle/meshgrid_cn.rst | 4 +- docs/api/paddle/metric/Auc_cn.rst | 2 +- docs/api/paddle/nn/AvgPool1D_cn.rst | 10 ++-- .../api/paddle/nn/ClipGradByGlobalNorm_cn.rst | 6 +-- docs/api/paddle/nn/ClipGradByValue_cn.rst | 4 +- docs/api/paddle/nn/Conv1D_cn.rst | 4 +- docs/api/paddle/nn/Conv2D_cn.rst | 4 +- docs/api/paddle/nn/HSigmoidLoss_cn.rst | 8 +-- docs/api/paddle/nn/Upsample_cn.rst | 2 +- .../api/paddle/nn/UpsamplingBilinear2D_cn.rst | 4 +- docs/api/paddle/nn/UpsamplingNearest2D_cn.rst | 4 +- .../paddle/nn/functional/cross_entropy_cn.rst | 12 ++--- .../paddle/nn/functional/hsigmoid_loss_cn.rst | 6 +-- .../paddle/nn/functional/interpolate_cn.rst | 6 +-- .../paddle/nn/functional/label_smooth_cn.rst | 6 +-- docs/api/paddle/nn/functional/upsample_cn.rst | 6 +-- docs/api/paddle/optimizer/Adadelta_cn.rst | 8 +-- docs/api/paddle/optimizer/AdamW_cn.rst | 8 +-- docs/api/paddle/optimizer/Adam_cn.rst | 12 ++--- docs/api/paddle/optimizer/Adamax_cn.rst | 8 +-- docs/api/paddle/optimizer/Lamb_cn.rst | 8 +-- docs/api/paddle/optimizer/Momentum_cn.rst | 8 +-- docs/api/paddle/optimizer/Optimizer_cn.rst | 8 +-- docs/api/paddle/optimizer/RMSProp_cn.rst | 8 +-- docs/api/paddle/optimizer/SGD_cn.rst | 8 +-- docs/api/paddle/rad2deg_cn.rst | 2 +- docs/api/paddle/sparse/cast_cn.rst | 4 +- .../paddle/sparse/sparse_coo_tensor_cn.rst | 8 +-- .../paddle/sparse/sparse_csr_tensor_cn.rst | 6 +-- docs/api/paddle/static/Executor_cn.rst | 54 +++++++++---------- docs/api/paddle/static/Program_cn.rst | 4 +- .../paddle/static/WeightNormParamAttr_cn.rst | 8 +-- docs/api/paddle/static/nn/conv2d_cn.rst | 4 +- .../paddle/static/nn/conv2d_transpose_cn.rst | 4 +- .../paddle/static/nn/conv3d_transpose_cn.rst | 4 +- docs/api/paddle/static/nn/embedding_cn.rst | 10 ++-- docs/api/paddle/static/nn/row_conv_cn.rst | 4 +- .../paddle/static/nn/sequence_reverse_cn.rst | 2 +- docs/api/paddle/vander_cn.rst | 2 +- docs/api/paddle/vision/ops/roi_align_cn.rst | 4 +- 84 files changed, 253 insertions(+), 253 deletions(-) diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 2b77da459c1..21c4dc14646 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -246,7 +246,7 @@ tensor 创建相关 " :ref:`paddle.complex ` ", "给定实部和虚部，返回一个复数 Tensor" " :ref:`paddle.create_parameter ` ", "创建一个参数,该参数是一个可学习的变量, 拥有梯度并且可优化" " :ref:`paddle.clone ` ", "对输入 Tensor ``x`` 进行拷贝，并返回一个新的 Tensor，并且该操作提供梯度回传" - " :ref:`paddle.batch ` ", "一个 reader 的装饰器。返回的 reader 将输入 reader 的数据打包成指定的 batch_size 大小的批处理数据(不推荐使用)" + " :ref:`paddle.batch ` ", "一个 reader 的装饰器。返回的 reader 将输入 reader 的数据打包成指定的 batch_size 大小的批处理数据（不推荐使用）" " :ref:`paddle.polar `", "对于给定的模 ``abs`` 和相位角 ``angle``，返回一个对应复平面上的坐标复数 Tensor" " :ref:`paddle.vander ` ", "生成范德蒙德矩阵。" diff --git a/docs/api/paddle/Tensor_cn.rst b/docs/api/paddle/Tensor_cn.rst index e2d45c60340..c1a8d213e37 100755 --- a/docs/api/paddle/Tensor_cn.rst +++ b/docs/api/paddle/Tensor_cn.rst @@ -370,9 +370,9 @@ backward(grad_tensor=None, retain_graph=False) 从当前 Tensor 开始计算反向的神经网络，传导并计算计算图中 Tensor 的梯度。 参数： - - **grad_tensor** (Tensor, optional) - 当前 Tensor 的初始梯度值。如果 ``grad_tensor`` 是 None，当前 Tensor 的初始梯度值将会是值全为 1.0 的 Tensor；如果 ``grad_tensor`` 不是 None，必须和当前 Tensor 有相同的长度。默认值：None。 + - **grad_tensor** (Tensor, 可选) - 当前 Tensor 的初始梯度值。如果 ``grad_tensor`` 是 None，当前 Tensor 的初始梯度值将会是值全为 1.0 的 Tensor；如果 ``grad_tensor`` 不是 None，必须和当前 Tensor 有相同的长度。默认值：None。 - - **retain_graph** (bool, optional) - 如果为 False，反向计算图将被释放。如果在 backward()之后继续添加 OP， + - **retain_graph** (bool, 可选) - 如果为 False，反向计算图将被释放。如果在 backward()之后继续添加 OP， 需要设置为 True，此时之前的反向计算图会保留。将其设置为 False 会更加节省内存。默认值：False。 返回：无 @@ -682,8 +682,8 @@ cuda(device_id=None, blocking=False) 如果当前 Tensor 已经在 GPU 上，且 device_id 为 None，则不会发生任何拷贝。 参数： - - **device_id** (int, optional) - 目标 GPU 的设备 Id，默认为 None，此时为当前 Tensor 的设备 Id，如果当前 Tensor 不在 GPU 上，则为 0。 - - **blocking** (bool, optional) - 如果为 False 并且当前 Tensor 处于固定内存上，将会发生主机到设备端的异步拷贝。否则，会发生同步拷贝。默认为 False。 + - **device_id** (int, 可选) - 目标 GPU 的设备 Id，默认为 None，此时为当前 Tensor 的设备 Id，如果当前 Tensor 不在 GPU 上，则为 0。 + - **blocking** (bool, 可选) - 如果为 False 并且当前 Tensor 处于固定内存上，将会发生主机到设备端的异步拷贝。否则，会发生同步拷贝。默认为 False。 返回：拷贝到 GPU 上的 Tensor @@ -981,8 +981,8 @@ fill_diagonal_(x, value, offset=0, wrap=False, name=None) 参数： - **x** (Tensor) - 需要修改对角线元素值的原始 Tensor。 - **value** (float) - 以输入 value 值修改原始 Tensor 对角线元素。 - - **offset** (int, optional) - 所选取对角线相对原始主对角线位置的偏移量，正向右上方偏移，负向左下方偏移，默认为 0。 - - **wrap** (bool, optional) - 对于 2 维 Tensor，height>width 时是否循环填充，默认为 False。 + - **offset** (int，可选) - 所选取对角线相对原始主对角线位置的偏移量，正向右上方偏移，负向左下方偏移，默认为 0。 + - **wrap** (bool，可选) - 对于 2 维 Tensor，height>width 时是否循环填充，默认为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回：修改原始 Tensor x 的对角线元素为 value 以后的新的 Tensor。 @@ -1008,9 +1008,9 @@ fill_diagonal_tensor(x, y, offset=0, dim1=0, dim2=1, name=None) 参数： - **x** (Tensor) - 需要填充局部对角线区域的原始 Tensor。 - **y** (Tensor) - 需要被填充到原始 Tensor x 对角线区域的输入 Tensor。 - - **offset** (int, optional) - 选取局部区域对角线位置相对原始主对角线位置的偏移量，正向右上方偏移，负向左下方偏移，默认为 0。 - - **dim1** (int, optional) - 指定对角线所参考第一个维度，默认为 0。 - - **dim2** (int, optional) - 指定对角线所参考第二个维度，默认为 1。 + - **offset** (int，可选) - 选取局部区域对角线位置相对原始主对角线位置的偏移量，正向右上方偏移，负向左下方偏移，默认为 0。 + - **dim1** (int，可选) - 指定对角线所参考第一个维度，默认为 0。 + - **dim2** (int，可选) - 指定对角线所参考第二个维度，默认为 1。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回：将 y 的值填充到输入 Tensor x 对角线区域以后所组合成的新 Tensor。 @@ -2304,9 +2304,9 @@ Inplace 版本的 :ref:`cn_api_tensor_uniform`，返回一个从均匀分布采 参数： - **x** (Tensor) - 待被随机数填充的输入 Tensor。 - - **min** (float|int, optional) - 生成随机数的下界，min 包含在该范围内。默认为-1.0。 - - **max** (float|int, optional) - 生成随机数的上界，max 不包含在该范围内。默认为 1.0。 - - **seed** (int, optional) - 用于生成随机数的随机种子。如果 seed 为 0，将使用全局默认生成器的种子（可通过 paddle.seed 设置）。 + - **min** (float|int，可选) - 生成随机数的下界，min 包含在该范围内。默认为-1.0。 + - **max** (float|int，可选) - 生成随机数的上界，max 不包含在该范围内。默认为 1.0。 + - **seed** (int，可选) - 用于生成随机数的随机种子。如果 seed 为 0，将使用全局默认生成器的种子（可通过 paddle.seed 设置）。 注意如果 seed 不为 0，该操作每次将生成同一个随机值。默认为 0。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/amp/debugging/check_numerics_cn.rst b/docs/api/paddle/amp/debugging/check_numerics_cn.rst index aada53fd100..023a13c150e 100644 --- a/docs/api/paddle/amp/debugging/check_numerics_cn.rst +++ b/docs/api/paddle/amp/debugging/check_numerics_cn.rst @@ -11,10 +11,10 @@ check_numerics 参数 ::::::::: -- **tensor** （Tensor）– 需要检查的目标 Tensor 。 -- **op_type** （str）– 产生目标 Tensor 的 OP 或 API 。 +- **tensor** (Tensor) – 需要检查的目标 Tensor 。 +- **op_type** (str) – 产生目标 Tensor 的 OP 或 API 。 - **var_name** (str) – 目标 Tensor 的名字。 -- **debug_mode** (paddle.amp.debugging.DebugMode, 可选) : 要使用的调试类型。默认值为 ``paddle.amp.debugging.DebugMode.CHECK_NAN_INF_AND_ABORT``。 +- **debug_mode** (paddle.amp.debugging.DebugMode, 可选) - 要使用的调试类型。默认值为 ``paddle.amp.debugging.DebugMode.CHECK_NAN_INF_AND_ABORT``。 返回 ::::::::: diff --git a/docs/api/paddle/amp/is_bfloat16_supported_cn.rst b/docs/api/paddle/amp/is_bfloat16_supported_cn.rst index 1f97b4e507e..0b04be5580a 100644 --- a/docs/api/paddle/amp/is_bfloat16_supported_cn.rst +++ b/docs/api/paddle/amp/is_bfloat16_supported_cn.rst @@ -11,7 +11,7 @@ is_bfloat16_supported 参数 :::::::::::: - - **device** (str|None, optional) - 指定要查询的设备，它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中，x 是 GPU、 XPU 的编号。如果 ``device`` 为 None， 则查询当前设备（与飞桨安装版本保持一致），默认为 None。 + - **device** (str|None，可选) - 指定要查询的设备，它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中，x 是 GPU、 XPU 的编号。如果 ``device`` 为 None， 则查询当前设备（与飞桨安装版本保持一致），默认为 None。 代码示例 diff --git a/docs/api/paddle/amp/is_float16_supported_cn.rst b/docs/api/paddle/amp/is_float16_supported_cn.rst index 1a2d1fc799e..a1b9e797e7e 100644 --- a/docs/api/paddle/amp/is_float16_supported_cn.rst +++ b/docs/api/paddle/amp/is_float16_supported_cn.rst @@ -11,7 +11,7 @@ is_float16_supported 参数 :::::::::::: - - **device** (str|None, optional) - 指定要查询的设备，它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中，x 是 GPU、 XPU 的编号。如果 ``device`` 为 None， 则查询当前设备（与飞桨安装版本保持一致）， 默认为 None。 + - **device** (str|None，可选) - 指定要查询的设备，它可以是 cpu、 gpu、 xpu、gpu:x、xpu:x。其中，x 是 GPU、 XPU 的编号。如果 ``device`` 为 None， 则查询当前设备（与飞桨安装版本保持一致）， 默认为 None。 代码示例 diff --git a/docs/api/paddle/argmax_cn.rst b/docs/api/paddle/argmax_cn.rst index 2df908d8a15..48a2851bd60 100644 --- a/docs/api/paddle/argmax_cn.rst +++ b/docs/api/paddle/argmax_cn.rst @@ -12,7 +12,7 @@ argmax :::::::: - **x** (Tensor) - 输入的多维 ``Tensor``，支持的数据类型：float16、float32、float64、int16、int32、int64、uint8。 - **axis** (int，可选) - 指定对输入 Tensor 进行运算的轴，``axis`` 的有效范围是[-R, R），R 是输入 ``x`` 的维度个数，``axis`` 为负数时，进行计算的 ``axis`` 与 ``axis`` + R 一致。默认值为 None，将会对输入的 `x` 进行平铺展开，返回最大值的索引。 - - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留减小的维度。如果 keepdim 为 True，则输出 Tensor 和 x 具有相同的维度(减少的维度除外，减少的维度的大小为 1)，默认值为 False。 + - **keepdim** (bool，可选) - 是否在输出 Tensor 中保留减小的维度。如果 keepdim 为 True，则输出 Tensor 和 x 具有相同的维度（减少的维度除外，减少的维度的大小为 1），默认值为 False。 - **dtype** (np.dtype|str，可选) - 输出 Tensor 的数据类型，可选值为 int32，int64，默认值为 int64，将返回 int64 类型的结果。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/atan2_cn.rst b/docs/api/paddle/atan2_cn.rst index dd1d5efd367..8d51b5bc3a6 100644 --- a/docs/api/paddle/atan2_cn.rst +++ b/docs/api/paddle/atan2_cn.rst @@ -25,7 +25,7 @@ atan2 - **x** (Tensor) - 输入的 Tensor，数据类型为：int32、int64、float16、float32、float64。 - **y** (Tensor) - 输入的 Tensor，数据类型为：int32、int64、float16、float32、float64。 -- **name** (str，可选） - 操作的名称(可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 +- **name** (str，可选) - 操作的名称（可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::: diff --git a/docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst b/docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst index b73998c57bc..4f204763a1e 100644 --- a/docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst +++ b/docs/api/paddle/audio/features/LogMelSpectrogram_cn.rst @@ -14,19 +14,19 @@ LogMelSpectrogram - **n_fft** (int，可选) - 离散傅里叶变换中频率窗大小，默认 512。 - **hop_length** (int，可选) - 帧移，默认 512。 - **win_length** (int，可选) - 短时 FFT 的窗长，默认为 None。 - - **window** (str，可选) - 窗函数名，默认'hann'。 - - **power** (float，可选) - 幅度谱的指数，默认是2.0。 + - **window** (str，可选) - 窗函数名，默认``hann``。 + - **power** (float，可选) - 幅度谱的指数，默认是 2.0。 - **center** (bool，可选) - 对输入信号填充，如果 True，那么 t 以 t*hop_length 为中心，如果为 False，则 t 以 t*hop_length 开始，默认是 True。 - **pad_mode** (str，可选) - 如果 center 是 True，选择填充的方式，默认值是'reflect'。 - - **n_mels** (int，可选) - mel bins 的数目，默认是64。 + - **n_mels** (int，可选) - mel bins 的数目，默认是 64。 - **f_min** (float，可选) - 最小频率(hz)，默认 50.0。 - **f_max** (float，可选) - 最大频率(hz)，默认为 None。 - **htk** (bool，可选) - 在计算 fbank 矩阵时是否用在 HTK 公式缩放，默认是 False。 - - **norm** (Union[str，float]，可选) - 计算 fbank 矩阵时正则化的种类，默认是'slaney'，你也可以 norm=0.5，使用 p-norm 正则化。 + - **norm** (Union[str，float]，可选) - 计算 fbank 矩阵时正则化的种类，默认是``slaney``，你也可以 norm=0.5，使用 p-norm 正则化。 - **ref_value** (float，可选) - 参照值，如果小于 1.0，信号的 db 会被提升，相反 db 会下降，默认值为 1.0。 - - **amin** (float，可选) - 输入的幅值的最小值，默认是1e-10。 - - **top_db** (float，可选) - log-mel 谱的最大值(db)，默认是None。 - - **dtype** (str，可选) - 输入和窗的数据类型，默认是'float32'。 + - **amin** (float，可选) - 输入的幅值的最小值，默认是 1e-10。 + - **top_db** (float，可选) - log-mel 谱的最大值(db)，默认是 None。 + - **dtype** (str，可选) - 输入和窗的数据类型，默认是``float32``。 返回 diff --git a/docs/api/paddle/audio/functional/compute_fbank_matrix_cn.rst b/docs/api/paddle/audio/functional/compute_fbank_matrix_cn.rst index 146c4f86fd9..85d24ec8d2e 100644 --- a/docs/api/paddle/audio/functional/compute_fbank_matrix_cn.rst +++ b/docs/api/paddle/audio/functional/compute_fbank_matrix_cn.rst @@ -12,17 +12,17 @@ compute_fbank_matrix - **sr** (int) - 采样率。 - **n_fft** (int) - fft bins 的数目。 - - **n_mels** (float，可选) - mels bins 的数目，默认是64。 - - **f_min** (float，可选) - 最小频率(hz)，默认是0.0。 + - **n_mels** (float，可选) - mels bins 的数目，默认是 64。 + - **f_min** (float，可选) - 最小频率(hz)，默认是 0.0。 - **f_max** (Optional[float]，可选) - 最大频率(hz)，默认是 None。 - **htk** (bool，可选) - 是否使用 htk 缩放，默认是 False。 - - **norm** (Union[str, float]，可选) - norm 的类型，默认是'slaney'。 - - **dtype** (str，可选) - 返回矩阵的数据类型，默认'float32'。 + - **norm** (Union[str, float]，可选) - norm 的类型，默认是``slaney``。 + - **dtype** (str，可选) - 返回矩阵的数据类型，默认``float32``。 返回 ::::::::: -``paddle.Tensor``，Tensor shape (n_mels， n_fft//2 + 1)。 +``paddle.Tensor``，Tensor shape (n_mels, n_fft//2 + 1)。 代码示例 ::::::::: diff --git a/docs/api/paddle/autograd/hessian_cn.rst b/docs/api/paddle/autograd/hessian_cn.rst index 705dadf2501..3fcbe7e6b4d 100644 --- a/docs/api/paddle/autograd/hessian_cn.rst +++ b/docs/api/paddle/autograd/hessian_cn.rst @@ -27,7 +27,7 @@ hessian - **ys** (Tensor) - 因变量 ``ys`` ，数据类型为单个 Tensor。 - **xs** (Tensor|Tuple[Tensor, ...]) - 自变量 ``xs`` ，数据类型为 Tensor 或 Tensor 元组。 -- **batch_axis** (int, optional) - ``0`` 表示参数包含 batch 维度，且第 0 维为 batch 维， +- **batch_axis** (int，可选) - ``0`` 表示参数包含 batch 维度，且第 0 维为 batch 维， ``None`` 表示参数不包含 batch。默认值为 ``None`` 。 返回 diff --git a/docs/api/paddle/autograd/jacobian_cn.rst b/docs/api/paddle/autograd/jacobian_cn.rst index da91d962b38..379d1bda837 100644 --- a/docs/api/paddle/autograd/jacobian_cn.rst +++ b/docs/api/paddle/autograd/jacobian_cn.rst @@ -32,7 +32,7 @@ jacobian - **ys** (Tensor|Tuple[Tensor, ...]) - 因变量 ``ys`` ，数据类型为 Tensor 或 Tensor 元组。 - **xs** (Tensor|Tuple[Tensor, ...]) - 自变量 ``xs`` ，数据类型为 Tensor 或 Tensor 元组。 -- **batch_axis** (int, optional) - ``0`` 表示参数包含 batch 维度，且第 0 维为 batch 维， +- **batch_axis** (int，可选) - ``0`` 表示参数包含 batch 维度，且第 0 维为 batch 维， ``None`` 表示参数不包含 batch。默认值为 ``None`` 。 返回 diff --git a/docs/api/paddle/deg2rad_cn.rst b/docs/api/paddle/deg2rad_cn.rst index bf057976ae5..ce400a18a1c 100644 --- a/docs/api/paddle/deg2rad_cn.rst +++ b/docs/api/paddle/deg2rad_cn.rst @@ -15,7 +15,7 @@ deg2rad ::::::::: - **x** (Tensor) - 输入的 Tensor，数据类型为：int32、int64、float32、float64。 -- **name** (str，可选） - 操作的名称(可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 +- **name** (str，可选) - 操作的名称（可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::: diff --git a/docs/api/paddle/distributed/fleet/DistributedStrategy_cn.rst b/docs/api/paddle/distributed/fleet/DistributedStrategy_cn.rst index 23744a85407..20f6f1e29fc 100755 --- a/docs/api/paddle/distributed/fleet/DistributedStrategy_cn.rst +++ b/docs/api/paddle/distributed/fleet/DistributedStrategy_cn.rst @@ -439,25 +439,25 @@ sharding_configs 设置 sharding 策略的参数。 -**sharding_segment_strategy(float, optional):** 选择 sharding 中用来将前向反向 program 切 segments 的策略。目前可选策略有："segment_broadcast_MB" 和 "segment_anchors"。 segment 是 sharding 中引入的一个内部概念，目的是用来让通信和计算相互重叠掩盖（overlap）。默认值是 segment_broadcast_MB。 +**sharding_segment_strategy(float，可选):** 选择 sharding 中用来将前向反向 program 切 segments 的策略。目前可选策略有："segment_broadcast_MB" 和 "segment_anchors"。 segment 是 sharding 中引入的一个内部概念，目的是用来让通信和计算相互重叠掩盖（overlap）。默认值是 segment_broadcast_MB。 -**segment_broadcast_MB(float, optional):** 根据 sharding 广播通信中的参数量来切 segments，仅当 sharding_segment_strategy = segment_broadcast_MB 时生效。sharding 会在前向和反向中引入参数广播，在该 segment 策略下，每当参数广播量达到 “segment_broadcast_MB”时，在 program 中切出一个 segment。该参数是一个经验值，最优值会受模型大小和网咯拓扑的影响。默认值是 32。 +**segment_broadcast_MB(float，可选):** 根据 sharding 广播通信中的参数量来切 segments，仅当 sharding_segment_strategy = segment_broadcast_MB 时生效。sharding 会在前向和反向中引入参数广播，在该 segment 策略下，每当参数广播量达到 “segment_broadcast_MB”时，在 program 中切出一个 segment。该参数是一个经验值，最优值会受模型大小和网咯拓扑的影响。默认值是 32。 **segment_anchors(list):** 根据用户选定的锚点切割 segments，仅当 sharding_segment_strategy = segment_anchors 生效。该策略可以让用户更精确的控制 program 的切分，目前还在实验阶段。 -**sharding_degree(int, optional):** sharding 并行数。sharding_degree=1 时，sharding 策略会被关闭。默认值是 8。 +**sharding_degree(int，可选):** sharding 并行数。sharding_degree=1 时，sharding 策略会被关闭。默认值是 8。 -**gradient_merge_acc_step(int, optional):** 梯度累积中的累积步数。gradient_merge_acc_step=1 梯度累积会被关闭。默认值是 1。 +**gradient_merge_acc_step(int，可选):** 梯度累积中的累积步数。gradient_merge_acc_step=1 梯度累积会被关闭。默认值是 1。 -**optimize_offload(bool, optional):** 优化器状态卸载开关。开启后会将优化器中的状态(moment) 卸载到 Host 的内存中，以到达节省 GPU 显存、支持更大模型的目的。开启后，优化器状态会在训练的更新阶段经历：预取-计算-卸载（offload）三个阶段，更新阶段耗时会增加。这个策略需要权衡显存节省量和训练速度，仅推荐在开启梯度累积并且累积步数较大时开启。因为累积步数较大时，训练中更新阶段的比例将远小于前向&反向阶段，卸载引入的耗时将不明显。 +**optimize_offload(bool，可选):** 优化器状态卸载开关。开启后会将优化器中的状态(moment) 卸载到 Host 的内存中，以到达节省 GPU 显存、支持更大模型的目的。开启后，优化器状态会在训练的更新阶段经历：预取-计算-卸载（offload）三个阶段，更新阶段耗时会增加。这个策略需要权衡显存节省量和训练速度，仅推荐在开启梯度累积并且累积步数较大时开启。因为累积步数较大时，训练中更新阶段的比例将远小于前向&反向阶段，卸载引入的耗时将不明显。 -**dp_degree(int, optional):** 数据并行的路数。当 dp_degree>=2 时，会在内层并行的基础上，再引入 dp_degree 路 数据并行。用户需要保证 global_world_size = mp_degree * sharding_degree * pp_degree * dp_degree。默认值是 1。 +**dp_degree(int，可选):** 数据并行的路数。当 dp_degree>=2 时，会在内层并行的基础上，再引入 dp_degree 路 数据并行。用户需要保证 global_world_size = mp_degree * sharding_degree * pp_degree * dp_degree。默认值是 1。 -**mp_degree(int, optional):** [仅在混合并行中使用] megatron 并行数。mp_degree=1 时，mp 策略会被关闭。默认值是 1。 +**mp_degree(int，可选):** [仅在混合并行中使用] megatron 并行数。mp_degree=1 时，mp 策略会被关闭。默认值是 1。 -**pp_degree(int, optional):** [仅在混合并行中使用] pipeline 并行数。pp_degree=1 时，pipeline 策略会被关闭。默认值是 1。 +**pp_degree(int，可选):** [仅在混合并行中使用] pipeline 并行数。pp_degree=1 时，pipeline 策略会被关闭。默认值是 1。 -**pp_allreduce_in_optimize(bool, optional):** [仅在混合并行中使用] 在开启 pipeline 并行后，将 allreduce 操作从反向阶段移动到更新阶段。根据不同的网络拓扑，该选项会影响训练速度，该策略目前还在实验阶段。默认值是 False。 +**pp_allreduce_in_optimize(bool，可选):** [仅在混合并行中使用] 在开启 pipeline 并行后，将 allreduce 操作从反向阶段移动到更新阶段。根据不同的网络拓扑，该选项会影响训练速度，该策略目前还在实验阶段。默认值是 False。 .. code-block:: python diff --git a/docs/api/paddle/distributed/fleet/UtilBase_cn.rst b/docs/api/paddle/distributed/fleet/UtilBase_cn.rst index ca91716f667..42d297ccecf 100644 --- a/docs/api/paddle/distributed/fleet/UtilBase_cn.rst +++ b/docs/api/paddle/distributed/fleet/UtilBase_cn.rst @@ -16,11 +16,11 @@ all_reduce(input, mode="sum", comm_world="worker") - **input** (list|numpy.array) – 归约操作的输入。 - **mode** (str) - 归约操作的模式，包含求和，取最大值和取最小值，默认为求和归约。 - - **comm_world** (str) - 归约操作的通信集合，包含：server 集合(“server")，worker 集合("worker")及所有节点集合("all")，默认为 worker 集合。 + - **comm_world** (str) - 归约操作的通信集合，包含：server 集合(``server``)，worker 集合(``worker``)及所有节点集合(``all``)，默认为 worker 集合。 **返回** -Numpy.array|None：一个和 `input` 形状一致的 numpy 数组或 None。 +Numpy.array|None：一个和``input``形状一致的 numpy 数组或 None。 **代码示例** @@ -64,7 +64,7 @@ barrier(comm_world="worker") **参数** - - **comm_world** (str) - 阻塞操作的通信集合，包含：server 集合(“server")，worker 集合("worker")及所有节点集合("all")，默认为 worker 集合。 + - **comm_world** (str) - 阻塞操作的通信集合，包含：server 集合(``server``)，worker 集合(``worker``)及所有节点集合(``all``)，默认为 worker 集合。 **代码示例** @@ -105,7 +105,7 @@ all_gather(input, comm_world="worker") **参数** - **input** (int|float) - 聚合操作的输入。 - - **comm_world** (str) - 聚合操作的通信集合，包含：server 集合(“server")，worker 集合("worker")及所有节点集合("all")，默认为 worker 集合。 + - **comm_world** (str) - 聚合操作的通信集合，包含：server 集合(``server``)，worker 集合(``worker``)及所有节点集合(``all``)，默认为 worker 集合。 **返回** diff --git a/docs/api/paddle/distribution/Beta_cn.rst b/docs/api/paddle/distribution/Beta_cn.rst index df8abea1b34..c19cc63dc08 100644 --- a/docs/api/paddle/distribution/Beta_cn.rst +++ b/docs/api/paddle/distribution/Beta_cn.rst @@ -28,7 +28,7 @@ Beta - **alpha** (float|Tensor) - 即上述公式中 :math:`\alpha` 参数，大于零，支持 Broadcast 语义。当参数类型为 Tensor 时，表示批量创建多个不同参数的分布，``batch_shape`` (参考 :ref:`cn_api_distribution_Distribution` 基类) 为参数 Broadcast 后的形状。 -- **beta** (float|Tensor） - 即上述公式中 :math:`\beta` 参数，大于零，支持 Broadcast 语 +- **beta** (float|Tensor) - 即上述公式中 :math:`\beta` 参数，大于零，支持 Broadcast 语 义。当参数类型为 Tensor 时，表示批量创建多个不同参数的分布，``batch_shape`` (参考 :ref:`cn_api_distribution_Distribution` 基类) 为参数 Broadcast 后的形状。 diff --git a/docs/api/paddle/empty_cn.rst b/docs/api/paddle/empty_cn.rst index bbc32d34b2d..d448e13f8bb 100644 --- a/docs/api/paddle/empty_cn.rst +++ b/docs/api/paddle/empty_cn.rst @@ -13,7 +13,7 @@ empty :::::::::::: - **shape** (list|tuple|Tensor) – 指定创建 Tensor 的形状(shape)，数据类型为 int32 或者 int64。 - - **dtype** （np.dtype|str，可选）- 输出变量的数据类型，可以是 bool、float16、float32、float64、int32、int64、complex64、complex128。若为 None，则输出变量的数据类型为系统全局默认类型，默认值为 None。 + - **dtype** (np.dtype|str，可选)- 输出变量的数据类型，可以是 bool、float16、float32、float64、int32、int64、complex64、complex128。若为 None，则输出变量的数据类型为系统全局默认类型，默认值为 None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/erfinv_cn.rst b/docs/api/paddle/erfinv_cn.rst index 8da17f7548e..a9a8bdd281f 100644 --- a/docs/api/paddle/erfinv_cn.rst +++ b/docs/api/paddle/erfinv_cn.rst @@ -14,7 +14,7 @@ erfinv ::::::::: - **x** (Tensor) - 输入的 Tensor，数据类型为：float32、float64。 -- **name** (str，可选） - 操作的名称(可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 +- **name** (str，可选) - 操作的名称（可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::: diff --git a/docs/api/paddle/fft/Overview_cn.rst b/docs/api/paddle/fft/Overview_cn.rst index 37a4107355d..bd419597f40 100644 --- a/docs/api/paddle/fft/Overview_cn.rst +++ b/docs/api/paddle/fft/Overview_cn.rst @@ -71,12 +71,12 @@ paddle.fft 目录下包含飞桨框架支持的快速傅里叶变换的相关 AP 背景 ========================== 傅里叶分析是将信号表示为一系列周期性成分，并且从这些周期性成分中还原信号的方法。当信号和傅里叶 -变换都被替换成离散化的，这个过程称为离散傅里叶变换 (Discrete Fourier Transform, DFT). +变换都被替换成离散化的，这个过程称为离散傅里叶变换（Discrete Fourier Transform, DFT）。 因为快速傅里叶变换算法的高效性，傅里叶变换称为数值计算的一个重要支柱。 离散傅里叶变换将离散的输入表示为离散频率的周期性成分之和，在数字信号处理上有广泛的应用，比如滤 -波。在数字信号处理的语境中，离散傅里叶变换的输入一般是定义在时域上的，称为信号(signal)，其输出 -定义在频域上的，称为频谱(spectrum). +波。在数字信号处理的语境中，离散傅里叶变换的输入一般是定义在时域上的，称为信号（signal），其输出 +定义在频域上的，称为频谱（spectrum）. 实现细节 @@ -163,6 +163,6 @@ d 是傅里叶变换维数。 :math:`n_{1}, n_{2}, \cdots, n_{d}` 是每个傅 自动微分与 Wertinger Calculus ======================================== -paddle.fft 中的傅里叶变换函数支持自动微分，使用的方法是维廷格微积分(Wertinger Calculus)。 +paddle.fft 中的傅里叶变换函数支持自动微分，使用的方法是维廷格微积分（Wertinger Calculus）。 对于复函数 :math:`f: \mathbb{C} \rightarrow \mathbb{C}`，paddle 中的惯例是使用 :math:`f(z)` 对其输入的共轭的偏导数 :math:`\frac{\partial f}{\partial z^{*}}`. diff --git a/docs/api/paddle/fft/fft_cn.rst b/docs/api/paddle/fft/fft_cn.rst index 5200027f77f..127866d53bb 100644 --- a/docs/api/paddle/fft/fft_cn.rst +++ b/docs/api/paddle/fft/fft_cn.rst @@ -7,7 +7,7 @@ fft 一维离散傅里叶变换。 -通过快速傅里叶变换(FFT)算法对 M 维 Tensor 中的一维计算离散傅里叶变换。 +通过快速傅里叶变换（FFT）算法对 M 维 Tensor 中的一维计算离散傅里叶变换。 参数 ::::::::: diff --git a/docs/api/paddle/fft/fftfreq_cn.rst b/docs/api/paddle/fft/fftfreq_cn.rst index ece6d217087..00d27fc46b2 100644 --- a/docs/api/paddle/fft/fftfreq_cn.rst +++ b/docs/api/paddle/fft/fftfreq_cn.rst @@ -5,7 +5,7 @@ fftfreq .. py:function:: paddle.fft.fftfreq(n, d=1.0, dtype=None, name=None) -返回离散傅里叶变换的频率窗口(frequency bins)中心序列，以 "循环/采样间隔" 为单位。例如，采 +返回离散傅里叶变换的频率窗口（frequency bins）中心序列，以 "循环/采样间隔" 为单位。例如，采 样间隔以秒为单位，则频率的单位是 "循环/秒"。 对于窗口长度 n 和采样间隔 d，输出的频率序列 f 排布如下： diff --git a/docs/api/paddle/fft/hfft2_cn.rst b/docs/api/paddle/fft/hfft2_cn.rst index 1150adc09fa..e7a838bd775 100644 --- a/docs/api/paddle/fft/hfft2_cn.rst +++ b/docs/api/paddle/fft/hfft2_cn.rst @@ -5,7 +5,7 @@ hfft2 .. py:function:: paddle.fft.hfft2(x, s=None, axes=(-2, -1), norm="backward", name=None) -通过快速傅里叶变换(FFT)算法计算二维厄米特(Hermitian)傅里叶变换。 +通过快速傅里叶变换（FFT）算法计算二维厄米特(Hermitian)傅里叶变换。 参数 diff --git a/docs/api/paddle/fft/hfft_cn.rst b/docs/api/paddle/fft/hfft_cn.rst index 8ca2db2c4d7..275b148b846 100644 --- a/docs/api/paddle/fft/hfft_cn.rst +++ b/docs/api/paddle/fft/hfft_cn.rst @@ -6,7 +6,7 @@ hfft .. py:function:: paddle.fft.hfft(x, n=None, axis=-1, norm="backward", name=None) -通过快速傅里叶变换(FFT)算法计算一维厄米特(Hermitian)傅里叶变换。 +通过快速傅里叶变换（FFT）算法计算一维厄米特（Hermitian）傅里叶变换。 参数 @@ -17,7 +17,7 @@ hfft ``n//2+1``，如果输入 Tensor 的长度大于 ``n//2+1``，输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``n//2+1``，则输入 Tensor 会被补零。如果 ``n`` 没有被指定，则取 ``2*(m-1)``，其中，``m`` 是输入 Tensor 在 ``axis`` 维的长度。 -- **axis** (int，optional) - 傅里叶变换的轴。如果没有指定，默认是使用最后一维。 +- **axis** (int，可选) - 傅里叶变换的轴。如果没有指定，默认是使用最后一维。 - **norm** (str，可选) - 傅里叶变换的缩放模式，缩放系数由变换的方向和缩放模式同时决定。取 值必须是 "forward", "backward", "ortho" 之一，默认值为 "backward"。三种缩放模式对 应的行为如下： diff --git a/docs/api/paddle/fft/hfftn_cn.rst b/docs/api/paddle/fft/hfftn_cn.rst index 762393bd6f5..b6e331af183 100644 --- a/docs/api/paddle/fft/hfftn_cn.rst +++ b/docs/api/paddle/fft/hfftn_cn.rst @@ -5,7 +5,7 @@ hfftn .. py:function:: paddle.fft.hfftn(x, s=None, axes=None, norm="backward", name=None) -通过快速傅里叶变换(FFT)算法计算 N 维厄米特(Hermitian)傅里叶变换。 +通过快速傅里叶变换（FFT）算法计算 N 维厄米特（Hermitian）傅里叶变换。 参数 diff --git a/docs/api/paddle/fft/ifft_cn.rst b/docs/api/paddle/fft/ifft_cn.rst index 6f6c64e56fb..3987ada21e2 100644 --- a/docs/api/paddle/fft/ifft_cn.rst +++ b/docs/api/paddle/fft/ifft_cn.rst @@ -5,7 +5,7 @@ ifft .. py:function:: paddle.fft.ifft(x, n=None, axis=-1, norm="backward", name=None) -一维傅里叶变换(``fft``)的逆变换。在一定的误差范围内，``ifft(fft(x)) == x``。 +一维傅里叶变换（``fft``）的逆变换。在一定的误差范围内，``ifft(fft(x)) == x``。 参数 ::::::::: @@ -14,7 +14,7 @@ ifft - **n** (int，可选) - 输出 Tensor 中在傅里叶变换轴的长度。如果 ``n`` 比输入 Tensor 中 对应轴的长度小，输入数据会被截断。如果 ``n`` 比输入 Tensor 中对应轴的长度大，则输入会被 补零。如果 ``n`` 没有被指定，则使用输入 Tensor 中由 ``axis`` 指定的轴的长度。 -- **axis** (int, optional) - 傅里叶变换的轴。如果没有指定，默认使用最后一维。 +- **axis** (int, 可选) - 傅里叶变换的轴。如果没有指定，默认使用最后一维。 - **norm** (str，可选) - 傅里叶变换的缩放模式，缩放系数由变换的方向和缩放模式同时决定。取值 必须是 "forward"，"backward"，"ortho" 之一，默认值为 "backward"。三种缩放模式对 应的行为如下： diff --git a/docs/api/paddle/fft/ihfft2_cn.rst b/docs/api/paddle/fft/ihfft2_cn.rst index c30f7d3d579..b9ef16d5329 100644 --- a/docs/api/paddle/fft/ihfft2_cn.rst +++ b/docs/api/paddle/fft/ihfft2_cn.rst @@ -5,9 +5,9 @@ ihfft2 .. py:function:: paddle.fft.ihfft2(x, s=None, axes=(-2, -1), norm="backward", name=None) -二维厄米特(Hermitian)傅里叶变换的逆变换。 +二维厄米特（Hermitian）傅里叶变换的逆变换。 -使用快速傅里叶变换(FFT)算法来对 M 维 Tensor 中的某两维计算厄米特(Hermitian)傅里叶变换 +使用快速傅里叶变换（FFT）算法来对 M 维 Tensor 中的某两维计算厄米特（Hermitian）傅里叶变换 的逆变换，默认取最后两维作为傅里叶变换的轴。 diff --git a/docs/api/paddle/fft/ihfft_cn.rst b/docs/api/paddle/fft/ihfft_cn.rst index 1021542011e..a7c34fe502f 100644 --- a/docs/api/paddle/fft/ihfft_cn.rst +++ b/docs/api/paddle/fft/ihfft_cn.rst @@ -5,7 +5,7 @@ ihfft .. py:function:: paddle.fft.ihfft(x, n=None, axis=-1, norm="backward", name=None) -使用快速傅里叶变换(FFT)算法计算一维厄米特(Hermitian)傅里叶变换的逆变换。 +使用快速傅里叶变（FFT）算法计算一维厄米特（Hermitian）傅里叶变换的逆变换。 参数 diff --git a/docs/api/paddle/fft/ihfftn_cn.rst b/docs/api/paddle/fft/ihfftn_cn.rst index 04716ca4eb6..7cf9ce9281d 100644 --- a/docs/api/paddle/fft/ihfftn_cn.rst +++ b/docs/api/paddle/fft/ihfftn_cn.rst @@ -5,9 +5,9 @@ ihfftn .. py:function:: paddle.fft.ihfftn(x, s=None, axes=None, norm="backward", name=None) -N 维厄米特(Hermitian)傅里叶变换的逆变换。 +N 维厄米特（Hermitian）傅里叶变换的逆变换。 -使用快速傅里叶变换(FFT)算法对 M 维 Tensor 中的某 N 维计算厄米特(Hermitian)傅里叶变换的逆变 +使用快速傅里叶变换（FFT）算法对 M 维 Tensor 中的某 N 维计算厄米特(Hermitian)傅里叶变换的逆变 换，沿最后一个轴进行实数变换，其余轴复数变换。 diff --git a/docs/api/paddle/fft/irfft2_cn.rst b/docs/api/paddle/fft/irfft2_cn.rst index f9314665834..81d054ec34d 100644 --- a/docs/api/paddle/fft/irfft2_cn.rst +++ b/docs/api/paddle/fft/irfft2_cn.rst @@ -5,7 +5,7 @@ irfft2 .. py:function:: paddle.fft.irfft2(x, s=None, axes=(-2, -1), norm="backward", name=None) -通过快速傅里叶变换(FFT)算法计算二维实数傅里叶变换 （rfft2）的逆变换。 +通过快速傅里叶变换（FFT）算法计算二维实数傅里叶变换 （rfft2）的逆变换。 参数 @@ -30,7 +30,7 @@ irfft2 返回 ::::::::: Tensor，数据类型为实数。由输入 Tensor（可能被截断或者补零之后）在指定维度进行傅里叶变换的输出。 -二维厄米特傅里叶变换为 N 维厄米特傅里叶(``irfftn``)变换的特例。 +二维厄米特傅里叶变换为 N 维厄米特傅里（``irfftn``）变换的特例。 代码示例 ::::::::: diff --git a/docs/api/paddle/fft/irfft_cn.rst b/docs/api/paddle/fft/irfft_cn.rst index ac9c95de6ae..d4193356421 100644 --- a/docs/api/paddle/fft/irfft_cn.rst +++ b/docs/api/paddle/fft/irfft_cn.rst @@ -6,7 +6,7 @@ irfft .. py:function:: paddle.fft.irfft(x, n=None, axis=-1, norm="backward", name=None) -通过快速傅里叶变换(FFT)算法计算一维实数傅里叶变换 （rfft）的逆变换。 +通过快速傅里叶变换（FFT）算法计算一维实数傅里叶变换 （rfft）的逆变换。 参数 @@ -17,7 +17,7 @@ irfft ``n//2+1``，如果输入 Tensor 的长度大于 ``n//2+1``，输入 Tensor 会被截断。如果输入 Tensor 的长度小于 ``n//2+1``，则输入 Tensor 会被补零。如果 ``n`` 没有被指定，则取 ``2*(m-1)``，其中，``m`` 是输入 Tensor 在 ``axis`` 维的长度。 -- **axis** (int，optional) - 傅里叶变换的轴。如果没有指定，默认是使用最后一维。 +- **axis** (int，可选) - 傅里叶变换的轴。如果没有指定，默认是使用最后一维。 - **norm** (str，可选) - 傅里叶变换的缩放模式，缩放系数由变换的方向和缩放模式同时决定。取 值必须是 "forward", "backward", "ortho" 之一，默认值为 "backward"。三种缩放模式对 应的行为如下： diff --git a/docs/api/paddle/fft/rfft2_cn.rst b/docs/api/paddle/fft/rfft2_cn.rst index 6e2552f3b02..c43dac7c23e 100644 --- a/docs/api/paddle/fft/rfft2_cn.rst +++ b/docs/api/paddle/fft/rfft2_cn.rst @@ -7,7 +7,7 @@ rfft2 二维实数傅里叶变换。 -使用快速傅里叶变换(FFT)算法对 M 维 Tensor 中的某两维计算实数傅里叶变换，默认取最后两维作为傅立 +使用快速傅里叶变换（FFT）算法对 M 维 Tensor 中的某两维计算实数傅里叶变换，默认取最后两维作为傅立 叶变换的轴。 diff --git a/docs/api/paddle/fft/rfftn_cn.rst b/docs/api/paddle/fft/rfftn_cn.rst index 4490895ad06..428837743b9 100644 --- a/docs/api/paddle/fft/rfftn_cn.rst +++ b/docs/api/paddle/fft/rfftn_cn.rst @@ -7,7 +7,7 @@ rfftn N 维实数傅里叶变换。 -使用快速傅里叶变换(FFT)算法对 M 维 Tensor 中的某 N 维计算实数傅里叶变换，沿最后一个轴进行实数 +使用快速傅里叶变换（FFT）算法对 M 维 Tensor 中的某 N 维计算实数傅里叶变换，沿最后一个轴进行实数 变换，其余轴复数变换。 diff --git a/docs/api/paddle/fluid/dygraph/MultiStepDecay_cn.rst b/docs/api/paddle/fluid/dygraph/MultiStepDecay_cn.rst index 410a8e7834c..f6c319333d3 100644 --- a/docs/api/paddle/fluid/dygraph/MultiStepDecay_cn.rst +++ b/docs/api/paddle/fluid/dygraph/MultiStepDecay_cn.rst @@ -27,9 +27,9 @@ MultiStepDecay 参数 :::::::::::: - - **learning_rate** (float|int) - 初始化的学习率。可以是Python的float或int。 + - **learning_rate** (float|int) - 初始化的学习率。可以是 Python 的 float 或 int。 - **milestones** (tuple|list) - 列表或元组。必须是递增的。 - - **decay_rate** (float, optional) - 学习率的衰减率。``new_lr = origin_lr * decay_rate``。其值应该小于1.0。默认：0.1。 + - **decay_rate** (float，可选) - 学习率的衰减率。``new_lr = origin_lr * decay_rate``。其值应该小于 1.0。默认：0.1。 返回 :::::::::::: @@ -39,7 +39,7 @@ MultiStepDecay :::::::::::: .. code-block:: python - + import paddle.fluid as fluid import numpy as np with fluid.dygraph.guard(): @@ -70,7 +70,7 @@ epoch(epoch=None) **参数** - - **epoch** (int|float，可选) - 类型：int或float。指定当前的epoch数。默认：无，此时将会自动累计epoch数。 + - **epoch** (int|float，可选) - 类型：int 或 float。指定当前的 epoch 数。默认：无，此时将会自动累计 epoch 数。 **返回** diff --git a/docs/api/paddle/fluid/dygraph/StepDecay_cn.rst b/docs/api/paddle/fluid/dygraph/StepDecay_cn.rst index ad90eacfa8f..0b8a5ee820b 100644 --- a/docs/api/paddle/fluid/dygraph/StepDecay_cn.rst +++ b/docs/api/paddle/fluid/dygraph/StepDecay_cn.rst @@ -25,9 +25,9 @@ StepDecay 参数 :::::::::::: - - **learning_rate** (float|int) - 初始化的学习率。可以是Python的float或int。 + - **learning_rate** (float|int) - 初始化的学习率。可以是 Python 的 float 或 int。 - **step_size** (int) - 学习率每衰减一次的间隔。 - - **decay_rate** (float, optional) - 学习率的衰减率。``new_lr = origin_lr * decay_rate``。其值应该小于1.0。默认：0.1。 + - **decay_rate** (float，可选) - 学习率的衰减率。``new_lr = origin_lr * decay_rate``。其值应该小于 1.0。默认：0.1。 返回 :::::::::::: @@ -37,7 +37,7 @@ StepDecay :::::::::::: .. code-block:: python - + import paddle.fluid as fluid import numpy as np with fluid.dygraph.guard(): @@ -50,7 +50,7 @@ StepDecay for batch_id in range(5): out = linear(input) loss = fluid.layers.reduce_mean(out) - adam.minimize(loss) + adam.minimize(loss) scheduler.epoch() print("epoch:{}, current lr is {}" .format(epoch, adam.current_step_lr())) # epoch:0, current lr is 0.5 @@ -71,7 +71,7 @@ epoch(epoch=None) **参数** - - **epoch** (int|float，可选) - 类型：int或float。指定当前的epoch数。默认：无，此时将会自动累计epoch数。 + - **epoch** (int|float，可选) - 类型：int 或 float。指定当前的 epoch 数。默认：无，此时将会自动累计 epoch 数。 **返回** diff --git a/docs/api/paddle/fluid/require_version_cn.rst b/docs/api/paddle/fluid/require_version_cn.rst index 6341e407f5f..ee5b786a85a 100644 --- a/docs/api/paddle/fluid/require_version_cn.rst +++ b/docs/api/paddle/fluid/require_version_cn.rst @@ -13,7 +13,7 @@ require_version :::::::::::: - **min_version** (str) - 指定所需要的最低版本（如‘1.4.0’） - - **max_version** (str, optional) – 指定可接受的最高版本（如‘1.7.0’），默认值None，表示任意大于等于 ``min_version`` 的版本都可以接受。 + - **max_version** (str，可选) – 指定可接受的最高版本（如‘1.7.0’），默认值 None，表示任意大于等于 ``min_version`` 的版本都可以接受。 返回 :::::::::::: @@ -23,14 +23,14 @@ require_version :::::::::::: - - ``TypeError`` – ``min_version`` 的类型不是str。 - - ``TypeError`` – ``max_version`` 的类型不是str或type(None)。 + - ``TypeError`` – ``min_version`` 的类型不是 str。 + - ``TypeError`` – ``max_version`` 的类型不是 str 或 type(None)。 - ``ValueError`` – ``min_version`` 的值不是正常的版本号格式。 - - ``ValueError`` – ``max_version`` 的值不是正常的版本号格式或None。 + - ``ValueError`` – ``max_version`` 的值不是正常的版本号格式或 None。 - ``Exception`` – 已安装的版本低于 ``min_version`` 或者高于 ``max_version`` 。 代码示例 :::::::::::: -COPY-FROM: paddle.fluid.require_version \ No newline at end of file +COPY-FROM: paddle.fluid.require_version diff --git a/docs/api/paddle/gcd_cn.rst b/docs/api/paddle/gcd_cn.rst index 85b633eae35..6fcf9bcd08a 100644 --- a/docs/api/paddle/gcd_cn.rst +++ b/docs/api/paddle/gcd_cn.rst @@ -21,7 +21,7 @@ gcd - **x** (Tensor) - 输入的 Tensor，数据类型为：int32，int64。 - **y** (Tensor) - 输入的 Tensor，数据类型为：int32，int64。 -- **name** (str，可选） - 操作的名称(可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 +- **name** (str，可选) - 操作的名称（可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::: diff --git a/docs/api/paddle/incubate/ModelAverage_cn.rst b/docs/api/paddle/incubate/ModelAverage_cn.rst index 2bd598c7c14..e84d6baec38 100644 --- a/docs/api/paddle/incubate/ModelAverage_cn.rst +++ b/docs/api/paddle/incubate/ModelAverage_cn.rst @@ -9,18 +9,18 @@ ModelAverage 优化器，在训练过程中累积特定连续的历史 ``Paramet 在滑动窗口中累积 ``Parameters`` 的平均值，将结果将保存在临时变量中，通过调用 ``apply()`` 方法可应用于当前模型的 ``Parameters``，使用 ``restore()`` 方法恢复当前模型 ``Parameters`` 的值。 -计算平均值的窗口大小由 ``average_window_rate`` ， ``min_average_window`` ， ``max_average_window`` 以及当前 ``Parameters`` 更新次数(num_updates)共同决定。 +计算平均值的窗口大小由 ``average_window_rate`` ， ``min_average_window`` ， ``max_average_window`` 以及当前 ``Parameters`` 更新次数（num_updates）共同决定。 -累积次数（num_accumulates）大于特定窗口阈值 (average_window) 时，将累积的 ``Parameters`` 临时变量置为 0.0。 +累积次数（num_accumulates）大于特定窗口阈值（average_window）时，将累积的 ``Parameters`` 临时变量置为 0.0。 ``num_accumulates`` 表示当前累积的次数，可以抽象理解为累积窗口的长度；窗口长度至少要达到 ``min_average_window`` 参数设定的长度，并且不能超过 ``max_average_window`` 参数或者 ``num_updates`` * ``average_window_rate`` 规定的长度，否则为 0；而其中 ``num_updates`` 表示当前 ``Parameters`` 更新的次数，``average_window_rate`` 是一个计算窗口长度的系数。 参数 ::::::::: - - **average_window_rate** (float) – 相对于 ``Parameters`` 更新次数的窗口长度计算比率。 + - **average_window_rate** (float) - 相对于 ``Parameters`` 更新次数的窗口长度计算比率。 - **parameters** (list，可选) - 为了最小化 ``loss`` 需要更新的 Tensor 列表。动态图模式下该参数是必需的；静态图模型下该参数的默认值为 None，此时所有参数都会被更新。 - - **min_average_window** (int，可选) – 平均值计算窗口长度的最小值，默认值为 10000。 - - **max_average_window** (int，可选) – 平均值计算窗口长度的最大值，默认值为 10000。 + - **min_average_window** (int，可选) - 平均值计算窗口长度的最小值，默认值为 10000。 + - **max_average_window** (int，可选) - 平均值计算窗口长度的最大值，默认值为 10000。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 代码示例 @@ -38,10 +38,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 一个包含需要最小化的损失值变量的 Tensor。 + - **loss** (Tensor) - 一个包含需要最小化的损失值变量的 Tensor。 - **startup_program** (Program，可选) - 用于初始化 ``Parameters`` 中参数的 ``Program``，默认值为 None，此时将使用 ``default_startup_program``。 - - **parameters** (list，可选) – 待更新的 ``Parameters`` 或者 ``Parameter.name`` 组成的列表，默认值为 None，此时将更新所有的 ``Parameters``。 - - **no_grad_set** (set，可选) – 不需要更新的 ``Parameters`` 或者 ``Parameter.name`` 组成的集合，默认值为 None。 + - **parameters** (list，可选) - 待更新的 ``Parameters`` 或者 ``Parameter.name`` 组成的列表，默认值为 None，此时将更新所有的 ``Parameters``。 + - **no_grad_set** (set，可选) - 不需要更新的 ``Parameters`` 或者 ``Parameter.name`` 组成的集合，默认值为 None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 **返回** @@ -74,7 +74,7 @@ apply(executor=None, need_restore=True) **参数** - - **executor** (Executor) – 静态图模式下当前网络的执行器；动态图模式下默认值为 None。 + - **executor** (Executor) - 静态图模式下当前网络的执行器；动态图模式下默认值为 None。 - **need_restore** (bool) - 恢复标志变量；设为 True 时，执行完成后会将网络的 ``Parameters``恢复为网络默认的值，设为 False 将不会恢复。默认值为 True。 **代码示例** @@ -89,7 +89,7 @@ restore(executor=None) **参数** - - **executor** (Executor) – 静态图模式下当前网络的执行器；动态图模式下默认值为 None。 + - **executor** (Executor) - 静态图模式下当前网络的执行器；动态图模式下默认值为 None。 **代码示例** diff --git a/docs/api/paddle/incubate/autograd/Hessian_cn.rst b/docs/api/paddle/incubate/autograd/Hessian_cn.rst index 662cff20e6c..8c6df2de5fd 100644 --- a/docs/api/paddle/incubate/autograd/Hessian_cn.rst +++ b/docs/api/paddle/incubate/autograd/Hessian_cn.rst @@ -11,8 +11,8 @@ Hessian ``is_batched`` 表示是否支持 batch, ``True`` 表示支持并默认第零维作为 batch 维。 在计算海森矩阵时，所有输入 Tensor 会沿着 batch 维外的其它维度进行展平，且当输入为 Tensor 序列时， -所有展平后的 Tensor 会被拼接成一个新的 Tensor。因此，``Hessian`` 最终的输出为一个二维(不包含 -batch)或三维(包含 batch，第零维为 batch)的 Tensor。 +所有展平后的 Tensor 会被拼接成一个新的 Tensor。因此，``Hessian`` 最终的输出为一个二维（不包含 +batch）或三维（包含 batch，第零维为 batch）的 Tensor。 例如，假设 ``is_batched=True``，输入 Tensor 经过展平并拼接后的形状为 ``(B, M)``，输出 Tensor 形状为 ``(B, 1)``，则最终输出海森矩阵形状为 ``(B, M, M)``。其中，``B`` 为 batch @@ -33,7 +33,7 @@ Tensor 形状为 ``(B, 1)``，则最终输出海森矩阵形状为 ``(B, M, M)`` - **func** (Callable) - Python 函数，输入参数为 ``xs``，输出为只包含一个元素 Tensor，即 如果 ``is_batched=True``，输出形状为 ``(B, 1)`` , ``B`` 表示 batch 大小， ``is_batched=False``，输出形状为 ``(1)`` 。 -- **xs** (Tensor|Sequence[Tensor]） - 函数 ``func`` 的输入参数，数据类型为 Tensor 或 +- **xs** (Tensor|Sequence[Tensor]) - 函数 ``func`` 的输入参数，数据类型为 Tensor 或 Tensor 序列。 - **is_batched** (bool) - ``True`` 表示包含 batch 维，且默认第零维为 batch 维，``False`` 表示不包含 batch。默认值为 ``False`` 。 diff --git a/docs/api/paddle/incubate/autograd/Jacobian_cn.rst b/docs/api/paddle/incubate/autograd/Jacobian_cn.rst index 8902f133f8e..e0c3093f9a4 100644 --- a/docs/api/paddle/incubate/autograd/Jacobian_cn.rst +++ b/docs/api/paddle/incubate/autograd/Jacobian_cn.rst @@ -12,7 +12,7 @@ Jacobian 在计算雅可比矩阵时，输入 Tensor batch 维外的其它维度会被展平，且当输入为 Tensor 序列时， 所有展平后的 Tensor 会被拼接成一个新的 Tensor。输出按照同样规则进行处理。因此，``Jacobian`` 最终 -的输出为一个二维(不包含 batch)或三维(包含 batch，第零维为 batch)的 Tensor。 +的输出为一个二维（不包含 batch）或三维（包含 batch，第零维为 batch）的 Tensor。 例如，假设 ``is_batched=True``，输入 Tensor 经过展平并拼接后的形状为 ``(B, M)``，输出 Tensor 经过展平并拼接后的形状为 ``(B, N)``，则最终输出雅可比矩阵形状为 ``(B, M, N)`` 。 @@ -39,7 +39,7 @@ Tensor 经过展平并拼接后的形状为 ``(B, N)``，则最终输出雅可 ::::::::: - **func** (Callable) - Python 函数，输入参数为 ``xs``，输出为 Tensor 或 Tensor 序列。 -- **xs** (Tensor|Sequence[Tensor]） - 函数 ``func`` 的输入参数，数据类型为 Tensor 或 +- **xs** (Tensor|Sequence[Tensor]) - 函数 ``func`` 的输入参数，数据类型为 Tensor 或 Tensor 序列。 - **is_batched** (bool) - ``True`` 表示包含 batch 维，且默认第零维为 batch 维，``False`` 表示不包含 batch。默认值为 ``False`` 。 diff --git a/docs/api/paddle/incubate/autograd/Overview_cn.rst b/docs/api/paddle/incubate/autograd/Overview_cn.rst index 33fefabe373..8dc4000f5f2 100644 --- a/docs/api/paddle/incubate/autograd/Overview_cn.rst +++ b/docs/api/paddle/incubate/autograd/Overview_cn.rst @@ -239,7 +239,7 @@ _________________________ 整体架构如下图： -- 基础算子体系：由初等函数组成，并定义对应的前向(Linearize)和反向(Transpose)规则，且前向和反向规则也基于基础算子实现； +- 基础算子体系：由初等函数组成，并定义对应的前向（Linearize）和反向（Transpose）规则，且前向和反向规则也基于基础算子实现； - 程序变换：输入初始程序，Linearize 变换调用前向规则输出前向计算程序，Transpose 变换基于前向计算程序调用反向规则输出反向计算程序； - 自动微分 API：提供前向、反向模式的高阶微分 API； diff --git a/docs/api/paddle/io/ComposeDataset_cn.rst b/docs/api/paddle/io/ComposeDataset_cn.rst index d1016eec4b7..05375b1d39a 100644 --- a/docs/api/paddle/io/ComposeDataset_cn.rst +++ b/docs/api/paddle/io/ComposeDataset_cn.rst @@ -7,7 +7,7 @@ ComposeDataset 由多个数据集的字段组成的数据集。 -这个数据集用于将多个映射式(map-style)且长度相等数据集按字段组合为一个新的数据集。 +这个数据集用于将多个映射式（map-style）且长度相等数据集按字段组合为一个新的数据集。 参数 :::::::::::: @@ -16,7 +16,7 @@ ComposeDataset 返回 :::::::::::: -Dataset，字段组合后的数据集 +Dataset，字段组合后的数据集。 代码示例 :::::::::::: diff --git a/docs/api/paddle/io/Dataset_cn.rst b/docs/api/paddle/io/Dataset_cn.rst index 0c03fa8d1e4..4fcd8859c1f 100644 --- a/docs/api/paddle/io/Dataset_cn.rst +++ b/docs/api/paddle/io/Dataset_cn.rst @@ -7,7 +7,7 @@ Dataset 概述 Dataset 的方法和行为的抽象类。 -映射式(map-style)数据集需要继承这个基类，映射式数据集为可以通过一个键值索引并获取指定样本的数据集，所有映射式数据集须实现以下方法： +映射式（map-style）数据集需要继承这个基类，映射式数据集为可以通过一个键值索引并获取指定样本的数据集，所有映射式数据集须实现以下方法： ``__getitem__``：根据给定索引获取数据集中指定样本，在 ``paddle.io.DataLoader`` 中需要使用此函数通过下标获取样本。 diff --git a/docs/api/paddle/jit/to_static_cn.rst b/docs/api/paddle/jit/to_static_cn.rst index d3f57f0b29c..c92fc2c2b5c 100644 --- a/docs/api/paddle/jit/to_static_cn.rst +++ b/docs/api/paddle/jit/to_static_cn.rst @@ -14,7 +14,7 @@ to_static - **function** (callable) - 待转换的动态图函数。若以装饰器形式使用，则被装饰函数默认会被解析为此参数值，无需显式指定。 - **input_spec** (list[InputSpec]|tuple[InputSpec]) - 用于指定被装饰函数中输入 Tensor 的 shape、dtype 和 name 信息，为包含 InputSpec 的 list/tuple 类型。 - **build_strategy** (BuildStrategy|None)：通过配置 build_strategy，对转换后的计算图进行优化，例如：计算图中算子融合、计算图执行过程中开启内存/显存优化等。关于 build_strategy 更多信息，请参阅 ``paddle.static.BuildStrategy``。默认为 None。 - - **backend** (str, Optional): 指定后端编译器，可以指定为 `CINN` 或者 None。当该参数指定为 `CINN` 时，将会使用 CINN 编译器来加速训练和推理。 + - **backend** (str，可选): 指定后端编译器，可以指定为 `CINN` 或者 None。当该参数指定为 `CINN` 时，将会使用 CINN 编译器来加速训练和推理。 - **kwargs**: 支持的 key 包括 `property` - **property**: 表示被装饰的函数是否以 class property 属性的方式进行导出 diff --git a/docs/api/paddle/lcm_cn.rst b/docs/api/paddle/lcm_cn.rst index 6eddcbbb7fb..98c1e777d6a 100644 --- a/docs/api/paddle/lcm_cn.rst +++ b/docs/api/paddle/lcm_cn.rst @@ -21,7 +21,7 @@ lcm - **x** (Tensor) - 输入的 Tensor，数据类型为：int32，int64。 - **y** (Tensor) - 输入的 Tensor，数据类型为：int32，int64。 -- **name** (str，可选） - 操作的名称(可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 +- **name** (str，可选) - 操作的名称（可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::: diff --git a/docs/api/paddle/linalg/pca_lowrank.rst b/docs/api/paddle/linalg/pca_lowrank.rst index d6e3ab920c2..b320b4ba591 100644 --- a/docs/api/paddle/linalg/pca_lowrank.rst +++ b/docs/api/paddle/linalg/pca_lowrank.rst @@ -6,7 +6,7 @@ pca_lowrank .. py:function:: paddle.linalg.pca_lowrank(x, q=None, center=True, niter=2, name=None) -计算在低秩矩阵或者批次的矩阵上的线性主成分分析(PCA)。 +计算在低秩矩阵或者批次的矩阵上的线性主成分分析（PCA）。 记 :math:`X` 为一个矩阵或者批次矩阵，输出结果满足： diff --git a/docs/api/paddle/meshgrid_cn.rst b/docs/api/paddle/meshgrid_cn.rst index 628c124476b..1695338421e 100644 --- a/docs/api/paddle/meshgrid_cn.rst +++ b/docs/api/paddle/meshgrid_cn.rst @@ -13,8 +13,8 @@ meshgrid 参数 :::::::::::: - - \* **args** （Tensor|Tensor 数组）- 输入变量为 k 个一维 Tensor，形状分别为(N1,), (N2,), ..., (Nk, )。支持数据类型为 float32、float64、int32 和 int64。 - - ** **kargs** （可选）- 目前只接受 name 参数（str），具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + - **args** (Tensor|Tensor 数组) - 输入变量为 k 个一维 Tensor，形状分别为(N1,), (N2,), ..., (Nk, )。支持数据类型为 float32、float64、int32 和 int64。 + - **kargs** (可选) - 目前只接受 name 参数（str），具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/metric/Auc_cn.rst b/docs/api/paddle/metric/Auc_cn.rst index 0cacb41d77c..363c7af1d45 100644 --- a/docs/api/paddle/metric/Auc_cn.rst +++ b/docs/api/paddle/metric/Auc_cn.rst @@ -19,7 +19,7 @@ Auc - **curve** (str) - 将要计算的曲线名的模式，包括'ROC'（默认）或者'PR'（Precision-Recall-curve）。 - **num_thresholds** (int) - 离散化 AUC 曲线的整数阈值数，默认是 4095。 - - **name** (str，可选) – metric 实例的名字，默认是'auc'。 + - **name** (str，可选) - metric 实例的名字，默认是'auc'。 代码示例 1 :::::::::::: diff --git a/docs/api/paddle/nn/AvgPool1D_cn.rst b/docs/api/paddle/nn/AvgPool1D_cn.rst index 402bc554966..52c7fe7d58e 100755 --- a/docs/api/paddle/nn/AvgPool1D_cn.rst +++ b/docs/api/paddle/nn/AvgPool1D_cn.rst @@ -17,11 +17,11 @@ AvgPool1D 参数 ::::::::: - - **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`。如果是 turple 或者 list 类型，则应是 `[pad_left, pad_right]` 形式。如果 padding 是一个非 0 值，那么表示会在输入的两端都 padding 上同样长度的 0。默认值为 0。 - - **exclusive** (bool，可选)：是否用额外 padding 的值计算平均池化结果，默认为 True。 - - **ceil_mode** (bool，可选)：是否用 ceil 函数计算输出的 height 和 width，如果设置为 False，则使用 floor 函数来计算，默认为 False。 + - **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`。如果是 turple 或者 list 类型，则应是 `[pad_left, pad_right]` 形式。如果 padding 是一个非 0 值，那么表示会在输入的两端都 padding 上同样长度的 0。默认值为 0。 + - **exclusive** (bool，可选) - 是否用额外 padding 的值计算平均池化结果，默认为 True。 + - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出的 height 和 width，如果设置为 False，则使用 floor 函数来计算，默认为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/ClipGradByGlobalNorm_cn.rst b/docs/api/paddle/nn/ClipGradByGlobalNorm_cn.rst index aa3f97993d2..739a3477901 100644 --- a/docs/api/paddle/nn/ClipGradByGlobalNorm_cn.rst +++ b/docs/api/paddle/nn/ClipGradByGlobalNorm_cn.rst @@ -34,9 +34,9 @@ ClipGradByGlobalNorm 参数 :::::::::::: - - **clip_norm** (float) - 所允许的范数最大值 - - **group_name** (str, optional) - 剪切的组名 - - **auto_skip_clip** (bool, optional): 跳过剪切梯度。默认值为 False。 + - **clip_norm** (float) - 所允许的范数最大值。 + - **group_name** (str，可选) - 剪切的组名。 + - **auto_skip_clip** (bool，可选) - 跳过剪切梯度。默认值为 False。 代码示例 :::::::::::: diff --git a/docs/api/paddle/nn/ClipGradByValue_cn.rst b/docs/api/paddle/nn/ClipGradByValue_cn.rst index c6e6ea59855..407cfec213d 100644 --- a/docs/api/paddle/nn/ClipGradByValue_cn.rst +++ b/docs/api/paddle/nn/ClipGradByValue_cn.rst @@ -26,8 +26,8 @@ ClipGradByValue 参数 :::::::::::: - - **max** (foat) - 要修剪的最大值。 - - **min** (float，optional) - 要修剪的最小值。如果用户没有设置，将被自动设置为 ``-max`` （此时 ``max`` 必须大于 :math:`0`）。 + - **max** (float) - 要修剪的最大值。 + - **min** (float，可选) - 要修剪的最小值。如果用户没有设置，将被自动设置为 ``-max`` （此时 ``max`` 必须大于 :math:`0`）。 代码示例 :::::::::::: diff --git a/docs/api/paddle/nn/Conv1D_cn.rst b/docs/api/paddle/nn/Conv1D_cn.rst index fb628a99c11..17c745e1f3d 100644 --- a/docs/api/paddle/nn/Conv1D_cn.rst +++ b/docs/api/paddle/nn/Conv1D_cn.rst @@ -37,9 +37,9 @@ Conv1D - **padding** (int|list|tuple|str，可选) - 填充大小。可以是以下三种格式：（1）字符串，可以是"VALID"或者"SAME"，表示填充算法，计算细节可参考下述 ``padding`` = "SAME"或 ``padding`` = "VALID" 时的计算公式。（2）整数，表示在输入特征两侧各填充 ``padding`` 大小的 0。（3）包含一个整数的列表或元组，表示在输入特征两侧各填充 ``padding[0]`` 大小的 0。默认值：0。 - **dilation** (int|list|tuple，可选) - 空洞大小。可以为单个整数或包含一个整数的元组或列表，表示卷积核中的元素的空洞。默认值：1。 - **groups** (int，可选) - 一维卷积层的组数。根据 Alex Krizhevsky 的深度卷积神经网络（CNN）论文中的成组卷积：当 group=n，输入和卷积核分别根据通道数量平均分为 n 组，第一组卷积核和第一组输入进行卷积计算，第二组卷积核和第二组输入进行卷积计算，……，第 n 组卷积核和第 n 组输入进行卷积计算。默认值：1。 - - **padding_mode** (str，可选)：填充模式。包括 ``'zeros'``, ``'reflect'``, ``'replicate'`` 或者 ``'circular'``。默认值：``'zeros'`` 。 + - **padding_mode** (str，可选) - 填充模式。包括 ``'zeros'``, ``'reflect'``, ``'replicate'`` 或者 ``'circular'``。默认值：``'zeros'`` 。 - **weight_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - - **bias_attr** （ParamAttr|bool，可选）- 指定偏置参数属性的对象。若 ``bias_attr`` 为 bool 类型，只支持为 False，表示没有偏置参数。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 + - **bias_attr** (ParamAttr|bool，可选) - 指定偏置参数属性的对象。若 ``bias_attr`` 为 bool 类型，只支持为 False，表示没有偏置参数。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是"NCL"和"NLC"。N 是批尺寸，C 是通道数，L 是特征长度。默认值："NCL"。 diff --git a/docs/api/paddle/nn/Conv2D_cn.rst b/docs/api/paddle/nn/Conv2D_cn.rst index a583ebd37ee..bd053c1b1a9 100644 --- a/docs/api/paddle/nn/Conv2D_cn.rst +++ b/docs/api/paddle/nn/Conv2D_cn.rst @@ -37,9 +37,9 @@ Conv2D - **padding** (int|list|tuple|str，可选) - 填充大小。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法，计算细节可参考上述 ``padding`` = "SAME"或 ``padding`` = "VALID" 时的计算公式。如果它是一个元组或列表，它可以有 3 种格式：(1)包含 4 个二元组：当 ``data_format`` 为"NCHW"时为 [[0,0], [0,0], [padding_height_top, padding_height_bottom], [padding_width_left, padding_width_right]]，当 ``data_format`` 为"NHWC"时为[[0,0], [padding_height_top, padding_height_bottom], [padding_width_left, padding_width_right], [0,0]]；(2)包含 4 个整数值：[padding_height_top, padding_height_bottom, padding_width_left, padding_width_right]；(3)包含 2 个整数值：[padding_height, padding_width]，此时 padding_height_top = padding_height_bottom = padding_height， padding_width_left = padding_width_right = padding_width。若为一个整数，padding_height = padding_width = padding。默认值：0。 - **dilation** (int|list|tuple，可选) - 空洞大小。可以为单个整数或包含两个整数的元组或列表，分别表示卷积核中的元素沿着高和宽的空洞。如果为单个整数，表示高和宽的空洞都等于该整数。默认值：1。 - **groups** (int，可选) - 二维卷积层的组数。根据 Alex Krizhevsky 的深度卷积神经网络（CNN）论文中的成组卷积：当 group=n，输入和卷积核分别根据通道数量平均分为 n 组，第一组卷积核和第一组输入进行卷积计算，第二组卷积核和第二组输入进行卷积计算，……，第 n 组卷积核和第 n 组输入进行卷积计算。默认值：1。 - - **padding_mode** (str，可选)：填充模式。包括 ``'zeros'``, ``'reflect'``, ``'replicate'`` 或者 ``'circular'``。默认值：``'zeros'`` 。 + - **padding_mode** (str，可选) - 填充模式。包括 ``'zeros'``, ``'reflect'``, ``'replicate'`` 或者 ``'circular'``。默认值：``'zeros'`` 。 - **weight_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - - **bias_attr** （ParamAttr|bool，可选）- 指定偏置参数属性的对象。若 ``bias_attr`` 为 bool 类型，只支持为 False，表示没有偏置参数。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 + - **bias_attr** (ParamAttr|bool，可选) - 指定偏置参数属性的对象。若 ``bias_attr`` 为 bool 类型，只支持为 False，表示没有偏置参数。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW"。 diff --git a/docs/api/paddle/nn/HSigmoidLoss_cn.rst b/docs/api/paddle/nn/HSigmoidLoss_cn.rst index 772dd3e50b2..ecba6a8f6aa 100644 --- a/docs/api/paddle/nn/HSigmoidLoss_cn.rst +++ b/docs/api/paddle/nn/HSigmoidLoss_cn.rst @@ -27,10 +27,10 @@ HSigmoidLoss :::::::::: - **feature_size** (int) - 输入 Tensor 的特征大尺寸。 - **num_classes** (int) - 类别总数(字典大小)必须大于等于 2。若使用默认树结构，即当 ``is_custom=False`` 时，必须设置该参数。若使用自定义树结构，即当 ``is_custom=True`` 时，它取值应为自定义树结构的非叶节点的个数，用于指定二分类的类别总数。 - - **weight_attr** (ParamAttr，可选) – 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - - **bias_attr** (ParamAttr，可选) – 指定偏置参数属性的对象，若 `bias_attr` 为 bool 类型，如果设置为 False，表示不会为该层添加偏置；如果设置为 True，表示使用默认的偏置参数属性。默认值为 None，表示使用默认的偏置参数属性。默认的偏置参数属性将偏置参数的初始值设为 0。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - - **is_custom** (bool，可选) – 是否使用用户自定义二叉树取代默认二叉树结构。如果设置为 True，请务必设置 ``path_table`` ， ``path_code`` ， ``num_classes``，否则必须设置 num_classes。默认值为 False。 - - **is_sparse** (bool，可选) – 是否使用稀疏更新方式。如果设置为 True，W 的梯度和输入梯度将会变得稀疏。默认值为 False。 + - **weight_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 + - **bias_attr** (ParamAttr，可选) - 指定偏置参数属性的对象，若 `bias_attr` 为 bool 类型，如果设置为 False，表示不会为该层添加偏置；如果设置为 True，表示使用默认的偏置参数属性。默认值为 None，表示使用默认的偏置参数属性。默认的偏置参数属性将偏置参数的初始值设为 0。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 + - **is_custom** (bool，可选) - 是否使用用户自定义二叉树取代默认二叉树结构。如果设置为 True，请务必设置 ``path_table`` ， ``path_code`` ， ``num_classes``，否则必须设置 num_classes。默认值为 False。 + - **is_sparse** (bool，可选) - 是否使用稀疏更新方式。如果设置为 True，W 的梯度和输入梯度将会变得稀疏。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 diff --git a/docs/api/paddle/nn/Upsample_cn.rst b/docs/api/paddle/nn/Upsample_cn.rst index 2263131dcaf..a8b3b1a7c54 100644 --- a/docs/api/paddle/nn/Upsample_cn.rst +++ b/docs/api/paddle/nn/Upsample_cn.rst @@ -151,7 +151,7 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation ::::::::: - **size** (list|tuple|Tensor|None) - 输出 Tensor 的形状，输入为 3D Tensor 时，形状为为(out_w)的 1-D Tensor。输入为 4D Tensor 时，形状为为(out_h, out_w)的 2-D Tensor。输入为 5-D Tensor 时，形状为(out_d, out_h, out_w)的 3-D Tensor。如果 :code:`size` 是列表，每一个元素可以是整数或者形状为[]的 0-D Tensor。如果 :code:`size` 是 Tensor，则其为 1D Tensor。默认值为 None。 - - **scale_factor** (float|Tensor|list|tuple|None，可选)-输入的深度、高度或宽度的缩放因子。:code:`size` 和 :code:`scale_factor` 至少要设置一个。:code:`size` 的优先级高于 :code:`scale_factor`。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。 + - **scale_factor** (float|Tensor|list|tuple|None，可选) - 输入的深度、高度或宽度的缩放因子。:code:`size` 和 :code:`scale_factor` 至少要设置一个。:code:`size` 的优先级高于 :code:`scale_factor`。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。 - **mode** (str，可选) - 插值方法。支持"bilinear"或"trilinear"或"nearest"或"bicubic"或"linear"或"area"。默认值为"nearest"。 - **align_corners** (bool，可选) - 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 False。 - **align_mode** (int，可选) - 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值为 0。 diff --git a/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst b/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst index 9577ba8b47e..ef6d215e584 100644 --- a/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst +++ b/docs/api/paddle/nn/UpsamplingBilinear2D_cn.rst @@ -26,8 +26,8 @@ https://en.wikipedia.org/wiki/Bilinear_interpolation :::::::::::: - **size** (list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor，形状为为(out_h, out_w)的 2-D Tensor。如果 :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'。 + - **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 4d65c2a1288..080001e16f3 100644 --- a/docs/api/paddle/nn/UpsamplingNearest2D_cn.rst +++ b/docs/api/paddle/nn/UpsamplingNearest2D_cn.rst @@ -54,8 +54,8 @@ https://en.wikipedia.org/wiki/Nearest-neighbor_interpolation :::::::::::: - **size** (list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor，形状为(out_h, out_w)的 2-D Tensor。如果 :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'。 + - **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/functional/cross_entropy_cn.rst b/docs/api/paddle/nn/functional/cross_entropy_cn.rst index 80fed526c80..ee93fbb1c2f 100644 --- a/docs/api/paddle/nn/functional/cross_entropy_cn.rst +++ b/docs/api/paddle/nn/functional/cross_entropy_cn.rst @@ -81,12 +81,12 @@ cross_entropy 参数 ::::::::: - - **input** (Tensor) – 维度为 :math:`[N_1, N_2, ..., N_k, C]` 的多维 Tensor，其中最后一维 C 是类别数目。数据类型为 float32 或 float64。它需要未缩放的 ``input``。该 OP 不应该对 softmax 运算的输出进行操作，否则会产生错误的结果。 - - **label** (Tensor) – 输入 input 对应的标签值。若 soft_label=False，要求 label 维度为 :math:`[N_1, N_2, ..., N_k]` 或 :math:`[N_1, N_2, ..., N_k, 1]`，数据类型为'int32', 'int64', 'float32', 'float64'，且值必须大于等于 0 且小于 C；若 soft_label=True，要求 label 的维度、数据类型与 input 相同，且每个样本各软标签的总和为 1。 - - **weight** (Tensor，可选) – 权重 Tensor，需要手动给每个类调整权重，形状是（C）。它的维度与类别相同，数据类型为 float32，float64。默认值为 None。 - - **ignore_index** (int) – 指定一个忽略的标签值，此标签值不参与计算，负值表示无需忽略任何标签值。仅在 soft_label=False 时有效。默认值为-100。 - - **reduction** (str，可选) – 指示如何按批次大小平均损失，可选值为"none","mean","sum"，如果选择是"mean"，则返回 reduce 后的平均损失；如果选择是"sum"，则返回 reduce 后的总损失。如果选择是"none"，则返回没有 reduce 的损失。默认值是“mean”。 - - **soft_label** (bool，可选) – 指明 label 是否为软标签。默认为 False，表示 label 为硬标签；若 soft_label=True 则表示软标签。 + - **input** (Tensor) - 维度为 :math:`[N_1, N_2, ..., N_k, C]` 的多维 Tensor，其中最后一维 C 是类别数目。数据类型为 float32 或 float64。它需要未缩放的 ``input``。该 OP 不应该对 softmax 运算的输出进行操作，否则会产生错误的结果。 + - **label** (Tensor) - 输入 input 对应的标签值。若 soft_label=False，要求 label 维度为 :math:`[N_1, N_2, ..., N_k]` 或 :math:`[N_1, N_2, ..., N_k, 1]`，数据类型为'int32', 'int64', 'float32', 'float64'，且值必须大于等于 0 且小于 C；若 soft_label=True，要求 label 的维度、数据类型与 input 相同，且每个样本各软标签的总和为 1。 + - **weight** (Tensor，可选) - 权重 Tensor，需要手动给每个类调整权重，形状是（C）。它的维度与类别相同，数据类型为 float32，float64。默认值为 None。 + - **ignore_index** (int) - 指定一个忽略的标签值，此标签值不参与计算，负值表示无需忽略任何标签值。仅在 soft_label=False 时有效。默认值为-100。 + - **reduction** (str，可选) - 指示如何按批次大小平均损失，可选值为"none","mean","sum"，如果选择是"mean"，则返回 reduce 后的平均损失；如果选择是"sum"，则返回 reduce 后的总损失。如果选择是"none"，则返回没有 reduce 的损失。默认值是“mean”。 + - **soft_label** (bool，可选) - 指明 label 是否为软标签。默认为 False，表示 label 为硬标签；若 soft_label=True 则表示软标签。 - **axis** (int，可选) - 进行 softmax 计算的维度索引。它应该在 :math:`[-1，dim-1]` 范围内，而 ``dim`` 是输入 logits 的维度。默认值：-1。 - **use_softmax** (bool，可选) - 指定是否对 input 进行 softmax 归一化。默认值：True。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/hsigmoid_loss_cn.rst b/docs/api/paddle/nn/functional/hsigmoid_loss_cn.rst index 6af38615b16..3f9fa02f50f 100644 --- a/docs/api/paddle/nn/functional/hsigmoid_loss_cn.rst +++ b/docs/api/paddle/nn/functional/hsigmoid_loss_cn.rst @@ -30,9 +30,9 @@ hsigmoid_loss - **num_classes** (int) - 类别总数(字典大小)必须大于等于 2。若使用默认树结构，即当 ``path_table`` 和 ``path_code`` 都为 None 时，必须设置该参数。若使用自定义树结构，即当 ``path_table`` 和 ``path_code`` 都不为 None 时，它取值应为自定义树结构的非叶节点的个数，用于指定二分类的类别总数。 - **weight** (Tensor) - 权重参数。形状为 ``[numclasses-1, D]``，数据类型和 ``input`` 相同。 - **bias** (Tensor，可选) - 偏置参数。形状为 ``[numclasses-1, 1]``，数据类型和 ``input`` 相同。如果设置为 None，将没有偏置参数。默认值为 None。 - - **path_table** (Tensor，可选) – 存储每一批样本从类别（单词）到根节点的路径，按照从叶至根方向存储。数据类型为 int64，形状为 ``[N, L]``，其中 L 为路径长度。``path_table`` 和 ``path_code`` 应具有相同的形状，对于每个样本 i，path_table[i]为一个类似 np.ndarray 的结构，该数组内的每个元素都是其双亲结点权重矩阵的索引。默认值为 None。 - - **path_code** (Tensor，可选) – 存储每一批样本从类别（单词）到根节点的路径编码，按从叶至根方向存储。数据类型为 int64，形状为 ``[N, L]``。默认值为 None。 - - **is_sparse** (bool，可选) – 是否使用稀疏更新方式。如果设置为 True，W 的梯度和输入梯度将会变得稀疏。默认值为 False。 + - **path_table** (Tensor，可选) - 存储每一批样本从类别（单词）到根节点的路径，按照从叶至根方向存储。数据类型为 int64，形状为 ``[N, L]``，其中 L 为路径长度。``path_table`` 和 ``path_code`` 应具有相同的形状，对于每个样本 i，path_table[i]为一个类似 np.ndarray 的结构，该数组内的每个元素都是其双亲结点权重矩阵的索引。默认值为 None。 + - **path_code** (Tensor，可选) - 存储每一批样本从类别（单词）到根节点的路径编码，按从叶至根方向存储。数据类型为 int64，形状为 ``[N, L]``。默认值为 None。 + - **is_sparse** (bool，可选) - 是否使用稀疏更新方式。如果设置为 True，W 的梯度和输入梯度将会变得稀疏。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/interpolate_cn.rst b/docs/api/paddle/nn/functional/interpolate_cn.rst index 111754c6428..4bb100a1597 100644 --- a/docs/api/paddle/nn/functional/interpolate_cn.rst +++ b/docs/api/paddle/nn/functional/interpolate_cn.rst @@ -145,9 +145,9 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation - **size** (list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor 时，形状为为(out_h, out_w)的 2-D Tensor。输入为 5-D Tensor 时，形状为(out_d, out_h, out_w)的 3-D Tensor。如果 :code:`out_shape` 是列表，每一个元素可以是整数或者形状为[]的 Tensor。如果 :code:`out_shape` 是 Tensor，则其为 1D Tensor。默认值为 None。 - **scale_factor** (float|Tensor|list|tuple|None)-输入的高度或宽度的乘数因子。out_shape 和 scale 至少要设置一个。out_shape 的优先级高于 scale。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。 - **mode** (str，可选) - 插值方法。支持"bilinear"或"trilinear"或"nearest"或"bicubic"或"linear"或"area"。默认值为"nearest"。 - - **align_corners** （bool，可选）- 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 False。 - - **align_mode** （int，可选）- 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值：0。 - - **data_format** （str，可选）- 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 4-D Tensor，支持 NCHW(num_batches, channels, height, width) 或者 NHWC(num_batches, height, width, channels)，对于 5-D Tensor，支持 NCDHW(num_batches, channels, depth, height, width)或者 NDHWC(num_batches, depth, height, width, channels)，默认值：'NCHW'。 + - **align_corners** (bool，可选) - 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 False。 + - **align_mode** (int，可选) - 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。默认值：0。 + - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 4-D Tensor，支持 NCHW(num_batches, channels, height, width) 或者 NHWC(num_batches, height, width, channels)，对于 5-D Tensor，支持 NCDHW(num_batches, channels, depth, height, width)或者 NDHWC(num_batches, depth, height, width, channels)，默认值：'NCHW'。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/label_smooth_cn.rst b/docs/api/paddle/nn/functional/label_smooth_cn.rst index f7e74fbb10d..11b3ecbb82c 100644 --- a/docs/api/paddle/nn/functional/label_smooth_cn.rst +++ b/docs/api/paddle/nn/functional/label_smooth_cn.rst @@ -25,9 +25,9 @@ label_smooth 参数 :::::::::::: - - **label** （Tensor） - 包含标签数据的输入变量，数据类型为：float16、float32、float64。标签数据应使用 one-hot 表示，是维度为 :math:`[N_1, ..., Depth]` 的多维 Tensor，其中 Depth 为字典大小。 - - **prior_dist** （Tensor，可选） - 用于平滑标签的先验分布，是维度为 :math:`[1，class\_num]` 的 2D Tensor。如果未设置，则使用均匀分布。默认值为 None。 - - **epsilon** （float，可选） - 用于混合原始真实分布和固定分布的权重。默认值为 0.1。 + - **label** (Tensor) - 包含标签数据的输入变量，数据类型为：float16、float32、float64。标签数据应使用 one-hot 表示，是维度为 :math:`[N_1, ..., Depth]` 的多维 Tensor，其中 Depth 为字典大小。 + - **prior_dist** (Tensor，可选) - 用于平滑标签的先验分布，是维度为 :math:`[1，class\_num]` 的 2D Tensor。如果未设置，则使用均匀分布。默认值为 None。 + - **epsilon** (float，可选) - 用于混合原始真实分布和固定分布的权重。默认值为 0.1。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/upsample_cn.rst b/docs/api/paddle/nn/functional/upsample_cn.rst index 847cad979c4..f8caec66961 100644 --- a/docs/api/paddle/nn/functional/upsample_cn.rst +++ b/docs/api/paddle/nn/functional/upsample_cn.rst @@ -144,9 +144,9 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation - **size** (list|tuple|Tensor|None) - 输出 Tensor，输入为 4D Tensor 时，形状为为(out_h, out_w)的 2-D Tensor。输入为 5-D Tensor 时，形状为(out_d, out_h, out_w)的 3-D Tensor。如果 :code:`out_shape` 是列表，每一个元素可以是整数或者形状为[]的变量。如果 :code:`out_shape` 是变量，则其维度大小为 1。默认值为 None。 - **scale_factor** (float|Tensor|list|tuple|None)-输入的高度或宽度的乘数因子。out_shape 和 scale 至少要设置一个。out_shape 的优先级高于 scale。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。 - **mode** (str，可选) - 插值方法。支持"bilinear"或"trilinear"或"nearest"或"bicubic"或"linear"或"area"。默认值为"nearest"。 - - **align_mode** （int，可选）- 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。 - - **align_corners** （bool，可选）- 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 True - - **data_format** （str，可选）- 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 4-D Tensor，支持 NCHW(num_batches, channels, height, width) 或者 NHWC(num_batches, height, width, channels)，对于 5-D Tensor，支持 NCDHW(num_batches, channels, depth, height, width)或者 NDHWC(num_batches, depth, height, width, channels)，默认值：'NCHW'。 + - **align_mode** (int，可选)- 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。 + - **align_corners** (bool，可选) - 一个可选的 bool 型参数，如果为 True，则将输入和输出 Tensor 的 4 个角落像素的中心对齐，并保留角点像素的值。默认值为 True + - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 4-D Tensor，支持 NCHW(num_batches, channels, height, width) 或者 NHWC(num_batches, height, width, channels)，对于 5-D Tensor，支持 NCDHW(num_batches, channels, depth, height, width)或者 NDHWC(num_batches, depth, height, width, channels)，默认值：'NCHW'。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/optimizer/Adadelta_cn.rst b/docs/api/paddle/optimizer/Adadelta_cn.rst index db0d2270b87..f5e214a6156 100644 --- a/docs/api/paddle/optimizer/Adadelta_cn.rst +++ b/docs/api/paddle/optimizer/Adadelta_cn.rst @@ -95,10 +95,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program` 。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program` 。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/AdamW_cn.rst b/docs/api/paddle/optimizer/AdamW_cn.rst index 6cd79791d19..2e8c8a8d72b 100755 --- a/docs/api/paddle/optimizer/AdamW_cn.rst +++ b/docs/api/paddle/optimizer/AdamW_cn.rst @@ -130,10 +130,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program` 。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program` 。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/Adam_cn.rst b/docs/api/paddle/optimizer/Adam_cn.rst index 1bf2e8eba55..cbcb49f6fca 100755 --- a/docs/api/paddle/optimizer/Adam_cn.rst +++ b/docs/api/paddle/optimizer/Adam_cn.rst @@ -125,8 +125,8 @@ append_regularization_ops(parameters_and_grads, regularization=None) **参数** - - **parameters_and_grads** – 需要被正则化的(parameters, gradients)列表。 - - **regularization** – 全局正则化器，如果该参数未被设置正则化策略，将应用该正则化器。 + - **parameters_and_grads** - 需要被正则化的(parameters, gradients)列表。 + - **regularization** - 全局正则化器，如果该参数未被设置正则化策略，将应用该正则化器。 **返回** @@ -143,10 +143,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/Adamax_cn.rst b/docs/api/paddle/optimizer/Adamax_cn.rst index 7125659ec43..6978f156afd 100755 --- a/docs/api/paddle/optimizer/Adamax_cn.rst +++ b/docs/api/paddle/optimizer/Adamax_cn.rst @@ -105,10 +105,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/Lamb_cn.rst b/docs/api/paddle/optimizer/Lamb_cn.rst index 10b7c8aabf9..a62194f7f33 100755 --- a/docs/api/paddle/optimizer/Lamb_cn.rst +++ b/docs/api/paddle/optimizer/Lamb_cn.rst @@ -99,10 +99,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/Momentum_cn.rst b/docs/api/paddle/optimizer/Momentum_cn.rst index 470a0f2ab5e..e92a38a40ec 100644 --- a/docs/api/paddle/optimizer/Momentum_cn.rst +++ b/docs/api/paddle/optimizer/Momentum_cn.rst @@ -88,10 +88,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/Optimizer_cn.rst b/docs/api/paddle/optimizer/Optimizer_cn.rst index 0cdb2933bc9..9b22b05519b 100755 --- a/docs/api/paddle/optimizer/Optimizer_cn.rst +++ b/docs/api/paddle/optimizer/Optimizer_cn.rst @@ -83,10 +83,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/RMSProp_cn.rst b/docs/api/paddle/optimizer/RMSProp_cn.rst index e1c06d497a6..b861fb2d210 100755 --- a/docs/api/paddle/optimizer/RMSProp_cn.rst +++ b/docs/api/paddle/optimizer/RMSProp_cn.rst @@ -101,10 +101,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/optimizer/SGD_cn.rst b/docs/api/paddle/optimizer/SGD_cn.rst index 20d7df05516..fa56349b455 100644 --- a/docs/api/paddle/optimizer/SGD_cn.rst +++ b/docs/api/paddle/optimizer/SGD_cn.rst @@ -79,10 +79,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None) **参数** - - **loss** (Tensor) – 需要最小化的损失值变量。 - - **startup_program** (Program，可选) – 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 - - **parameters** (list，可选) – 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 - - **no_grad_set** (set，可选) – 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 + - **loss** (Tensor) - 需要最小化的损失值变量。 + - **startup_program** (Program，可选) - 用于初始化 parameters 中参数的 :ref:`cn_api_fluid_Program`，默认值为 None，此时将使用 :ref:`cn_api_fluid_default_startup_program`。 + - **parameters** (list，可选) - 待更新的 Parameter 或者 Parameter.name 组成的列表，默认值为 None，此时将更新所有的 Parameter。 + - **no_grad_set** (set，可选) - 不需要更新的 Parameter 或者 Parameter.name 组成的集合，默认值为 None。 **返回** diff --git a/docs/api/paddle/rad2deg_cn.rst b/docs/api/paddle/rad2deg_cn.rst index cf7c15328b2..a4e8e59fdf5 100644 --- a/docs/api/paddle/rad2deg_cn.rst +++ b/docs/api/paddle/rad2deg_cn.rst @@ -15,7 +15,7 @@ rad2deg ::::::::: - **x** (Tensor) - 输入的 Tensor，数据类型为：int32、int64、float32、float64。 -- **name** (str，可选） - 操作的名称(可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 +- **name** (str，可选) - 操作的名称（可选，默认值为 None）。更多信息请参见 :ref:`api_guide_Name`。 返回 ::::::::: diff --git a/docs/api/paddle/sparse/cast_cn.rst b/docs/api/paddle/sparse/cast_cn.rst index f408ffffd32..40786194030 100644 --- a/docs/api/paddle/sparse/cast_cn.rst +++ b/docs/api/paddle/sparse/cast_cn.rst @@ -11,8 +11,8 @@ cast 参数 ::::::::: - **x** (SparseTensor) - 输入的稀疏 Tensor，可以为 Coo 或 Csr 格式，数据类型为 float32、float64。 - - **index_dtype** (np.dtype|str, optional) - SparseCooTensor 的 index 类型，SparseCsrTensor 的 crows/cols 类型。可以是 uint8，int8，int16，int32，int64。 - - **value_dtype** (np.dtype|str, optional) - SparseCooTensor 或 SparseCsrTensor 的 value 类型。可以是 uint8，int8，int16，int32，int64。 + - **index_dtype** (np.dtype|str，可选) - SparseCooTensor 的 index 类型，SparseCsrTensor 的 crows/cols 类型。可以是 uint8，int8，int16，int32，int64。 + - **value_dtype** (np.dtype|str，可选) - SparseCooTensor 或 SparseCsrTensor 的 value 类型。可以是 uint8，int8，int16，int32，int64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/sparse/sparse_coo_tensor_cn.rst b/docs/api/paddle/sparse/sparse_coo_tensor_cn.rst index dfca401f11e..4ac6bc2c0a8 100644 --- a/docs/api/paddle/sparse/sparse_coo_tensor_cn.rst +++ b/docs/api/paddle/sparse/sparse_coo_tensor_cn.rst @@ -22,15 +22,15 @@ sparse_coo_tensor list，tuple，numpy\.ndarray，paddle\.Tensor 类型。 - **values** (list|tuple|ndarray|Tensor) - 初始化 tensor 的数据，可以是 list，tuple，numpy\.ndarray，paddle\.Tensor 类型。 - - **shape** (list|tuple, optional) - 稀疏 Tensor 的形状，也是 Tensor 的形状，如果没有提供，将自动推测出最小的形状。 - - **dtype** (str|np.dtype, optional) - 创建 tensor 的数据类型，可以是 'bool' ，'float16'，'float32'， + - **shape** (list|tuple，可选) - 稀疏 Tensor 的形状，也是 Tensor 的形状，如果没有提供，将自动推测出最小的形状。 + - **dtype** (str|np.dtype，可选) - 创建 tensor 的数据类型，可以是 'bool' ，'float16'，'float32'， 'float64' ，'int8'，'int16'，'int32'，'int64'，'uint8'，'complex64'，'complex128'。 默认值为 None，如果 ``values`` 为 python 浮点类型，则从 :ref:`cn_api_paddle_framework_get_default_dtype` 获取类型，如果 ``values`` 为其他类型， 则会自动推导类型。 - - **place** (CPUPlace|CUDAPinnedPlace|CUDAPlace|str, optional) - 创建 tensor 的设备位置，可以是 + - **place** (CPUPlace|CUDAPinnedPlace|CUDAPlace|str，可选) - 创建 tensor 的设备位置，可以是 CPUPlace, CUDAPinnedPlace, CUDAPlace。默认值为 None，使用全局的 place。 - - **stop_gradient** (bool, optional) - 是否阻断 Autograd 的梯度传导。默认值为 True，此时不进行梯度传传导。 + - **stop_gradient** (bool，可选) - 是否阻断 Autograd 的梯度传导。默认值为 True，此时不进行梯度传传导。 返回 ::::::::: diff --git a/docs/api/paddle/sparse/sparse_csr_tensor_cn.rst b/docs/api/paddle/sparse/sparse_csr_tensor_cn.rst index 4a032e366fb..40b72189a6a 100644 --- a/docs/api/paddle/sparse/sparse_csr_tensor_cn.rst +++ b/docs/api/paddle/sparse/sparse_csr_tensor_cn.rst @@ -27,14 +27,14 @@ sparse_csr_tensor - **values** (list|tuple|ndarray|Tensor) - 一维数组，存储非零元素，可以是 list，tuple，numpy\.ndarray，paddle\.Tensor 类型。 - **shape** (list|tuple) - 稀疏 Tensor 的形状，也是 Tensor 的形状，如果没有提供，将自动推测出最小的形状。 - - **dtype** (str|np.dtype, optional) - 创建 tensor 的数据类型，可以是 'bool' ，'float16'，'float32'， + - **dtype** (str|np.dtype，可选) - 创建 tensor 的数据类型，可以是 'bool' ，'float16'，'float32'， 'float64' ，'int8'，'int16'，'int32'，'int64'，'uint8'，'complex64'，'complex128'。 默认值为 None，如果 ``values`` 为 python 浮点类型，则从 :ref:`cn_api_paddle_framework_get_default_dtype` 获取类型，如果 ``values`` 为其他类型， 则会自动推导类型。 - - **place** (CPUPlace|CUDAPinnedPlace|CUDAPlace|str, optional) - 创建 tensor 的设备位置，可以是 + - **place** (CPUPlace|CUDAPinnedPlace|CUDAPlace|str，可选) - 创建 tensor 的设备位置，可以是 CPUPlace, CUDAPinnedPlace, CUDAPlace。默认值为 None，使用全局的 place。 - - **stop_gradient** (bool, optional) - 是否阻断 Autograd 的梯度传导。默认值为 True，此时不进行梯度传传导。 + - **stop_gradient** (bool，可选) - 是否阻断 Autograd 的梯度传导。默认值为 True，此时不进行梯度传传导。 返回 ::::::::: diff --git a/docs/api/paddle/static/Executor_cn.rst b/docs/api/paddle/static/Executor_cn.rst index 9ad97a06c86..51b2cea2ba5 100644 --- a/docs/api/paddle/static/Executor_cn.rst +++ b/docs/api/paddle/static/Executor_cn.rst @@ -49,15 +49,15 @@ run(program=None, feed=None, fetch_list=None, feed_var_name='feed', fetch_var_na **参数** - - **program** (Program|CompiledProgram) – 该参数为被执行的 Program 或 CompiledProgram，如果未提供该参数，即该参数为 None，在该接口内，main_program 将被设置为 paddle.static.default_main_program()。默认为：None。 - - **feed** (list|dict) – 该参数表示模型的输入变量。如果是单卡训练，``feed`` 为 ``dict`` 类型，如果是多卡训练，参数 ``feed`` 可以是 ``dict`` 或者 ``list`` 类型变量，如果该参数类型为 ``dict`` ，feed 中的数据将会被分割(split)并分送给多个设备（CPU/GPU），即输入数据被均匀分配到不同设备上；如果该参数类型为 ``list``，则列表中的各个元素都会直接分别被拷贝到各设备中。默认为：None。 - - **fetch_list** (list) – 该参数表示模型运行之后需要返回的变量。默认为：None。 - - **feed_var_name** (str) – 该参数表示数据输入算子(feed operator)的输入变量名称。默认为："feed"。 - - **fetch_var_name** (str) – 该参数表示结果获取算子(fetch operator)的输出变量名称。默认为："fetch"。 - - **scope** (Scope) – 该参数表示执行当前 program 所使用的作用域，用户可以为不同的 program 指定不同的作用域。默认值：paddle.static.global_scope()。 - - **return_numpy** (bool) – 该参数表示是否将返回的计算结果（fetch list 中指定的变量）转化为 numpy；如果为 False，则每个变量返回的类型为 Tensor，否则返回变量的类型为 numpy.ndarray。默认为：True。 - - **use_program_cache** (bool) – 该参数表示是否对输入的 Program 进行缓存。如果该参数为 True，在以下情况时，模型运行速度可能会更快：输入的 program 为 ``paddle.static.Program``，并且模型运行过程中，调用该接口的参数（program、 feed 变量名和 fetch_list 变量）名始终不变。默认为：False。 - - **use_prune** (bool) - 该参数表示输入 Program 是否会被裁剪。如果该参数为 True，会根据 feed 和 fetch_list 裁剪 Program，这意味着对生成 fetch_list 没有必要的算子和变量会被裁剪掉。默认为 False，即算子和变量在运行过程不会被裁剪。注意如果 Optimizer.minimize()返回的 tuple 被作为 fetch_list 参数，那么 use_prune 会被重载为 True 并且 Program 会被裁剪。 + - **program** (Program|CompiledProgram，可选) – 该参数为被执行的 Program 或 CompiledProgram，如果未提供该参数，即该参数为 None，在该接口内，main_program 将被设置为 paddle.static.default_main_program()。默认为：None。 + - **feed** (list|dict，可选) – 该参数表示模型的输入变量。如果是单卡训练，``feed`` 为 ``dict`` 类型，如果是多卡训练，参数 ``feed`` 可以是 ``dict`` 或者 ``list`` 类型变量，如果该参数类型为 ``dict`` ，feed 中的数据将会被分割(split)并分送给多个设备（CPU/GPU），即输入数据被均匀分配到不同设备上；如果该参数类型为 ``list``，则列表中的各个元素都会直接分别被拷贝到各设备中。默认为：None。 + - **fetch_list** (list，可选) – 该参数表示模型运行之后需要返回的变量。默认为：None。 + - **feed_var_name** (str，可选) – 该参数表示数据输入算子(feed operator)的输入变量名称。默认为："feed"。 + - **fetch_var_name** (str，可选) – 该参数表示结果获取算子(fetch operator)的输出变量名称。默认为："fetch"。 + - **scope** (Scope，可选) – 该参数表示执行当前 program 所使用的作用域，用户可以为不同的 program 指定不同的作用域。默认值：paddle.static.global_scope()。 + - **return_numpy** (bool，可选) – 该参数表示是否将返回的计算结果（fetch list 中指定的变量）转化为 numpy；如果为 False，则每个变量返回的类型为 Tensor，否则返回变量的类型为 numpy.ndarray。默认为：True。 + - **use_program_cache** (bool，可选) – 该参数表示是否对输入的 Program 进行缓存。如果该参数为 True，在以下情况时，模型运行速度可能会更快：输入的 program 为 ``paddle.static.Program``，并且模型运行过程中，调用该接口的参数（program、 feed 变量名和 fetch_list 变量）名始终不变。默认为：False。 + - **use_prune** (bool，可选) - 该参数表示输入 Program 是否会被裁剪。如果该参数为 True，会根据 feed 和 fetch_list 裁剪 Program，这意味着对生成 fetch_list 没有必要的算子和变量会被裁剪掉。默认为 False，即算子和变量在运行过程不会被裁剪。注意如果 Optimizer.minimize()返回的 tuple 被作为 fetch_list 参数，那么 use_prune 会被重载为 True 并且 Program 会被裁剪。 **返回** @@ -83,15 +83,15 @@ infer_from_dataset 的文档与 train_from_dataset 几乎完全相同，只是 **参数** - - **program** (Program|CompiledProgram) – 需要执行的 program，如果没有给定那么默认使用 default_main_program (未编译的)。 - - **dataset** (paddle.fluid.Dataset) – 在此函数外创建的数据集，用户应当在调用函数前提供完整定义的数据集。必要时请检查 Dataset 文件。默认为 None。 - - **scope** (Scope) – 执行这个 program 的域，用户可以指定不同的域。默认为全局域。 - - **thread** (int) – 用户想要在这个函数中运行的线程数量。线程的实际数量为 min(Dataset.thread_num, thread)，如果 thread > 0，默认为 0。 - - **debug** (bool) – 是否开启 debug 模式，默认为 False。 - - **fetch_list** (Tensor List) – 返回变量列表，每个变量都会在预测过程中被打印出来，默认为 None。 - - **fetch_info** (String List) – 每个变量的打印信息，默认为 None。 - - **print_period** (int) – 每两次打印之间间隔的 mini-batches 的数量，默认为 100。 - - **fetch_handler** (FetchHandler) - 获取用户定义的输出类。 + - **program** (Program|CompiledProgram，可选) – 需要执行的 program，如果没有给定那么默认使用 default_main_program (未编译的)。 + - **dataset** (paddle.fluid.Dataset，可选) – 在此函数外创建的数据集，用户应当在调用函数前提供完整定义的数据集。必要时请检查 Dataset 文件。默认为 None。 + - **scope** (Scope，可选) – 执行这个 program 的域，用户可以指定不同的域。默认为全局域。 + - **thread** (int，可选) – 用户想要在这个函数中运行的线程数量。线程的实际数量为 min(Dataset.thread_num, thread)，如果 thread > 0，默认为 0。 + - **debug** (bool，可选) – 是否开启 debug 模式，默认为 False。 + - **fetch_list** (Tensor List，可选) – 返回变量列表，每个变量都会在预测过程中被打印出来，默认为 None。 + - **fetch_info** (String List，可选) – 每个变量的打印信息，默认为 None。 + - **print_period** (int，可选) – 每两次打印之间间隔的 mini-batches 的数量，默认为 100。 + - **fetch_handler** (FetchHandler，可选) - 获取用户定义的输出类。 **返回** @@ -111,15 +111,15 @@ train_from_dataset 将销毁每次运行在 executor 中创建的所有资源。 **参数** - - **program** (Program|CompiledProgram) – 需要执行的 program，如果没有给定那么默认使用 default_main_program (未编译的)。 - - **dataset** (paddle.fluid.Dataset) – 在此函数外创建的数据集，用户应当在调用函数前提供完整定义的数据集。必要时请检查 Dataset 文件。默认为 None。 - - **scope** (Scope) – 执行这个 program 的域，用户可以指定不同的域。默认为全局域。 - - **thread** (int) – 用户想要在这个函数中运行的线程数量。线程的实际数量为 min(Dataset.thread_num, thread)，如果 thread > 0，默认为 0。 - - **debug** (bool) – 是否开启 debug 模式，默认为 False。 - - **fetch_list** (Tensor List) – 返回变量列表，每个变量都会在训练过程中被打印出来，默认为 None。 - - **fetch_info** (String List) – 每个变量的打印信息，默认为 None。 - - **print_period** (int) – 每两次打印之间间隔的 mini-batches 的数量，默认为 100。 - - **fetch_handler** (FetchHandler) - 获取用户定义的输出类。 + - **program** (Program|CompiledProgram，可选) – 需要执行的 program，如果没有给定那么默认使用 default_main_program (未编译的)。 + - **dataset** (paddle.fluid.Dataset，可选) – 在此函数外创建的数据集，用户应当在调用函数前提供完整定义的数据集。必要时请检查 Dataset 文件。默认为 None。 + - **scope** (Scope，可选) – 执行这个 program 的域，用户可以指定不同的域。默认为全局域。 + - **thread** (int，可选) – 用户想要在这个函数中运行的线程数量。线程的实际数量为 min(Dataset.thread_num, thread)，如果 thread > 0，默认为 0。 + - **debug** (bool，可选) – 是否开启 debug 模式，默认为 False。 + - **fetch_list** (Tensor List，可选) – 返回变量列表，每个变量都会在训练过程中被打印出来，默认为 None。 + - **fetch_info** (String List，可选) – 每个变量的打印信息，默认为 None。 + - **print_period** (int，可选) – 每两次打印之间间隔的 mini-batches 的数量，默认为 100。 + - **fetch_handler** (FetchHandler，可选) - 获取用户定义的输出类。 **返回** diff --git a/docs/api/paddle/static/Program_cn.rst b/docs/api/paddle/static/Program_cn.rst index 0d1ca36c986..e405879c496 100644 --- a/docs/api/paddle/static/Program_cn.rst +++ b/docs/api/paddle/static/Program_cn.rst @@ -50,7 +50,7 @@ to_string(throw_on_error, with_details=False) **参数** - **throw_on_error** (bool) - 是否在没有设置必需字段时抛出异常。 - - **with_details** (bool) - 值为 true 时，打印更多关于变量和参数的信息，如 trainable, optimize_attr 等。 + - **with_details** (bool，可选) - 值为 true 时，打印更多关于变量和参数的信息，如 trainable, optimize_attr 等。 **返回** @@ -108,7 +108,7 @@ clone(for_test=False) **参数** - - **for_test** (bool) – 取值为 True 时，clone 方法内部会把 operator 的属性 ``is_test`` 设置为 True，并裁剪反向 OP 和参数优化 OP，默认值为 False。 + - **for_test** (bool，可选) – 取值为 True 时，clone 方法内部会把 operator 的属性 ``is_test`` 设置为 True，并裁剪反向 OP 和参数优化 OP，默认值为 False。 **返回** diff --git a/docs/api/paddle/static/WeightNormParamAttr_cn.rst b/docs/api/paddle/static/WeightNormParamAttr_cn.rst index ba694d1628f..d4b94cb41b8 100644 --- a/docs/api/paddle/static/WeightNormParamAttr_cn.rst +++ b/docs/api/paddle/static/WeightNormParamAttr_cn.rst @@ -21,14 +21,14 @@ 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` ) 中也 设置了正则化，``optimizer`` 中的正则化将被忽略。默认值为 None，表示没有正则化。 - - **trainable** (bool) - 可选，指明参数是否可训练，默认为 True。 - - **do_model_average** (bool) - 可选，指明参数是否需要模型平均化操作(Model Average)，默认为 False。 - - **need_clip** (bool) - 可选，指明参数梯度是否需要在优化器中进行 clip，默认为 True。 + - **trainable** (bool，可选) - 指明参数是否可训练，默认为 True。 + - **do_model_average** (bool，可选) - 指明参数是否需要模型平均化操作(Model Average)，默认为 False。 + - **need_clip** (bool，可选) - 指明参数梯度是否需要在优化器中进行 clip，默认为 True。 代码示例 diff --git a/docs/api/paddle/static/nn/conv2d_cn.rst b/docs/api/paddle/static/nn/conv2d_cn.rst index ac560883b75..818f1dbb99b 100644 --- a/docs/api/paddle/static/nn/conv2d_cn.rst +++ b/docs/api/paddle/static/nn/conv2d_cn.rst @@ -83,8 +83,8 @@ conv2d - **dilation** (int|list|tuple，可选) - 膨胀比例大小。空洞卷积时会使用该参数，滤波器对输入进行卷积时，感受野里每相邻两个特征点之间的空洞信息。如果膨胀比例为列表或元组，则必须包含两个整型数：（dilation_height,dilation_width）。若为一个整数，dilation_height = dilation_width = dilation。默认值：1。 - **groups** (int，可选) - 二维卷积层的组数。根据 Alex Krizhevsky 的深度卷积神经网络（CNN）论文中的成组卷积：当 group=n，输入和滤波器分别根据通道数量平均分为 n 组，第一组滤波器和第一组输入进行卷积计算，第二组滤波器和第二组输入进行卷积计算，……，第 n 组滤波器和第 n 组输入进行卷积计算。默认值：1。 - **param_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - - **bias_attr** （ParamAttr|bool，可选）- 指定偏置参数属性的对象。若 ``bias_attr`` 为 bool 类型，只支持为 False，表示没有偏置参数。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 - - **use_cudnn** （bool，可选）- 是否使用 cudnn 内核。只有已安装 cudnn 库时才有效。默认值：True。 + - **bias_attr** (ParamAttr|bool，可选) - 指定偏置参数属性的对象。若 ``bias_attr`` 为 bool 类型，只支持为 False，表示没有偏置参数。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。 + - **use_cudnn** (bool，可选) - 是否使用 cudnn 内核。只有已安装 cudnn 库时才有效。默认值：True。 - **act** (str，可选) - 激活函数类型，如 tanh、softmax、sigmoid，relu 等，支持列表请参考 :ref:`api_guide_activations`。如果设为 None，则未添加激活函数。默认值：None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - **data_format** (str，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW"。 diff --git a/docs/api/paddle/static/nn/conv2d_transpose_cn.rst b/docs/api/paddle/static/nn/conv2d_transpose_cn.rst index 80a2015983f..d304145a867 100644 --- a/docs/api/paddle/static/nn/conv2d_transpose_cn.rst +++ b/docs/api/paddle/static/nn/conv2d_transpose_cn.rst @@ -93,8 +93,8 @@ conv2d_transpose - **stride** (int|tuple，可选) - 步长 stride 大小。滤波器和输入进行卷积计算时滑动的步长。如果 stride 是一个元组，则必须包含两个整型数，形式为(stride_height，stride_width)。否则，stride_height = stride_width = stride。默认：stride = 1。 - **dilation** (int|tuple，可选) - 膨胀比例(dilation)大小。空洞卷积时会指该参数，滤波器对输入进行卷积时，感受野里每相邻两个特征点之间的空洞信息，根据 `可视化效果图 `_ 较好理解。如果膨胀比例 dilation 是一个元组，那么元组必须包含两个整型数，形式为(dilation_height, dilation_width)。否则，dilation_height = dilation_width = dilation。默认：dilation= 1。 - **groups** (int，可选) - 二维转置卷积层的组数。从 Alex Krizhevsky 的 CNN Deep 论文中的群卷积中受到启发，当 group=2 时，输入和滤波器分别根据通道数量平均分为两组，第一组滤波器和第一组输入进行卷积计算，第二组滤波器和第二组输入进行卷积计算。默认：group = 1。 - - **param_attr** (ParamAttr，可选)：指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv2d_transpose 算子默认的权重初始化是 Xavier。 - - **bias_attr** （ParamAttr|False，可选）- 指定偏置参数属性的对象。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv2d_transpose 算子默认的偏置初始化是 0.0。 + - **param_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv2d_transpose 算子默认的权重初始化是 Xavier。 + - **bias_attr** (ParamAttr|False，可选) - 指定偏置参数属性的对象。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv2d_transpose 算子默认的偏置初始化是 0.0。 - **use_cudnn** (bool，可选) - 是否使用 cudnn 内核，只有已安装 cudnn 库时才有效。默认：True。 - **act** (str，可选) - 激活函数类型，如果设置为 None，则不使用激活函数。默认：None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/static/nn/conv3d_transpose_cn.rst b/docs/api/paddle/static/nn/conv3d_transpose_cn.rst index 276718c118b..8f0d88d7bc4 100755 --- a/docs/api/paddle/static/nn/conv3d_transpose_cn.rst +++ b/docs/api/paddle/static/nn/conv3d_transpose_cn.rst @@ -100,8 +100,8 @@ conv3d_transpose - **stride** (int|tuple，可选) - 步长 stride 大小。滤波器和输入进行卷积计算时滑动的步长。如果 stride 是一个元组，那么元组的形式为(stride_depth，stride_height，stride_width)。否则，stride_depth = stride_height = stride_width = stride。默认：stride = 1。 - **dilation** (int|tuple，可选) - 膨胀比例 dilation 大小。空洞卷积时会指该参数，滤波器对输入进行卷积时，感受野里每相邻两个特征点之间的空洞信息，根据 `可视化效果图 `_ 较好理解。如果膨胀比例 dilation 是一个元组，那么元组的形式为(dilation_depth，dilation_height， dilation_width)。否则，dilation_depth = dilation_height = dilation_width = dilation。默认：dilation= 1。 - **groups** (int，可选) - 三维转置卷积层的组数。从 Alex Krizhevsky 的 CNN Deep 论文中的群卷积中受到启发，当 group=2 时，输入和滤波器分别根据通道数量平均分为两组，第一组滤波器和第一组输入进行卷积计算，第二组滤波器和第二组输入进行卷积计算。默认：group = 1。 - - **param_attr** (ParamAttr，可选)：指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv3d_transpose 算子默认的权重初始化是 Xavier。 - - **bias_attr** （ParamAttr|False，可选）- 指定偏置参数属性的对象。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv3d_transpose 算子默认的偏置初始化是 0.0。 + - **param_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv3d_transpose 算子默认的权重初始化是 Xavier。 + - **bias_attr** (ParamAttr|False，可选) - 指定偏置参数属性的对象。默认值为 None，表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_fluid_ParamAttr` 。conv3d_transpose 算子默认的偏置初始化是 0.0。 - **use_cudnn** (bool，可选) - 是否使用 cudnn 内核，只有已安装 cudnn 库时才有效。默认：True。 - **act** (str，可选) - 激活函数类型，如果设置为 None，则不使用激活函数。默认：None。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/static/nn/embedding_cn.rst b/docs/api/paddle/static/nn/embedding_cn.rst index b9cc2d0b098..5c1ee33baaf 100644 --- a/docs/api/paddle/static/nn/embedding_cn.rst +++ b/docs/api/paddle/static/nn/embedding_cn.rst @@ -64,11 +64,11 @@ input 中的 id 必须满足 ``0 =< id < size[0]``，否则程序会抛异常退 - **input** (Variable) - 存储 id 信息的 Tensor，数据类型必须为：int64，输入的 shape 最后一维须为 1。input 中的 id 必须满足 ``0 =< id < size[0]`` 。 - **size** (tuple|list) - embedding 矩阵的维度。必须包含两个元素，第一个元素为 vocab_size(词表大小)，第二个为 emb_size（embedding 层维度）。 - - **is_sparse** (bool) - 是否使用稀疏的更新方式，这个参数只会影响反向的梯度更新的性能，sparse 更新速度更快，推荐使用稀疏更新的方式。但某些 optimizer 不支持 sparse 更新，比如 :ref:`cn_api_paddle_optimizer_Adadelta` 、 :ref:`cn_api_paddle_optimizer_Adamax`，此时 is_sparse 必须为 False。默认为 False。 - - **is_distributed** (bool) - 是否使用分布式的方式存储 embedding 矩阵，仅在多机分布式 cpu 训练中使用。默认为 False。 - - **padding_idx** (int|long|None) - padding_idx 需在区间 ``[-vocab_size, vocab_size)``，否则不生效，``padding_idx < 0`` 时，padding_idx 会被改成``vocab_size + padding_idx``，input 中等于 padding_index 的 id 对应的 embedding 信息会被设置为 0，且这部分填充数据在训练时将不会被更新。如果为 None，不作处理，默认为 None。 - - **param_attr** (ParamAttr) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr`。此外，可以通过 ``param_attr`` 参数加载用户自定义或预训练的词向量。只需将本地词向量转为 numpy 数据格式，且保证本地词向量的 shape 和 embedding 的 ``size`` 参数一致，然后使用 :ref:`cn_api_paddle_to_tensor` 进行初始化，即可实现加载自定义或预训练的词向量。 - - **dtype** (str) - 输出 Tensor 的数据类型，数据类型必须为：float32 或 float64，默认为 float32。 + - **is_sparse** (bool，可选) - 是否使用稀疏的更新方式，这个参数只会影响反向的梯度更新的性能，sparse 更新速度更快，推荐使用稀疏更新的方式。但某些 optimizer 不支持 sparse 更新，比如 :ref:`cn_api_paddle_optimizer_Adadelta` 、 :ref:`cn_api_paddle_optimizer_Adamax`，此时 is_sparse 必须为 False。默认为 False。 + - **is_distributed** (bool，可选) - 是否使用分布式的方式存储 embedding 矩阵，仅在多机分布式 cpu 训练中使用。默认为 False。 + - **padding_idx** (int|long|None，可选) - padding_idx 需在区间 ``[-vocab_size, vocab_size)``，否则不生效，``padding_idx < 0`` 时，padding_idx 会被改成``vocab_size + padding_idx``，input 中等于 padding_index 的 id 对应的 embedding 信息会被设置为 0，且这部分填充数据在训练时将不会被更新。如果为 None，不作处理，默认为 None。 + - **param_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr`。此外，可以通过 ``param_attr`` 参数加载用户自定义或预训练的词向量。只需将本地词向量转为 numpy 数据格式，且保证本地词向量的 shape 和 embedding 的 ``size`` 参数一致，然后使用 :ref:`cn_api_paddle_to_tensor` 进行初始化，即可实现加载自定义或预训练的词向量。 + - **dtype** (str，可选) - 输出 Tensor 的数据类型，数据类型必须为：float32 或 float64，默认为 float32。 返回 :::::::::::: diff --git a/docs/api/paddle/static/nn/row_conv_cn.rst b/docs/api/paddle/static/nn/row_conv_cn.rst index 54143720c1c..057d81ae3ba 100644 --- a/docs/api/paddle/static/nn/row_conv_cn.rst +++ b/docs/api/paddle/static/nn/row_conv_cn.rst @@ -32,8 +32,8 @@ row_conv - **input** (Tensor) - 支持输入为 LodTensor 和 Tensor，输入类型可以是[float32, float64]，它支持可变时间长度的输入序列。当输入 input 为 LodTensor 时，其内部 Tensor 是一个具有形状(T x N)的矩阵，其中 T 是这个 mini batch 中的总的 timestep，N 是输入数据维数。当输入 input 为 Tensor 时，其形状为(B x T x N)的三维矩阵，B 为 mini batch 大小，T 为每个 batch 输入中的最大 timestep，N 是输入数据维数。 - **future_context_size** (int) - 下文大小。请注意，卷积核的 shape 是[future_context_size + 1, N]，N 和输入 input 的数据维度 N 保持一致。 - - **param_attr** (ParamAttr) - 参数的属性，包括名称、初始化器等。 - - **act** (str) - 非线性激活函数。 + - **param_attr** (ParamAttr，可选) - 参数的属性，包括名称、初始化器等，默认为 None。 + - **act** (str，可选) - 非线性激活函数，默认为 None。 返回 :::::::::::: diff --git a/docs/api/paddle/static/nn/sequence_reverse_cn.rst b/docs/api/paddle/static/nn/sequence_reverse_cn.rst index 69f05a7bd92..14e296871d4 100644 --- a/docs/api/paddle/static/nn/sequence_reverse_cn.rst +++ b/docs/api/paddle/static/nn/sequence_reverse_cn.rst @@ -35,7 +35,7 @@ sequence_reverse 参数 ::::::::: - - **x** (Variable) – 输入是 LoD level 为 1 的 Tensor。目前仅支持对 LoD 层次(LoD level)为 1 的 Tensor 进行反转。数据类型为 float32，float64，int8，int32 或 int64。 + - **x** (Variable) - 输入是 LoD level 为 1 的 Tensor。目前仅支持对 LoD 层次(LoD level)为 1 的 Tensor 进行反转。数据类型为 float32，float64，int8，int32 或 int64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/vander_cn.rst b/docs/api/paddle/vander_cn.rst index 134c42859d1..5844caebf45 100644 --- a/docs/api/paddle/vander_cn.rst +++ b/docs/api/paddle/vander_cn.rst @@ -6,7 +6,7 @@ vander .. py:function:: paddle.vander(x, n=None, increasing=False, name=None) 生成范德蒙德矩阵。 -输出矩阵的每一列都是输入向量的幂。 幂的顺序由递增的布尔参数确定。 具体而言，当递增为 “false” 时，第 i 个输出列是输入向量元素顺序的升序，其幂为 N-i-1。 每行都有等比级数的这样一个矩阵称为 Alexandre-Theophile Vandermonde 矩阵。 +输出矩阵的每一列都是输入向量的幂。 幂的顺序由递增的布尔参数确定。 具体而言，当递增为 ``false`` 时，第 i 个输出列是输入向量元素顺序的升序，其幂为 N-i-1。 每行都有等比级数的这样一个矩阵称为 Alexandre-Theophile Vandermonde 矩阵。 参数 :::::::::: diff --git a/docs/api/paddle/vision/ops/roi_align_cn.rst b/docs/api/paddle/vision/ops/roi_align_cn.rst index 42e57b0a66f..8f11f5a9d5c 100644 --- a/docs/api/paddle/vision/ops/roi_align_cn.rst +++ b/docs/api/paddle/vision/ops/roi_align_cn.rst @@ -15,8 +15,8 @@ roi_align - **boxes_num** (Tensor) - 该 batch 中每一张图所包含的框数量。数据类型为 int32。 - **output_size** (int|Tuple(int, int)) - 池化后输出的尺寸(H, W)，数据类型为 int32。如果 output_size 是单个 int 类型整数，则 H 和 W 都与其相等。 - **spatial_scale** (float32，可选) - 空间比例因子，用于将 boxes 中的坐标从其输入尺寸按比例映射到 input 特征图的尺寸。 - - **sampling_ratio** (int32，可选) – 插值网格中用于计算每个池化输出条柱的输出值的采样点数。如果大于 0，则使用每个条柱的精确采样点。如果小于或等于 0，则使用自适应数量的网格点（计算为 ``ceil(roi_width / output_width)``，高度同理）。默认值：-1。 - - **aligned** (bool，可选）- 默认值为 True，表示像素移动框将其坐标移动-0.5，以便与两个相邻像素索引更好地对齐。如果为 False，则是使用遗留版本的实现。 + - **sampling_ratio** (int32，可选) - 插值网格中用于计算每个池化输出条柱的输出值的采样点数。如果大于 0，则使用每个条柱的精确采样点。如果小于或等于 0，则使用自适应数量的网格点（计算为 ``ceil(roi_width / output_width)``，高度同理）。默认值：-1。 + - **aligned** (bool，可选) - 默认值为 True，表示像素移动框将其坐标移动-0.5，以便与两个相邻像素索引更好地对齐。如果为 False，则是使用遗留版本的实现。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 From 70b335a4acd0baa27f9d7124e91a38415ea0fcfe Mon Sep 17 00:00:00 2001 From: enkilee Date: Mon, 26 Jun 2023 21:31:49 +0800 Subject: [PATCH 2/2] revert unsequeeze 0D-tensor --- docs/api/paddle/unsqueeze_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/unsqueeze_cn.rst b/docs/api/paddle/unsqueeze_cn.rst index 190c2b3a400..7ad25b69840 100644 --- a/docs/api/paddle/unsqueeze_cn.rst +++ b/docs/api/paddle/unsqueeze_cn.rst @@ -12,8 +12,8 @@ unsqueeze 参数 ::::::::: - - **x** (Tensor)- 输入的 `Tensor`，数据类型为：bfloat16、float32、float64、bool、int8、int32、int64。 - - **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple，它的元素可以是整数或者形状为[1]的 Tensor。如果 axis 的类型是 Tensor，则是 1-D Tensor。如果 axis 是负数，则 axis=axis+ndim(x)+1 。 + - **x** (Tensor) - 输入的 `Tensor`，数据类型为：bfloat16、float32、float64、bool、int8、int32、int64。 + - **axis** (int|list|tuple|Tensor) - 表示要插入维度的位置。数据类型是 int32。如果 axis 的类型是 list 或 tuple，它的元素可以是整数或者形状为[]的 0-D Tensor。如果 axis 的类型是 Tensor，则是 1-D Tensor。如果 axis 是负数，则 axis=axis+ndim(x)+1 。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回