diff --git a/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst b/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst index 2eea199bcd4..0adff75ec18 100644 --- a/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst +++ b/docs/api/paddle/nn/MultiLabelSoftMarginLoss_cn.rst @@ -22,19 +22,19 @@ MultiLabelSoftMarginLoss 参数 ::::::::: - **weight** (Tensor，可选) - 手动设定权重，默认为 None - - **reduction** (str,可选) - 指定应用于输出结果的计算方式，可选值有: ``'none'``, ``'mean'``, ``'sum'`` 。默认为 ``'mean'``，计算 Loss 的均值；设置为 ``'sum'`` 时，计算 Loss 的总和；设置为 ``'none'`` 时，则返回原始 Loss。 + - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有: ``'none'``, ``'mean'``, ``'sum'`` 。默认为 ``'mean'``，计算 Loss 的均值；设置为 ``'sum'`` 时，计算 Loss 的总和；设置为 ``'none'`` 时，则返回原始 Loss。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 输入 ::::::::: - - **input** (Tensor): - 输入 Tensor，维度是 [N, *], 其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64。 - - **label** (Tensor): - 标签，维度是 [N, *], 与 ``input`` 相同，Tensor 中的值应该只包含 1 和 -1。数据类型为：float32、float64。 + - **input** (Tensor)：输入 Tensor，维度是 [N, *], 其中 N 是 batch size， `*` 是任意数量的额外维度。数据类型为：float32、float64。 + - **label** (Tensor)：标签，维度是 [N, *], 与 ``input`` 相同，Tensor 中的值应该只包含 1 和 -1。数据类型为：float32、float64。 形状 ::::::::: - - **input** (Tensor) - :math:`[N, *]` , 其中 N 是 batch_size， `*` 是任意其他维度。数据类型是 float32、float64。 - - **label** (Tensor) - :math:`[N, *]` ，标签 ``label`` 的维度、数据类型与输入 ``input`` 相同。 - - **output** (Tensor) - 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``, 则输出的维度为 :math:`[N, *]` , 与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``, 则输出的维度为 :math:`[1]` 。 + - **input** (Tensor)： :math:`[N, *]` , 其中 N 是 batch_size， `*` 是任意其他维度。数据类型是 float32、float64。 + - **label** (Tensor)： :math:`[N, *]` ，标签 ``label`` 的维度、数据类型与输入 ``input`` 相同。 + - **output** (Tensor)： 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``, 则输出的维度为 :math:`[N, *]` , 与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``, 则输出的维度为 :math:`[1]` 。 返回 diff --git a/docs/api/paddle/nn/Overview_cn.rst b/docs/api/paddle/nn/Overview_cn.rst index 1356c20d571..5c775bc38de 100644 --- a/docs/api/paddle/nn/Overview_cn.rst +++ b/docs/api/paddle/nn/Overview_cn.rst @@ -511,8 +511,8 @@ Embedding 相关函数 " :ref:`paddle.nn.functional.pixel_shuffle ` ", "将 Tensor 重新排列" " :ref:`paddle.nn.functional.pixel_unshuffle ` ", "将 Tensor 重新排列，是 pixel_shuffle 的逆操作" " :ref:`paddle.nn.functional.square_error_cost ` ", "用于计算预测值和目标值的方差估计" - " :ref:`paddle.nn.functional.unfold ` ", "对每一个卷积核覆盖下的区域，将元素重新排成一列" - " :ref:`paddle.nn.functional.fold ` ", "该 Op 用于将一个滑动局部块组合成一个大的 Tensor,通常也被称为 col2im。" + " :ref:`paddle.nn.functional.unfold ` ", "对每一个卷积核覆盖下的区域，将元素重新排成一列" + " :ref:`paddle.nn.functional.fold ` ", "用于将一个滑动局部块组合成一个大的 Tensor,通常也被称为 col2im。" " :ref:`paddle.nn.functional.gather_tree ` ", "整个束搜索结束后使用,获得每个时间步选择的的候选词 id 及其对应的在搜索树中的 parent 节点" " :ref:`paddle.nn.functional.glu ` ", "门控线性单元" " :ref:`paddle.nn.functional.pairwise_distance ` ", "计算两组向量两两之间的距离" diff --git a/docs/api/paddle/nn/Unfold_cn.rst b/docs/api/paddle/nn/Unfold_cn.rst index 5fde5689bbe..e69ceb5e304 100644 --- a/docs/api/paddle/nn/Unfold_cn.rst +++ b/docs/api/paddle/nn/Unfold_cn.rst @@ -1,9 +1,9 @@ .. _cn_api_fluid_layers_unfold: -unfold +Unfold ------------------------------- -.. py:function:: paddle.nn.Unfold(kernel_size=[3,3], strides=1, paddings=1, dilation=1, name=None) +.. py:class:: paddle.nn.Unfold(kernel_sizes, dilations=1, paddings=0, strides=1, name=None) @@ -11,7 +11,7 @@ unfold 实现的功能与卷积中用到的 im2col 函数一样，通常也被称作为 im2col 过程。对于每一个卷积核覆盖下的区域，元素会被重新排成一列。当卷积核在整个图片上滑动时，将会形成一系列的列向量。对于每一个输入形状为[N, C, H, W]的 ``x``，都将会按照下面公式计算出一个形状为[N, Cout, Lout]的输出。 .. note:: - 对应的 `functional 方法` 请参考：:ref:`cn_api_nn_functional_unfold` 。 + 对应的 `functional 方法` 请参考：:ref:`cn_api_nn_functional_unfold`。 **样例**： @@ -31,10 +31,10 @@ unfold 参数 :::::::::::: - - **kernel_size** (int|list of int) – 卷积核的尺寸，整数或者整型列表。如果为整型列表，应包含两个元素 ``[k_h, k_w]``，卷积核大小为 ``k_h * k_w``；如果为整数 k，会被当作整型列表 ``[k, k]`` 处理 - - **strides** (int|list of int，可选) – 卷积步长，整数或者整型列表。如果为整型列表，应该包含两个元素 ``[stride_h, stride_w]``。如果为整数，则 ``stride_h = stride_w = strides``。默认值为 1 - - **paddings** (int|list of int，可选) – 每个维度的扩展，整数或者整型列表。如果为整型列表，长度应该为 4 或者 2；长度为 4 对应的 padding 参数是：[padding_top, padding_left，padding_bottom, padding_right]，长度为 2 对应的 padding 参数是[padding_h, padding_w]，会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding，则会被当作[padding, padding, padding, padding]处理。默认值为 0 + - **kernel_sizes** (int|list of int) – 卷积核的尺寸，整数或者整型列表。如果为整型列表，应包含两个元素 ``[k_h, k_w]``，卷积核大小为 ``k_h * k_w``；如果为整数 k，会被当作整型列表 ``[k, k]`` 处理 - **dilations** (int|list of int，可选) – 卷积膨胀，整型列表或者整数。如果为整型列表，应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation，会被当作整型列表[dilation, dilation]处理。默认值为 1 + - **paddings** (int|list of int，可选) – 每个维度的扩展，整数或者整型列表。如果为整型列表，长度应该为 4 或者 2；长度为 4 对应的 padding 参数是：[padding_top, padding_left，padding_bottom, padding_right]，长度为 2 对应的 padding 参数是[padding_h, padding_w]，会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding，则会被当作[padding, padding, padding, padding]处理。默认值为 0 + - **strides** (int|list of int，可选) – 卷积步长，整数或者整型列表。如果为整型列表，应该包含两个元素 ``[stride_h, stride_w]``。如果为整数，则 ``stride_h = stride_w = strides``。默认值为 1 - **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 96aabb5b14c..0f64d39f51a 100644 --- a/docs/api/paddle/nn/Upsample_cn.rst +++ b/docs/api/paddle/nn/Upsample_cn.rst @@ -6,7 +6,7 @@ Upsample .. py:class:: paddle.nn.Upsample(size=None, scale_factor=None, mode='nearest', align_corners=False, align_mode=0, data_format='NCHW', name=None) -该 OP 用于调整一个 batch 中图片的大小。 +用于调整一个 batch 中图片的大小。 输入为 3-D Tensor 时形状为(num_batches, channels, in_w)，输入为 4-D Tensor 时形状为(num_batches, channels, in_h, in_w)或者(num_batches, in_h, in_w, channels)，输入为 5-D Tensor 时形状为(num_batches, channels, in_d, in_h, in_w)或者(num_batches, in_d, in_h, in_w, channels)，并且调整大小只适用于深度，高度和宽度对应的维度。 @@ -150,17 +150,17 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation 参数 ::::::::: - - **size** (list|tuple|Variable|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:`out_shape` 是列表，每一个元素可以是整数或者形状为[1]的变量。如果 :code:`out_shape` 是变量，则其维度大小为 1。默认值为 None。 - - **scale_factor** (float|Tensor|list|tuple|None)-输入的高度或宽度的乘数因子。out_shape 和 scale 至少要设置一个。out_shape 的优先级高于 scale。默认值为 None。如果 scale_factor 是一个 list 或 tuple，它必须与输入的 shape 匹配。 + - **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` 是列表，每一个元素可以是整数或者形状为[1]的变量。如果 :code:`size` 是变量，则其维度大小为 1。默认值为 None。 + - **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 个角落像素的中心对齐，并保留角点像素的值。默认值为 True - - **align_mode** （int，可选）- 双线性插值的可选项。可以是 '0' 代表 src_idx = scale *（dst_indx + 0.5）-0.5；如果为'1'，代表 src_idx = scale * dst_index。 - - **data_format** （str，可选）- 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 3-D Tensor，支持 NCHW(num_batches, channels, width)，对于 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，可选) - 指定输入的数据格式，输出的数据格式将与输入保持一致。对于 3-D Tensor，支持 NCW(num_batches, channels, width)或者 NWC(num_batches, width, channels)，对于 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。 返回 :::::::::::: -3-D Tensor，形状为 (num_batches, channels, out_w) ；4-D Tensor，形状为 (num_batches, channels, out_h, out_w) 或 (num_batches, out_h, out_w, channels)；或者 5-D Tensor，形状为 (num_batches, channels, out_d, out_h, out_w) 或 (num_batches, out_d, out_h, out_w, channels)。 +3-D Tensor，形状为(num_batches, channels, out_w)或者(num_batches, out_w, channels)；4-D Tensor，形状为 (num_batches, channels, out_h, out_w) 或 (num_batches, out_h, out_w, channels)；或者 5-D Tensor，形状为 (num_batches, channels, out_d, out_h, out_w) 或 (num_batches, out_d, out_h, out_w, channels)。 代码示例 diff --git a/docs/api/paddle/nn/functional/mse_loss_cn.rst b/docs/api/paddle/nn/functional/mse_loss_cn.rst index c994f94d6a5..4ccc6454aa0 100644 --- a/docs/api/paddle/nn/functional/mse_loss_cn.rst +++ b/docs/api/paddle/nn/functional/mse_loss_cn.rst @@ -29,13 +29,13 @@ mse_loss ::::::::: - **input** (Tensor) - 预测值，维度为 :math:`[N_1, N_2, ..., N_k]` 的多维 Tensor。数据类型为 float32 或 float64。 - **label** (Tensor) - 目标值，维度为 :math:`[N_1, N_2, ..., N_k]` 的多维 Tensor。数据类型为 float32 或 float64。 - - **reduction** (string, optional) - 输出的归约方法可以是'none'、'mean'或'sum'。 + - **reduction** (str, 可选) - 输出的归约方法可以是'none'、'mean'或'sum'。 - 如果 :attr:`reduction` 是 ``'mean'``，则返回减少的平均损失。 - 如果 :attr:`reduction` 是 ``'sum'``，则返回减少的总损失。 - 如果 :attr: `reduction` 为 `'none'`，返回未减少的损失。默认为 `'mean'`。 - - **name** (str, optional) - 操作的名称（可选，默认为 None）。 更多信息请参考:ref:`api_guide_Name`。 + - **name** (str, 可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 ::::::::: diff --git a/docs/api/paddle/nn/functional/unfold_cn.rst b/docs/api/paddle/nn/functional/unfold_cn.rst index 1428b73ae0b..3c33521ab88 100644 --- a/docs/api/paddle/nn/functional/unfold_cn.rst +++ b/docs/api/paddle/nn/functional/unfold_cn.rst @@ -1,4 +1,4 @@ -.. _cn_api_fluid_layers_unfold: +.. _cn_api_nn_functional_unfold: unfold ------------------------------- @@ -47,7 +47,7 @@ unfold - **strides** (int|list of int，可选) – 卷积步长，整数或者整型列表。如果为整型列表，应该包含两个元素 ``[stride_h, stride_w]``。如果为整数，则 ``stride_h = stride_w = strides``。默认值为 1 - **paddings** (int|list of int，可选) – 每个维度的扩展，整数或者整型列表。如果为整型列表，长度应该为 4 或者 2；长度为 4 对应的 padding 参数是：[padding_top, padding_left，padding_bottom, padding_right]，长度为 2 对应的 padding 参数是[padding_h, padding_w]，会被当作[padding_h, padding_w, padding_h, padding_w]处理。如果为整数 padding，则会被当作[padding, padding, padding, padding]处理。默认值为 0 - **dilations** (int|list of int，可选) – 卷积膨胀，整型列表或者整数。如果为整型列表，应该包含两个元素[dilation_h, dilation_w]。如果是整数 dilation，会被当作整型列表[dilation, dilation]处理。默认值为 1 - - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 + - **name** (str，可选) – 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回