From 0ecf6f44b8d7b59a152423e7f7216f74b9e343a9 Mon Sep 17 00:00:00 2001 From: manfredss Date: Tue, 18 Aug 2026 19:06:45 +0800 Subject: [PATCH 1/2] fix docs: align API signatures and CN docs with EN sources --- docs/api/paddle/Overview_cn.rst | 5 + docs/api/paddle/Tensor__upper_cn.rst | 220 +++++++++++++++--- .../function/once_differentiable_cn.rst | 14 +- docs/api/paddle/compat/Overview_cn.rst | 23 ++ docs/api/paddle/compat/allclose_cn.rst | 29 +++ .../compat/distributions/Categorical_cn.rst | 20 ++ docs/api/paddle/compat/equal_cn.rst | 25 ++ docs/api/paddle/compat/nn/AvgPool1d_cn.rst | 18 ++ docs/api/paddle/compat/nn/AvgPool2d_cn.rst | 19 ++ docs/api/paddle/compat/nn/BatchNorm1d_cn.rst | 20 ++ docs/api/paddle/compat/nn/BatchNorm2d_cn.rst | 19 ++ docs/api/paddle/compat/nn/BatchNorm3d_cn.rst | 19 ++ .../compat/nn/MultiheadAttention_cn.rst | 28 +++ .../compat/nn/functional/log_softmax_cn.rst | 26 +++ .../scaled_dot_product_attention_cn.rst | 30 +++ .../paddle/compat/nn/functional/unfold_cn.rst | 28 +++ docs/api/paddle/compat/unique_cn.rst | 28 +++ docs/api/paddle/distribution/Overview_cn.rst | 12 + .../constraint/positive_definite_check_cn.rst | 19 ++ docs/api/paddle/equal_cn.rst | 10 +- docs/api/paddle/float8_e5m2_cn.rst | 9 + docs/api/paddle/io/BatchSampler_cn.rst | 2 + docs/api/paddle/io/RandomSampler_cn.rst | 2 +- docs/api/paddle/io/TensorDataset_cn.rst | 6 +- docs/api/paddle/io/get_worker_info_cn.rst | 2 +- docs/api/paddle/mm_cn.rst | 5 +- docs/api/paddle/movedim_cn.rst | 8 + docs/api/paddle/nn/LeakyReLU_cn.rst | 3 +- docs/api/paddle/nn/Module_cn.rst | 59 +++-- docs/api/paddle/nn/Overview_cn.rst | 2 + docs/api/paddle/nn/PReLU_cn.rst | 6 + docs/api/paddle/nn/ReLU_cn.rst | 3 +- docs/api/paddle/nn/functional/l1_loss_cn.rst | 2 +- docs/api/paddle/nn/init/sparse__cn.rst | 21 ++ .../paddle/nn/utils/rnn/pad_sequence_cn.rst | 26 +++ docs/api/paddle/optim/Adagrad_cn.rst | 27 +++ docs/api/paddle/optim/AdamW_cn.rst | 28 +++ docs/api/paddle/optim/Optimizer_cn.rst | 31 +++ docs/api/paddle/optim/Overview_cn.rst | 16 ++ docs/api/paddle/optim/SGD_cn.rst | 26 +++ docs/api/paddle/optimizer/Adagrad_cn.rst | 7 +- docs/api/paddle/optimizer/AdamW_cn.rst | 7 +- docs/api/paddle/random/get_rng_state_cn.rst | 11 +- docs/api/paddle/uint16_cn.rst | 9 + docs/api/paddle/uint32_cn.rst | 9 + docs/api/paddle/uint64_cn.rst | 9 + .../api/paddle/utils/data/BatchSampler_cn.rst | 13 +- docs/api/paddle/utils/data/DataLoader_cn.rst | 38 +++ .../paddle/utils/data/RandomSampler_cn.rst | 10 +- .../paddle/utils/data/TensorDataset_cn.rst | 13 ++ .../paddle/utils/data/default_collate_cn.rst | 14 +- .../distributed/DistributedSampler_cn.rst | 23 ++ 52 files changed, 980 insertions(+), 79 deletions(-) create mode 100644 docs/api/paddle/compat/allclose_cn.rst create mode 100644 docs/api/paddle/compat/distributions/Categorical_cn.rst create mode 100644 docs/api/paddle/compat/equal_cn.rst create mode 100644 docs/api/paddle/compat/nn/AvgPool1d_cn.rst create mode 100644 docs/api/paddle/compat/nn/AvgPool2d_cn.rst create mode 100644 docs/api/paddle/compat/nn/BatchNorm1d_cn.rst create mode 100644 docs/api/paddle/compat/nn/BatchNorm2d_cn.rst create mode 100644 docs/api/paddle/compat/nn/BatchNorm3d_cn.rst create mode 100644 docs/api/paddle/compat/nn/MultiheadAttention_cn.rst create mode 100644 docs/api/paddle/compat/nn/functional/log_softmax_cn.rst create mode 100644 docs/api/paddle/compat/nn/functional/scaled_dot_product_attention_cn.rst create mode 100644 docs/api/paddle/compat/nn/functional/unfold_cn.rst create mode 100644 docs/api/paddle/compat/unique_cn.rst create mode 100644 docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst create mode 100644 docs/api/paddle/float8_e5m2_cn.rst create mode 100644 docs/api/paddle/movedim_cn.rst create mode 100644 docs/api/paddle/nn/init/sparse__cn.rst create mode 100644 docs/api/paddle/nn/utils/rnn/pad_sequence_cn.rst create mode 100644 docs/api/paddle/optim/Adagrad_cn.rst create mode 100644 docs/api/paddle/optim/AdamW_cn.rst create mode 100644 docs/api/paddle/optim/Optimizer_cn.rst create mode 100644 docs/api/paddle/optim/Overview_cn.rst create mode 100644 docs/api/paddle/optim/SGD_cn.rst create mode 100644 docs/api/paddle/uint16_cn.rst create mode 100644 docs/api/paddle/uint32_cn.rst create mode 100644 docs/api/paddle/uint64_cn.rst create mode 100644 docs/api/paddle/utils/data/DataLoader_cn.rst create mode 100644 docs/api/paddle/utils/data/TensorDataset_cn.rst create mode 100644 docs/api/paddle/utils/data/distributed/DistributedSampler_cn.rst diff --git a/docs/api/paddle/Overview_cn.rst b/docs/api/paddle/Overview_cn.rst index 5265fcb91b1..b84039e056a 100755 --- a/docs/api/paddle/Overview_cn.rst +++ b/docs/api/paddle/Overview_cn.rst @@ -333,6 +333,7 @@ tensor 属性相关 " :ref:`paddle.iinfo ` ", "返回一个 iinfo 对象，该对象包含了输入的整数类 paddle.dtype 的各种相关的数值信息" " :ref:`paddle.finfo ` ", "返回一个 finfo 对象，该对象包含了输入的整数类 paddle.dtype 的各种相关的数值信息" + " :ref:`paddle.float8_e5m2 ` ", "E5M2 格式的 8 位浮点数据类型" " :ref:`paddle.imag ` ", "返回一个包含输入复数 Tensor 的虚部数值的新 Tensor" " :ref:`paddle.real ` ", "返回一个包含输入复数 Tensor 的实部数值的新 Tensor" " :ref:`paddle.shape ` ", "获得输入 Tensor 或 SelectedRows 的 shape" @@ -342,6 +343,9 @@ tensor 属性相关 " :ref:`paddle.broadcast_shapes ` ", "返回对多个 shape 做 broadcast 操作后得到的 shape" " :ref:`paddle.is_floating_point ` ", "判断输入 Tensor 的数据类型是否为浮点类型" " :ref:`paddle.Size ` ", "tuple 的子类, paddle.Tensor.size() 的返回类型，用于描述张量的维度大小。" + " :ref:`paddle.uint16 ` ", "16 位无符号整数数据类型" + " :ref:`paddle.uint32 ` ", "32 位无符号整数数据类型" + " :ref:`paddle.uint64 ` ", "64 位无符号整数数据类型" .. _tensor_creation: @@ -549,6 +553,7 @@ tensor 元素操作相关（如：转置，reshape 等） " :ref:`paddle.swapaxes ` ", "根据 perm 对输入的多维 Tensor 进行数据重排" " :ref:`paddle.swapdims ` ", "根据 perm 对输入的多维 Tensor 进行数据重排" " :ref:`paddle.moveaxis ` ", "移动 Tensor 的轴，根据移动之后的轴对输入的多维 Tensor 进行数据重排" + " :ref:`paddle.movedim ` ", "移动 Tensor 的轴，根据移动之后的轴对输入的多维 Tensor 进行数据重排" " :ref:`paddle.tensordot ` ", "沿多个轴对输入的 x 和 y 进行 Tensor 缩并操作" " :ref:`paddle.unbind ` ", "将输入 Tensor 按照指定的维度分割成多个子 Tensor" " :ref:`paddle.unique ` ", "返回 Tensor 按升序排序后的独有元素" diff --git a/docs/api/paddle/Tensor__upper_cn.rst b/docs/api/paddle/Tensor__upper_cn.rst index bd3486cb809..bb8302375b7 100755 --- a/docs/api/paddle/Tensor__upper_cn.rst +++ b/docs/api/paddle/Tensor__upper_cn.rst @@ -353,11 +353,11 @@ is_cpu d.is_cpu -numpy(force=True) -::::::::: +numpy(\*, force=True) +::::::::::::::::::::: -参数： - - **force** (bool, 可选) - 此参数用于 pytorch 兼容，无实际作用，默认为 True。 +关键字参数： + - **force** (bool，可选) - PyTorch 兼容参数，当前 Paddle 实现中不改变转换行为。默认值：True。 返回：将 Tensor 转为 numpy 返回 @@ -398,7 +398,9 @@ clear_gradient(set_to_zero=True) ::::::::: 清理 Tensor 的反向梯度。 -参数： + +**参数** + - **set_to_zero** (bool) - True 表示将梯度值覆盖为 0。False 则释放梯度持有的存储空间。 返回：None @@ -886,6 +888,18 @@ type_as(other) print("original tensor's dtype is: {}".format(x.dtype)) print("new tensor's dtype is: {}".format(x_float.dtype)) +type(dtype=None, non_blocking=False, \*\*kwargs) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: + +未指定 ``dtype`` 时返回包含数据类型、设备及稀疏布局信息的类型名称；指定 ``dtype`` 时将当前 Tensor 转换为目标类型。 + +参数： + - **dtype** (str|paddle.dtype|type|None，可选) - 目标数据类型或 Tensor 类型。默认值：None。 + - **non_blocking** (bool，可选) - 是否允许异步转换。默认值：False。 + - **kwargs** (dict，可选) - 兼容参数；支持已弃用的 ``async`` 作为 ``non_blocking`` 的别名。 + +返回类型：str|Tensor + int() ::::::::: @@ -999,17 +1013,24 @@ atanh_(name=None) Inplace 版本的 :ref:`cn_api_paddle_atanh` API，对输入 ``x`` 采用 Inplace 策略。 -backward(grad_tensor=None, retain_graph=False) -::::::::: +backward(grad_tensor=None, retain_graph=False, create_graph=False, \*, dump_backward_graph_path=None) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: 从当前 Tensor 开始计算反向的神经网络，传导并计算计算图中 Tensor 的梯度。 参数： - - **grad_tensor** (Tensor, 可选) - 当前 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。别名 ``gradient``。 - **retain_graph** (bool, 可选) - 如果为 False，反向计算图将被释放。如果在 backward()之后继续添加 OP， 需要设置为 True，此时之前的反向计算图会保留。将其设置为 False 会更加节省内存。默认值：False。 + - **create_graph** (bool, 可选) - 是否创建导数计算图，以便继续计算高阶导数。默认值：False。 + +关键字参数 +::::::::::: + + - **dump_backward_graph_path** (str|None，可选) - 指定保存反向图调试文件的目录。设置后，会在该目录生成 dot 格式的反向图和调试调用栈信息。默认值：None。 + 返回：无 **代码示例** @@ -1319,8 +1340,8 @@ cross(y, axis=None, name=None) 请参考 :ref:`cn_api_paddle_cross` -cuda(device_id=None, blocking=False) -::::::::: +cuda(device_id=None, blocking=True) +:::::::::::::::::::::::::::::::::::::::: 将当前 Tensor 的拷贝到 GPU 上，且返回的 Tensor 不保留在原计算图中。 @@ -1336,7 +1357,7 @@ cuda(device_id=None, blocking=False) 参数： - **device_id** (int, str, paddle.core.Place, 可选) - Tensor 移动的目标设备。若为 int，则为目标 GPU 的设备 Id。默认为 None，此时为当前 Tensor 的设备 Id，如果当前 Tensor 不在 GPU 上，则为 0。别名 ``device``。 - - **blocking** (bool, 可选) - 如果为 False 并且当前 Tensor 处于固定内存上，将会发生主机到设备端的异步拷贝。否则，会发生同步拷贝。默认为 False。 + - **blocking** (bool, 可选) - 是否阻塞执行拷贝。默认值为 True。在 PyTorch 风格调用中对应参数名为 ``non_blocking``，其语义相反，默认值为 False。 返回：拷贝到 GPU 上的 Tensor @@ -1391,6 +1412,26 @@ diagonal(offset=0, axis1=0, axis2=1, name=None) 请参考 :ref:`cn_api_paddle_diagonal` +diag(offset=0, padding_value=0, name=None, \*, out=None) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: + +根据输入 Tensor 的维度提取对角线或构造对角矩阵。 + +参数： + - **offset** (int，可选) - 指定对角线相对主对角线的偏移量。默认值：0。别名 ``diagonal``。 + - **padding_value** (float|int，可选) - 构造二维矩阵时填充非对角线位置的值。默认值：0。 + - **name** (str|None，可选) - API 名称。默认值：None。 + +关键字参数 +::::::::::: + - **out** (Tensor|None，可选) - 保存结果的 Tensor。默认值：None。 + +返回：计算后的 Tensor。 + +返回类型：Tensor + +请参考 :ref:`cn_api_paddle_diag` + digamma(name=None) ::::::::: @@ -1916,6 +1957,20 @@ index_add(index, axis, value, name=None) 请参考 :ref:`cn_api_paddle_index_add` +index_copy_(dim, index, source) +:::::::::::::::::::::::::::::::::: + +将 ``source`` 沿 ``dim`` 维复制到当前 Tensor 中由 ``index`` 指定的位置，并原地修改当前 Tensor。 + +参数： + - **dim** (int) - 执行索引复制的维度。 + - **index** (Tensor) - 一维索引 Tensor。 + - **source** (Tensor) - 要复制的数据 Tensor。 + +返回：原地修改后的当前 Tensor。 + +返回类型：Tensor + index_put(indices, value, accumulate=False, name=None) ::::::::: @@ -2200,14 +2255,15 @@ matrix_power(x, n, name=None) 请参考 :ref:`cn_api_paddle_linalg_matrix_power` -max(axis=None, keepdim=False, name=None) +max() ::::::::: -返回：计算后的 Tensor +返回当前 Tensor 中所有元素的最大值。 返回类型：Tensor -请参考 :ref:`cn_api_paddle_max` +.. note:: + 启用 PyTorch 兼容模式后，本方法有三种互斥调用方式：``max(*, out=None)``、``max(dim, keepdim=False, *, out=None)`` 和 ``max(other, *, out=None)``。第二种返回 ``(values, indices)``，第三种执行逐元素最大值。请参考 :ref:`cn_api_paddle_compat_max`。 amax(axis=None, keepdim=False, name=None, \*, out=None) ::::::::: @@ -2236,14 +2292,14 @@ mean(axis=None, keepdim=False, name=None) 请参考 :ref:`cn_api_paddle_mean` -median(axis=None, keepdim=False, name=None) -::::::::: +median(dim=None, keepdim=False, \*, out=None) +:::::::::::::::::::::::::::::::::::::::::::::::: -返回：沿着 ``axis`` 进行中位数计算的结果 +返回中位数。``dim`` 为 None 时返回单个 Tensor；指定 ``dim`` 时返回包含 ``values`` 和 ``indices`` 的具名元组。 -返回类型：Tensor +返回类型：Tensor|MedianRetType -请参考 :ref:`cn_api_paddle_median` +请参考 :ref:`cn_api_paddle_compat_median` nanmedian(axis=None, keepdim=False, name=None) ::::::::: @@ -2254,14 +2310,56 @@ nanmedian(axis=None, keepdim=False, name=None) 请参考 :ref:`cn_api_paddle_nanmedian` -min(axis=None, keepdim=False, name=None) +nanmean(axis=None, keepdim=False, name=None, \*, dtype=None, out=None) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: + +忽略 NaN 元素，计算当前 Tensor 沿指定维度的平均值。 + +参数： + - **axis** (int|list|tuple|None，可选) - 进行归约的维度，别名 ``dim``。默认值：None。 + - **keepdim** (bool，可选) - 是否保留归约维度。默认值：False。 + - **name** (str|None，可选) - API 名称。默认值：None。 + +关键字参数 +::::::::::: + - **dtype** (str|paddle.dtype|None，可选) - 计算和输出的数据类型。默认值：None。 + - **out** (Tensor|None，可选) - 保存结果的 Tensor。默认值：None。 + +返回类型：Tensor + +请参考 :ref:`cn_api_paddle_nanmean` + +nansum(axis=None, dtype=None, keepdim=False, name=None, \*, out=None) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: + +忽略 NaN 元素，计算当前 Tensor 沿指定维度的总和。 + +.. note:: + 还支持 PyTorch 风格签名 ``nansum(dim=None, keepdim=False, *, dtype=None, out=None)``。 + +参数： + - **axis** (int|list|tuple|None，可选) - 进行归约的维度，别名 ``dim``。默认值：None。 + - **dtype** (str|paddle.dtype|None，可选) - 计算和输出的数据类型。默认值：None。 + - **keepdim** (bool，可选) - 是否保留归约维度。默认值：False。 + - **name** (str|None，可选) - API 名称。默认值：None。 + +关键字参数 +::::::::::: + - **out** (Tensor|None，可选) - 保存结果的 Tensor。默认值：None。 + +返回类型：Tensor + +请参考 :ref:`cn_api_paddle_nansum` + +min() ::::::::: -返回：计算后的 Tensor +返回当前 Tensor 中所有元素的最小值。 返回类型：Tensor -请参考 :ref:`cn_api_paddle_min` +.. note:: + 启用 PyTorch 兼容模式后，本方法有三种互斥调用方式：``min(*, out=None)``、``min(dim, keepdim=False, *, out=None)`` 和 ``min(other, *, out=None)``。第二种返回 ``(values, indices)``，第三种执行逐元素最小值。请参考 :ref:`cn_api_paddle_compat_min`。 amin(axis=None, keepdim=False, name=None, \*, out=None) ::::::::: @@ -2272,6 +2370,23 @@ amin(axis=None, keepdim=False, name=None, \*, out=None) 请参考 :ref:`cn_api_paddle_amin` +aminmax(axis=None, keepdim=False, \*, out=None) +:::::::::::::::::::::::::::::::::::::::::::::::: + +同时计算当前 Tensor 沿指定维度的最小值和最大值。 + +参数： + - **axis** (int|list|tuple|None，可选) - 进行归约的维度，别名 ``dim``。默认值：None，表示归约所有元素。 + - **keepdim** (bool，可选) - 是否在输出中保留归约维度。默认值：False。 + +关键字参数 +::::::::::: + - **out** (tuple[Tensor, Tensor]|None，可选) - 保存最小值和最大值结果的两个 Tensor。默认值：None。 + +返回：二元 tuple，第一个 Tensor 为最小值，第二个 Tensor 为最大值。 + +返回类型：tuple[Tensor, Tensor] + minimum(y, axis=-1, name=None, \*, out=None) ::::::::: @@ -2398,6 +2513,13 @@ norm(p=fro, axis=None, keepdim=False, name=None) 请参考 :ref:`cn_api_paddle_linalg_norm` +nbytes +::::::::: + +当前稠密 Tensor 占用的字节数。稀疏 Tensor 不支持该属性。 + +返回类型：int + not_equal(y, name=None) ::::::::: @@ -2407,14 +2529,12 @@ not_equal(y, name=None) 请参考 :ref:`cn_api_paddle_not_equal` -numel(name=None) +numel() ::::::::: -返回：计算后的 Tensor - -返回类型：Tensor +返回：当前 Tensor 中元素的总数。 -请参考 :ref:`cn_api_paddle_numel` +返回类型：int pin_memory(y, name=None) @@ -2594,6 +2714,19 @@ reshape(shape, name=None) 请参考 :ref:`cn_api_paddle_reshape` +reshape_as(other, name=None) +:::::::::::::::::::::::::::::: + +将当前 Tensor 重塑为与 ``other`` 相同的形状。 + +参数： + - **other** (Tensor) - 提供目标形状的 Tensor。 + - **name** (str|None，可选) - API 名称。默认值：None。 + +返回：重塑后的 Tensor。 + +返回类型：Tensor + ravel() ::::::::: @@ -2955,11 +3088,14 @@ stanh(scale_a=0.67, scale_b=1.7159, name=None) 请参考 :ref:`cn_api_paddle_stanh` -std(axis=None, unbiased=True, keepdim=False, name=None) -::::::::: +std(axis=None, unbiased=None, keepdim=False, name=None, \*, correction=1, out=None) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: 返回：计算后的 Tensor +.. note:: + 还支持 PyTorch 风格签名 ``std(dim=None, *, correction=1, keepdim=False, out=None)``。 + 返回类型：Tensor 请参考 :ref:`cn_api_paddle_std` @@ -3155,6 +3291,14 @@ transpose(perm, name=None) 请参考 :ref:`cn_api_paddle_transpose` +transpose_(perm, name=None) +:::::::::::::::::::::::::::: + +原地版本的 :ref:`cn_api_paddle_transpose`，按照 ``perm`` 重新排列当前 Tensor 的维度。 + +.. note:: + 还支持 PyTorch 风格签名 ``transpose_(dim0, dim1)``，用于交换两个维度。 + permute(dims, name=None) ::::::::: @@ -3248,14 +3392,14 @@ Inplace 版本的 :ref:`cn_api_paddle_uniform`，返回一个从均匀分布采 # [-0.15477282, 0.96190143, -0.05395842, -0.62789059], # [-0.90525085, 0.63603556, 0.06997657, -0.16352385]]) -unique(return_index=False, return_inverse=False, return_counts=False, axis=None, dtype=int64, name=None) -::::::::: +unique(sorted=True, return_inverse=False, return_counts=False, dim=None) +:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -返回：计算后的 Tensor +返回当前 Tensor 中的唯一元素，并可选返回逆索引和计数。 -返回类型：Tensor +返回类型：Tensor|tuple[Tensor, ...] -请参考 :ref:`cn_api_paddle_unique` +请参考 :ref:`cn_api_paddle_compat_unique` unsqueeze(axis, name=None) ::::::::: @@ -3649,12 +3793,12 @@ cols() # Tensor(shape=[5], dtype=int64, place=Place(gpu:0), stop_gradient=True, # [1, 3, 2, 0, 1]) -is_sparse() +is_sparse ::::::::: -当输入 SparseCooTensor/SparseCsrTensor 时，返回 True；当输入 DenseTensor 时，返回 False。 +当输入为 COO 布局的稀疏 Tensor 时返回 True，其他情况返回 False。 -返回：是否为稀疏 Tensor（包括 SparseCooTensor 和 SparseCsrTensor） +返回：是否为 COO 布局的稀疏 Tensor。 返回类型：bool @@ -3668,7 +3812,7 @@ is_sparse() values = [1.0, 2.0, 3.0] dense_shape = [3, 3] coo = paddle.sparse.sparse_coo_tensor(indices, values, dense_shape) - coo.is_sparse() + coo.is_sparse # True is_sparse_coo() diff --git a/docs/api/paddle/autograd/function/once_differentiable_cn.rst b/docs/api/paddle/autograd/function/once_differentiable_cn.rst index 0bf4a3acce6..11a3ce16796 100644 --- a/docs/api/paddle/autograd/function/once_differentiable_cn.rst +++ b/docs/api/paddle/autograd/function/once_differentiable_cn.rst @@ -3,6 +3,16 @@ once_differentiable ------------------------------- -.. py:function:: paddle.autograd.function.once_differentiable +.. py:function:: paddle.autograd.function.once_differentiable(backward) -``paddle.autograd.py_layer.once_differentiable`` 的别名。 +``paddle.autograd.py_layer.once_differentiable`` 的别名，用作 ``PyLayer.backward`` 方法的装饰器，使该反向方法本身不可再次求导。 + +参数 +::::::::: + + - **backward** (Callable) - 要包装的 ``PyLayer.backward`` 函数。 + +返回 +::::::::: + +Callable，包装后的反向函数。 diff --git a/docs/api/paddle/compat/Overview_cn.rst b/docs/api/paddle/compat/Overview_cn.rst index b084c0395b1..911408c4e2e 100644 --- a/docs/api/paddle/compat/Overview_cn.rst +++ b/docs/api/paddle/compat/Overview_cn.rst @@ -14,6 +14,8 @@ PyTorch 兼容函数 :header: "API 名称", "API 功能" :widths: 10, 30 + " :ref:`allclose ` ", "逐元素近似比较并返回 Python bool" + " :ref:`equal ` ", "比较两个 Tensor 是否完全相等并返回 Python bool" " :ref:`max ` ", "包含 ``amax``、同时返回 values 及 indices 的轴向最大值、``maximum`` 三种功能" " :ref:`median ` ", "兼容版中位数，支持 dim/keepdim/out 签名" " :ref:`min ` ", "包含 ``amin``、同时返回 values 及 indices 的轴向最小值、``minimum`` 三种功能" @@ -21,6 +23,7 @@ PyTorch 兼容函数 " :ref:`slogdet ` ", "slogdet 函数" " :ref:`sort ` ", "同时返回 values 及 indices 的排序" " :ref:`split ` ", "允许非整除块大小输入的 Tensor 轴向切分" + " :ref:`unique ` ", "PyTorch 对齐的唯一元素统计接口" .. _about_compat_nn: @@ -32,7 +35,13 @@ PyTorch 兼容的 nn 模块 :header: "类名称", "类功能" :widths: 10, 30 + " :ref:`AvgPool1d ` ", "PyTorch 对齐的一维平均池化层" + " :ref:`AvgPool2d ` ", "PyTorch 对齐的二维平均池化层" + " :ref:`BatchNorm1d ` ", "PyTorch 对齐的一维批归一化层" + " :ref:`BatchNorm2d ` ", "PyTorch 对齐的二维批归一化层" + " :ref:`BatchNorm3d ` ", "PyTorch 对齐的三维批归一化层" " :ref:`Linear ` ", "PyTorch 对齐的 ``paddle.nn.Linear`` 兼容版本" + " :ref:`MultiheadAttention ` ", "PyTorch 对齐的多头注意力层" " :ref:`Unfold ` ", "允许 Tensor 输入的 ``paddle.nn.Unfold`` 兼容版本" @@ -46,5 +55,19 @@ PyTorch 兼容的 nn.functional 模块 :widths: 10, 30 " :ref:`linear ` ", "PyTorch 对齐的 ``paddle.nn.functional.linear`` 兼容版本" + " :ref:`log_softmax ` ", "PyTorch 对齐的 log-softmax 函数" " :ref:`pad ` ", "从最后一维度开始进行 padding、padding 正确兼容转换的填充函数" + " :ref:`scaled_dot_product_attention ` ", "PyTorch 布局的缩放点积注意力" " :ref:`softmax ` ", "softmax 函数" + " :ref:`unfold ` ", "PyTorch 参数名的 im2col 操作" + +.. _about_compat_distribution: + +PyTorch 兼容的概率分布 +:::::::::::::::::::::::::::::: + +.. csv-table:: + :header: "类名称", "类功能" + :widths: 10, 30 + + " :ref:`Categorical ` ", "支持 probs 或 logits 的类别分布" diff --git a/docs/api/paddle/compat/allclose_cn.rst b/docs/api/paddle/compat/allclose_cn.rst new file mode 100644 index 00000000000..991cd02b095 --- /dev/null +++ b/docs/api/paddle/compat/allclose_cn.rst @@ -0,0 +1,29 @@ +.. _cn_api_paddle_compat_allclose: + +allclose +------------------------------- + +.. py:function:: paddle.compat.allclose(input, other, rtol=1e-5, atol=1e-8, equal_nan=False, name=None) + +逐元素比较两个 Tensor 是否在给定容差内相等，并返回单个 Python ``bool``。 + +参数 +::::::::: + + - **input** (Tensor) - 第一个输入 Tensor。 + - **other** (Tensor) - 第二个输入 Tensor。 + - **rtol** (float，可选) - 相对容差。默认值：1e-5。 + - **atol** (float，可选) - 绝对容差。默认值：1e-8。 + - **equal_nan** (bool，可选) - 是否将同一位置的 NaN 视为相等。默认值：False。 + - **name** (str|None，可选) - API 名称。默认值：None。 + +返回 +::::::::: + +bool，所有元素均满足容差条件时为 True。 + +代码示例 +::::::::: + +COPY-FROM: paddle.compat.allclose + diff --git a/docs/api/paddle/compat/distributions/Categorical_cn.rst b/docs/api/paddle/compat/distributions/Categorical_cn.rst new file mode 100644 index 00000000000..48a367c8220 --- /dev/null +++ b/docs/api/paddle/compat/distributions/Categorical_cn.rst @@ -0,0 +1,20 @@ +.. _cn_api_paddle_compat_distributions_Categorical: + +Categorical +------------------------------- + +.. py:class:: paddle.compat.distributions.Categorical(probs=None, logits=None, validate_args=None) + +PyTorch 兼容的类别分布。``probs`` 和 ``logits`` 必须且只能提供一个，最后一维表示类别。 + +参数 +::::::::: + + - **probs** (Tensor|None，可选) - 各类别的概率，至少为一维；传入后会沿最后一维归一化。默认值：None。 + - **logits** (Tensor|None，可选) - 各类别未归一化的对数概率，至少为一维。默认值：None。 + - **validate_args** (bool|None，可选) - 是否验证参数是否满足分布约束。默认值：None。 + +返回 +::::::::: + +Categorical 分布实例。 diff --git a/docs/api/paddle/compat/equal_cn.rst b/docs/api/paddle/compat/equal_cn.rst new file mode 100644 index 00000000000..37ba268339d --- /dev/null +++ b/docs/api/paddle/compat/equal_cn.rst @@ -0,0 +1,25 @@ +.. _cn_api_paddle_compat_equal: + +equal +------------------------------- + +.. py:function:: paddle.compat.equal(input, other) + +判断两个 Tensor 的形状和全部元素是否相同。该兼容接口返回单个 Python ``bool``，不会因为输入 dtype 不同而直接判定不相等；包含 NaN 的 Tensor 不与自身相等。 + +参数 +::::::::: + + - **input** (Tensor) - 第一个输入 Tensor。 + - **other** (Tensor) - 第二个输入 Tensor。 + +返回 +::::::::: + +bool，形状和全部元素相同时为 True。 + +代码示例 +::::::::: + +COPY-FROM: paddle.compat.equal + diff --git a/docs/api/paddle/compat/nn/AvgPool1d_cn.rst b/docs/api/paddle/compat/nn/AvgPool1d_cn.rst new file mode 100644 index 00000000000..3dc1fe9d3e2 --- /dev/null +++ b/docs/api/paddle/compat/nn/AvgPool1d_cn.rst @@ -0,0 +1,18 @@ +.. _cn_api_paddle_compat_nn_AvgPool1d: + +AvgPool1d +------------------------------- + +.. py:class:: paddle.compat.nn.AvgPool1d(kernel_size, stride=None, padding=0, ceil_mode=False, count_include_pad=True) + +PyTorch 兼容的一维平均池化层。输入和输出采用 NCL 布局。 + +参数 +::::::::: + + - **kernel_size** (int|list|tuple) - 池化核大小。 + - **stride** (int|list|tuple|None，可选) - 池化步长。默认值：None，使用 ``kernel_size``。 + - **padding** (str|int|list|tuple，可选) - 填充大小。默认值：0。 + - **ceil_mode** (bool，可选) - 是否使用 ceil 计算输出长度。默认值：False。 + - **count_include_pad** (bool，可选) - 计算平均值时是否计入填充元素。默认值：True。 + diff --git a/docs/api/paddle/compat/nn/AvgPool2d_cn.rst b/docs/api/paddle/compat/nn/AvgPool2d_cn.rst new file mode 100644 index 00000000000..5a3cd87d72e --- /dev/null +++ b/docs/api/paddle/compat/nn/AvgPool2d_cn.rst @@ -0,0 +1,19 @@ +.. _cn_api_paddle_compat_nn_AvgPool2d: + +AvgPool2d +------------------------------- + +.. py:class:: paddle.compat.nn.AvgPool2d(kernel_size, stride=None, padding=0, ceil_mode=False, count_include_pad=True, divisor_override=None) + +PyTorch 兼容的二维平均池化层。输入和输出采用 NCHW 布局。 + +参数 +::::::::: + + - **kernel_size** (int|list|tuple) - 池化核大小。 + - **stride** (int|list|tuple|None，可选) - 池化步长。默认值：None，使用 ``kernel_size``。 + - **padding** (str|int|list|tuple，可选) - 填充大小。默认值：0。 + - **ceil_mode** (bool，可选) - 是否使用 ceil 计算输出尺寸。默认值：False。 + - **count_include_pad** (bool，可选) - 计算平均值时是否计入填充元素。默认值：True。 + - **divisor_override** (int|None，可选) - 指定平均值计算的除数。默认值：None。 + diff --git a/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst b/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst new file mode 100644 index 00000000000..53ecfbdd69d --- /dev/null +++ b/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst @@ -0,0 +1,20 @@ +.. _cn_api_paddle_compat_nn_BatchNorm1d: + +BatchNorm1d +------------------------------- + +.. py:class:: paddle.compat.nn.BatchNorm1d(num_features, eps=1e-5, momentum=0.1, affine=True, track_running_stats=True, device=None, dtype=None) + +PyTorch 兼容的一维批归一化层。 + +参数 +::::::::: + + - **num_features** (int) - 输入的通道数。 + - **eps** (float，可选) - 数值稳定项。默认值：1e-5。 + - **momentum** (float|None，可选) - 运行统计量的更新系数；转换为 Paddle 更新系数时使用 ``1 - momentum``。默认值：0.1。 + - **affine** (bool，可选) - 是否创建可学习的缩放和偏置参数。默认值：True。 + - **track_running_stats** (bool，可选) - 是否跟踪运行均值和方差。默认值：True。 + - **device** (PlaceLike|None，可选) - 参数设备。默认值：None。 + - **dtype** (DTypeLike|None，可选) - 参数数据类型。默认值：None。 + diff --git a/docs/api/paddle/compat/nn/BatchNorm2d_cn.rst b/docs/api/paddle/compat/nn/BatchNorm2d_cn.rst new file mode 100644 index 00000000000..673a741af8b --- /dev/null +++ b/docs/api/paddle/compat/nn/BatchNorm2d_cn.rst @@ -0,0 +1,19 @@ +.. _cn_api_paddle_compat_nn_BatchNorm2d: + +BatchNorm2d +------------------------------- + +.. py:class:: paddle.compat.nn.BatchNorm2d(num_features, eps=1e-5, momentum=0.1, affine=True, track_running_stats=True, device=None, dtype=None) + +PyTorch 兼容的二维批归一化层，参数含义与 :ref:`cn_api_paddle_compat_nn_BatchNorm1d` 相同。 + +参数 +::::::::: + + - **num_features** (int) - 输入的通道数。 + - **eps** (float，可选) - 数值稳定项。默认值：1e-5。 + - **momentum** (float|None，可选) - 运行统计量的更新系数。默认值：0.1。 + - **affine** (bool，可选) - 是否创建可学习的缩放和偏置参数。默认值：True。 + - **track_running_stats** (bool，可选) - 是否跟踪运行均值和方差。默认值：True。 + - **device** (PlaceLike|None，可选) - 参数设备。默认值：None。 + - **dtype** (DTypeLike|None，可选) - 参数数据类型。默认值：None。 diff --git a/docs/api/paddle/compat/nn/BatchNorm3d_cn.rst b/docs/api/paddle/compat/nn/BatchNorm3d_cn.rst new file mode 100644 index 00000000000..65ac34e8413 --- /dev/null +++ b/docs/api/paddle/compat/nn/BatchNorm3d_cn.rst @@ -0,0 +1,19 @@ +.. _cn_api_paddle_compat_nn_BatchNorm3d: + +BatchNorm3d +------------------------------- + +.. py:class:: paddle.compat.nn.BatchNorm3d(num_features, eps=1e-5, momentum=0.1, affine=True, track_running_stats=True, device=None, dtype=None) + +PyTorch 兼容的三维批归一化层，参数含义与 :ref:`cn_api_paddle_compat_nn_BatchNorm1d` 相同。 + +参数 +::::::::: + + - **num_features** (int) - 输入的通道数。 + - **eps** (float，可选) - 数值稳定项。默认值：1e-5。 + - **momentum** (float|None，可选) - 运行统计量的更新系数。默认值：0.1。 + - **affine** (bool，可选) - 是否创建可学习的缩放和偏置参数。默认值：True。 + - **track_running_stats** (bool，可选) - 是否跟踪运行均值和方差。默认值：True。 + - **device** (PlaceLike|None，可选) - 参数设备。默认值：None。 + - **dtype** (DTypeLike|None，可选) - 参数数据类型。默认值：None。 diff --git a/docs/api/paddle/compat/nn/MultiheadAttention_cn.rst b/docs/api/paddle/compat/nn/MultiheadAttention_cn.rst new file mode 100644 index 00000000000..c890da16999 --- /dev/null +++ b/docs/api/paddle/compat/nn/MultiheadAttention_cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_paddle_compat_nn_MultiheadAttention: + +MultiheadAttention +------------------------------- + +.. py:class:: paddle.compat.nn.MultiheadAttention(embed_dim, num_heads, dropout=0.0, bias=True, add_bias_kv=False, add_zero_attn=False, kdim=None, vdim=None, batch_first=False, device=None, dtype=None) + +PyTorch 兼容的多头注意力层。 + +参数 +::::::::: + + - **embed_dim** (int) - 模型的总特征维度。 + - **num_heads** (int) - 注意力头数。 + - **dropout** (float，可选) - 注意力权重的 dropout 概率。默认值：0.0。 + - **bias** (bool，可选) - 是否为输入和输出投影添加偏置。默认值：True。 + - **add_bias_kv** (bool，可选) - 是否向 key 和 value 序列添加偏置。默认值：False。 + - **add_zero_attn** (bool，可选) - 是否向 key 和 value 序列添加全零项。默认值：False。 + - **kdim** (int|None，可选) - key 的特征维度。默认值：None，使用 ``embed_dim``。 + - **vdim** (int|None，可选) - value 的特征维度。默认值：None，使用 ``embed_dim``。 + - **batch_first** (bool，可选) - 输入输出是否使用 ``[batch, seq, feature]`` 布局。默认值：False。 + - **device** (PlaceLike|None，可选) - 参数设备。默认值：None。 + - **dtype** (DTypeLike|None，可选) - 参数数据类型。默认值：None。 + +代码示例 +::::::::: + +COPY-FROM: paddle.compat.nn.MultiheadAttention diff --git a/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst b/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst new file mode 100644 index 00000000000..f660dc8fd79 --- /dev/null +++ b/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst @@ -0,0 +1,26 @@ +.. _cn_api_paddle_compat_nn_functional_log_softmax: + +log_softmax +------------------------------- + +.. py:function:: paddle.compat.nn.functional.log_softmax(input, dim=None, dtype=None, *, out=None) + +沿指定维度计算 log-softmax。 + +参数 +::::::::: + + - **input** (Tensor) - 输入 Tensor。 + - **dim** (int|None，可选) - 计算 log-softmax 的维度。默认值：None。 + - **dtype** (DTypeLike|None，可选) - 计算前转换到的数据类型。默认值：None。 + +关键字参数 +::::::::::: + + - **out** (Tensor|None，可选) - 保存计算结果的 Tensor。默认值：None。 + +返回 +::::::::: + +Tensor，形状与 ``input`` 相同。 + diff --git a/docs/api/paddle/compat/nn/functional/scaled_dot_product_attention_cn.rst b/docs/api/paddle/compat/nn/functional/scaled_dot_product_attention_cn.rst new file mode 100644 index 00000000000..d4f4bb06d94 --- /dev/null +++ b/docs/api/paddle/compat/nn/functional/scaled_dot_product_attention_cn.rst @@ -0,0 +1,30 @@ +.. _cn_api_paddle_compat_nn_functional_scaled_dot_product_attention: + +scaled_dot_product_attention +------------------------------- + +.. py:function:: paddle.compat.nn.functional.scaled_dot_product_attention(query, key, value, attn_mask=None, dropout_p=0.0, is_causal=False, scale=None, enable_gqa=False) + +PyTorch 兼容的缩放点积注意力。与原生接口不同，本接口的 Q、K、V 布局为 ``[batch_size, num_heads, seq_len, head_dim]`` 或 ``[num_heads, seq_len, head_dim]``。 + +参数 +::::::::: + + - **query** (Tensor) - 查询 Tensor。 + - **key** (Tensor) - 键 Tensor。 + - **value** (Tensor) - 值 Tensor。 + - **attn_mask** (Tensor|None，可选) - 可广播到注意力分数形状的掩码。默认值：None。 + - **dropout_p** (float，可选) - 注意力权重的 dropout 概率。默认值：0.0。 + - **is_causal** (bool，可选) - 是否使用因果掩码。为 True 时不能同时传入 ``attn_mask``。默认值：False。 + - **scale** (float|None，可选) - 注意力权重的缩放因子；None 表示使用 ``1 / sqrt(head_dim)``。默认值：None。 + - **enable_gqa** (bool，可选) - 是否启用 GQA。默认值：False。 + +返回 +::::::::: + +Tensor，缩放点积注意力的结果。 + +代码示例 +::::::::: + +COPY-FROM: paddle.compat.nn.functional.scaled_dot_product_attention diff --git a/docs/api/paddle/compat/nn/functional/unfold_cn.rst b/docs/api/paddle/compat/nn/functional/unfold_cn.rst new file mode 100644 index 00000000000..908ca5c370c --- /dev/null +++ b/docs/api/paddle/compat/nn/functional/unfold_cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_paddle_compat_nn_functional_unfold: + +unfold +------------------------------- + +.. py:function:: paddle.compat.nn.functional.unfold(input, kernel_size, dilation=1, padding=0, stride=1) + +PyTorch 兼容的 im2col 操作，将二维滑动窗口覆盖的区域展开为列。 + +参数 +::::::::: + + - **input** (Tensor) - NCHW 布局的四维输入 Tensor。 + - **kernel_size** (int|list|tuple|Tensor) - 卷积核大小。 + - **dilation** (int|list|tuple|Tensor，可选) - 卷积核膨胀系数。默认值：1。 + - **padding** (int|list|tuple|Tensor，可选) - 输入填充大小。默认值：0。 + - **stride** (int|list|tuple|Tensor，可选) - 滑动步长。默认值：1。 + +返回 +::::::::: + +Tensor，形状为 ``[N, C * kernel_size[0] * kernel_size[1], L]``。 + +代码示例 +::::::::: + +COPY-FROM: paddle.compat.nn.functional.unfold + diff --git a/docs/api/paddle/compat/unique_cn.rst b/docs/api/paddle/compat/unique_cn.rst new file mode 100644 index 00000000000..8a406974c94 --- /dev/null +++ b/docs/api/paddle/compat/unique_cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_paddle_compat_unique: + +unique +------------------------------- + +.. py:function:: paddle.compat.unique(input, sorted=True, return_inverse=False, return_counts=False, dim=None) + +返回输入 Tensor 中的唯一元素，并可选返回逆索引和各元素出现次数。 + +参数 +::::::::: + + - **input** (Tensor) - 输入 Tensor。 + - **sorted** (bool，可选) - 是否对唯一元素排序。默认值：True。 + - **return_inverse** (bool，可选) - 是否返回将唯一元素映射回输入的索引。默认值：False。 + - **return_counts** (bool，可选) - 是否返回每个唯一元素的出现次数。默认值：False。 + - **dim** (int|None，可选) - 计算唯一元素的维度。默认值：None，表示将输入展平后计算。 + +返回 +::::::::: + +Tensor；当 ``return_inverse`` 或 ``return_counts`` 为 True 时，返回包含所请求结果的 tuple。 + +代码示例 +::::::::: + +COPY-FROM: paddle.compat.unique + diff --git a/docs/api/paddle/distribution/Overview_cn.rst b/docs/api/paddle/distribution/Overview_cn.rst index 87109ec4403..be9f6d2e314 100644 --- a/docs/api/paddle/distribution/Overview_cn.rst +++ b/docs/api/paddle/distribution/Overview_cn.rst @@ -9,6 +9,7 @@ paddle.distribution 目录下包含飞桨框架支持的随机变量的概率分 - :ref:`随机变量的概率分布 ` - :ref:`随机变量的变换 ` - :ref:`KL 散度相关 API ` +- :ref:`分布约束相关 API ` .. _about_distribution: @@ -80,3 +81,14 @@ KL 散度相关 API " :ref:`register_kl ` ", "注册 KL 散度" " :ref:`kl_divergence ` ", "计算 KL 散度" + +.. _about_distribution_constraint: + +分布约束相关 API +:::::::::::::::::::: + +.. csv-table:: + :header: "API 名称", "API 功能" + :widths: 10, 30 + + " :ref:`positive_definite.check ` ", "检查矩阵是否为对称正定矩阵" diff --git a/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst b/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst new file mode 100644 index 00000000000..53018072a79 --- /dev/null +++ b/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst @@ -0,0 +1,19 @@ +.. _cn_api_paddle_distribution_constraint_positive_definite_check: + +positive_definite.check +------------------------------- + +.. py:method:: paddle.distribution.constraint.positive_definite.check(value) + +检查输入的最后两个维度是否构成对称正定矩阵。 + +参数 +::::::::: + + - **value** (Tensor) - 要检查的 Tensor；最后两个维度表示矩阵。 + +返回 +::::::::: + +Tensor，bool 类型，形状为 ``value.shape[:-2]``，表示每个矩阵是否为对称正定矩阵。 + diff --git a/docs/api/paddle/equal_cn.rst b/docs/api/paddle/equal_cn.rst index 39706a5969c..2493d0c048d 100644 --- a/docs/api/paddle/equal_cn.rst +++ b/docs/api/paddle/equal_cn.rst @@ -2,7 +2,7 @@ equal ------------------------------- -.. py:function:: paddle.equal(x, y, name=None) +.. py:function:: paddle.equal(x, y, name=None, *, out=None) 返回 :math:`x==y` 逐元素比较 x 和 y 是否相等，相同位置的元素相同则返回 True，否则返回 False。使用重载算子 ``==`` 可以有相同的计算函数效果。 @@ -13,10 +13,14 @@ equal 参数 :::::::::::: - - **x** (Tensor) - 输入 Tensor，支持的数据类型包括 bool、float16、float32、float64、uint8、int8、int16、int32、int64。 - - **y** (Tensor) - 输入 Tensor，支持的数据类型包括 bool、float16、float32、float64、uint8、int8、int16、int32、int64。 + - **x** (Tensor) - 输入 Tensor，支持的数据类型包括 bool、float16、float32、float64、uint8、int8、int16、int32、int64、complex64、complex128。别名 ``input``。 + - **y** (Tensor) - 输入 Tensor，支持的数据类型包括 bool、float16、float32、float64、uint8、int8、int16、int32、int64、complex64、complex128。别名 ``other``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::::: + + - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 返回 :::::::::::: diff --git a/docs/api/paddle/float8_e5m2_cn.rst b/docs/api/paddle/float8_e5m2_cn.rst new file mode 100644 index 00000000000..7a9c047624c --- /dev/null +++ b/docs/api/paddle/float8_e5m2_cn.rst @@ -0,0 +1,9 @@ +.. _cn_api_paddle_float8_e5m2: + +float8_e5m2 +------------------------------- + +.. py:data:: paddle.float8_e5m2 + +8 位浮点数据类型，包含 1 位符号、5 位指数和 2 位尾数。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 + diff --git a/docs/api/paddle/io/BatchSampler_cn.rst b/docs/api/paddle/io/BatchSampler_cn.rst index 3870e3be4d5..59c562e5f5c 100644 --- a/docs/api/paddle/io/BatchSampler_cn.rst +++ b/docs/api/paddle/io/BatchSampler_cn.rst @@ -5,6 +5,8 @@ BatchSampler .. py:class:: paddle.io.BatchSampler(dataset=None, sampler=None, shuffle=False, batch_size=1, drop_last=False) +本类还支持 PyTorch 风格签名 ``paddle.io.BatchSampler(sampler=None, batch_size=1, drop_last=False)``。两种签名中均必须通过 ``dataset`` 或 ``sampler`` 提供样本来源，且二者不能同时设置。 + 批采样器的基础实现，用于 ``paddle.io.DataLoader`` 中迭代式获取 mini-batch 的样本下标数组，数组长度与 ``batch_size`` 一致。 所有用于 ``paddle.io.DataLoader`` 中的批采样器都必须是 ``paddle.io.BatchSampler`` 的子类并实现以下方法： diff --git a/docs/api/paddle/io/RandomSampler_cn.rst b/docs/api/paddle/io/RandomSampler_cn.rst index da91031c18d..7ad3a004e3a 100644 --- a/docs/api/paddle/io/RandomSampler_cn.rst +++ b/docs/api/paddle/io/RandomSampler_cn.rst @@ -9,7 +9,7 @@ RandomSampler 参数 ::::::::: - - **data_source** (Dataset) - 此参数必须是 :ref:`cn_api_paddle_io_Dataset` 或 :ref:`cn_api_paddle_io_IterableDataset` 的一个子类实例或实现了 ``__len__`` 的 Python 对象，用于生成样本下标。默认值为 None。 + - **data_source** (Dataset) - 必填。此参数必须是 :ref:`cn_api_paddle_io_Dataset` 或 :ref:`cn_api_paddle_io_IterableDataset` 的一个子类实例或实现了 ``__len__`` 的 Python 对象，用于生成样本下标。 - **replacement** (bool，可选) - 如果为 ``False`` 则会采样整个数据集，如果为 ``True`` 则会按 ``num_samples`` 指定的样本数采集。默认值为 ``False`` 。 - **num_samples** (int，可选) - 按此参数采集对应的样本数。默认值为 None，此时设为 ``data_source`` 的长度。 - **generator** (Generator，可选) - 指定采样 ``data_source`` 的采样器。默认值为 None，不启用。 diff --git a/docs/api/paddle/io/TensorDataset_cn.rst b/docs/api/paddle/io/TensorDataset_cn.rst index d2e5c878397..fbfbe609251 100644 --- a/docs/api/paddle/io/TensorDataset_cn.rst +++ b/docs/api/paddle/io/TensorDataset_cn.rst @@ -3,7 +3,9 @@ TensorDataset ------------------------------- -.. py:class:: paddle.io.TensorDataset +.. py:class:: paddle.io.TensorDataset(tensors) + +也支持可变位置参数形式 ``paddle.io.TensorDataset(*tensors)``。 由 Tensor 列表定义的数据集。 @@ -12,7 +14,7 @@ TensorDataset 参数 :::::::::::: - - **tensors** (list of Tensors) - Tensor 列表，这些 Tensor 的第一维形状相同 + - **tensors** (list|tuple[Tensor]) - Tensor 序列，或按可变位置参数逐个传入的 Tensor；这些 Tensor 的第一维形状相同。 返回 :::::::::::: diff --git a/docs/api/paddle/io/get_worker_info_cn.rst b/docs/api/paddle/io/get_worker_info_cn.rst index 1ae66b4a611..1c650fdf505 100644 --- a/docs/api/paddle/io/get_worker_info_cn.rst +++ b/docs/api/paddle/io/get_worker_info_cn.rst @@ -3,7 +3,7 @@ get_worker_info ------------------------------- -.. py:class:: paddle.io.get_worker_info +.. py:function:: paddle.io.get_worker_info() 获取 ``paddle.io.DataLoader`` 子进程信息的函数，用于 ``paddle.io.IterableDataset`` 中划分子进程数据。子进程信息包含以下字段： diff --git a/docs/api/paddle/mm_cn.rst b/docs/api/paddle/mm_cn.rst index 12301f206bb..832a6b1f8dc 100644 --- a/docs/api/paddle/mm_cn.rst +++ b/docs/api/paddle/mm_cn.rst @@ -3,7 +3,7 @@ mm ------------------------------- -.. py:function:: paddle.mm(input, mat2, name=None, *, out=None) +.. py:function:: paddle.mm(input, mat2, name=None, *, out_dtype=None, out=None) @@ -23,12 +23,13 @@ mm 关键字参数 :::::::::::: + - **out_dtype** (paddle.dtype|None，可选) - 指定输出的数据类型。当前仅支持 CUDA 设备上输入为 float16 或 bfloat16 的二维 Tensor 时将输出类型指定为 ``paddle.float32``，且两个输入的数据类型必须相同。默认值为 ``None``。 - **out** (Tensor，可选) - 输出 Tensor，若不为 ``None``，计算结果将保存在该 Tensor 中，默认值为 ``None``。 返回 :::::::::::: - - Tensor，矩阵相乘后的结果。 + - Tensor，矩阵相乘后的结果。未指定 ``out_dtype`` 时，其数据类型与输入相同。 :: diff --git a/docs/api/paddle/movedim_cn.rst b/docs/api/paddle/movedim_cn.rst new file mode 100644 index 00000000000..f777247f341 --- /dev/null +++ b/docs/api/paddle/movedim_cn.rst @@ -0,0 +1,8 @@ +.. _cn_api_paddle_movedim: + +movedim +------------------------------- + +.. py:function:: paddle.movedim(x, source, destination, name=None) + +``moveaxis`` 的别名，请参考 :ref:`cn_api_paddle_moveaxis`。 diff --git a/docs/api/paddle/nn/LeakyReLU_cn.rst b/docs/api/paddle/nn/LeakyReLU_cn.rst index 18240efc1db..723d0ffc9b2 100644 --- a/docs/api/paddle/nn/LeakyReLU_cn.rst +++ b/docs/api/paddle/nn/LeakyReLU_cn.rst @@ -2,7 +2,7 @@ LeakyReLU ------------------------------- -.. py:class:: paddle.nn.LeakyReLU(negative_slope=0.01, name=None) +.. py:class:: paddle.nn.LeakyReLU(negative_slope=0.01, inplace=False, name=None) LeakyReLU 激活层，创建一个可调用对象以计算输入 ``x`` 的 ``LeakReLU`` 。 @@ -21,6 +21,7 @@ LeakyReLU 激活层，创建一个可调用对象以计算输入 ``x`` 的 ``Lea 参数 :::::::::: - **negative_slope** (float，可选) - :math:`x < 0` 时的斜率。默认值为 0.01。 + - **inplace** (bool，可选) - 是否使用原地操作。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 diff --git a/docs/api/paddle/nn/Module_cn.rst b/docs/api/paddle/nn/Module_cn.rst index e987c74a65e..2d32987ded9 100644 --- a/docs/api/paddle/nn/Module_cn.rst +++ b/docs/api/paddle/nn/Module_cn.rst @@ -30,10 +30,14 @@ COPY-FROM: paddle.nn.Module :::::::::::: -train() -''''''''' +train(mode=True) +'''''''''''''''' + +根据 ``mode`` 设置此层及其所有子层的训练模式。这只会影响某些模块，如 Dropout 和 BatchNorm。 + +**参数** -将此层及其所有子层设置为训练模式。这只会影响某些模块，如 Dropout 和 BatchNorm。 + - **mode** (bool，可选) - True 表示训练模式，False 表示预测模式。默认值：True。 **返回** Module (返回网络层)， self (返回自身) @@ -247,7 +251,7 @@ modules() Iterator[Module]，一个由所有层组成的列表。 get_submodule(target) ------------- +''''''''' 返回指定名称的子层。 @@ -259,7 +263,7 @@ get_submodule(target) Module，指定名称的子层，如果不存在会抛出异常。 set_submodule(target, module, strict=False) ------------- +''''''''' 设置指定名称的子层。 @@ -289,7 +293,7 @@ clear_gradients(set_to_zero=True) COPY-FROM: paddle.nn.Module.clear_gradients requires_grad_(requires_grad=True) --------------- +''''''''' 设置该层参数是否参与梯度计算。 @@ -301,7 +305,7 @@ requires_grad_(requires_grad=True) Module，自身实例。 zero_grad(set_to_none=True) ---------- +''''''''' 重置所有模型参数的梯度。 @@ -403,7 +407,7 @@ iterator，产出名称和 buffer 的元组的迭代器。 COPY-FROM: paddle.nn.Module.named_buffers get_buffer ------------ +''''''''' 返回指定名称的 buffer。 @@ -444,6 +448,7 @@ add_parameter(name, parameter) ''''''''' 添加参数实例。可以通过 self.name 访问该 parameter。 + .. note:: ``register_parameter`` 是 ``add_parameter`` 的别名，两者在使用和功能上完全等价。 @@ -477,6 +482,13 @@ dict，包含所有参数和可持久行 buffers 的 dict COPY-FROM: paddle.nn.Module.state_dict +**get_extra_state()** + +返回需要一并保存到 ``state_dict`` 中的额外状态。基类未提供默认状态；需要持久化额外状态的子类应重写此方法，并同时重写 ``set_extra_state(state)``。 + +**返回** +任意可序列化对象，表示 Module 的额外状态。 + set_state_dict(state_dict, use_structured_name=True, assign=False) ''''''''' @@ -514,16 +526,29 @@ load_state_dict(state_dict, strict=True, assign=False) - **missing_keys** (list) - 缺失的参数名列表。 - **unexpected_keys** (list) - 传入 ``state_dict`` 中未被当前 Module 使用的参数名列表。 -to(device=None, dtype=None, blocking=None) -''''''''' +to(\*args, \*\*kwargs) +'''''''''''''''''''''' 根据给定的 device、dtype 和 blocking 转换 Module 中的 parameters 和 buffers。 +本方法支持三种调用方式： + +1. ``to(device=None, dtype=None, blocking=True, *, non_blocking=False)``； +2. ``to(dtype, blocking=True, *, non_blocking=False)``； +3. ``to(tensor, blocking=True, *, non_blocking=False)``。 + +该方法会原地修改当前 Module。 + **参数** - **device** （str|paddle.CPUPlace()|paddle.CUDAPlace()|paddle.CUDAPinnedPlace()|paddle.XPUPlace()|None，可选) - 希望存储 Module 的设备位置。如果为 None，设备位置和原始的 Tensor 的设备位置一致。如果设备位置是 string 类型，取值可为 ``cpu``, ``gpu:x`` and ``xpu:x``，这里的 ``x`` 是 GPUs 或者 XPUs 的编号。默认值：None。 - **dtype** （str|numpy.dtype|paddle.dtype|None，可选) - 数据的类型。如果为 None，数据类型和原始的 Tensor 一致。默认值：None。 - - **blocking** （bool|None，可选）- 如果为 False 并且当前 Tensor 处于固定内存上，将会发生主机到设备端的异步拷贝。否则，会发生同步拷贝。如果为 None，blocking 会被设置为 True。默认为 False。 + - **tensor** (Tensor，可选) - 作为目标设备和数据类型的参考 Tensor。 + - **blocking** （bool，可选）- 是否阻塞执行拷贝。默认值：True。 + +**关键字参数** + + - **non_blocking** (bool，可选) - PyTorch 风格的非阻塞参数，语义与 ``blocking`` 相反。默认值：False。 **代码示例** @@ -546,7 +571,7 @@ astype(dtype=None) COPY-FROM: paddle.nn.Module.astype type(dst_type) ----- +''''''''' 将所有参数和 buffer 转换为指定数据类型。 @@ -604,18 +629,18 @@ bfloat16(excluded_layers=None) COPY-FROM: paddle.nn.Module.bfloat16 double() ------- +''''''''' 将所有浮点型的参数和通过 ``register_buffers()`` 注册的 Buffer 变量转换为 double 数据类型。 half() ----- +''''''''' 将所有浮点型的参数和通过 ``register_buffers()`` 注册的 Buffer 变量转换为 half 数据类型。 cuda(device) ----- +''''''''' 将所有模型参数和 buffer 移动到 GPU。 @@ -628,7 +653,7 @@ Module，自身实例。 xpu(device) ---- +''''''''' 将所有模型参数和 buffer 移动到 XPU。 @@ -641,7 +666,7 @@ Module，自身实例。 cpu() ---- +''''''''' 将所有模型参数和 buffer 移动到 CPU。 diff --git a/docs/api/paddle/nn/Overview_cn.rst b/docs/api/paddle/nn/Overview_cn.rst index 1cff7ecca24..f16500a4a48 100644 --- a/docs/api/paddle/nn/Overview_cn.rst +++ b/docs/api/paddle/nn/Overview_cn.rst @@ -581,6 +581,7 @@ Embedding 相关函数 " :ref:`paddle.nn.init.kaiming_uniform_ ` ", "函数式版本的 :ref:`paddle.nn.initializer.KaimingUniform ` API" " :ref:`paddle.nn.initializer.Normal ` ", "随机正态（高斯）分布初始化函数" " :ref:`paddle.nn.init.normal_ ` ", "函数式版本的 :ref:`paddle.nn.initializer.Normal ` API" + " :ref:`paddle.nn.init.sparse_ ` ", "将二维 Tensor 原地初始化为稀疏矩阵" " :ref:`paddle.nn.initializer.set_global_initializer ` ", "用于设置 Paddle 框架中全局的参数初始化方法" " :ref:`paddle.nn.initializer.calculate_gain ` ", "获取某些激活函数的推荐增益值（增益值可用于对某些初始化 API 进行设置，以调整初始化值）" " :ref:`paddle.nn.initializer.Dirac ` ", "通过狄拉克 delta 函数来初始化 3D/4D/5D Tensor，一般用于卷积层，能最大程度保留卷积层输入的特性" @@ -622,6 +623,7 @@ Embedding 相关函数 " :ref:`paddle.nn.utils.clip_grad_norm_ ` ", "对一组张量的梯度按范数进行裁剪" " :ref:`paddle.nn.utils.clip_grad_value_ ` ", "对一组张量的梯度按值范围进行裁剪" " :ref:`paddle.nn.utils.parameters_to_vector ` ", "将参数列表转换成一个一维 Tensor" + " :ref:`paddle.nn.utils.rnn.pad_sequence ` ", "填充并堆叠长度不同的 Tensor 序列" " :ref:`paddle.nn.utils.remove_weight_norm ` ", "移除传入 layer 中的权重归一化" " :ref:`paddle.nn.utils.spectral_norm ` ", "对传入 layer 中的权重谱归一化" " :ref:`paddle.nn.utils.vector_to_parameters ` ", "将一个一维 Tensor 转换成参数列表" diff --git a/docs/api/paddle/nn/PReLU_cn.rst b/docs/api/paddle/nn/PReLU_cn.rst index c3bc3324251..1ac89289370 100644 --- a/docs/api/paddle/nn/PReLU_cn.rst +++ b/docs/api/paddle/nn/PReLU_cn.rst @@ -6,6 +6,12 @@ PReLU PReLU 激活层（PReLU Activation Operator）。计算公式如下： +该 API 支持以下两种签名： + +1. ``PReLU(num_parameters=1, init=0.25, weight_attr=None, data_format="NCHW", name=None, device=None, dtype=None)`` （Paddle 风格）。 + +2. ``PReLU(num_parameters=1, init=0.25, device=None, dtype=None)`` （PyTorch 风格）。 + 如果使用近似计算： .. math:: diff --git a/docs/api/paddle/nn/ReLU_cn.rst b/docs/api/paddle/nn/ReLU_cn.rst index f0bd5427dab..f16626748dd 100644 --- a/docs/api/paddle/nn/ReLU_cn.rst +++ b/docs/api/paddle/nn/ReLU_cn.rst @@ -2,7 +2,7 @@ ReLU ------------------------------- -.. py:class:: paddle.nn.ReLU(name=None) +.. py:class:: paddle.nn.ReLU(inplace=False, name=None) ReLU 激活层（Rectified Linear Unit）。计算公式如下： @@ -14,6 +14,7 @@ ReLU 激活层（Rectified Linear Unit）。计算公式如下： 参数 :::::::::: + - **inplace** (bool，可选) - 是否使用原地操作。默认值为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 diff --git a/docs/api/paddle/nn/functional/l1_loss_cn.rst b/docs/api/paddle/nn/functional/l1_loss_cn.rst index 94ccb3d6068..d509dc88b1d 100644 --- a/docs/api/paddle/nn/functional/l1_loss_cn.rst +++ b/docs/api/paddle/nn/functional/l1_loss_cn.rst @@ -28,7 +28,7 @@ l1_loss 参数 ::::::::: - **input** (Tensor) - 输入的 Tensor，维度是[N, *]，其中 N 是 batch size， ``*`` 是任意数量的额外维度。数据类型为：float32、float64、int32、int64。 - - **label** (Tensor) - 标签，维度是[N, *]，与 ``input`` 相同。数据类型为：float32、float64、int32、int64。 + - **label** (Tensor) - 标签，维度是[N, *]，与 ``input`` 相同。数据类型为：float32、float64、int32、int64。别名 ``target``。 - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``, ``'mean'``, ``'sum'``。默认为 ``'mean'``，计算 ``L1Loss`` 的均值；设置为 ``'sum'`` 时，计算 ``L1Loss`` 的总和；设置为 ``'none'`` 时，则返回 ``L1Loss``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/init/sparse__cn.rst b/docs/api/paddle/nn/init/sparse__cn.rst new file mode 100644 index 00000000000..35e5aada7b6 --- /dev/null +++ b/docs/api/paddle/nn/init/sparse__cn.rst @@ -0,0 +1,21 @@ +.. _cn_api_paddle_nn_init_sparse_: + +sparse_ +------------------------------- + +.. py:function:: paddle.nn.init.sparse_(tensor, sparsity, std=0.01) + +将二维输入 Tensor 原地初始化为稀疏矩阵。每列指定比例的元素会被置零，其余元素从均值为 0、标准差为 ``std`` 的正态分布采样。 + +参数 +::::::::: + + - **tensor** (Tensor) - 要初始化的二维 Tensor。 + - **sparsity** (float) - 每列中被置零元素的比例。 + - **std** (float，可选) - 非零元素正态分布的标准差。默认值：0.01。 + +返回 +::::::::: + +Tensor，原地初始化后的输入 Tensor。 + diff --git a/docs/api/paddle/nn/utils/rnn/pad_sequence_cn.rst b/docs/api/paddle/nn/utils/rnn/pad_sequence_cn.rst new file mode 100644 index 00000000000..d132ad11758 --- /dev/null +++ b/docs/api/paddle/nn/utils/rnn/pad_sequence_cn.rst @@ -0,0 +1,26 @@ +.. _cn_api_paddle_nn_utils_rnn_pad_sequence: + +pad_sequence +------------------------------- + +.. py:function:: paddle.nn.utils.rnn.pad_sequence(sequences, batch_first=False, padding_value=0.0, padding_side='right') + +将一组长度不同、其余维度相同的 Tensor 填充到相同长度并堆叠。 + +参数 +::::::::: + + - **sequences** (Iterable[Tensor]) - 形状为 ``[L, *]`` 的 Tensor 序列；各 Tensor 的尾部维度和 dtype 必须相同。 + - **batch_first** (bool，可选) - True 时输出布局为 ``[B, T, *]``，否则为 ``[T, B, *]``。默认值：False。 + - **padding_value** (float，可选) - 填充元素的值。默认值：0.0。 + - **padding_side** (str，可选) - 填充方向，可为 ``'right'`` 或 ``'left'``。默认值：``'right'``。 + +返回 +::::::::: + +Tensor，填充并堆叠后的结果。 + +代码示例 +::::::::: + +COPY-FROM: paddle.nn.utils.rnn.pad_sequence diff --git a/docs/api/paddle/optim/Adagrad_cn.rst b/docs/api/paddle/optim/Adagrad_cn.rst new file mode 100644 index 00000000000..5a7d171d1cf --- /dev/null +++ b/docs/api/paddle/optim/Adagrad_cn.rst @@ -0,0 +1,27 @@ +.. _cn_api_paddle_optim_Adagrad: + +Adagrad +------------------------------- + +.. py:class:: paddle.optim.Adagrad(params, lr=0.01, lr_decay=0, weight_decay=0, initial_accumulator_value=0, eps=1e-10, foreach=None, *, maximize=False, differentiable=False, fused=None) + +PyTorch 风格构造签名的 Adagrad 优化器。 + +参数 +::::::::: + + - **params** (Sequence[Tensor]|Sequence[dict]|None) - 要优化的参数或参数组。 + - **lr** (float|Tensor，可选) - 学习率。默认值：0.01。 + - **lr_decay** (float，可选) - 学习率衰减系数。默认值：0。 + - **weight_decay** (float，可选) - 权重衰减系数。默认值：0。 + - **initial_accumulator_value** (float，可选) - 累加器初始值。默认值：0。 + - **eps** (float，可选) - 数值稳定项。默认值：1e-10。 + - **foreach** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + +关键字参数 +::::::::::: + + - **maximize** (bool，可选) - 是否最大化目标函数。默认值：False。 + - **differentiable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 + - **fused** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + diff --git a/docs/api/paddle/optim/AdamW_cn.rst b/docs/api/paddle/optim/AdamW_cn.rst new file mode 100644 index 00000000000..53f95f39871 --- /dev/null +++ b/docs/api/paddle/optim/AdamW_cn.rst @@ -0,0 +1,28 @@ +.. _cn_api_paddle_optim_AdamW: + +AdamW +------------------------------- + +.. py:class:: paddle.optim.AdamW(params, lr=0.001, betas=(0.9, 0.999), eps=1e-8, weight_decay=0.01, amsgrad=False, *, maximize=False, foreach=None, capturable=False, differentiable=False, fused=None) + +PyTorch 风格构造签名的 AdamW 优化器。 + +参数 +::::::::: + + - **params** (Sequence[Tensor]|Sequence[dict]|None) - 要优化的参数或参数组。 + - **lr** (float|Tensor，可选) - 学习率。默认值：0.001。 + - **betas** (tuple[float|Tensor, float|Tensor]，可选) - 一阶、二阶矩估计的衰减系数。默认值：``(0.9, 0.999)``。 + - **eps** (float，可选) - 数值稳定项。默认值：1e-8。 + - **weight_decay** (float，可选) - 权重衰减系数。默认值：0.01。 + - **amsgrad** (bool，可选) - 是否使用 AMSGrad。默认值：False。 + +关键字参数 +::::::::::: + + - **maximize** (bool，可选) - 是否最大化目标函数。默认值：False。 + - **foreach** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + - **capturable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 + - **differentiable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 + - **fused** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + diff --git a/docs/api/paddle/optim/Optimizer_cn.rst b/docs/api/paddle/optim/Optimizer_cn.rst new file mode 100644 index 00000000000..50e0637401c --- /dev/null +++ b/docs/api/paddle/optim/Optimizer_cn.rst @@ -0,0 +1,31 @@ +.. _cn_api_paddle_optim_Optimizer: + +Optimizer +------------------------------- + +.. py:class:: paddle.optim.Optimizer(params, defaults) + +PyTorch 风格的优化器基类。 + +参数 +::::::::: + + - **params** (Sequence[Tensor]|Sequence[dict]|None) - 要优化的参数或参数组。 + - **defaults** (dict) - 优化器默认配置。支持 ``lr`` 或 ``learning_rate``、``weight_decay``、``grad_clip`` 和 ``maximize``；``lr`` 与 ``learning_rate`` 不能同时提供。 + +方法 +::::::::: + +step(closure=None) +'''''''''''''''''' + +执行一次参数更新。 + +**参数** + + - **closure** (Callable|None，可选) - 重新计算模型并返回 loss 的闭包。默认值：None。 + +**返回** + +Tensor|None；提供 ``closure`` 时返回其结果，否则返回 None。 + diff --git a/docs/api/paddle/optim/Overview_cn.rst b/docs/api/paddle/optim/Overview_cn.rst new file mode 100644 index 00000000000..a88dd2b60a1 --- /dev/null +++ b/docs/api/paddle/optim/Overview_cn.rst @@ -0,0 +1,16 @@ +.. _cn_overview_optim: + +paddle.optim +------------------------------- + +``paddle.optim`` 提供 PyTorch 风格的优化器构造签名，并复用 ``paddle.optimizer`` 的优化器实现。 + +.. csv-table:: + :header: "API 名称", "API 功能" + :widths: 10, 30 + + " :ref:`Adagrad ` ", "PyTorch 风格的 Adagrad 优化器" + " :ref:`AdamW ` ", "PyTorch 风格的 AdamW 优化器" + " :ref:`Optimizer ` ", "PyTorch 风格的优化器基类" + " :ref:`SGD ` ", "PyTorch 风格的 SGD 优化器" + diff --git a/docs/api/paddle/optim/SGD_cn.rst b/docs/api/paddle/optim/SGD_cn.rst new file mode 100644 index 00000000000..de1ae8ac9eb --- /dev/null +++ b/docs/api/paddle/optim/SGD_cn.rst @@ -0,0 +1,26 @@ +.. _cn_api_paddle_optim_SGD: + +SGD +------------------------------- + +.. py:class:: paddle.optim.SGD(params=None, lr=0.001, momentum=0, dampening=0, weight_decay=0, nesterov=False, *, maximize=False, foreach=None, differentiable=False, fused=None) + +PyTorch 风格构造签名的随机梯度下降优化器。 + +参数 +::::::::: + + - **params** (Sequence[Tensor]|Sequence[dict]|None，可选) - 要优化的参数或参数组。默认值：None。 + - **lr** (float|Tensor，可选) - 学习率。默认值：0.001。 + - **momentum** (float，可选) - 兼容保留参数，当前实现会忽略非零值。默认值：0。 + - **dampening** (float，可选) - 兼容保留参数，当前实现会忽略非零值。默认值：0。 + - **weight_decay** (float|Tensor，可选) - 权重衰减系数。默认值：0。 + - **nesterov** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 + +关键字参数 +::::::::::: + + - **maximize** (bool，可选) - 是否最大化目标函数。默认值：False。 + - **foreach** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + - **differentiable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 + - **fused** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 diff --git a/docs/api/paddle/optimizer/Adagrad_cn.rst b/docs/api/paddle/optimizer/Adagrad_cn.rst index eeeca3350a6..20dfba07920 100644 --- a/docs/api/paddle/optimizer/Adagrad_cn.rst +++ b/docs/api/paddle/optimizer/Adagrad_cn.rst @@ -3,7 +3,7 @@ Adagrad ------------------------------- -.. py:class:: paddle.optimizer.Adagrad(learning_rate, epsilon=1e-06, parameters=None, weight_decay=None, grad_clip=None, name=None, initial_accumulator_value=0.0) +.. py:class:: paddle.optimizer.Adagrad(learning_rate, epsilon=1e-06, parameters=None, weight_decay=None, grad_clip=None, name=None, initial_accumulator_value=0.0, *, maximize=False) Adaptive Gradient 优化器（自适应梯度优化器，简称 Adagrad）可以针对不同参数样本数不平均的问题，自适应地为各个参数分配不同的学习率。 @@ -36,6 +36,11 @@ Adaptive Gradient 优化器（自适应梯度优化器，简称 Adagrad）可以 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 - **initial_accumulator_value** (float，可选) - moment 累加器的初始值，默认值为 0.0。 +关键字参数 +:::::::::::: + + - **maximize** (bool，可选) - 是否最大化目标函数，而不是最小化目标函数。默认值为 False。 + 代码示例 :::::::::::: diff --git a/docs/api/paddle/optimizer/AdamW_cn.rst b/docs/api/paddle/optimizer/AdamW_cn.rst index 29b8a7b993d..18b024033da 100755 --- a/docs/api/paddle/optimizer/AdamW_cn.rst +++ b/docs/api/paddle/optimizer/AdamW_cn.rst @@ -3,7 +3,7 @@ AdamW ------------------------------- -.. py:class:: paddle.optimizer.AdamW(learning_rate=0.001, beta1=0.9, beta2=0.999, epsilon=1e-08, parameters=None, weight_decay=0.01, lr_ratio=None, apply_decay_param_fun=None, grad_clip=None, lazy_mode=False, multi_precision=False, amsgrad=False, name=None) +.. py:class:: paddle.optimizer.AdamW(learning_rate=0.001, beta1=0.9, beta2=0.999, epsilon=1e-08, parameters=None, weight_decay=0.01, use_lowprecision_moment=False, lr_ratio=None, apply_decay_param_fun=None, grad_clip=None, lazy_mode=False, multi_precision=False, amsgrad=False, name=None, *, maximize=False) @@ -39,6 +39,7 @@ AdamW 优化器出自 `DECOUPLED WEIGHT DECAY REGULARIZATION ` 、 :ref:`paddle.nn.ClipGradByNorm ` 、 :ref:`paddle.nn.ClipGradByValue ` 。 @@ -48,6 +49,10 @@ AdamW 优化器出自 `DECOUPLED WEIGHT DECAY REGULARIZATION `，默认为 False。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 +关键字参数 +:::::::::::: + + - **maximize** (bool，可选) - 是否最大化目标函数，而不是最小化目标函数。默认值为 False。 代码示例 :::::::::::: diff --git a/docs/api/paddle/random/get_rng_state_cn.rst b/docs/api/paddle/random/get_rng_state_cn.rst index 3618023e306..4d377e9351e 100644 --- a/docs/api/paddle/random/get_rng_state_cn.rst +++ b/docs/api/paddle/random/get_rng_state_cn.rst @@ -3,10 +3,15 @@ get_rng_state ------------------------------- -.. py:function:: paddle.random.get_rng_state() +.. py:function:: paddle.random.get_rng_state(device=None) -``paddle.device.cpu.get_rng_state`` 的别名，请参考 :ref:`cn_api_paddle_get_rng_state`。 +返回默认 CPU 随机数生成器的状态。该接口是 ``paddle.device.cpu.get_rng_state`` 的别名。 + +参数 +::::::::: + + - **device** (CPUPlace|str|int|None，可选) - 兼容设备参数；当前实现读取默认 CPU 生成器的状态。默认值：None。 返回 ::::::::: -Tensor：CPU 随机数生成器的初始种子值。 +core.GeneratorState：随机数生成器状态，可传给 ``paddle.random.set_rng_state`` 恢复随机状态。 diff --git a/docs/api/paddle/uint16_cn.rst b/docs/api/paddle/uint16_cn.rst new file mode 100644 index 00000000000..b2a2110478f --- /dev/null +++ b/docs/api/paddle/uint16_cn.rst @@ -0,0 +1,9 @@ +.. _cn_api_paddle_uint16: + +uint16 +------------------------------- + +.. py:data:: paddle.uint16 + +16 位无符号整数数据类型。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 + diff --git a/docs/api/paddle/uint32_cn.rst b/docs/api/paddle/uint32_cn.rst new file mode 100644 index 00000000000..2d74550d74b --- /dev/null +++ b/docs/api/paddle/uint32_cn.rst @@ -0,0 +1,9 @@ +.. _cn_api_paddle_uint32: + +uint32 +------------------------------- + +.. py:data:: paddle.uint32 + +32 位无符号整数数据类型。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 + diff --git a/docs/api/paddle/uint64_cn.rst b/docs/api/paddle/uint64_cn.rst new file mode 100644 index 00000000000..dbfa95db964 --- /dev/null +++ b/docs/api/paddle/uint64_cn.rst @@ -0,0 +1,9 @@ +.. _cn_api_paddle_uint64: + +uint64 +------------------------------- + +.. py:data:: paddle.uint64 + +64 位无符号整数数据类型。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 + diff --git a/docs/api/paddle/utils/data/BatchSampler_cn.rst b/docs/api/paddle/utils/data/BatchSampler_cn.rst index ea7133adc07..28a31573456 100644 --- a/docs/api/paddle/utils/data/BatchSampler_cn.rst +++ b/docs/api/paddle/utils/data/BatchSampler_cn.rst @@ -3,6 +3,15 @@ BatchSampler ------------------------------- -.. py:class:: paddle.utils.data.BatchSampler +.. py:class:: paddle.utils.data.BatchSampler(dataset=None, sampler=None, shuffle=False, batch_size=1, drop_last=False) -``paddle.io.BatchSampler`` 的别名，请参考 :ref:`cn_api_paddle_io_BatchSampler`。 +``paddle.io.BatchSampler`` 的别名，也支持 PyTorch 风格签名 ``paddle.utils.data.BatchSampler(sampler=None, batch_size=1, drop_last=False)``。请参考 :ref:`cn_api_paddle_io_BatchSampler`。 + +参数 +::::::::: + + - **dataset** (Dataset|None，可选) - 用于生成样本索引的数据集。默认值：None。 + - **sampler** (Sampler|Iterable|None，可选) - 样本索引采样器，不能与 ``dataset`` 同时设置。默认值：None。 + - **shuffle** (bool，可选) - 是否打乱索引。默认值：False。 + - **batch_size** (int，可选) - 每个批次的样本数。默认值：1。 + - **drop_last** (bool，可选) - 是否丢弃最后一个不完整批次。默认值：False。 diff --git a/docs/api/paddle/utils/data/DataLoader_cn.rst b/docs/api/paddle/utils/data/DataLoader_cn.rst new file mode 100644 index 00000000000..ab7d17af505 --- /dev/null +++ b/docs/api/paddle/utils/data/DataLoader_cn.rst @@ -0,0 +1,38 @@ +.. _cn_api_paddle_utils_data_DataLoader: + +DataLoader +------------------------------- + +.. py:class:: paddle.utils.data.DataLoader(dataset, batch_size=1, shuffle=False, sampler=None, batch_sampler=None, num_workers=0, collate_fn=None, pin_memory=False, drop_last=False, timeout=0, worker_init_fn=None, multiprocessing_context=None, generator=None, *, prefetch_factor=None, persistent_workers=False, pin_memory_device='', in_order=True) + +按批次加载数据集的 PyTorch 兼容接口，基于 :ref:`cn_api_paddle_io_DataLoader` 实现。 + +参数 +::::::::: + + - **dataset** (Dataset) - 要加载的数据集。 + - **batch_size** (int|None，可选) - 每个批次的样本数。默认值：1。 + - **shuffle** (bool，可选) - 是否在每个 epoch 打乱数据。默认值：False。 + - **sampler** (BatchSampler|None，可选) - 兼容参数，作为批次索引采样器使用，不能与 ``batch_sampler`` 同时设置。默认值：None。 + - **batch_sampler** (BatchSampler|None，可选) - 指定批次索引的采样器。默认值：None。 + - **num_workers** (int，可选) - 加载数据的子进程数。默认值：0。 + - **collate_fn** (Callable|None，可选) - 将样本列表整理成批次的函数。默认值：None。 + - **pin_memory** (bool，可选) - 兼容保留参数；当前实现会忽略 True。默认值：False。 + - **drop_last** (bool，可选) - 是否丢弃最后一个不完整批次。默认值：False。 + - **timeout** (float，可选) - 从工作进程获取批次的超时时间，单位为秒。默认值：0。 + - **worker_init_fn** (Callable|None，可选) - 每个工作进程启动后调用的初始化函数。默认值：None。 + - **multiprocessing_context** (Any|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + - **generator** (Any|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + +关键字参数 +::::::::::: + + - **prefetch_factor** (int|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 + - **persistent_workers** (bool，可选) - 是否在数据集消费完一次后保持工作进程存活。默认值：False。 + - **pin_memory_device** (str，可选) - 兼容保留参数，当前实现会忽略非空值。默认值：''。 + - **in_order** (bool，可选) - 兼容保留参数，当前实现会忽略 False。默认值：True。 + +返回 +::::::::: + +DataLoader，可迭代的数据加载器。 diff --git a/docs/api/paddle/utils/data/RandomSampler_cn.rst b/docs/api/paddle/utils/data/RandomSampler_cn.rst index 110d8d13d75..11107a974cf 100644 --- a/docs/api/paddle/utils/data/RandomSampler_cn.rst +++ b/docs/api/paddle/utils/data/RandomSampler_cn.rst @@ -3,6 +3,14 @@ RandomSampler ------------------------------- -.. py:class:: paddle.utils.data.RandomSampler +.. py:class:: paddle.utils.data.RandomSampler(data_source, replacement=False, num_samples=None, generator=None) ``paddle.io.RandomSampler`` 的别名，请参考 :ref:`cn_api_paddle_io_RandomSampler`。 + +参数 +::::::::: + + - **data_source** (Dataset) - 必填，要进行随机采样的数据集。 + - **replacement** (bool，可选) - 是否有放回采样。默认值：False。 + - **num_samples** (int|None，可选) - 要采样的样本数。默认值：None。 + - **generator** (Generator|None，可选) - 随机数生成器。默认值：None。 diff --git a/docs/api/paddle/utils/data/TensorDataset_cn.rst b/docs/api/paddle/utils/data/TensorDataset_cn.rst new file mode 100644 index 00000000000..be965ff22de --- /dev/null +++ b/docs/api/paddle/utils/data/TensorDataset_cn.rst @@ -0,0 +1,13 @@ +.. _cn_api_paddle_utils_data_TensorDataset: + +TensorDataset +------------------------------- + +.. py:class:: paddle.utils.data.TensorDataset(tensors) + +``paddle.io.TensorDataset`` 的别名，同时支持可变位置参数形式 ``paddle.utils.data.TensorDataset(*tensors)``。请参考 :ref:`cn_api_paddle_io_TensorDataset`。 + +参数 +::::::::: + + - **tensors** (Sequence[Tensor]|Tensor) - 第一维长度相同的一组 Tensor，可作为一个序列传入，也可作为可变位置参数逐个传入。 diff --git a/docs/api/paddle/utils/data/default_collate_cn.rst b/docs/api/paddle/utils/data/default_collate_cn.rst index 2b7c5edadf2..148972290c9 100644 --- a/docs/api/paddle/utils/data/default_collate_cn.rst +++ b/docs/api/paddle/utils/data/default_collate_cn.rst @@ -3,6 +3,16 @@ default_collate ------------------------------- -.. py:function:: paddle.utils.data.default_collate() +.. py:function:: paddle.utils.data.default_collate(batch) -``paddle.io.dataloader.collate.default_collate_fn`` 的别名，请参考 :ref:`cn_api_paddle_io_DataLoader`。 +``paddle.io.dataloader.collate.default_collate_fn`` 的别名。该函数接收样本数据组成的列表，递归处理其中的列表、字典、字符串、数值、NumPy 数组和 Tensor，并沿第 0 维堆叠数值、NumPy 数组和 Tensor。请参考 :ref:`cn_api_paddle_io_DataLoader`。 + +参数 +::::::::: + + - **batch** (list) - 样本数据组成的列表。 + +返回 +::::::::: + +批处理后的数据；输入中的数值、NumPy 数组和 paddle.Tensor 会被堆叠为 batch 数据。 diff --git a/docs/api/paddle/utils/data/distributed/DistributedSampler_cn.rst b/docs/api/paddle/utils/data/distributed/DistributedSampler_cn.rst new file mode 100644 index 00000000000..9bde207f872 --- /dev/null +++ b/docs/api/paddle/utils/data/distributed/DistributedSampler_cn.rst @@ -0,0 +1,23 @@ +.. _cn_api_paddle_utils_data_distributed_DistributedSampler: + +DistributedSampler +------------------------------- + +.. py:class:: paddle.utils.data.distributed.DistributedSampler(dataset, num_replicas=None, rank=None, shuffle=True, seed=0, drop_last=False) + +为分布式训练划分数据集，使每个进程获得互斥的数据子集。 + +参数 +::::::::: + + - **dataset** (Sized) - 要采样的数据集，必须实现 ``__len__``。 + - **num_replicas** (int|None，可选) - 参与训练的进程数。默认值：None，使用当前分布式环境的进程数。 + - **rank** (int|None，可选) - 当前进程的 rank。默认值：None，使用当前分布式环境的 rank。 + - **shuffle** (bool，可选) - 是否按 ``seed`` 在每个 epoch 打乱索引。默认值：True。 + - **seed** (int，可选) - 打乱索引使用的随机种子。默认值：0。 + - **drop_last** (bool，可选) - 是否丢弃尾部数据，使数据能被各进程均分。默认值：False。 + +返回 +::::::::: + +DistributedSampler，分布式样本索引迭代器。 From 83e82419e56468a93ec9d6b8f910369802f08f68 Mon Sep 17 00:00:00 2001 From: manfredss Date: Tue, 18 Aug 2026 19:16:25 +0800 Subject: [PATCH 2/2] fix codestyle --- docs/api/paddle/compat/allclose_cn.rst | 1 - docs/api/paddle/compat/equal_cn.rst | 1 - docs/api/paddle/compat/nn/AvgPool1d_cn.rst | 1 - docs/api/paddle/compat/nn/AvgPool2d_cn.rst | 1 - docs/api/paddle/compat/nn/BatchNorm1d_cn.rst | 1 - docs/api/paddle/compat/nn/functional/log_softmax_cn.rst | 1 - docs/api/paddle/compat/nn/functional/unfold_cn.rst | 1 - docs/api/paddle/compat/unique_cn.rst | 1 - .../distribution/constraint/positive_definite_check_cn.rst | 1 - docs/api/paddle/float8_e5m2_cn.rst | 1 - docs/api/paddle/nn/init/sparse__cn.rst | 1 - docs/api/paddle/optim/Adagrad_cn.rst | 1 - docs/api/paddle/optim/AdamW_cn.rst | 1 - docs/api/paddle/optim/Optimizer_cn.rst | 1 - docs/api/paddle/optim/Overview_cn.rst | 1 - docs/api/paddle/uint16_cn.rst | 1 - docs/api/paddle/uint32_cn.rst | 1 - docs/api/paddle/uint64_cn.rst | 1 - 18 files changed, 18 deletions(-) diff --git a/docs/api/paddle/compat/allclose_cn.rst b/docs/api/paddle/compat/allclose_cn.rst index 991cd02b095..92a40db579f 100644 --- a/docs/api/paddle/compat/allclose_cn.rst +++ b/docs/api/paddle/compat/allclose_cn.rst @@ -26,4 +26,3 @@ bool，所有元素均满足容差条件时为 True。 ::::::::: COPY-FROM: paddle.compat.allclose - diff --git a/docs/api/paddle/compat/equal_cn.rst b/docs/api/paddle/compat/equal_cn.rst index 37ba268339d..148d4f50ea9 100644 --- a/docs/api/paddle/compat/equal_cn.rst +++ b/docs/api/paddle/compat/equal_cn.rst @@ -22,4 +22,3 @@ bool，形状和全部元素相同时为 True。 ::::::::: COPY-FROM: paddle.compat.equal - diff --git a/docs/api/paddle/compat/nn/AvgPool1d_cn.rst b/docs/api/paddle/compat/nn/AvgPool1d_cn.rst index 3dc1fe9d3e2..20692ec1446 100644 --- a/docs/api/paddle/compat/nn/AvgPool1d_cn.rst +++ b/docs/api/paddle/compat/nn/AvgPool1d_cn.rst @@ -15,4 +15,3 @@ PyTorch 兼容的一维平均池化层。输入和输出采用 NCL 布局。 - **padding** (str|int|list|tuple，可选) - 填充大小。默认值：0。 - **ceil_mode** (bool，可选) - 是否使用 ceil 计算输出长度。默认值：False。 - **count_include_pad** (bool，可选) - 计算平均值时是否计入填充元素。默认值：True。 - diff --git a/docs/api/paddle/compat/nn/AvgPool2d_cn.rst b/docs/api/paddle/compat/nn/AvgPool2d_cn.rst index 5a3cd87d72e..6aab80e2175 100644 --- a/docs/api/paddle/compat/nn/AvgPool2d_cn.rst +++ b/docs/api/paddle/compat/nn/AvgPool2d_cn.rst @@ -16,4 +16,3 @@ PyTorch 兼容的二维平均池化层。输入和输出采用 NCHW 布局。 - **ceil_mode** (bool，可选) - 是否使用 ceil 计算输出尺寸。默认值：False。 - **count_include_pad** (bool，可选) - 计算平均值时是否计入填充元素。默认值：True。 - **divisor_override** (int|None，可选) - 指定平均值计算的除数。默认值：None。 - diff --git a/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst b/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst index 53ecfbdd69d..da2c0fa5cc5 100644 --- a/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst +++ b/docs/api/paddle/compat/nn/BatchNorm1d_cn.rst @@ -17,4 +17,3 @@ PyTorch 兼容的一维批归一化层。 - **track_running_stats** (bool，可选) - 是否跟踪运行均值和方差。默认值：True。 - **device** (PlaceLike|None，可选) - 参数设备。默认值：None。 - **dtype** (DTypeLike|None，可选) - 参数数据类型。默认值：None。 - diff --git a/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst b/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst index f660dc8fd79..098959d8b6c 100644 --- a/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst +++ b/docs/api/paddle/compat/nn/functional/log_softmax_cn.rst @@ -23,4 +23,3 @@ log_softmax ::::::::: Tensor，形状与 ``input`` 相同。 - diff --git a/docs/api/paddle/compat/nn/functional/unfold_cn.rst b/docs/api/paddle/compat/nn/functional/unfold_cn.rst index 908ca5c370c..9428db61b36 100644 --- a/docs/api/paddle/compat/nn/functional/unfold_cn.rst +++ b/docs/api/paddle/compat/nn/functional/unfold_cn.rst @@ -25,4 +25,3 @@ Tensor，形状为 ``[N, C * kernel_size[0] * kernel_size[1], L]``。 ::::::::: COPY-FROM: paddle.compat.nn.functional.unfold - diff --git a/docs/api/paddle/compat/unique_cn.rst b/docs/api/paddle/compat/unique_cn.rst index 8a406974c94..c1c9f525f03 100644 --- a/docs/api/paddle/compat/unique_cn.rst +++ b/docs/api/paddle/compat/unique_cn.rst @@ -25,4 +25,3 @@ Tensor；当 ``return_inverse`` 或 ``return_counts`` 为 True 时，返回包 ::::::::: COPY-FROM: paddle.compat.unique - diff --git a/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst b/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst index 53018072a79..9eea89fe08f 100644 --- a/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst +++ b/docs/api/paddle/distribution/constraint/positive_definite_check_cn.rst @@ -16,4 +16,3 @@ positive_definite.check ::::::::: Tensor，bool 类型，形状为 ``value.shape[:-2]``，表示每个矩阵是否为对称正定矩阵。 - diff --git a/docs/api/paddle/float8_e5m2_cn.rst b/docs/api/paddle/float8_e5m2_cn.rst index 7a9c047624c..ad27f4d5fcf 100644 --- a/docs/api/paddle/float8_e5m2_cn.rst +++ b/docs/api/paddle/float8_e5m2_cn.rst @@ -6,4 +6,3 @@ float8_e5m2 .. py:data:: paddle.float8_e5m2 8 位浮点数据类型，包含 1 位符号、5 位指数和 2 位尾数。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 - diff --git a/docs/api/paddle/nn/init/sparse__cn.rst b/docs/api/paddle/nn/init/sparse__cn.rst index 35e5aada7b6..da3a04b7a93 100644 --- a/docs/api/paddle/nn/init/sparse__cn.rst +++ b/docs/api/paddle/nn/init/sparse__cn.rst @@ -18,4 +18,3 @@ sparse_ ::::::::: Tensor，原地初始化后的输入 Tensor。 - diff --git a/docs/api/paddle/optim/Adagrad_cn.rst b/docs/api/paddle/optim/Adagrad_cn.rst index 5a7d171d1cf..39df15f2e88 100644 --- a/docs/api/paddle/optim/Adagrad_cn.rst +++ b/docs/api/paddle/optim/Adagrad_cn.rst @@ -24,4 +24,3 @@ PyTorch 风格构造签名的 Adagrad 优化器。 - **maximize** (bool，可选) - 是否最大化目标函数。默认值：False。 - **differentiable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 - **fused** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 - diff --git a/docs/api/paddle/optim/AdamW_cn.rst b/docs/api/paddle/optim/AdamW_cn.rst index 53f95f39871..fb506650aa0 100644 --- a/docs/api/paddle/optim/AdamW_cn.rst +++ b/docs/api/paddle/optim/AdamW_cn.rst @@ -25,4 +25,3 @@ PyTorch 风格构造签名的 AdamW 优化器。 - **capturable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 - **differentiable** (bool，可选) - 兼容保留参数，当前实现会忽略 True。默认值：False。 - **fused** (bool|None，可选) - 兼容保留参数，当前实现会忽略非 None 值。默认值：None。 - diff --git a/docs/api/paddle/optim/Optimizer_cn.rst b/docs/api/paddle/optim/Optimizer_cn.rst index 50e0637401c..a14a0711742 100644 --- a/docs/api/paddle/optim/Optimizer_cn.rst +++ b/docs/api/paddle/optim/Optimizer_cn.rst @@ -28,4 +28,3 @@ step(closure=None) **返回** Tensor|None；提供 ``closure`` 时返回其结果，否则返回 None。 - diff --git a/docs/api/paddle/optim/Overview_cn.rst b/docs/api/paddle/optim/Overview_cn.rst index a88dd2b60a1..9da3be1e241 100644 --- a/docs/api/paddle/optim/Overview_cn.rst +++ b/docs/api/paddle/optim/Overview_cn.rst @@ -13,4 +13,3 @@ paddle.optim " :ref:`AdamW ` ", "PyTorch 风格的 AdamW 优化器" " :ref:`Optimizer ` ", "PyTorch 风格的优化器基类" " :ref:`SGD ` ", "PyTorch 风格的 SGD 优化器" - diff --git a/docs/api/paddle/uint16_cn.rst b/docs/api/paddle/uint16_cn.rst index b2a2110478f..35fd5bdc13c 100644 --- a/docs/api/paddle/uint16_cn.rst +++ b/docs/api/paddle/uint16_cn.rst @@ -6,4 +6,3 @@ uint16 .. py:data:: paddle.uint16 16 位无符号整数数据类型。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 - diff --git a/docs/api/paddle/uint32_cn.rst b/docs/api/paddle/uint32_cn.rst index 2d74550d74b..e821426cf75 100644 --- a/docs/api/paddle/uint32_cn.rst +++ b/docs/api/paddle/uint32_cn.rst @@ -6,4 +6,3 @@ uint32 .. py:data:: paddle.uint32 32 位无符号整数数据类型。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 - diff --git a/docs/api/paddle/uint64_cn.rst b/docs/api/paddle/uint64_cn.rst index dbfa95db964..bc9f31d61f9 100644 --- a/docs/api/paddle/uint64_cn.rst +++ b/docs/api/paddle/uint64_cn.rst @@ -6,4 +6,3 @@ uint64 .. py:data:: paddle.uint64 64 位无符号整数数据类型。可在接受 ``paddle.dtype`` 的 API 中作为 dtype 参数使用。 -