update nn.functional docs

TCChenlong · TCChenlong · commit a5d0c27ea89d · 2022-03-31T16:54:21.000+08:00
diff --git a/docs/api/paddle/nn/functional/adaptive_avg_pool1d_cn.rst b/docs/api/paddle/nn/functional/adaptive_avg_pool1d_cn.rst
@@ -23,9 +23,6 @@ adaptive_avg_pool1d
 :::::::::
 ``Tensor``, 输入 `x` 经过自适应池化计算得到的目标3-D Tensor，其数据类型与输入相同。
 
-抛出异常
-:::::::::
-    - ``ValueError`` - ``output_size`` 应是一个整数。
 
 代码示例
 :::::::::
diff --git a/docs/api/paddle/nn/functional/adaptive_avg_pool2d_cn.rst b/docs/api/paddle/nn/functional/adaptive_avg_pool2d_cn.rst
@@ -34,9 +34,6 @@ adaptive_avg_pool2d
 :::::::::
 ``Tensor``, 默认形状为（批大小，通道数，输出特征高度，输出特征宽度），即NCHW格式的4-D Tensor，其数据类型与输入相同。
 
-抛出异常
-:::::::::
-    - ``ValueError`` - 如果 ``data_format`` 既不是"NCHW"也不是"NHWC"。
 
 代码示例
 :::::::::
diff --git a/docs/api/paddle/nn/functional/adaptive_avg_pool3d_cn.rst b/docs/api/paddle/nn/functional/adaptive_avg_pool3d_cn.rst
@@ -39,9 +39,6 @@ adaptive_avg_pool3d
 :::::::::
 ``Tensor``, 默认形状为（批大小，通道数，输出特征长度，输出特征高度，输出特征宽度），即NCDHW格式的5-D Tensor，其数据类型与输入相同。
 
-抛出异常
-:::::::::
-    - ``ValueError`` - 如果 ``data_format`` 既不是"NCDHW"也不是"NDHWC"。
 
 代码示例
 :::::::::
diff --git a/docs/api/paddle/nn/functional/adaptive_max_pool1d_cn.rst b/docs/api/paddle/nn/functional/adaptive_max_pool1d_cn.rst
@@ -24,9 +24,6 @@ adaptive_max_pool1d
 :::::::::
 ``Tensor``, 输入 `x` 经过自适应池化计算得到的目标3-D Tensor，其数据类型与输入相同。
 
-抛出异常
-:::::::::
-    - ``ValueError`` - 如果 ``output_size`` 不是int类型值。
 
 代码示例
 :::::::::
diff --git a/docs/api/paddle/nn/functional/class_center_sample_cn.rst b/docs/api/paddle/nn/functional/class_center_sample_cn.rst
@@ -16,6 +16,7 @@ class_center_sample
 更多的细节信息，请参考论文《Partial FC: Training 10 Million Identities on a Single Machine》，arxiv: https://arxiv.org/abs/2010.05222
 
 提示:
+
     如果正类别中心数量大于给定的 ``num_samples``，将保留所有的正类别中心，因此 ``sampled_class_center`` 的维度将是 [``num_positive_class_centers``]。
 
 
@@ -32,10 +33,6 @@ class_center_sample
 
     ``Tensor`` 二元组 - (``remapped_label``, ``sampled_class_center``)，``remapped_label`` 是重新映射后的标签，``sampled_class_center`` 是所采样的类别中心。
 
-抛出异常
-::::::::::::
-
-    - :code:`ValueError` - ``num_samples`` > ``num_classes`` 时抛出异常。
 
 代码示例
 ::::::::::::
diff --git a/docs/api/paddle/nn/functional/conv1d_cn.rst b/docs/api/paddle/nn/functional/conv1d_cn.rst
@@ -14,6 +14,7 @@ conv1d
     Out = \sigma \left ( W * X + b \right )
 
 其中：
+
     - :math:`X` ：输入值，NCL或NLC格式的3-D Tensor
     - :math:`W` ：卷积核值，MCL格式的3-D Tensor
     - :math:`*` ：卷积操作
diff --git a/docs/api/paddle/nn/functional/conv1d_transpose_cn.rst b/docs/api/paddle/nn/functional/conv1d_transpose_cn.rst
@@ -21,6 +21,7 @@ conv1d_transpose
                         Out=\sigma (W*X+b)\\
 
 其中：
+
     -  :math:`X` : 输入，具有NCL或NLC格式的3-D Tensor
     -  :math:`W` : 卷积核，具有NCL格式的3-D Tensor
     -  :math:`*` : 卷积计算（注意：转置卷积本质上的计算还是卷积）
diff --git a/docs/api/paddle/nn/functional/conv2d_cn.rst b/docs/api/paddle/nn/functional/conv2d_cn.rst
@@ -14,6 +14,7 @@ conv2d
     Out = \sigma \left ( W * X + b \right )
 
 其中：
+
     - :math:`X` ：输入值，NCHW或NHWC格式的4-D Tensor
     - :math:`W` ：卷积核值，MCHW格式的4-D Tensor
     - :math:`*` ：卷积操作
diff --git a/docs/api/paddle/nn/functional/conv2d_transpose_cn.rst b/docs/api/paddle/nn/functional/conv2d_transpose_cn.rst
@@ -21,6 +21,7 @@ conv2d_transpose
                         Out=\sigma (W*X+b)\\
 
 其中：
+
     -  :math:`X` : 输入，具有NCHW或NHWC格式的4-D Tensor
     -  :math:`W` : 卷积核，具有NCHW格式的4-D Tensor
     -  :math:`*` : 卷积计算（注意：转置卷积本质上的计算还是卷积）
diff --git a/docs/api/paddle/nn/functional/conv3d_cn.rst b/docs/api/paddle/nn/functional/conv3d_cn.rst
@@ -14,6 +14,7 @@ conv3d
     Out = \sigma \left ( W * X + b \right )
 
 其中：
+
     - :math:`X` ：输入值，NCDHW或NDHWC格式的5-D Tensor
     - :math:`W` ：卷积核值，MCDHW格式的5-D Tensor
     - :math:`*` ：卷积操作
diff --git a/docs/api/paddle/nn/functional/conv3d_transpose_cn.rst b/docs/api/paddle/nn/functional/conv3d_transpose_cn.rst
@@ -21,6 +21,7 @@ conv3d_transpose
                         \\Out=\sigma (W*X+b)\\
 
 其中：
+
     -  :math:`X` : 输入，具有NCDHW或NDHWC格式的5-D Tensor
     -  :math:`W` : 卷积核，具有NCDHW格式的5-D Tensor
     -  :math:`*` : 卷积操作（注意：转置卷积本质上的计算还是卷积）
diff --git a/docs/api/paddle/nn/functional/cosine_similarity_cn.rst b/docs/api/paddle/nn/functional/cosine_similarity_cn.rst
@@ -18,11 +18,7 @@ cosine_similarity
   
 返回
 ::::::::::::
- 余弦相似度的计算结果，数据类型与x1, x2相同。
-
-返回类型
-::::::::::::
-Tensor
+Tensor, 余弦相似度的计算结果，数据类型与x1, x2相同。
 
 
 
diff --git a/docs/api/paddle/nn/functional/embedding_cn.rst b/docs/api/paddle/nn/functional/embedding_cn.rst
@@ -49,11 +49,8 @@ embedding
 
 返回
 ::::::::::::
-input映射后得到的Embedding Tensor，数据类型和权重定义的类型一致。
+Tensor, input映射后得到的Embedding Tensor，数据类型和权重定义的类型一致。
 
-返回类型
-::::::::::::
-Tensor
 
 代码示例
 ::::::::::::
diff --git a/docs/api/paddle/nn/functional/grid_sample_cn.rst b/docs/api/paddle/nn/functional/grid_sample_cn.rst
@@ -64,11 +64,8 @@ step 2：
 
 返回
 ::::::::::::
- 输入X基于输入网格的双线性插值计算结果，维度为 :math:`[N, C, H, W]` 的4-D Tensor
+Tensor, 输入X基于输入网格的双线性插值计算结果，维度为 :math:`[N, C, H, W]` 的4-D Tensor, 数据类型与 ``x`` 一致。
 
-返回类型
-::::::::::::
-变量(Tensor)，数据类型与 ``x`` 一致
 
 代码示例
 ::::::::::::
diff --git a/docs/api/paddle/nn/functional/hardswish_cn.rst b/docs/api/paddle/nn/functional/hardswish_cn.rst
@@ -21,8 +21,6 @@ hardswish激活函数。在MobileNetV3架构中被提出，相较于swish函数
 其中，:math:`x` 为输入的 Tensor
 
 参数
-::::::::::::
-
 ::::::::::
     - x (Tensor) - 输入的 ``Tensor`` ，数据类型为：float32、float64。
     - name (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
diff --git a/docs/api/paddle/nn/functional/interpolate_cn.rst b/docs/api/paddle/nn/functional/interpolate_cn.rst
@@ -155,24 +155,6 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation
 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)。
 
 
-抛出异常
-::::::::::::
-
-    - :code:`TypeError` - out_shape应该是一个列表、元组或张量。
-    - :code:`TypeError` - actual_shape应该是变量或None。
-    - :code:`ValueError` - interpolate的"mode"只能是"BILINEAR"或"TRILINEAR"或"NEAREST"或"BICUBIC"或"LINEAR"或"AREA"。
-    - :code:`ValueError` - 'linear' 只支持 3-D tensor。
-    - :code:`ValueError` - 'bilinear', 'bicubic' ，'nearest' 只支持 4-D tensor。
-    - :code:`ValueError` - 'trilinear' 只支持 5-D tensor
-    - :code:`ValueError` - out_shape 和 scale 不可同时为 None。
-    - :code:`ValueError` - out_shape 的长度必须为1如果输入是3D张量
-    - :code:`ValueError` - out_shape 的长度必须为2如果输入是4D张量。
-    - :code:`ValueError` - out_shape 的长度必须为3如果输入是5D张量。
-    - :code:`ValueError` - scale应大于0。
-    - :code:`TypeError`  - align_corners 应为bool型。
-    - :code:`ValueError` - align_mode 只能取 ‘0’ 或 ‘1’。
-    - :code:`ValueError` - data_format 只能取 'NCW', 'NCHW'、'NHWC'、'NCDHW' 或者 'NDHWC'。
-
 代码示例
 ::::::::::::
 
diff --git a/docs/api/paddle/nn/functional/local_response_norm_cn.rst b/docs/api/paddle/nn/functional/local_response_norm_cn.rst
@@ -14,6 +14,7 @@ local_response_norm
     Output(i,x,y) = Input(i,x,y)/\left ( k+\alpha \sum_{j=max(0,i-size/2)}^{min(C-1,i+size/2)}(Input(j,x,y))^2 \right )^\beta
 
 在以上公式中：
+
   - :math:`size` ：累加的通道数
   - :math:`k` ：位移
   - :math:`\alpha` ： 缩放参数
diff --git a/docs/api/paddle/nn/functional/margin_cross_entropy_cn.rst b/docs/api/paddle/nn/functional/margin_cross_entropy_cn.rst
@@ -11,6 +11,7 @@ margin_cross_entropy
 其中，:math:`\theta_{y_i}` 是特征 :math:`x` 与类 :math:`w_{i}` 的角度。更详细的介绍请参考 ``Arcface loss``，https://arxiv.org/abs/1801.07698 。
 
 提示:
+
     这个 API 支持单卡，也支持多卡（模型并行），使用模型并行时，``logits.shape[-1]`` 在每张卡上可以不同。
 
 参数
@@ -31,11 +32,6 @@ margin_cross_entropy
 
     - ``Tensor`` (``loss``) 或者 ``Tensor`` 二元组 (``loss``, ``softmax``) - 如果 ``return_softmax=False`` 返回 ``loss``，否则返回 (``loss``, ``softmax``)。当使用模型并行时 ``softmax == shard_softmax``，否则 ``softmax`` 的维度与 ``logits`` 相同。如果 ``reduction == None``，``loss`` 的维度为 ``[N, 1]``，否则为 ``[1]``。
 
-抛出异常
-::::::::::::
-
-    - :code:`ValueError` - ``logits_dims - 1 != label_dims and logits_dims != label_dims`` 时抛出异常。
-
 代码示例
 ::::::::::::
 COPY-FROM: paddle.nn.functional.margin_cross_entropy:code-example1
diff --git a/docs/api/paddle/nn/functional/mse_loss_cn.rst b/docs/api/paddle/nn/functional/mse_loss_cn.rst
@@ -26,8 +26,6 @@ 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。
diff --git a/docs/api/paddle/nn/functional/normalize_cn.rst b/docs/api/paddle/nn/functional/normalize_cn.rst
@@ -29,11 +29,6 @@ normalize
 :::::::::
 ``Tensor``, 输出的形状和数据类型和 ``x`` 相同。
 
-抛出异常
-::::::::::::
-
-:::::::::
-    - ``TypeError`` - 当参数  ``p`` 或者 ``axis`` 的类型不符合要求时。或者当参数 ``x`` 的类型或数据类型不符合要求时。
 
 代码示例
 :::::::::
diff --git a/docs/api/paddle/nn/functional/npair_loss_cn.rst b/docs/api/paddle/nn/functional/npair_loss_cn.rst
@@ -22,7 +22,6 @@ NPair损失需要成对的数据。NPair损失分为两部分：第一部分是
 返回
 ::::::::::::
 
-:::::::::
 经过npair loss计算之后的结果 `Tensor` 。
 
 
diff --git a/docs/api/paddle/nn/functional/pad_cn.rst b/docs/api/paddle/nn/functional/pad_cn.rst
@@ -27,11 +27,11 @@ pad
   - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。
 返回
 ::::::::::::
- 对 ``x`` 进行 ``'pad'`` 的结果，数据类型和 ``x`` 相同。
+Tensor, 对 ``x`` 进行 ``'pad'`` 的结果，数据类型和 ``x`` 相同。
 
 返回类型
-::::::::::::
-Tensor
+
+
 
 **示例**：
 
diff --git a/docs/api/paddle/nn/functional/relu6_cn.rst b/docs/api/paddle/nn/functional/relu6_cn.rst
@@ -14,8 +14,6 @@ relu6激活层
 其中，:math:`x` 为输入的 Tensor
 
 参数
-::::::::::::
-
 ::::::::::
  - x (Tensor) - 输入的 ``Tensor`` ，数据类型为：float32、float64。
  - name (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
diff --git a/docs/api/paddle/nn/functional/softmax_with_cross_entropy_cn.rst b/docs/api/paddle/nn/functional/softmax_with_cross_entropy_cn.rst
@@ -48,9 +48,6 @@ softmax_with_cross_entropy
   - 如果 ``return_softmax`` 为 False，则返回交叉熵损失结果的 ``Tensor`` ，数据类型和 ``logits`` 一致，除了 ``axis`` 维度上的形状为1，其余维度和 ``logits`` 一致。
   - 如果 ``return_softmax`` 为 True，则返回交叉熵损失结果的 ``Tensor`` 和softmax结果的 ``Tensor`` 组成的元组。其中交叉熵损失结果的数据类型和 ``logits`` 一致，除了 ``axis`` 维度上的形状为1，其余维度上交叉熵损失结果和 ``logits`` 一致；softmax结果的数据类型和 ``logits`` 一致，维度和 ``logits`` 一致。
 
-返回类型
-::::::::::::
-变量或者两个变量组成的元组
 
 代码示例
 ::::::::::::
diff --git a/docs/api/paddle/nn/functional/softsign_cn.rst b/docs/api/paddle/nn/functional/softsign_cn.rst
@@ -14,8 +14,6 @@ softsign激活层
 其中，:math:`x` 为输入的 Tensor
 
 参数
-::::::::::::
-
 ::::::::::
  - x (Tensor) - 输入的 ``Tensor`` ，数据类型为：float32、float64。
  - name (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
diff --git a/docs/api/paddle/nn/functional/sparse_attention_cn.rst b/docs/api/paddle/nn/functional/sparse_attention_cn.rst
@@ -18,8 +18,6 @@ sparse_attention
     目前该API只在CUDA11.3及以上版本中使用。
 
 参数
-::::::::::::
-
 :::::::::
   - query (Tensor) - 输入的Tensor，代表注意力模块中的 ``query`` ，这是一个4维Tensor，形状为 :[batch_size, num_heads, seq_len, head_dim]，数据类型为float32或float64。
   - key (Tensor) - 输入的Tensor，代表注意力模块中的 ``key`` ，这是一个4维Tensor，形状为 :[batch_size, num_heads, seq_len, head_dim]，数据类型为float32或float64。
@@ -28,8 +26,6 @@ sparse_attention
   - sparse_csr_columns (Tensor) - 输入的Tensor，注意力模块中的稀疏特性，稀疏特性使用CSR格式表示， ``colunms`` 代表矩阵中每一行非零元的列索引值。这是一个3维Tensor，形状为 :[batch_size, num_heads, sparse_nnz]，数据类型为int32。
 
 返回
-::::::::::::
-
 :::::::::
   ``Tensor`` ，代表注意力模块的结果。这是一个4维Tensor，形状为 :[batch_size, num_heads, seq_len, head_dim]，数据类型为float32或float64。
 
diff --git a/docs/api/paddle/nn/functional/tanhshrink_cn.rst b/docs/api/paddle/nn/functional/tanhshrink_cn.rst
@@ -14,8 +14,6 @@ tanhshrink激活层
 其中，:math:`x` 为输入的 Tensor
 
 参数
-::::::::::::
-
 ::::::::::
  - x (Tensor) - 输入的 ``Tensor`` ，数据类型为：float32、float64。
  - name (str, 可选) - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
diff --git a/docs/api/paddle/nn/functional/upsample_cn.rst b/docs/api/paddle/nn/functional/upsample_cn.rst
@@ -154,25 +154,6 @@ https://en.wikipedia.org/wiki/Bicubic_interpolation
 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)。
 
 
-抛出异常
-::::::::::::
-
-    - :code:`TypeError` - out_shape应该是一个列表、元组或张量。
-    - :code:`TypeError` - actual_shape应该是变量或None。
-    - :code:`ValueError` - upsample的"resample"只能是"BILINEAR"或"TRILINEAR"或"NEAREST"或"BICUBIC"或"LINEAR"或"AREA"。
-    - :code:`ValueError` - 'linear' 只支持 3-D tensor。
-    - :code:`ValueError` - 'bilinear', 'bicubic' ，'nearest' 只支持 4-D tensor。
-    - :code:`ValueError` - 'trilinear' 只支持 5-D tensor
-    - :code:`ValueError` - out_shape 和 scale 不可同时为 None。
-    - :code:`ValueError` - out_shape 的长度必须为1如果输入是3D张量
-    - :code:`ValueError` - out_shape 的长度必须为2如果输入是4D张量。
-    - :code:`ValueError` - out_shape 的长度必须为3如果输入是5D张量。
-    - :code:`ValueError` - scale应大于0。
-    - :code:`TypeError`  - align_corners 应为bool型。
-    - :code:`ValueError` - align_mode 只能取 ‘0’ 或 ‘1’。
-    - :code:`ValueError` - data_format 只能取 'NCW', 'NCHW'、'NHWC'、'NCDHW' 或者 'NDHWC'。
-
-
 代码示例
 ::::::::::::
 
diff --git a/docs/api/paddle/nn/utils/spectral_norm_cn.rst b/docs/api/paddle/nn/utils/spectral_norm_cn.rst
@@ -26,6 +26,8 @@ spectral_norm
 可参考: `Spectral Normalization <https://arxiv.org/abs/1802.05957>`_
 
 参数
+::::::::::::
+
     - **layer** (paddle.nn.Layer) - 要添加权重谱归一化的层。
     - **name** (str, 可选) - 权重参数的名字。默认：'weight'.
     - **n_power_iterations** (int, 可选) - 将用于计算的 ``SpectralNorm`` 幂迭代次数，默认值：1。
