diff --git a/doc/fluid/api_cn/backward_cn/append_backward_cn.rst b/doc/fluid/api_cn/backward_cn/append_backward_cn.rst index b3aa98f93e501d66687689c47c611677b4d7673e..05532cbfdc7831edf94db113bb51716ffb5fc508 100644 --- a/doc/fluid/api_cn/backward_cn/append_backward_cn.rst +++ b/doc/fluid/api_cn/backward_cn/append_backward_cn.rst @@ -7,6 +7,12 @@ append_backward .. py:function:: paddle.fluid.backward.append_backward(loss, parameter_list=None, no_grad_set=None, callbacks=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.append_backward +:alias: paddle.append_backward,paddle.framework.append_backward +:old_api: paddle.fluid.backward.append_backward + + + diff --git a/doc/fluid/api_cn/backward_cn/gradients_cn.rst b/doc/fluid/api_cn/backward_cn/gradients_cn.rst index 0165f7f2f3d0bc61bde4b08c3b79ddf1fee4e4ba..10dd8862a503c3d01bec6538a0034266e318e2bb 100644 --- a/doc/fluid/api_cn/backward_cn/gradients_cn.rst +++ b/doc/fluid/api_cn/backward_cn/gradients_cn.rst @@ -7,6 +7,12 @@ gradients .. py:function:: paddle.fluid.backward.gradients(targets, inputs, target_gradients=None, no_grad_set=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.gradients +:alias: paddle.gradients,paddle.framework.gradients +:old_api: paddle.fluid.backward.gradients + + + diff --git a/doc/fluid/api_cn/clip_cn/GradientClipByGlobalNorm_cn.rst b/doc/fluid/api_cn/clip_cn/GradientClipByGlobalNorm_cn.rst index 58558411f3cd13208aebb6c5bf6050fe16c29854..e080728ef5540749a68b80f50b4d05cebcf8134d 100644 --- a/doc/fluid/api_cn/clip_cn/GradientClipByGlobalNorm_cn.rst +++ b/doc/fluid/api_cn/clip_cn/GradientClipByGlobalNorm_cn.rst @@ -10,6 +10,9 @@ GradientClipByGlobalNorm :old_api: paddle.fluid.clip.GradientClipByGlobalNorm + + + 将一个 Tensor列表 :math:`t\_list` 中所有Tensor的L2范数之和，限定在 ``clip_norm`` 范围内。 diff --git a/doc/fluid/api_cn/clip_cn/GradientClipByNorm_cn.rst b/doc/fluid/api_cn/clip_cn/GradientClipByNorm_cn.rst index 07199a3a60f6683fc06d4b7e4253f2ac58d84bdd..2172648ecd7a2f2714619245fedff1b059baa614 100644 --- a/doc/fluid/api_cn/clip_cn/GradientClipByNorm_cn.rst +++ b/doc/fluid/api_cn/clip_cn/GradientClipByNorm_cn.rst @@ -11,6 +11,9 @@ GradientClipByNorm + + + 将输入的多维Tensor :math:`X` 的L2范数限制在 ``clip_norm`` 范围之内。 - 如果L2范数大于 ``clip_norm`` ，则该 Tensor 会乘以一个系数进行压缩 diff --git a/doc/fluid/api_cn/clip_cn/GradientClipByValue_cn.rst b/doc/fluid/api_cn/clip_cn/GradientClipByValue_cn.rst index 58e218cb9888a49d06bbfebdddce3a1506f5fc76..faa3b3c55d01ed811e43a3b09edc551d0a905c30 100644 --- a/doc/fluid/api_cn/clip_cn/GradientClipByValue_cn.rst +++ b/doc/fluid/api_cn/clip_cn/GradientClipByValue_cn.rst @@ -12,6 +12,9 @@ GradientClipByValue + + + 将输入的多维Tensor :math:`X` 的值限制在 [min, max] 范围。 输入的 Tensor 不是从该类里传入， 而是默认会选择 ``Program`` 中全部的梯度，如果 ``need_clip`` 不为None，则可以只选择部分参数进行梯度裁剪。 diff --git a/doc/fluid/api_cn/clip_cn/set_gradient_clip_cn.rst b/doc/fluid/api_cn/clip_cn/set_gradient_clip_cn.rst index eae01c0c3f58774f874caf19785444c7dae3df64..38df027d7ef7044b826246ed0cec3d4ab14915d2 100644 --- a/doc/fluid/api_cn/clip_cn/set_gradient_clip_cn.rst +++ b/doc/fluid/api_cn/clip_cn/set_gradient_clip_cn.rst @@ -10,6 +10,9 @@ set_gradient_clip + + + .. warning:: 此API对位置使用的要求较高，其必须位于组建网络之后， ``minimize`` 之前，因此在未来版本中可能被删除，故不推荐使用。推荐在 ``optimizer`` 初始化时设置梯度裁剪。 有三种裁剪策略： :ref:`cn_api_fluid_clip_GradientClipByGlobalNorm` 、 :ref:`cn_api_fluid_clip_GradientClipByNorm` 、 :ref:`cn_api_fluid_clip_GradientClipByValue` 。 diff --git a/doc/fluid/api_cn/dygraph_cn/BackwardStrategy_cn.rst b/doc/fluid/api_cn/dygraph_cn/BackwardStrategy_cn.rst index e5bee2a137388d489c2a8de4e31ff6e4ace4b006..2d0c815bd174f04f27bc974ba99cdd78203f2f6a 100644 --- a/doc/fluid/api_cn/dygraph_cn/BackwardStrategy_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/BackwardStrategy_cn.rst @@ -10,6 +10,9 @@ BackwardStrategy + + + **注意：该API只在动态图下生效** BackwardStrategy是描述动态图反向执行的策略，主要功能是定义动态图反向执行时的不同策略 diff --git a/doc/fluid/api_cn/dygraph_cn/BatchNorm_cn.rst b/doc/fluid/api_cn/dygraph_cn/BatchNorm_cn.rst index bede52decd8cf46131fd2cdf6b0b91673fd34781..eed5384991394e25e5deca405caa72c8b69b2f50 100644 --- a/doc/fluid/api_cn/dygraph_cn/BatchNorm_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/BatchNorm_cn.rst @@ -11,6 +11,9 @@ BatchNorm + + + 该接口用于构建 ``BatchNorm`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。其中实现了批归一化层（Batch Normalization Layer）的功能，可用作卷积和全连接操作的批归一化函数，根据当前批次数据按通道计算的均值和方差进行归一化。更多详情请参考 : `Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift `_ 当use_global_stats = False时，:math:`\mu_{\beta}` 和 :math:`\sigma_{\beta}^{2}` 是minibatch的统计数据。计算公式如下： diff --git a/doc/fluid/api_cn/dygraph_cn/BilinearTensorProduct_cn.rst b/doc/fluid/api_cn/dygraph_cn/BilinearTensorProduct_cn.rst index 59b18c17a32951135e431ef036a6d32771651399..7aa817d86fca4628b2c5c37d159977e4d601c97c 100644 --- a/doc/fluid/api_cn/dygraph_cn/BilinearTensorProduct_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/BilinearTensorProduct_cn.rst @@ -11,6 +11,9 @@ BilinearTensorProduct + + + 该接口用于构建 ``BilinearTensorProduct`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。双线性乘积计算式子如下。 .. math:: diff --git a/doc/fluid/api_cn/dygraph_cn/Conv2DTranspose_cn.rst b/doc/fluid/api_cn/dygraph_cn/Conv2DTranspose_cn.rst index b500bdbf6c7884f1bc263532eb0f3db379790fa8..ab8958ae666ac06cf76200d27af17541dffeb507 100644 --- a/doc/fluid/api_cn/dygraph_cn/Conv2DTranspose_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Conv2DTranspose_cn.rst @@ -5,6 +5,11 @@ Conv2DTranspose .. py:class:: paddle.fluid.dygraph.Conv2DTranspose(num_channels, num_filters, filter_size, output_size=None, padding=0, stride=1, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, dtype="float32") +:alias_main: paddle.nn.Conv2DTranspose +:alias: paddle.nn.Conv2DTranspose,paddle.nn.layer.Conv2DTranspose,paddle.nn.layer.conv.Conv2DTranspose + + + diff --git a/doc/fluid/api_cn/dygraph_cn/Conv3DTranspose_cn.rst b/doc/fluid/api_cn/dygraph_cn/Conv3DTranspose_cn.rst index a3e4134d1e6a31dd8e206bcf5546d511a79e9d7a..aef1dddc3e520cf3be397c97396eff597259eb59 100644 --- a/doc/fluid/api_cn/dygraph_cn/Conv3DTranspose_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Conv3DTranspose_cn.rst @@ -5,6 +5,11 @@ Conv3DTranspose .. py:class:: paddle.fluid.dygraph.Conv3DTranspose(num_channels, num_filters, filter_size, output_size=None, padding=0, stride=1, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, name=None, dtype="float32") +:alias_main: paddle.nn.Conv3DTranspose +:alias: paddle.nn.Conv3DTranspose,paddle.nn.layer.Conv3DTranspose,paddle.nn.layer.conv.Conv3DTranspose + + + diff --git a/doc/fluid/api_cn/dygraph_cn/Conv3D_cn.rst b/doc/fluid/api_cn/dygraph_cn/Conv3D_cn.rst index 9e0291edba17ab22bc5288e21b4e16ee5a0305f0..82476178a51610642d9f611dcf6d5a315e26b75e 100644 --- a/doc/fluid/api_cn/dygraph_cn/Conv3D_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Conv3D_cn.rst @@ -5,6 +5,11 @@ Conv3D .. py:class:: paddle.fluid.dygraph.Conv3D(num_channels, num_filters, filter_size, stride=1, padding=0, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, dtype="float32") +:alias_main: paddle.nn.Conv3D +:alias: paddle.nn.Conv3D,paddle.nn.layer.Conv3D,paddle.nn.layer.conv.Conv3D + + + diff --git a/doc/fluid/api_cn/dygraph_cn/CosineDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/CosineDecay_cn.rst index 92ffd6338eddd0034b8d2cb3f06ddb7d9c537018..58e34bd01a9ee09b157df3c02cb27383f34815f7 100644 --- a/doc/fluid/api_cn/dygraph_cn/CosineDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/CosineDecay_cn.rst @@ -10,6 +10,9 @@ CosineDecay + + + 该接口提供按余弦函数衰减学习率的功能。 余弦衰减的计算方式如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/Embedding_cn.rst b/doc/fluid/api_cn/dygraph_cn/Embedding_cn.rst index 985bf1c9eb834aa024ebab792a00b151328ef77a..f0797c3a34543648d6a0bcc8c6746f49dbd32ebb 100644 --- a/doc/fluid/api_cn/dygraph_cn/Embedding_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Embedding_cn.rst @@ -11,6 +11,9 @@ Embedding + + + 嵌入层(Embedding Layer) 该接口用于构建 ``Embedding`` 的一个可调用对象，具体用法参照 ``代码示例`` 。其根据input中的id信息从embedding矩阵中查询对应embedding信息，并会根据输入的size (vocab_size, emb_size)和dtype自动构造一个二维embedding矩阵。 diff --git a/doc/fluid/api_cn/dygraph_cn/ExponentialDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/ExponentialDecay_cn.rst index 8a110ba82f47d912428e2e8b6bec45d30e62a739..d178c38ce9bbbb4986f50c375f45380e423fcfe9 100644 --- a/doc/fluid/api_cn/dygraph_cn/ExponentialDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/ExponentialDecay_cn.rst @@ -10,6 +10,9 @@ ExponentialDecay + + + 该接口提供一种学习率按指数函数衰减的功能。 指数衰减的计算方式如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/GroupNorm_cn.rst b/doc/fluid/api_cn/dygraph_cn/GroupNorm_cn.rst index 5a619d25a616a3cc8922373c335fad404623ba6d..b061ec204857651e65a9ca3667e0aa9d16c29170 100644 --- a/doc/fluid/api_cn/dygraph_cn/GroupNorm_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/GroupNorm_cn.rst @@ -11,6 +11,9 @@ GroupNorm + + + **Group Normalization层** 该接口用于构建 ``GroupNorm`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。其中实现了组归一化层的功能。更多详情请参考： `Group Normalization `_ 。 diff --git a/doc/fluid/api_cn/dygraph_cn/InstanceNorm_cn.rst b/doc/fluid/api_cn/dygraph_cn/InstanceNorm_cn.rst index 334fa5109f3ba0f52b1039357e08032671cd1849..dd96fac02e57213e903f9c044d4064b19e4400bf 100644 --- a/doc/fluid/api_cn/dygraph_cn/InstanceNorm_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/InstanceNorm_cn.rst @@ -5,6 +5,11 @@ InstanceNorm .. py:class:: paddle.fluid.dygraph.InstanceNorm(num_channels, epsilon=1e-05, param_attr=None, bias_attr=None, dtype='float32') +:alias_main: paddle.nn.InstanceNorm +:alias: paddle.nn.InstanceNorm,paddle.nn.layer.InstanceNorm,paddle.nn.layer.norm.InstanceNorm + + + 该接口用于构建 ``InstanceNorm`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。 可用作卷积和全连接操作的实例正则化函数，根据每个样本的每个通道的均值和方差信息进行正则化。该层需要的数据格式如下： diff --git a/doc/fluid/api_cn/dygraph_cn/InverseTimeDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/InverseTimeDecay_cn.rst index c693cc97791290950e90b6d5126edccb7d8ceed4..96b3970476d503ed735e7b34eeeba3daeb0d191d 100644 --- a/doc/fluid/api_cn/dygraph_cn/InverseTimeDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/InverseTimeDecay_cn.rst @@ -10,6 +10,9 @@ InverseTimeDecay + + + 该接口提供反时限学习率衰减的功能。 反时限学习率衰减计算方式如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/LayerList_cn.rst b/doc/fluid/api_cn/dygraph_cn/LayerList_cn.rst index 0dc2468dff0ca366300ee50558cab2c56df68aad..7e5fbb6533cf73cb4c2660eac54010172594a47d 100644 --- a/doc/fluid/api_cn/dygraph_cn/LayerList_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/LayerList_cn.rst @@ -5,6 +5,12 @@ LayerList .. py:class:: paddle.fluid.dygraph.LayerList(sublayers=None) +:alias_main: paddle.nn.LayerList +:alias: paddle.nn.LayerList +:old_api: paddle.fluid.dygraph.container.LayerList + + + diff --git a/doc/fluid/api_cn/dygraph_cn/LayerNorm_cn.rst b/doc/fluid/api_cn/dygraph_cn/LayerNorm_cn.rst index 2fd08fe7ab4ddf0fb1055a49bb96ac70bcb087d5..8894a04f641a804cf674ebbcd07b3909fe21f165 100644 --- a/doc/fluid/api_cn/dygraph_cn/LayerNorm_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/LayerNorm_cn.rst @@ -11,6 +11,9 @@ LayerNorm + + + 该接口用于构建 ``LayerNorm`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。其中实现了层归一化层（Layer Normalization Layer）的功能，其可以应用于小批量输入数据。更多详情请参考：`Layer Normalization `_ 计算公式如下 diff --git a/doc/fluid/api_cn/dygraph_cn/Layer_cn.rst b/doc/fluid/api_cn/dygraph_cn/Layer_cn.rst index 914e07cbf3a6bf38f641d713427cfc67161ef9bc..3b8c2ec12807c6744a9e803d89c69b8b8ef8e649 100644 --- a/doc/fluid/api_cn/dygraph_cn/Layer_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Layer_cn.rst @@ -5,6 +5,12 @@ Layer .. py:class:: paddle.fluid.dygraph.Layer(name_scope=None, dtype=core.VarDesc.VarType.FP32) +:alias_main: paddle.nn.Layer +:alias: paddle.nn.Layer +:old_api: paddle.fluid.dygraph.layers.Layer + + + diff --git a/doc/fluid/api_cn/dygraph_cn/Linear_cn.rst b/doc/fluid/api_cn/dygraph_cn/Linear_cn.rst index c741deb393c1eda09d4c8daa1521139c564e8ce9..73c658c8b809ad6956b2cc1b04482ddd90c2cf0b 100644 --- a/doc/fluid/api_cn/dygraph_cn/Linear_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Linear_cn.rst @@ -12,6 +12,9 @@ Linear + + + **线性变换层：** .. math:: diff --git a/doc/fluid/api_cn/dygraph_cn/NaturalExpDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/NaturalExpDecay_cn.rst index 110fd198ff2a50412c6ad25b38431e6e2114ce03..85060cc9edc2e52b36c5b0a2f8e6c33f59203eb9 100644 --- a/doc/fluid/api_cn/dygraph_cn/NaturalExpDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/NaturalExpDecay_cn.rst @@ -10,6 +10,9 @@ NaturalExpDecay + + + 该接口提供按自然指数衰减学习率的功能。 自然指数衰减的计算方式如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/NoamDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/NoamDecay_cn.rst index 390e8b3e3f5a7ea1dac71fbd75468d26b042b4c6..5114ec57afcd2c8cd46d4b647125703c1da1d9e6 100644 --- a/doc/fluid/api_cn/dygraph_cn/NoamDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/NoamDecay_cn.rst @@ -10,6 +10,9 @@ NoamDecay + + + 该接口提供Noam衰减学习率的功能。 Noam衰减的计算方式如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/ParallelEnv_cn.rst b/doc/fluid/api_cn/dygraph_cn/ParallelEnv_cn.rst index 846001c6e98239282f6a971d82a174d3e32068c5..68d74e7180a828f35a8076fb7ca573ec5e01bbff 100644 --- a/doc/fluid/api_cn/dygraph_cn/ParallelEnv_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/ParallelEnv_cn.rst @@ -5,6 +5,12 @@ ParallelEnv .. py:class:: paddle.fluid.dygraph.ParallelEnv() +:alias_main: paddle.imperative.ParallelEnv +:alias: paddle.imperative.ParallelEnv +:old_api: paddle.fluid.dygraph.parallel.ParallelEnv + + + **注意：** **这个类的曾用名为 Env， 这个旧的名字会被废弃，请使用新的类名 ParallelEnv。** diff --git a/doc/fluid/api_cn/dygraph_cn/ParameterList_cn.rst b/doc/fluid/api_cn/dygraph_cn/ParameterList_cn.rst index 82ca04fef6bde4a149153642c29b0e449931da9e..b0210a7fbb5db072afe810d68b7a0c687f908a1a 100644 --- a/doc/fluid/api_cn/dygraph_cn/ParameterList_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/ParameterList_cn.rst @@ -5,6 +5,12 @@ ParameterList .. py:class:: paddle.fluid.dygraph.ParameterList(parameters=None) +:alias_main: paddle.nn.ParameterList +:alias: paddle.nn.ParameterList +:old_api: paddle.fluid.dygraph.container.ParameterList + + + diff --git a/doc/fluid/api_cn/dygraph_cn/PiecewiseDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/PiecewiseDecay_cn.rst index d483d5d34ed9a271f1b61f1ed97b8c09ab2626f2..17a2f4ddc8a7d2ae3ef8ad8125a9c20e4c73f4fd 100644 --- a/doc/fluid/api_cn/dygraph_cn/PiecewiseDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/PiecewiseDecay_cn.rst @@ -10,6 +10,9 @@ PiecewiseDecay + + + 该接口提供对初始学习率进行分段(piecewise)常数衰减的功能。 分段常数衰减的过程举例描述如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/PolynomialDecay_cn.rst b/doc/fluid/api_cn/dygraph_cn/PolynomialDecay_cn.rst index ca3c050406d442d3d9b1dad49f3f42ccab5ea87c..5284d72d1d51f2956cc45db7760a5af87c9507ab 100644 --- a/doc/fluid/api_cn/dygraph_cn/PolynomialDecay_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/PolynomialDecay_cn.rst @@ -10,6 +10,9 @@ PolynomialDecay + + + 该接口提供学习率按多项式衰减的功能。通过多项式衰减函数，使得学习率值逐步从初始的 ``learning_rate``，衰减到 ``end_learning_rate`` 。 计算方式如下。 diff --git a/doc/fluid/api_cn/dygraph_cn/Pool2D_cn.rst b/doc/fluid/api_cn/dygraph_cn/Pool2D_cn.rst index fb47ba8ab256f2895f2d85b803e76d833b70159e..757cf96cfe51bdb1c62e880ec8100f059a07fda3 100644 --- a/doc/fluid/api_cn/dygraph_cn/Pool2D_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Pool2D_cn.rst @@ -11,6 +11,9 @@ Pool2D + + + 该接口用于构建 ``Pool2D`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。其将在神经网络中构建一个二维池化层，并使用上述输入参数的池化配置，为二维空间池化操作，根据 ``input`` ， 池化类型 ``pool_type`` ， 池化核大小 ``pool_size`` , 步长 ``pool_stride`` ，填充 ``pool_padding`` 这些参数得到输出。 输入X和输出Out是NCHW格式，N为批大小，C是通道数，H是特征高度，W是特征宽度。参数（ ``ksize``, ``strides``, ``paddings`` ）含有两个整型元素。分别表示高度和宽度上的参数。输入X的大小和输出Out的大小可能不一致。 diff --git a/doc/fluid/api_cn/dygraph_cn/ProgramTranslator_cn.rst b/doc/fluid/api_cn/dygraph_cn/ProgramTranslator_cn.rst index 75cd816fbdeb794fbfb8efd8ff471c16d6812875..982d7ad7a88d18750a1e08a43a8f8b0b8ed4a211 100644 --- a/doc/fluid/api_cn/dygraph_cn/ProgramTranslator_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/ProgramTranslator_cn.rst @@ -5,6 +5,12 @@ ProgramTranslator .. py:class:: paddle.fluid.dygraph.dygraph_to_static.ProgramTranslator() +:alias_main: paddle.imperative.ProgramTranslator +:alias: paddle.imperative.ProgramTranslator +:old_api: paddle.fluid.dygraph.ProgramTranslator + + + 将动态图函数转为静态图函数的类。该类是个单例（singleton）。 参数： diff --git a/doc/fluid/api_cn/dygraph_cn/Sequential_cn.rst b/doc/fluid/api_cn/dygraph_cn/Sequential_cn.rst index b39b4a556aae0612cff2ea4d33a7fbc0af10107a..4ac19de0008af4dccad07f5a1565ac190155e50b 100644 --- a/doc/fluid/api_cn/dygraph_cn/Sequential_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/Sequential_cn.rst @@ -5,6 +5,12 @@ Sequential .. py:class:: paddle.fluid.dygraph.Sequential(*layers) +:alias_main: paddle.nn.Sequential +:alias: paddle.nn.Sequential +:old_api: paddle.fluid.dygraph.container.Sequential + + + diff --git a/doc/fluid/api_cn/dygraph_cn/SpectralNorm_cn.rst b/doc/fluid/api_cn/dygraph_cn/SpectralNorm_cn.rst index d1677c60a870a6214860b5bb49418b35805d5bd9..7799f77c34b537f24835fed6595c0403dcab2f67 100644 --- a/doc/fluid/api_cn/dygraph_cn/SpectralNorm_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/SpectralNorm_cn.rst @@ -11,6 +11,9 @@ SpectralNorm + + + 该接口用于构建 ``SpectralNorm`` 类的一个可调用对象，具体用法参照 ``代码示例`` 。其中实现了谱归一化层的功能，用于计算fc、conv1d、conv2d、conv3d层的权重参数的谱正则值，输入权重参数应分别为2-D, 3-D, 4-D, 5-D张量，输出张量与输入张量维度相同。谱特征值计算方式如下： 步骤1：生成形状为[H]的向量U,以及形状为[W]的向量V,其中H是输入权重张量的第 ``dim`` 个维度，W是剩余维度的乘积。 diff --git a/doc/fluid/api_cn/dygraph_cn/TracedLayer_cn.rst b/doc/fluid/api_cn/dygraph_cn/TracedLayer_cn.rst index 342cc84f4c1a0992e5b1628956c9a4534e368770..c7302c9175d8decbb91c8aecad2f49350c26eabc 100644 --- a/doc/fluid/api_cn/dygraph_cn/TracedLayer_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/TracedLayer_cn.rst @@ -10,6 +10,12 @@ TracedLayer + + + + + + TracedLayer用于将前向动态图模型转换为静态图模型，主要用于将动态图保存后做在线C++预测。除此以外，用户也可使用转换后的静态图模型在Python端做预测，通常比原先的动态图性能更好。 TracedLayer使用 ``Executor`` 和 ``CompiledProgram`` 运行静态图模型。转换后的静态图模型与原动态图模型共享参数。 diff --git a/doc/fluid/api_cn/dygraph_cn/guard_cn.rst b/doc/fluid/api_cn/dygraph_cn/guard_cn.rst index 651e8b6b5998545b5b8cf6553bc39c5b59495c25..f4dd136e978f3d7c8563f5e5fb277ffe8595e49d 100644 --- a/doc/fluid/api_cn/dygraph_cn/guard_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/guard_cn.rst @@ -10,6 +10,9 @@ guard + + + 通过with语句创建一个dygraph运行的context，执行context代码。 参数： diff --git a/doc/fluid/api_cn/dygraph_cn/load_dygraph_cn.rst b/doc/fluid/api_cn/dygraph_cn/load_dygraph_cn.rst index 39b18d7830eaafa66c6a99a770cf8e85b8fc32b5..da34270c1f26abf8466f2b54458db3d746a0dab4 100644 --- a/doc/fluid/api_cn/dygraph_cn/load_dygraph_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/load_dygraph_cn.rst @@ -10,6 +10,12 @@ load_dygraph + + + + + + 该接口尝试从磁盘中加载参数或优化器的 ``dict`` 。 该接口会同时加载 ``model_path + ".pdparams"`` 和 ``model_path + ".pdopt"`` 中的内容。 diff --git a/doc/fluid/api_cn/dygraph_cn/no_grad_cn.rst b/doc/fluid/api_cn/dygraph_cn/no_grad_cn.rst index e93287287b29e61256e51249792d57390033d040..08a189e844d0bb879eb2b86a71654ab983fd1c95 100644 --- a/doc/fluid/api_cn/dygraph_cn/no_grad_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/no_grad_cn.rst @@ -10,6 +10,12 @@ no_grad + + + + + + 创建一个上下文来禁用动态图梯度计算。在此模式下，每次计算的结果都将具有stop_gradient=True。 也可以用作一个装饰器（确保不要用括号来初始化）。 diff --git a/doc/fluid/api_cn/dygraph_cn/prepare_context_cn.rst b/doc/fluid/api_cn/dygraph_cn/prepare_context_cn.rst index cd18f8d75081a1fbb868e6b92dd890465bbccb29..4c82ee85aa4e83052bb7dcd6eb6bc17830445c39 100644 --- a/doc/fluid/api_cn/dygraph_cn/prepare_context_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/prepare_context_cn.rst @@ -9,6 +9,12 @@ prepare_context + + + + + + 该API是进行多进程多卡训练的环境配置接口，接受一个ParallelStrategy结构体变量作为输入。当strategy属性中的nums_trainer小于2时，API会直接返回，当nums_trainer大于1且为CUDAPlace时，由于目前动态图模式仅支持GPU多卡训练，仅能配置NCCL多卡训练的环境，所以此时会对NCCL环境进行配置，具体内容包括：生成NCCL ID，并广播至参与训练的各进程，用于支持的处理器同步操作，创建并配置NCCL通信器等。 参数： diff --git a/doc/fluid/api_cn/dygraph_cn/save_dygraph_cn.rst b/doc/fluid/api_cn/dygraph_cn/save_dygraph_cn.rst index e830d9c8d071908716d1439efbed07cca13a456e..75f009eed54f3b1365f9e14276ec92924d958cb8 100644 --- a/doc/fluid/api_cn/dygraph_cn/save_dygraph_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/save_dygraph_cn.rst @@ -10,6 +10,12 @@ save_dygraph + + + + + + 该接口将传入的参数或优化器的 ``dict`` 保存到磁盘上。 ``state_dict`` 是通过 :ref:`cn_api_fluid_dygraph_Layer` 的 ``state_dict()`` 方法得到的。 diff --git a/doc/fluid/api_cn/dygraph_cn/to_variable_cn.rst b/doc/fluid/api_cn/dygraph_cn/to_variable_cn.rst index 76b8c01d928d7cad6855a3e11420567236742809..bd0bcba9c73025314a8f6f7a295020356cb5c39b 100644 --- a/doc/fluid/api_cn/dygraph_cn/to_variable_cn.rst +++ b/doc/fluid/api_cn/dygraph_cn/to_variable_cn.rst @@ -10,6 +10,9 @@ to_variable + + + 该函数实现从numpy\.ndarray对象或者Variable对象创建一个 ``Variable`` 类型的对象。 参数： diff --git a/doc/fluid/api_cn/executor_cn/Executor_cn.rst b/doc/fluid/api_cn/executor_cn/Executor_cn.rst index 09c3872c56ad2fb9b71e6ac3f082197ff65f6b13..e44db37c8d529824763d44a217c9ed0f3ba3c0ab 100644 --- a/doc/fluid/api_cn/executor_cn/Executor_cn.rst +++ b/doc/fluid/api_cn/executor_cn/Executor_cn.rst @@ -7,6 +7,12 @@ Executor .. py:class:: paddle.fluid.executor.Executor (place=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.Executor +:alias: paddle.Executor,paddle.framework.Executor +:old_api: paddle.fluid.executor.Executor + + + diff --git a/doc/fluid/api_cn/executor_cn/global_scope_cn.rst b/doc/fluid/api_cn/executor_cn/global_scope_cn.rst index 277bb23db092c0b44704ac5905a968f364d3bc7b..c98b4212272d3a49140969786c298c39dcb0d468 100644 --- a/doc/fluid/api_cn/executor_cn/global_scope_cn.rst +++ b/doc/fluid/api_cn/executor_cn/global_scope_cn.rst @@ -7,6 +7,12 @@ global_scope .. py:function:: paddle.fluid.global_scope() :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.global_scope +:alias: paddle.global_scope,paddle.framework.global_scope +:old_api: paddle.fluid.executor.global_scope + + + diff --git a/doc/fluid/api_cn/executor_cn/scope_guard_cn.rst b/doc/fluid/api_cn/executor_cn/scope_guard_cn.rst index e220cd8d451708031d2526534a686a852ba67807..20d0a031e597914eda401280f10b63afc8b8411b 100644 --- a/doc/fluid/api_cn/executor_cn/scope_guard_cn.rst +++ b/doc/fluid/api_cn/executor_cn/scope_guard_cn.rst @@ -7,6 +7,12 @@ scope_guard .. py:function:: paddle.fluid.executor.scope_guard (scope) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.scope_guard +:alias: paddle.scope_guard,paddle.framework.scope_guard +:old_api: paddle.fluid.executor.scope_guard + + + diff --git a/doc/fluid/api_cn/fluid_cn/BuildStrategy_cn.rst b/doc/fluid/api_cn/fluid_cn/BuildStrategy_cn.rst index 2d6f2fa0586898b53490af9f7a5bbb0a481a3aaa..1706a64316ba6151d92f40cef5385c0379dd0a6b 100644 --- a/doc/fluid/api_cn/fluid_cn/BuildStrategy_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/BuildStrategy_cn.rst @@ -10,6 +10,12 @@ BuildStrategy + + + + + + ``BuildStrategy`` 使用户更方便地控制 :ref:`cn_api_fluid_ParallelExecutor` 中计算图的建造方法，可通过设置 ``ParallelExecutor`` 中的 ``BuildStrategy`` 成员来实现此功能。 **代码示例** diff --git a/doc/fluid/api_cn/fluid_cn/CPUPlace_cn.rst b/doc/fluid/api_cn/fluid_cn/CPUPlace_cn.rst index e091352c9018b355e234f8407625199d51c48555..fdee3ddf443b75a3c35865a31be38d223a53279c 100644 --- a/doc/fluid/api_cn/fluid_cn/CPUPlace_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/CPUPlace_cn.rst @@ -5,6 +5,12 @@ CPUPlace .. py:class:: paddle.fluid.CPUPlace +:alias_main: paddle.CPUPlace +:alias: paddle.CPUPlace,paddle.framework.CPUPlace +:old_api: paddle.fluid.core.CPUPlace + + + diff --git a/doc/fluid/api_cn/fluid_cn/CUDAPinnedPlace_cn.rst b/doc/fluid/api_cn/fluid_cn/CUDAPinnedPlace_cn.rst index a3e669344b2bac46b8cb57d24bbc633bb3549be3..6248727182b173a1a71e6092de2560f841e6bc35 100644 --- a/doc/fluid/api_cn/fluid_cn/CUDAPinnedPlace_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/CUDAPinnedPlace_cn.rst @@ -5,6 +5,12 @@ CUDAPinnedPlace .. py:class:: paddle.fluid.CUDAPinnedPlace +:alias_main: paddle.CUDAPinnedPlace +:alias: paddle.CUDAPinnedPlace,paddle.framework.CUDAPinnedPlace +:old_api: paddle.fluid.core.CUDAPinnedPlace + + + diff --git a/doc/fluid/api_cn/fluid_cn/CUDAPlace_cn.rst b/doc/fluid/api_cn/fluid_cn/CUDAPlace_cn.rst index ba7cf62280b52b17dc310c8d9c1a5a4ca2cc6feb..60f9f9226a1b1e9c921245611d302b046a775946 100644 --- a/doc/fluid/api_cn/fluid_cn/CUDAPlace_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/CUDAPlace_cn.rst @@ -5,6 +5,12 @@ CUDAPlace .. py:class:: paddle.fluid.CUDAPlace +:alias_main: paddle.CUDAPlace +:alias: paddle.CUDAPlace,paddle.framework.CUDAPlace +:old_api: paddle.fluid.core.CUDAPlace + + + diff --git a/doc/fluid/api_cn/fluid_cn/CompiledProgram_cn.rst b/doc/fluid/api_cn/fluid_cn/CompiledProgram_cn.rst index c6576c63468cac361d12294eb06eb8063d33814f..fa76c005aa54f929693a5aef83aedbb794fbe349 100644 --- a/doc/fluid/api_cn/fluid_cn/CompiledProgram_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/CompiledProgram_cn.rst @@ -10,6 +10,12 @@ CompiledProgram + + + + + + CompiledProgram根据 `build_strategy` 的配置将输入的Program或Graph进行转换和优化，例如：计算图中算子融合、计算图执行过程中开启内存/显存优化等，关于build_strategy更多信息。请参阅 ``fluid.BuildStrategy`` 。 参数： diff --git a/doc/fluid/api_cn/fluid_cn/DataFeedDesc_cn.rst b/doc/fluid/api_cn/fluid_cn/DataFeedDesc_cn.rst index 29cf9b2a43c30fe7c6dd47af702eef29f9a863ec..84e2eca676106d7817e5b54272b5ae5d3a5cc934 100644 --- a/doc/fluid/api_cn/fluid_cn/DataFeedDesc_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/DataFeedDesc_cn.rst @@ -10,6 +10,9 @@ DataFeedDesc + + + 描述训练数据的格式。输入是一个文件路径名，其内容是protobuf message。 可以参考 :code:`paddle/fluid/framework/data_feed.proto` 查看我们如何定义message diff --git a/doc/fluid/api_cn/fluid_cn/DataFeeder_cn.rst b/doc/fluid/api_cn/fluid_cn/DataFeeder_cn.rst index 1151d922e5db990139ac616e2aca2d617c1931f5..ab88c9bf54067d5ea8c1057de8022c7b1420c227 100644 --- a/doc/fluid/api_cn/fluid_cn/DataFeeder_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/DataFeeder_cn.rst @@ -12,6 +12,9 @@ DataFeeder + + + ``DataFeeder`` 负责将reader(读取器)返回的数据转成一种特殊的数据结构，使它们可以输入到 ``Executor`` 和 ``ParallelExecutor`` 中。 reader通常返回一个minibatch条目列表。在列表中每一条目都是一个样本（sample）,它是由具有一至多个特征的列表或元组组成的。 diff --git a/doc/fluid/api_cn/fluid_cn/ExecutionStrategy_cn.rst b/doc/fluid/api_cn/fluid_cn/ExecutionStrategy_cn.rst index 25b623fbffda98bd12aea2579d882f5e33d97a43..62ad6781682ed4b1d340e881b6a49fba7a35e1cd 100644 --- a/doc/fluid/api_cn/fluid_cn/ExecutionStrategy_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/ExecutionStrategy_cn.rst @@ -10,6 +10,9 @@ ExecutionStrategy + + + 通过设置 ``ExecutionStrategy`` 中的选项，用户可以对执行器的执行配置进行调整，比如设置执行器中线程池的大小等。 返回：初始化后的ExecutionStrategy的实例 diff --git a/doc/fluid/api_cn/fluid_cn/Executor_cn.rst b/doc/fluid/api_cn/fluid_cn/Executor_cn.rst index 7a2053a891c88a99d7336528f33b7ef87bb25f11..dba7b6d0cef9c379480c473bc601ab6161f907b5 100644 --- a/doc/fluid/api_cn/fluid_cn/Executor_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/Executor_cn.rst @@ -11,6 +11,9 @@ Executor + + + Executor支持单GPU、多GPU以及CPU运行。 参数： diff --git a/doc/fluid/api_cn/fluid_cn/ParallelExecutor_cn.rst b/doc/fluid/api_cn/fluid_cn/ParallelExecutor_cn.rst index 8e391956ed24e66a6fb736dc4165b14a7e734cad..916251d5623edf507b51dc88f45a4a0c5534c7b7 100644 --- a/doc/fluid/api_cn/fluid_cn/ParallelExecutor_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/ParallelExecutor_cn.rst @@ -10,6 +10,12 @@ ParallelExecutor + + + + + + ``ParallelExecutor`` 是 ``Executor`` 的一个升级版本，可以支持基于数据并行的多节点模型训练和测试。如果采用数据并行模式， ``ParallelExecutor`` 在构造时会将参数分发到不同的节点上，并将输入的 ``Program`` 拷贝到不同的节点，在执行过程中，各个节点独立运行模型，将模型反向计算得到的参数梯度在多个节点之间进行聚合，之后各个节点独立的进行参数的更新。如果使用GPU运行模型，即 ``use_cuda=True`` ，节点指代GPU， ``ParallelExecutor`` 将自动获取在当前机器上可用的GPU资源，用户也可以通过在环境变量设置可用的GPU资源，例如：希望使用GPU0、GPU1计算，export CUDA_VISIBLEDEVICES=0,1；如果在CPU上进行操作，即 ``use_cuda=False`` ，节点指代CPU，**注意：此时需要用户在环境变量中手动添加 CPU_NUM ，并将该值设置为CPU设备的个数，例如：export CPU_NUM=4，如果没有设置该环境变量，执行器会在环境变量中添加该变量，并将其值设为1**。 参数: diff --git a/doc/fluid/api_cn/fluid_cn/ParamAttr_cn.rst b/doc/fluid/api_cn/fluid_cn/ParamAttr_cn.rst index 641ed94ab2d0b52e9ef2de4cdd783f61e5df672f..7258b1da872638e4b95c66f36d1a83df9845cede 100644 --- a/doc/fluid/api_cn/fluid_cn/ParamAttr_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/ParamAttr_cn.rst @@ -7,6 +7,12 @@ ParamAttr .. py:class:: paddle.fluid.ParamAttr(name=None, initializer=None, learning_rate=1.0, regularizer=None, trainable=True, do_model_average=False) +:alias_main: paddle.ParamAttr +:alias: paddle.ParamAttr,paddle.framework.ParamAttr +:old_api: paddle.fluid.param_attr.ParamAttr + + + diff --git a/doc/fluid/api_cn/fluid_cn/Program_cn.rst b/doc/fluid/api_cn/fluid_cn/Program_cn.rst index 2a611c7b0e913f8ed6ceb13ad88566c101dc8ef6..e3aaf7d89a9c200d40f986bb1e62ff684b54c5ea 100644 --- a/doc/fluid/api_cn/fluid_cn/Program_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/Program_cn.rst @@ -5,6 +5,12 @@ Program .. py:class:: paddle.fluid.Program +:alias_main: paddle.Program +:alias: paddle.Program,paddle.framework.Program +:old_api: paddle.fluid.framework.Program + + + diff --git a/doc/fluid/api_cn/fluid_cn/Variable_cn.rst b/doc/fluid/api_cn/fluid_cn/Variable_cn.rst index 4abe3040d20cc7dc223e7d0b1f3610e6fd87ea89..81f72ed1125e29b9d567f9fa20884168919e2ff0 100644 --- a/doc/fluid/api_cn/fluid_cn/Variable_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/Variable_cn.rst @@ -5,6 +5,12 @@ Variable .. py:class:: paddle.fluid.Variable +:alias_main: paddle.Variable +:alias: paddle.Variable,paddle.framework.Variable +:old_api: paddle.fluid.framework.Variable + + + diff --git a/doc/fluid/api_cn/fluid_cn/WeightNormParamAttr_cn.rst b/doc/fluid/api_cn/fluid_cn/WeightNormParamAttr_cn.rst index d17b0380c5f8c5903b75926f3ec326d4d3726320..adedd0eb46237bced01e3061371ead3394902566 100644 --- a/doc/fluid/api_cn/fluid_cn/WeightNormParamAttr_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/WeightNormParamAttr_cn.rst @@ -10,6 +10,12 @@ WeightNormParamAttr + + + + + + .. note:: 该类中的 ``gradient_clip`` 属性在2.0版本会废弃，推荐在初始化 ``optimizer`` 时设置梯度裁剪。共有三种裁剪策略： :ref:`cn_api_fluid_clip_GradientClipByGlobalNorm` 、 :ref:`cn_api_fluid_clip_GradientClipByNorm` 、 :ref:`cn_api_fluid_clip_GradientClipByValue` 。 diff --git a/doc/fluid/api_cn/fluid_cn/create_random_int_lodtensor_cn.rst b/doc/fluid/api_cn/fluid_cn/create_random_int_lodtensor_cn.rst index afe15fe1d4c92d7422d497cecc29ed10c2f4b14f..60ea69156757f9c34c52df46d68930d4d90b1c1c 100644 --- a/doc/fluid/api_cn/fluid_cn/create_random_int_lodtensor_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/create_random_int_lodtensor_cn.rst @@ -11,6 +11,9 @@ create_random_int_lodtensor + + + 创建一个包含随机整数的LoDTensor。 具体实现方法如下： diff --git a/doc/fluid/api_cn/fluid_cn/data_cn.rst b/doc/fluid/api_cn/fluid_cn/data_cn.rst index f250c9438581e2cddaebe4f72c8adb5c6821cdb9..3982bdc010aa632a34d50e8ce7880aecc8f11e2c 100644 --- a/doc/fluid/api_cn/fluid_cn/data_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/data_cn.rst @@ -13,6 +13,9 @@ data + + + 该OP会在全局block中创建变量（Variable），该全局变量可被计算图中的算子（operator）访问。该变量可作为占位符用于数据输入。例如用执行器（Executor）feed数据进该变量 注意： diff --git a/doc/fluid/api_cn/fluid_cn/default_main_program_cn.rst b/doc/fluid/api_cn/fluid_cn/default_main_program_cn.rst index 4759fafea72a09002fc9e497baeb99983b2c6218..ab24181eccf7dc1d4bf96d6710b6e6fb59ffcca0 100644 --- a/doc/fluid/api_cn/fluid_cn/default_main_program_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/default_main_program_cn.rst @@ -5,6 +5,12 @@ default_main_program .. py:function:: paddle.fluid.default_main_program() +:alias_main: paddle.default_main_program +:alias: paddle.default_main_program,paddle.framework.default_main_program +:old_api: paddle.fluid.framework.default_main_program + + + diff --git a/doc/fluid/api_cn/fluid_cn/default_startup_program_cn.rst b/doc/fluid/api_cn/fluid_cn/default_startup_program_cn.rst index bfc247c29b6a952d59e8ac524a558f32843cb536..20094de8655868fb67e285187a491926324c9dad 100644 --- a/doc/fluid/api_cn/fluid_cn/default_startup_program_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/default_startup_program_cn.rst @@ -8,6 +8,12 @@ default_startup_program .. py:function:: paddle.fluid.default_startup_program() +:alias_main: paddle.default_startup_program +:alias: paddle.default_startup_program,paddle.framework.default_startup_program +:old_api: paddle.fluid.framework.default_startup_program + + + diff --git a/doc/fluid/api_cn/fluid_cn/disable_dygraph_cn.rst b/doc/fluid/api_cn/fluid_cn/disable_dygraph_cn.rst index 59dc22b7b491cf59f13fe9586f6d98bbaa86f00b..84706f1307e8e78df51fa99c079b0f23110f00d9 100644 --- a/doc/fluid/api_cn/fluid_cn/disable_dygraph_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/disable_dygraph_cn.rst @@ -5,6 +5,12 @@ disable_dygraph .. py:function:: paddle.fluid.disable_dygraph() +:alias_main: paddle.disable_imperative +:alias: paddle.disable_imperative +:old_api: .fluid.dygraph.base.disable_dygraph + + + 该接口关闭动态图模式。 返回：无 diff --git a/doc/fluid/api_cn/fluid_cn/embedding_cn.rst b/doc/fluid/api_cn/fluid_cn/embedding_cn.rst index ee70bead5caa9abd9db685f1709cae196ced9028..70586de1a837811a64c59c6863f6711f3800f5e7 100644 --- a/doc/fluid/api_cn/fluid_cn/embedding_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/embedding_cn.rst @@ -10,6 +10,12 @@ embedding + + + + + + 该OP根据input中的id信息从embedding矩阵中查询对应embedding信息，函数会根据输入的size (vocab_size, emb_size)和dtype自动构造一个二维embedding矩阵。 输出的Tensor的shape是在输入Tensor shape的最后一维后面添加了emb_size的维度。 diff --git a/doc/fluid/api_cn/fluid_cn/enable_dygraph_cn.rst b/doc/fluid/api_cn/fluid_cn/enable_dygraph_cn.rst index 0df485bd856a4c70f3638db7c2f6b7470c143fe1..53d09469d26ff757e47af5a94708994ca60cbf9d 100644 --- a/doc/fluid/api_cn/fluid_cn/enable_dygraph_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/enable_dygraph_cn.rst @@ -5,6 +5,12 @@ enable_dygraph .. py:function:: paddle.fluid.enable_dygraph(place=None) +:alias_main: paddle.enable_imperative +:alias: paddle.enable_imperative +:old_api: .fluid.dygraph.base.enable_dygraph + + + 该接口打开动态图模式。 参数： diff --git a/doc/fluid/api_cn/fluid_cn/global_scope_cn.rst b/doc/fluid/api_cn/fluid_cn/global_scope_cn.rst index 86031eedc8c1c8f8fc9083054b189194dba6a009..d155edbe6f62830a443aab0c9f8c8c767b1a5526 100644 --- a/doc/fluid/api_cn/fluid_cn/global_scope_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/global_scope_cn.rst @@ -10,6 +10,9 @@ global_scope + + + 获取全局/默认作用域实例。很多API使用默认 ``global_scope`` ，例如 ``Executor.run`` 等。 返回：全局/默认作用域实例 diff --git a/doc/fluid/api_cn/fluid_cn/gradients_cn.rst b/doc/fluid/api_cn/fluid_cn/gradients_cn.rst index b5813a0a1c6b73aaecff4bb3939fbc3ef8d1b594..05b7b225b86658d841e7fc7fff6ae4dafb286cf8 100644 --- a/doc/fluid/api_cn/fluid_cn/gradients_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/gradients_cn.rst @@ -10,6 +10,9 @@ gradients + + + 将目标梯度反向传播到输入。 参数： diff --git a/doc/fluid/api_cn/fluid_cn/in_dygraph_mode_cn.rst b/doc/fluid/api_cn/fluid_cn/in_dygraph_mode_cn.rst index 06c960ce5c3debdc422d8098744b5e7ecaa73bb5..7e8756fa0e945c1676b5817d99bb96bfb935f168 100644 --- a/doc/fluid/api_cn/fluid_cn/in_dygraph_mode_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/in_dygraph_mode_cn.rst @@ -5,6 +5,12 @@ in_dygraph_mode .. py:function:: paddle.fluid.in_dygraph_mode() +:alias_main: paddle.in_imperative_mode +:alias: paddle.in_imperative_mode +:old_api: .fluid.framework.in_dygraph_mode + + + diff --git a/doc/fluid/api_cn/fluid_cn/load_cn.rst b/doc/fluid/api_cn/fluid_cn/load_cn.rst index a12a65fbed8eacfcf1f17246fc3ee3001dd81c70..41a6ea53609e8c997870aef91f79c1db7389219f 100644 --- a/doc/fluid/api_cn/fluid_cn/load_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/load_cn.rst @@ -9,6 +9,9 @@ load + + + 该接口从Program中过滤出参数和优化器信息，然后从文件中获取相应的值。 如果Program和加载的文件之间参数的维度或数据类型不匹配，将引发异常。 diff --git a/doc/fluid/api_cn/fluid_cn/load_op_library_cn.rst b/doc/fluid/api_cn/fluid_cn/load_op_library_cn.rst index 944b78dc4e9cc84a2cabc3951d3091969f3dc763..4ba03162e29397dae7cae5bf38ba011d5053ab26 100644 --- a/doc/fluid/api_cn/fluid_cn/load_op_library_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/load_op_library_cn.rst @@ -9,6 +9,9 @@ load_op_library + + + ``load_op_library`` 用于自定义C++算子中，用来加载算子动态共享库。加载库后，注册好的算子及其Kernel实现将在PaddlePaddle主进程中可以被调用。 请注意，自定义算子的类型不能与框架中的现有算子类型相同。 参数： diff --git a/doc/fluid/api_cn/fluid_cn/memory_optimize_cn.rst b/doc/fluid/api_cn/fluid_cn/memory_optimize_cn.rst index bc95cc3995e565d50cc846d613d449bb89d6e936..ea2386732cedd21c22fecc4dca745b75737ec77e 100644 --- a/doc/fluid/api_cn/fluid_cn/memory_optimize_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/memory_optimize_cn.rst @@ -10,5 +10,8 @@ memory_optimize + + + **从1.6版本开始此接口不再推荐使用，请不要在新写的代码中使用它，1.6+版本已默认开启更优的存储优化策略** diff --git a/doc/fluid/api_cn/fluid_cn/name_scope_cn.rst b/doc/fluid/api_cn/fluid_cn/name_scope_cn.rst index bf17054ba22ba285d436886c5e7491c8447c0132..a6100ab3e6b292447bd2cd55928c01ff5b2500dc 100644 --- a/doc/fluid/api_cn/fluid_cn/name_scope_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/name_scope_cn.rst @@ -11,6 +11,12 @@ name_scope + + + + + + 该函数为operators生成不同的命名空间。该函数只用于调试和可视化，不建议用在其它方面。 diff --git a/doc/fluid/api_cn/fluid_cn/one_hot_cn.rst b/doc/fluid/api_cn/fluid_cn/one_hot_cn.rst index fbf08df2176015fbe1a50ffef5da07e2a958089c..7b098ebafa62209229735a3ed0f98a7bf3f26f85 100644 --- a/doc/fluid/api_cn/fluid_cn/one_hot_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/one_hot_cn.rst @@ -11,6 +11,9 @@ one_hot + + + 该OP将输入（input）中的每个id转换为一个one-hot向量，其长度为 ``depth`` ，该id对应的向量维度上的值为1，其余维度的值为0。 输出的Tensor（或LoDTensor）的shape是在输入shape的最后一维后面添加了depth的维度。 diff --git a/doc/fluid/api_cn/fluid_cn/program_guard_cn.rst b/doc/fluid/api_cn/fluid_cn/program_guard_cn.rst index d1b9e68b08e74b52c029aa848ab5bd382cc36e9c..a19a319f32dc01175ee8f69d892a3ffe3353da89 100644 --- a/doc/fluid/api_cn/fluid_cn/program_guard_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/program_guard_cn.rst @@ -10,6 +10,12 @@ program_guard + + + + + + 该接口应配合使用python的 ``with`` 语句来将 ``with`` block 里的算子和变量添加进指定的全局主程序（main program）和启动程序（startup program）。 ``with`` 语句块中的fluid.layers下各接口将在新的main program（主程序）中添加operators（算子）和variables（变量）。 diff --git a/doc/fluid/api_cn/fluid_cn/release_memory_cn.rst b/doc/fluid/api_cn/fluid_cn/release_memory_cn.rst index ef68a966501630d8a29aadee6622f2e16bfca447..054d5bbc8625d133b602f13f148b75b41bc900e6 100644 --- a/doc/fluid/api_cn/fluid_cn/release_memory_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/release_memory_cn.rst @@ -10,4 +10,7 @@ release_memory + + + **从1.6版本开始此接口不再推荐使用，请不要在新写的代码中使用它，1.6+版本已默认开启更优的存储优化策略** diff --git a/doc/fluid/api_cn/fluid_cn/save_cn.rst b/doc/fluid/api_cn/fluid_cn/save_cn.rst index a15b23f2b5b1b798943dcb6d7ef49ce8fac229f1..cdfd9ed580e83a7794eb6be3a2573b4e83f0bef9 100644 --- a/doc/fluid/api_cn/fluid_cn/save_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/save_cn.rst @@ -7,9 +7,9 @@ save .. py:function:: paddle.fluid.save(program, model_path) :api_attr: 声明式编程模式（静态图) -:alias_main: paddle.save -:alias: paddle.save,paddle.tensor.save,paddle.tensor.io.save -:old_api: paddle.fluid.save + + + diff --git a/doc/fluid/api_cn/fluid_cn/scope_guard_cn.rst b/doc/fluid/api_cn/fluid_cn/scope_guard_cn.rst index df0566e1b7c3e4931bf69e3734773e4a333f4d57..80f0c90597e517f66b3b819a470c865ce26d7fd0 100644 --- a/doc/fluid/api_cn/fluid_cn/scope_guard_cn.rst +++ b/doc/fluid/api_cn/fluid_cn/scope_guard_cn.rst @@ -11,6 +11,9 @@ scope_guard + + + 该接口通过 python 的 ``with`` 语句切换作用域（scope）。 作用域记录了变量名和变量 ( :ref:`api_guide_Variable` ) 之间的映射关系，类似于编程语言中的大括号。 如果未调用此接口，所有的变量和变量名都会被记录在默认的全局作用域中。 diff --git a/doc/fluid/api_cn/framework_cn/manual_seed_cn.rst b/doc/fluid/api_cn/framework_cn/manual_seed_cn.rst index 7f1078e82095c244b02e3b7bcc0516725fe5ef98..be341a13d69c75b5357c76b8c4196171757bbd14 100644 --- a/doc/fluid/api_cn/framework_cn/manual_seed_cn.rst +++ b/doc/fluid/api_cn/framework_cn/manual_seed_cn.rst @@ -6,7 +6,10 @@ manual_seed .. py:function:: paddle.framework.manual_seed(seed) :alias_main: paddle.manual_seed -:alias: paddle.manual_seed,paddle.framework.random.manual_seed +:alias: paddle.manual_seed,paddle.framework.manual_seed,paddle.framework.random.manual_seed + + + diff --git a/doc/fluid/api_cn/initializer_cn/Bilinear_cn.rst b/doc/fluid/api_cn/initializer_cn/Bilinear_cn.rst index 78664ec87a1a3daa53bc50f94bd0ab832b8b466e..0d0bf75fa949222f3c455c704babb33d27b708af 100644 --- a/doc/fluid/api_cn/initializer_cn/Bilinear_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/Bilinear_cn.rst @@ -11,6 +11,9 @@ Bilinear + + + ``BilinearInitializer`` 的别名 diff --git a/doc/fluid/api_cn/initializer_cn/Constant_cn.rst b/doc/fluid/api_cn/initializer_cn/Constant_cn.rst index fdc567bd1b7ee4c9ddae0e13c018b54e0f2fe7e1..b1db97b897a6645267d2d9c81aed5f92eb81e95e 100644 --- a/doc/fluid/api_cn/initializer_cn/Constant_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/Constant_cn.rst @@ -11,6 +11,9 @@ Constant + + + ``ConstantInitializer`` 的别名 diff --git a/doc/fluid/api_cn/initializer_cn/MSRA_cn.rst b/doc/fluid/api_cn/initializer_cn/MSRA_cn.rst index 00ff2f29bc574fe3aa24d401fb05783eb23b01c1..5473f3d525487155ece6bff5828f283a9a713b8a 100644 --- a/doc/fluid/api_cn/initializer_cn/MSRA_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/MSRA_cn.rst @@ -11,5 +11,8 @@ MSRA + + + ``MSRAInitializer`` 的别名 diff --git a/doc/fluid/api_cn/initializer_cn/Normal_cn.rst b/doc/fluid/api_cn/initializer_cn/Normal_cn.rst index a7ae0fe063be50f8af93a4197f68c09157a17733..076d6c3a93426734fa95dc8c9f72c97c7b1ba0d5 100644 --- a/doc/fluid/api_cn/initializer_cn/Normal_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/Normal_cn.rst @@ -11,6 +11,9 @@ Normal + + + ``NormalInitializer`` 的别名 diff --git a/doc/fluid/api_cn/initializer_cn/TruncatedNormal_cn.rst b/doc/fluid/api_cn/initializer_cn/TruncatedNormal_cn.rst index d36b1c53f17417cc2f06b6641a16ed4de7a0b6f7..ef82ff26649b9280de74f4026324309b6a0d7c15 100644 --- a/doc/fluid/api_cn/initializer_cn/TruncatedNormal_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/TruncatedNormal_cn.rst @@ -11,6 +11,9 @@ TruncatedNormal + + + ``TruncatedNormalInitializer`` 的别名 diff --git a/doc/fluid/api_cn/initializer_cn/Uniform_cn.rst b/doc/fluid/api_cn/initializer_cn/Uniform_cn.rst index 48a7efeeeddd34a99effca7c37e1c8dea99bf761..cf8cac56e6462f2cb69c1f51d7021517952c5f85 100644 --- a/doc/fluid/api_cn/initializer_cn/Uniform_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/Uniform_cn.rst @@ -11,6 +11,9 @@ Uniform + + + ``UniformInitializer`` 的别名 diff --git a/doc/fluid/api_cn/initializer_cn/Xavier_cn.rst b/doc/fluid/api_cn/initializer_cn/Xavier_cn.rst index e19b2c7db8dcb80cadf0e7da5f3d10e39ba301d5..07c91e05948433ff208554e1f4cf512ea7c44a10 100644 --- a/doc/fluid/api_cn/initializer_cn/Xavier_cn.rst +++ b/doc/fluid/api_cn/initializer_cn/Xavier_cn.rst @@ -11,6 +11,9 @@ Xavier + + + ``XavierInitializer`` 的别名 diff --git a/doc/fluid/api_cn/io_cn/DataLoader_cn.rst b/doc/fluid/api_cn/io_cn/DataLoader_cn.rst index e8e1b68d3aadb0c9f5e3f958f4b096313e60c6e5..a5cd042f19bc3ae8d51c456826af0994d3149af3 100644 --- a/doc/fluid/api_cn/io_cn/DataLoader_cn.rst +++ b/doc/fluid/api_cn/io_cn/DataLoader_cn.rst @@ -5,6 +5,12 @@ DataLoader .. py:class:: paddle.fluid.io.DataLoader +:alias_main: paddle.io.DataLoader +:alias: paddle.io.DataLoader +:old_api: paddle.fluid.io.DataLoader + + + diff --git a/doc/fluid/api_cn/io_cn/batch_cn.rst b/doc/fluid/api_cn/io_cn/batch_cn.rst index 3e3804abfb573be5a561fa7fb48603a15bf5f87c..1b7848dbe6bcce92e4c484790782614fc8cf022e 100644 --- a/doc/fluid/api_cn/io_cn/batch_cn.rst +++ b/doc/fluid/api_cn/io_cn/batch_cn.rst @@ -5,6 +5,12 @@ batch .. py:function:: paddle.fluid.io.batch(reader, batch_size, drop_last=False) +:alias_main: paddle.io.batch +:alias: paddle.io.batch +:old_api: paddle.fluid.io.batch + + + diff --git a/doc/fluid/api_cn/io_cn/buffered_cn.rst b/doc/fluid/api_cn/io_cn/buffered_cn.rst index 027c6346f735874d8c9accc38024c09b5940c429..4656bb608500bcb5ca4c96c97167e6e2e3a0946f 100644 --- a/doc/fluid/api_cn/io_cn/buffered_cn.rst +++ b/doc/fluid/api_cn/io_cn/buffered_cn.rst @@ -5,6 +5,11 @@ buffered .. py:function:: paddle.fluid.io.buffered(reader, size) +:alias_main: paddle.io.buffered +:alias: paddle.io.buffered,paddle.io..reader.buffered + + + diff --git a/doc/fluid/api_cn/io_cn/cache_cn.rst b/doc/fluid/api_cn/io_cn/cache_cn.rst index e93e4c85d134c0feb2ff813a6127c89816baed76..b8a7eafd74acc57377c3d7e1583387e6a4d0890a 100644 --- a/doc/fluid/api_cn/io_cn/cache_cn.rst +++ b/doc/fluid/api_cn/io_cn/cache_cn.rst @@ -5,6 +5,11 @@ cache .. py:function:: paddle.fluid.io.cache(reader) +:alias_main: paddle.io.cache +:alias: paddle.io.cache,paddle.io..reader.cache + + + diff --git a/doc/fluid/api_cn/io_cn/chain_cn.rst b/doc/fluid/api_cn/io_cn/chain_cn.rst index 4a4872d268cc2dfbddad0a6d4720be54e5eb41c9..8d7fdde7c72077dddb426453be66c50a4dac74a7 100644 --- a/doc/fluid/api_cn/io_cn/chain_cn.rst +++ b/doc/fluid/api_cn/io_cn/chain_cn.rst @@ -5,6 +5,11 @@ chain .. py:function:: paddle.fluid.io.chain(*readers) +:alias_main: paddle.io.chain +:alias: paddle.io.chain,paddle.io..reader.chain + + + diff --git a/doc/fluid/api_cn/io_cn/compose_cn.rst b/doc/fluid/api_cn/io_cn/compose_cn.rst index b4393bab5db375413712c27b60fb0699e4d85370..80f9a7c1ac9f535e76fd5fd21ee225eadce9ec55 100644 --- a/doc/fluid/api_cn/io_cn/compose_cn.rst +++ b/doc/fluid/api_cn/io_cn/compose_cn.rst @@ -5,6 +5,11 @@ compose .. py:function:: paddle.fluid.io.compose(*readers, **kwargs) +:alias_main: paddle.io.compose +:alias: paddle.io.compose,paddle.io..reader.compose + + + diff --git a/doc/fluid/api_cn/io_cn/firstn_cn.rst b/doc/fluid/api_cn/io_cn/firstn_cn.rst index ba9c1d427ab3ec1946dab0e78f1a2021a712fe94..e2ac716037626efa396a791a22b7c677d4931f96 100644 --- a/doc/fluid/api_cn/io_cn/firstn_cn.rst +++ b/doc/fluid/api_cn/io_cn/firstn_cn.rst @@ -5,6 +5,11 @@ firstn .. py:function:: paddle.fluid.io.firstn(reader, n) +:alias_main: paddle.io.firstn +:alias: paddle.io.firstn,paddle.io..reader.firstn + + + diff --git a/doc/fluid/api_cn/io_cn/get_program_parameter_cn.rst b/doc/fluid/api_cn/io_cn/get_program_parameter_cn.rst index 43490ac9dff81daad4195593af4a2b4c5e443004..30fb6f2c6655b1baec2ed43408cb69dcebc14f5c 100644 --- a/doc/fluid/api_cn/io_cn/get_program_parameter_cn.rst +++ b/doc/fluid/api_cn/io_cn/get_program_parameter_cn.rst @@ -9,6 +9,9 @@ get_program_parameter + + + 该接口从Program中获取所有参数。 参数: diff --git a/doc/fluid/api_cn/io_cn/get_program_persistable_vars_cn.rst b/doc/fluid/api_cn/io_cn/get_program_persistable_vars_cn.rst index b7eb886d371c97f09fa8b4e25ba731313f3f9108..5f14831e82d62ae5c674a08edbccff361bf5ffa1 100644 --- a/doc/fluid/api_cn/io_cn/get_program_persistable_vars_cn.rst +++ b/doc/fluid/api_cn/io_cn/get_program_persistable_vars_cn.rst @@ -9,6 +9,9 @@ get_program_persistable_vars + + + 该接口从Program中获取所有persistable的变量。 参数: diff --git a/doc/fluid/api_cn/io_cn/load_cn.rst b/doc/fluid/api_cn/io_cn/load_cn.rst index 863dd4ea083bd3d663e4e3a4b06eaed787086b2d..c320b932b6bf7e0e67412a9e141cf486d60842ed 100644 --- a/doc/fluid/api_cn/io_cn/load_cn.rst +++ b/doc/fluid/api_cn/io_cn/load_cn.rst @@ -7,9 +7,12 @@ load :api_attr: 声明式编程模式（静态图) :alias_main: paddle.load -:alias: paddle.load,paddle.tensor.load,paddle.tensor.io.load +:alias: paddle.load,paddle.io.load,paddle.tensor.load,paddle.tensor.io.load :old_api: paddle.fluid.io.load + + + ``fluid.io.load`` 是 :ref:`cn_api_fluid_load` 的别名 diff --git a/doc/fluid/api_cn/io_cn/load_inference_model_cn.rst b/doc/fluid/api_cn/io_cn/load_inference_model_cn.rst index e53d9661a7bac90805a6e880a2c3046b68caa503..1934fcc9ea4a1045788f06a903c2bba19689287a 100644 --- a/doc/fluid/api_cn/io_cn/load_inference_model_cn.rst +++ b/doc/fluid/api_cn/io_cn/load_inference_model_cn.rst @@ -7,6 +7,12 @@ load_inference_model .. py:function:: paddle.fluid.io.load_inference_model(dirname, executor, model_filename=None, params_filename=None, pserver_endpoints=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.io.load_inference_model +:alias: paddle.io.load_inference_model +:old_api: paddle.fluid.io.load_inference_model + + + diff --git a/doc/fluid/api_cn/io_cn/load_params_cn.rst b/doc/fluid/api_cn/io_cn/load_params_cn.rst index 53a5bccc6f2024abf67a06320249a6652266077d..f3965aa79a51019eb69d1c8efd4942462642cb66 100644 --- a/doc/fluid/api_cn/io_cn/load_params_cn.rst +++ b/doc/fluid/api_cn/io_cn/load_params_cn.rst @@ -10,6 +10,9 @@ load_params + + + 该接口从指定的 ``main_program`` 中筛选出所有模型参数变量，并根据目录 ``dirname`` 或 ``filename`` 提供的参数文件对这些模型参数进行赋值。 使用 ``dirname`` 指定模型参数的存储路径。若模型参数变量以分离文件的形式存储在 ``dirname`` 指定的目录下，则设置 ``filename`` 值为None；若所有模型参数存储在一个单独的二进制文件中，则使用 ``filename`` 来指明这个二进制文件。 diff --git a/doc/fluid/api_cn/io_cn/load_persistables_cn.rst b/doc/fluid/api_cn/io_cn/load_persistables_cn.rst index 24d3eac7270cee0b3b1e61be1c21ac671099e1b3..2ae6e3023c3d2402367b52558b3aca6f1c7d4b03 100644 --- a/doc/fluid/api_cn/io_cn/load_persistables_cn.rst +++ b/doc/fluid/api_cn/io_cn/load_persistables_cn.rst @@ -10,6 +10,9 @@ load_persistables + + + 该接口从给定的 ``main_program`` 中取出所有 ``persistable==True`` 的变量（即持久性变量，详见 :ref:`api_guide_model_save_reader` ），并根据目录 ``dirname`` 或 ``filename`` 提供的参数文件对这些持久性变量进行赋值。 使用 ``dirname`` 指定持久性变量的存储路径。若持久性变量以分离文件的形式保存在 ``dirname`` 指定的目录下，则设置 ``filename`` 值为None；若所有持久性变量保存在一个单独的二进制文件中，则使用 ``filename`` 来指明这个二进制文件。 diff --git a/doc/fluid/api_cn/io_cn/load_program_state_cn.rst b/doc/fluid/api_cn/io_cn/load_program_state_cn.rst index 60b457b35043c25545522a808817f5f72899aa5b..4f5ad7245cfe816159a0e90e662620ba8252b3e9 100644 --- a/doc/fluid/api_cn/io_cn/load_program_state_cn.rst +++ b/doc/fluid/api_cn/io_cn/load_program_state_cn.rst @@ -6,6 +6,12 @@ load_program_state .. py:function:: paddle.fluid.io.load_program_state(model_path, var_list=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.io.load_program_state +:alias: paddle.io.load_program_state +:old_api: paddle.fluid.io.load_program_state + + + diff --git a/doc/fluid/api_cn/io_cn/load_vars_cn.rst b/doc/fluid/api_cn/io_cn/load_vars_cn.rst index 4126ae5eccefb3c713d20607031dd1ab2642f6fa..57178a8f2c4166f070943efcc3de1b3fda44488b 100644 --- a/doc/fluid/api_cn/io_cn/load_vars_cn.rst +++ b/doc/fluid/api_cn/io_cn/load_vars_cn.rst @@ -9,6 +9,9 @@ load_vars + + + 该接口从文件中加载 ``Program`` 的变量。 通过 ``vars`` 指定需要加载的变量，或者通过 ``predicate`` 筛选需要加载的变量， ``vars`` 和 ``predicate`` 不能同时为None。 diff --git a/doc/fluid/api_cn/io_cn/map_readers_cn.rst b/doc/fluid/api_cn/io_cn/map_readers_cn.rst index cb50e62839cd523184fef37d4ff9dc625c52fc6b..10e8602abf3a3ead77ac765cfaacbf91ec8b50f0 100644 --- a/doc/fluid/api_cn/io_cn/map_readers_cn.rst +++ b/doc/fluid/api_cn/io_cn/map_readers_cn.rst @@ -5,6 +5,11 @@ map_readers .. py:function:: paddle.fluid.io.map_readers(func, *readers) +:alias_main: paddle.io.map_readers +:alias: paddle.io.map_readers,paddle.io..reader.map_readers + + + diff --git a/doc/fluid/api_cn/io_cn/save_cn.rst b/doc/fluid/api_cn/io_cn/save_cn.rst index f5095aecb12322cda0284c9337bcf27c30dd0194..006a076199ba91e172594fcf1e8f74afc74ae001 100644 --- a/doc/fluid/api_cn/io_cn/save_cn.rst +++ b/doc/fluid/api_cn/io_cn/save_cn.rst @@ -7,6 +7,12 @@ save .. py:function:: paddle.fluid.io.save(program, model_path) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.save +:alias: paddle.save,paddle.io.save,paddle.tensor.save,paddle.tensor.io.save +:old_api: paddle.fluid.io.save + + + diff --git a/doc/fluid/api_cn/io_cn/save_inference_model_cn.rst b/doc/fluid/api_cn/io_cn/save_inference_model_cn.rst index e085e41395819349bbd3b4e87aed7f351a009cfe..aabcfa8834794235a5c7bd21d94686cf57feaf66 100644 --- a/doc/fluid/api_cn/io_cn/save_inference_model_cn.rst +++ b/doc/fluid/api_cn/io_cn/save_inference_model_cn.rst @@ -7,6 +7,12 @@ save_inference_model .. py:function:: paddle.fluid.io.save_inference_model(dirname, feeded_var_names, target_vars, executor, main_program=None, model_filename=None, params_filename=None, export_for_deployment=True, program_only=False) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.io.save_inference_model +:alias: paddle.io.save_inference_model +:old_api: paddle.fluid.io.save_inference_model + + + diff --git a/doc/fluid/api_cn/io_cn/save_params_cn.rst b/doc/fluid/api_cn/io_cn/save_params_cn.rst index 879c16ed0d192fbeaa9e803f07b245bd6d5ec076..6014971cedeaa133d3e8ccd488a3fda566054ab5 100644 --- a/doc/fluid/api_cn/io_cn/save_params_cn.rst +++ b/doc/fluid/api_cn/io_cn/save_params_cn.rst @@ -10,6 +10,9 @@ save_params + + + 该OP从 ``main_program`` 中取出所有参数，然后将它们保存到 ``dirname`` 目录下或名为 ``filename`` 的文件中。 ``dirname`` 用于指定保存参数的目标路径。若想将参数保存到多个独立文件中，设置 ``filename=None`` ； 若想将所有参数保存在单个文件中，请设置 ``filename`` 来指定该文件的名称。 diff --git a/doc/fluid/api_cn/io_cn/save_persistables_cn.rst b/doc/fluid/api_cn/io_cn/save_persistables_cn.rst index 9de51518e0caabcaf2a42a258116039753e5bac2..29d0d345661562d10fc851edc6008c15e68ae5f2 100644 --- a/doc/fluid/api_cn/io_cn/save_persistables_cn.rst +++ b/doc/fluid/api_cn/io_cn/save_persistables_cn.rst @@ -10,6 +10,9 @@ save_persistables + + + 该OP从给定 ``main_program`` 中取出所有持久性变量（详见 :ref:`api_guide_model_save_reader` ），然后将它们保存到目录 ``dirname`` 中或 ``filename`` 指定的文件中。 ``dirname`` 用于指定保存持久性变量的目录。如果想将持久性变量保存到指定目录的若干文件中，请设置 ``filename=None`` ; 若想将所有持久性变量保存在同一个文件中，请设置 ``filename`` 来指定文件的名称。 diff --git a/doc/fluid/api_cn/io_cn/save_vars_cn.rst b/doc/fluid/api_cn/io_cn/save_vars_cn.rst index 7530540754accd0f4658ba885721fab22493d738..efc0c0cfe038e65436dd321adfa86b76bc95fd5e 100644 --- a/doc/fluid/api_cn/io_cn/save_vars_cn.rst +++ b/doc/fluid/api_cn/io_cn/save_vars_cn.rst @@ -10,6 +10,9 @@ save_vars + + + 该接口将 ``Program`` 的变量保存到文件中。 通过 ``vars`` 指定需要保存的变量，或者通过 ``predicate`` 筛选需要保存的变量， ``vars`` 和 ``predicate`` 不能同时为None。 diff --git a/doc/fluid/api_cn/io_cn/set_program_state_cn.rst b/doc/fluid/api_cn/io_cn/set_program_state_cn.rst index 9af0478f0c88d1bc469c094725b13a33a7f28763..0168ff0867a63c8feddee938b7fd33b5312ccd98 100644 --- a/doc/fluid/api_cn/io_cn/set_program_state_cn.rst +++ b/doc/fluid/api_cn/io_cn/set_program_state_cn.rst @@ -6,6 +6,12 @@ set_program_state .. py:function:: paddle.fluid.io.set_program_state(program, state_dict) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.io.set_program_state +:alias: paddle.io.set_program_state +:old_api: paddle.fluid.io.set_program_state + + + diff --git a/doc/fluid/api_cn/io_cn/shuffle_cn.rst b/doc/fluid/api_cn/io_cn/shuffle_cn.rst index 7b64c23b7e5706e23a9051f60b3a55bea7ea6573..16562f0d9dd2f18098a359c3840f10cbd12e6fce 100644 --- a/doc/fluid/api_cn/io_cn/shuffle_cn.rst +++ b/doc/fluid/api_cn/io_cn/shuffle_cn.rst @@ -6,11 +6,14 @@ shuffle .. py:function:: paddle.fluid.io.shuffle(reader, buffer_size) :alias_main: paddle.shuffle -:alias: paddle.shuffle,paddle.tensor.shuffle,paddle.tensor.random.shuffle +:alias: paddle.shuffle,paddle.io.shuffle,paddle.tensor.shuffle,paddle.io..reader.shuffle,paddle.tensor.random.shuffle :old_api: paddle.fluid.io.shuffle + + + 该接口创建一个数据读取器，其功能是将原始数据读取器的数据打乱，然后返回无序的数据。 从原始数据读取器取出buf_size个数据到缓冲区，将缓冲区数据打乱，然后将无序的数据依次返回。当缓冲区数据全部输出后，再次执行上述步骤。 diff --git a/doc/fluid/api_cn/io_cn/xmap_readers_cn.rst b/doc/fluid/api_cn/io_cn/xmap_readers_cn.rst index 5f434ecb9525c4f8dd746319d2b4baace88c89ae..516bf5888ae5a3ba8baf93d6625f482c62e69ff7 100644 --- a/doc/fluid/api_cn/io_cn/xmap_readers_cn.rst +++ b/doc/fluid/api_cn/io_cn/xmap_readers_cn.rst @@ -5,6 +5,11 @@ xmap_readers .. py:function:: paddle.fluid.io.xmap_readers(mapper, reader, process_num, buffer_size, order=False) +:alias_main: paddle.io.xmap_readers +:alias: paddle.io.xmap_readers,paddle.io..reader.xmap_readers + + + diff --git a/doc/fluid/api_cn/layers_cn/BeamSearchDecoder_cn.rst b/doc/fluid/api_cn/layers_cn/BeamSearchDecoder_cn.rst index 67e7312aaef57ff031e410031aecc73bc50c265f..465256dad33a6e68d21a26b0ca4d9ca83e4066fa 100644 --- a/doc/fluid/api_cn/layers_cn/BeamSearchDecoder_cn.rst +++ b/doc/fluid/api_cn/layers_cn/BeamSearchDecoder_cn.rst @@ -10,6 +10,9 @@ BeamSearchDecoder :api_attr: 声明式编程模式（静态图) + + + 带beam search解码策略的解码器。该接口包装一个cell来计算概率，然后执行一个beam search步骤计算得分，并为每个解码步骤选择候选输出。更多详细信息请参阅 `Beam search `_ diff --git a/doc/fluid/api_cn/layers_cn/Decoder_cn.rst b/doc/fluid/api_cn/layers_cn/Decoder_cn.rst index 9adb65614226bafe68094528d902e88ec17d1d83..875cc85a85486fc39e77145ca942e146268447e3 100644 --- a/doc/fluid/api_cn/layers_cn/Decoder_cn.rst +++ b/doc/fluid/api_cn/layers_cn/Decoder_cn.rst @@ -11,6 +11,9 @@ Decoder + + + Decoder是dynamic_decode中使用的任何decoder实例的基类。它提供了为每一个时间步生成输出的接口，可用于生成序列。 diff --git a/doc/fluid/api_cn/layers_cn/DynamicRNN_cn.rst b/doc/fluid/api_cn/layers_cn/DynamicRNN_cn.rst index e082d6bf6e58467803050e426a8fa1cc1fcc9193..39adabe35c2e96f7aae22457ea680dd4ea69acb1 100644 --- a/doc/fluid/api_cn/layers_cn/DynamicRNN_cn.rst +++ b/doc/fluid/api_cn/layers_cn/DynamicRNN_cn.rst @@ -10,6 +10,9 @@ DynamicRNN + + + **注意：该类型的输入仅支持LoDTensor，如果您需要处理的输入数据是Tensor类型， 请使用StaticRNN（ fluid.layers.** :ref:`cn_api_fluid_layers_StaticRNN` **)。** diff --git a/doc/fluid/api_cn/layers_cn/GRUCell_cn.rst b/doc/fluid/api_cn/layers_cn/GRUCell_cn.rst index a714757be122b2c7dd2cd936f809725991807996..be35b253f932a4ff8ab602b7c01511576a4ccba2 100644 --- a/doc/fluid/api_cn/layers_cn/GRUCell_cn.rst +++ b/doc/fluid/api_cn/layers_cn/GRUCell_cn.rst @@ -9,6 +9,9 @@ GRUCell :api_attr: 声明式编程模式（静态图) + + + 门控循环单元（Gated Recurrent Unit）。通过对 :code:`fluid.contrib.layers.rnn_impl.BasicGRUUnit` 包装，来让它可以应用于RNNCell。 diff --git a/doc/fluid/api_cn/layers_cn/IfElse_cn.rst b/doc/fluid/api_cn/layers_cn/IfElse_cn.rst index 2ba7ff3b9eef50d97ba80f5e323df16ce7d6e815..fba814bc28506880940f78f3c7c4f7baa26a6862 100644 --- a/doc/fluid/api_cn/layers_cn/IfElse_cn.rst +++ b/doc/fluid/api_cn/layers_cn/IfElse_cn.rst @@ -10,6 +10,9 @@ IfElse + + + 该类用于实现IfElse分支控制功能， IfElse包含两个Block，true_block，false_block，IfElse会将满足True或False条件的数据分别放入不同的block运行。 cond是一个shape为[N, 1]、数据类型为bool的2-D tensor，表示输入数据对应部分的执行条件。 diff --git a/doc/fluid/api_cn/layers_cn/LSTMCell_cn.rst b/doc/fluid/api_cn/layers_cn/LSTMCell_cn.rst index 183dd4ff210000f8c9138d18d402d431d245dd86..559fe5b1233db6e06d65fc85a5f9bedcad06ec22 100644 --- a/doc/fluid/api_cn/layers_cn/LSTMCell_cn.rst +++ b/doc/fluid/api_cn/layers_cn/LSTMCell_cn.rst @@ -10,6 +10,9 @@ LSTMCell :api_attr: 声明式编程模式（静态图) + + + 长短期记忆单元（Long-Short Term Memory）。通过对 :code:`fluid.contrib.layers.rnn_impl.BasicLSTMUnit` 包装，来让它可以应用于RNNCell。 diff --git a/doc/fluid/api_cn/layers_cn/Print_cn.rst b/doc/fluid/api_cn/layers_cn/Print_cn.rst index 422bab77d425f81f2097ef9e297a7cf50335b1d6..3f7736821202fb593b103d717699bad0b9b3d4c5 100644 --- a/doc/fluid/api_cn/layers_cn/Print_cn.rst +++ b/doc/fluid/api_cn/layers_cn/Print_cn.rst @@ -10,6 +10,12 @@ Print + + + + + + **Print操作命令** 该OP创建一个打印操作，打印正在访问的Tensor内容。 diff --git a/doc/fluid/api_cn/layers_cn/RNNCell_cn.rst b/doc/fluid/api_cn/layers_cn/RNNCell_cn.rst index edc8d0df0369029d9c9021621919b7a60b1b7523..1fedfbb9484b9b6c2fa63fa2b518f5ae483a5280 100644 --- a/doc/fluid/api_cn/layers_cn/RNNCell_cn.rst +++ b/doc/fluid/api_cn/layers_cn/RNNCell_cn.rst @@ -10,6 +10,9 @@ RNNCell :api_attr: 声明式编程模式（静态图) + + + RNNCell是抽象的基类，代表将输入和状态映射到输出和新状态的计算，主要用于RNN。 .. py:method:: call(inputs, states, **kwargs) diff --git a/doc/fluid/api_cn/layers_cn/StaticRNN_cn.rst b/doc/fluid/api_cn/layers_cn/StaticRNN_cn.rst index ee524611b8f70b678c80d24a89728b9af20da90f..385dac037a734b385b292dc77e0047ab011d92c8 100644 --- a/doc/fluid/api_cn/layers_cn/StaticRNN_cn.rst +++ b/doc/fluid/api_cn/layers_cn/StaticRNN_cn.rst @@ -10,6 +10,9 @@ StaticRNN + + + 该OP用来处理一批序列数据，其中每个样本序列的长度必须相等。StaticRNN将序列按照时间步长展开，用户需要定义每个时间步中的处理逻辑。 参数： diff --git a/doc/fluid/api_cn/layers_cn/Switch_cn.rst b/doc/fluid/api_cn/layers_cn/Switch_cn.rst index e4d132861ae84f5d6ba6befc42a7b6811aed4d40..b0172aef5d047b94c94cdd0544b2fedf5961d893 100644 --- a/doc/fluid/api_cn/layers_cn/Switch_cn.rst +++ b/doc/fluid/api_cn/layers_cn/Switch_cn.rst @@ -10,6 +10,9 @@ Switch + + + 该类用于实现Switch分支控制功能。Switch分支包含多个case分支和一个default分支，Switch控制流会依次检查各case分支条件是否满足，并仅执行第一个满足条件的case分支后面的语句。若不存在满足条件的case分支，则仅执行default分支后面的语句。 .. note:: diff --git a/doc/fluid/api_cn/layers_cn/While_cn.rst b/doc/fluid/api_cn/layers_cn/While_cn.rst index 0e851830bd2dfeca29306e43cae88acb9aa2b798..6d8fcebdd36935375a36fa9bde51c2c5bda01fbb 100644 --- a/doc/fluid/api_cn/layers_cn/While_cn.rst +++ b/doc/fluid/api_cn/layers_cn/While_cn.rst @@ -11,6 +11,9 @@ While + + + 该类用于实现while循环控制功能，只要循环条件cond为True，就循环执行while循环体中的语句，直到cond为False为止。 .. note:: diff --git a/doc/fluid/api_cn/layers_cn/abs_cn.rst b/doc/fluid/api_cn/layers_cn/abs_cn.rst index cf726de9f97c0bc5c621654cf07ff5787f8c9260..2b1cde5801c311b68d9b607d28f33517e57f4282 100644 --- a/doc/fluid/api_cn/layers_cn/abs_cn.rst +++ b/doc/fluid/api_cn/layers_cn/abs_cn.rst @@ -11,6 +11,9 @@ abs + + + 绝对值激活函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/acos_cn.rst b/doc/fluid/api_cn/layers_cn/acos_cn.rst index 9185569aa0e9f5329c63bc734e3a96996042584e..6664fb0e9121d98f8641a4ec06b761eb5f53d3e6 100644 --- a/doc/fluid/api_cn/layers_cn/acos_cn.rst +++ b/doc/fluid/api_cn/layers_cn/acos_cn.rst @@ -11,6 +11,9 @@ acos + + + arccosine激活函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/adaptive_pool2d_cn.rst b/doc/fluid/api_cn/layers_cn/adaptive_pool2d_cn.rst index c2a5026955e2e2c1e5484ec1799ced2851921a88..d9a27037ae08d6f33f597105523ea63e68d33116 100644 --- a/doc/fluid/api_cn/layers_cn/adaptive_pool2d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/adaptive_pool2d_cn.rst @@ -11,6 +11,9 @@ adaptive_pool2d + + + 该OP使用上述输入参数的池化配置，为二维空间自适应池化操作，根据 ``input`` ， 池化类型 ``pool_type`` ， 池化核大小 ``pool_size`` 这些参数得到输出。 输入X和输出Out是NCHW格式，N为批大小，C是通道数，H是特征高度，W是特征宽度。参数 ``pool_size`` 含有两个整型元素, 分别代表高度和宽度上的参数。输出Out的H和W维由 ``pool_size`` 决定，即输出shape为 :math:`\left ( N,C,pool_size[0],pool_size[1] \right )` diff --git a/doc/fluid/api_cn/layers_cn/adaptive_pool3d_cn.rst b/doc/fluid/api_cn/layers_cn/adaptive_pool3d_cn.rst index ec7c4d13210b745f6dba3bd307ab1587558c2535..4461063e53ca7301326161c0963442327f23018a 100644 --- a/doc/fluid/api_cn/layers_cn/adaptive_pool3d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/adaptive_pool3d_cn.rst @@ -11,6 +11,9 @@ adaptive_pool3d + + + 该OP使用上述输入参数的池化配置，为二维空间自适应池化操作，根据 ``input`` ， 池化类型 ``pool_type`` ， 池化核大小 ``pool_size`` 这些参数得到输出。 输入X和输出Out是NCDHW格式，N为批大小，D是特征深度，C是通道数，H是特征高度，W是特征宽度。参数 ``pool_size`` 含有两个整型元素, 分别代表深度，高度和宽度上的参数。输出Out的D, H和W维由 ``pool_size`` 决定，即输出shape为 :math:`\left ( N,C,pool_size[0],pool_size[1],pool_size[2] \right )` diff --git a/doc/fluid/api_cn/layers_cn/add_position_encoding_cn.rst b/doc/fluid/api_cn/layers_cn/add_position_encoding_cn.rst index abba3377ba359ac496848262f1fe29705ea504b0..260ffef25add5254b320345da18877b15a96caed 100644 --- a/doc/fluid/api_cn/layers_cn/add_position_encoding_cn.rst +++ b/doc/fluid/api_cn/layers_cn/add_position_encoding_cn.rst @@ -11,6 +11,9 @@ add_position_encoding + + + 该OP将输入inpu中每个位置（序列中的位置）的特征与对应的位置编码加权求和，位置编码可参考论文: `Attention Is All You Need `_ 输出的计算公式如下： diff --git a/doc/fluid/api_cn/layers_cn/affine_channel_cn.rst b/doc/fluid/api_cn/layers_cn/affine_channel_cn.rst index c810d489a98304681ab230606d87b13bfed49ca4..6e70077ffd368a8d4fa09485e873d7076cbdbeaf 100644 --- a/doc/fluid/api_cn/layers_cn/affine_channel_cn.rst +++ b/doc/fluid/api_cn/layers_cn/affine_channel_cn.rst @@ -11,6 +11,9 @@ affine_channel + + + 对输入的每个 channel 应用单独的仿射变换。用于将空间批量归一化替换为其等价的固定变换。 输入也可以是二维张量，并在第二维应用仿射变换。 diff --git a/doc/fluid/api_cn/layers_cn/affine_grid_cn.rst b/doc/fluid/api_cn/layers_cn/affine_grid_cn.rst index 287116d9f5f6845eb0f874a78c329ca49676b14d..ec5fb335189bde4fe6fb6b43cc8f2bbbf179c2e8 100644 --- a/doc/fluid/api_cn/layers_cn/affine_grid_cn.rst +++ b/doc/fluid/api_cn/layers_cn/affine_grid_cn.rst @@ -11,6 +11,9 @@ affine_grid + + + 该OP用于生成仿射变换前后的feature maps的坐标映射关系。在视觉应用中，根据该OP得到的映射关系，将输入feature map的像素点变换到对应的坐标，就得到了经过仿射变换的feature map。 参数： diff --git a/doc/fluid/api_cn/layers_cn/anchor_generator_cn.rst b/doc/fluid/api_cn/layers_cn/anchor_generator_cn.rst index ada0130cce84b1f94d57f60859b04f3b83d1d6ca..db1b92c36d0f009e70d542db3cd7eacd52939780 100644 --- a/doc/fluid/api_cn/layers_cn/anchor_generator_cn.rst +++ b/doc/fluid/api_cn/layers_cn/anchor_generator_cn.rst @@ -11,6 +11,9 @@ anchor_generator + + + **Anchor generator operator** 为RCNN算法生成anchor，输入的每一位产生N个anchor，N=size(anchor_sizes)*size(aspect_ratios)。生成anchor的顺序首先是aspect_ratios循环，然后是anchor_sizes循环。 diff --git a/doc/fluid/api_cn/layers_cn/argmin_cn.rst b/doc/fluid/api_cn/layers_cn/argmin_cn.rst index 74ba5fbc52a2cc285cd9d1a370246e028ec0b14c..7caeace7c7caf0298fda935ac108826484cbc323 100644 --- a/doc/fluid/api_cn/layers_cn/argmin_cn.rst +++ b/doc/fluid/api_cn/layers_cn/argmin_cn.rst @@ -11,6 +11,9 @@ argmin + + + **argmin** 该OP沿 ``axis`` 计算输入 ``x`` 的最小元素的索引。 diff --git a/doc/fluid/api_cn/layers_cn/argsort_cn.rst b/doc/fluid/api_cn/layers_cn/argsort_cn.rst index a681b3beefadc7c601a42a23a958792b5bac9939..168fb3145c7e13544c2045c60ac71f44f9309738 100644 --- a/doc/fluid/api_cn/layers_cn/argsort_cn.rst +++ b/doc/fluid/api_cn/layers_cn/argsort_cn.rst @@ -11,6 +11,9 @@ argsort + + + 对输入变量沿给定轴进行排序，输出排序好的数据和相应的索引，其维度和输入相同。**默认升序排列，如果需要降序排列设置** ``descending=True`` 。 diff --git a/doc/fluid/api_cn/layers_cn/asin_cn.rst b/doc/fluid/api_cn/layers_cn/asin_cn.rst index 03109d28ec3125c9f1cc5a3e8bd97e63484bde07..333e8bcae4bcdcb8070780d79f542b71e6cff2f0 100644 --- a/doc/fluid/api_cn/layers_cn/asin_cn.rst +++ b/doc/fluid/api_cn/layers_cn/asin_cn.rst @@ -11,6 +11,9 @@ asin + + + arcsine激活函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/assign_cn.rst b/doc/fluid/api_cn/layers_cn/assign_cn.rst index da7b3c8f146aa744735c464902f0d633364e8288..880d070ded9dd8bb1e7e9e567b7c26138ff7e071 100644 --- a/doc/fluid/api_cn/layers_cn/assign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/assign_cn.rst @@ -11,6 +11,9 @@ assign + + + 该OP将输入Tensor或numpy数组拷贝至输出Tensor。 参数： diff --git a/doc/fluid/api_cn/layers_cn/atan_cn.rst b/doc/fluid/api_cn/layers_cn/atan_cn.rst index 1c36f104731560ef4918730b21682497cbd415e2..40d0c782277fac9dd49d5c36501dc18ba0f9a465 100644 --- a/doc/fluid/api_cn/layers_cn/atan_cn.rst +++ b/doc/fluid/api_cn/layers_cn/atan_cn.rst @@ -11,6 +11,9 @@ atan + + + arctanh激活函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/autoincreased_step_counter_cn.rst b/doc/fluid/api_cn/layers_cn/autoincreased_step_counter_cn.rst index 821b793f511e943ec53e253c1df108ac60286fea..e88769f8b481315b9f3f175644e602bc8ae87e58 100644 --- a/doc/fluid/api_cn/layers_cn/autoincreased_step_counter_cn.rst +++ b/doc/fluid/api_cn/layers_cn/autoincreased_step_counter_cn.rst @@ -10,6 +10,9 @@ autoincreased_step_counter + + + 创建一个自增变量，每个迭代累加一次，默认首次返回值为 1，默认累加步长为 1。 参数： diff --git a/doc/fluid/api_cn/layers_cn/batch_norm_cn.rst b/doc/fluid/api_cn/layers_cn/batch_norm_cn.rst index 95fa58257d7180f8a16176aa7b754f0b20124507..ada24f6f83207592ba1d2feff24ccc1cd1a05fb3 100644 --- a/doc/fluid/api_cn/layers_cn/batch_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/batch_norm_cn.rst @@ -7,6 +7,12 @@ batch_norm .. py:function:: paddle.fluid.layers.batch_norm(input, act=None, is_test=False, momentum=0.9, epsilon=1e-05, param_attr=None, bias_attr=None, data_layout='NCHW', in_place=False, name=None, moving_mean_name=None, moving_variance_name=None, do_model_average_for_mean_and_var=False, use_global_stats=False) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.batch_norm +:alias: paddle.declarative.batch_norm +:old_api: paddle.fluid.layers.batch_norm + + + diff --git a/doc/fluid/api_cn/layers_cn/beam_search_cn.rst b/doc/fluid/api_cn/layers_cn/beam_search_cn.rst index 36174f2a63b1dba8a02b7f34af9d2034e3363d6f..2f5a1a34a7098791b7c7835e542c663aec3c8e36 100644 --- a/doc/fluid/api_cn/layers_cn/beam_search_cn.rst +++ b/doc/fluid/api_cn/layers_cn/beam_search_cn.rst @@ -11,6 +11,9 @@ beam_search + + + 束搜索(Beam search)是在机器翻译等生成任务中选择候选词的一种经典算法 更多细节参考 `Beam Search `_ diff --git a/doc/fluid/api_cn/layers_cn/beam_search_decode_cn.rst b/doc/fluid/api_cn/layers_cn/beam_search_decode_cn.rst index a6b46142e1804180cae16c0ab99625fdafa3299c..001c19e1523e0dbed5bb19408a76698763615fa3 100644 --- a/doc/fluid/api_cn/layers_cn/beam_search_decode_cn.rst +++ b/doc/fluid/api_cn/layers_cn/beam_search_decode_cn.rst @@ -11,6 +11,9 @@ beam_search_decode + + + 该OP用在整个束搜索(Beam search)结束后，通过沿 ``ids`` 中保存的搜索路径回溯，为每个源句（样本）构造完整的beam search结果序列并保存在LoDTensor中。LoDTensor的格式和解析方式如下： :: diff --git a/doc/fluid/api_cn/layers_cn/bilinear_tensor_product_cn.rst b/doc/fluid/api_cn/layers_cn/bilinear_tensor_product_cn.rst index d65e2abdc70a6a109b69ae474ed64f49167ff37e..1e779db6d1ad2fcf931449a1e73a687daec0fbc6 100644 --- a/doc/fluid/api_cn/layers_cn/bilinear_tensor_product_cn.rst +++ b/doc/fluid/api_cn/layers_cn/bilinear_tensor_product_cn.rst @@ -7,6 +7,12 @@ bilinear_tensor_product .. py:function:: paddle.fluid.layers.bilinear_tensor_product(x, y, size, act=None, name=None, param_attr=None, bias_attr=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.bilinear_tensor_product +:alias: paddle.declarative.bilinear_tensor_product +:old_api: paddle.fluid.layers.bilinear_tensor_product + + + diff --git a/doc/fluid/api_cn/layers_cn/bipartite_match_cn.rst b/doc/fluid/api_cn/layers_cn/bipartite_match_cn.rst index 23f2832d97d605b6a80af69ec8ceafbdc3ad9d40..79f918f578ab9ff19a794ea71fad63d70e55effe 100644 --- a/doc/fluid/api_cn/layers_cn/bipartite_match_cn.rst +++ b/doc/fluid/api_cn/layers_cn/bipartite_match_cn.rst @@ -11,6 +11,9 @@ bipartite_match + + + 该OP实现了贪心二分匹配算法，该算法用于根据输入距离矩阵获得与最大距离的匹配。对于输入二维矩阵，二分匹配算法可以找到每一行的匹配列（匹配意味着最大距离），也可以找到每列的匹配行。此算子仅计算列到行的匹配索引。对于每个实例，匹配索引的数量是 输入距离矩阵的列号。**该OP仅支持CPU** diff --git a/doc/fluid/api_cn/layers_cn/box_clip_cn.rst b/doc/fluid/api_cn/layers_cn/box_clip_cn.rst index 2b5b4ad767b52a49333a9aada0cfce187e71aa1a..e9d605349ea1fb01fdaee2dd71fde7167d3bad96 100644 --- a/doc/fluid/api_cn/layers_cn/box_clip_cn.rst +++ b/doc/fluid/api_cn/layers_cn/box_clip_cn.rst @@ -11,6 +11,9 @@ box_clip + + + 将检测框框剪切为 ``im_info`` 给出的大小。对于每个输入框，公式如下： :: diff --git a/doc/fluid/api_cn/layers_cn/box_coder_cn.rst b/doc/fluid/api_cn/layers_cn/box_coder_cn.rst index eb991c1e53e93aa4bfa4b0aa512cf5d78465ee84..ae4a205ca1e5eb94437f59d2a9cd4b29b14c0228 100644 --- a/doc/fluid/api_cn/layers_cn/box_coder_cn.rst +++ b/doc/fluid/api_cn/layers_cn/box_coder_cn.rst @@ -11,6 +11,9 @@ box_coder + + + Bounding Box Coder 编码/解码带有先验框信息的目标边界框 diff --git a/doc/fluid/api_cn/layers_cn/box_decoder_and_assign_cn.rst b/doc/fluid/api_cn/layers_cn/box_decoder_and_assign_cn.rst index df65ef34c8563521040a6851646e4b23192f7424..4cb4a9d280d0ac14954776bcd01ca1678688f3ff 100644 --- a/doc/fluid/api_cn/layers_cn/box_decoder_and_assign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/box_decoder_and_assign_cn.rst @@ -11,6 +11,9 @@ box_decoder_and_assign + + + 边界框编码器。 根据先验框来解码目标边界框。 diff --git a/doc/fluid/api_cn/layers_cn/bpr_loss_cn.rst b/doc/fluid/api_cn/layers_cn/bpr_loss_cn.rst index 06195e5198988de8eb5cbdaf2460ea20bc3482bb..59418532ccad846a7c9a67aba6173faa184c0669 100644 --- a/doc/fluid/api_cn/layers_cn/bpr_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/bpr_loss_cn.rst @@ -12,6 +12,9 @@ bpr_loss + + + 贝叶斯个性化排序损失函数（Bayesian Personalized Ranking Loss Operator ） 该OP属于pairwise类型的损失函数。损失值由下式计算而得: diff --git a/doc/fluid/api_cn/layers_cn/brelu_cn.rst b/doc/fluid/api_cn/layers_cn/brelu_cn.rst index 0931ad4cea3cfd17ae8476e450762ed7b359c2c9..aa15041d50bffd50f3138c097c3c9e3a691124ea 100644 --- a/doc/fluid/api_cn/layers_cn/brelu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/brelu_cn.rst @@ -12,6 +12,9 @@ brelu + + + BReLU 激活函数 .. math:: out=min(max(x,t\_min),t\_max) diff --git a/doc/fluid/api_cn/layers_cn/case_cn.rst b/doc/fluid/api_cn/layers_cn/case_cn.rst index f1f76eae157728e7866eed1ef08e43c41dbe9a1f..e5ca1341fba074e4d290d8da9a26c302cc8c25fe 100644 --- a/doc/fluid/api_cn/layers_cn/case_cn.rst +++ b/doc/fluid/api_cn/layers_cn/case_cn.rst @@ -13,6 +13,9 @@ case + + + 该OP的运行方式类似于python的if-elif-elif-else。 参数： diff --git a/doc/fluid/api_cn/layers_cn/cast_cn.rst b/doc/fluid/api_cn/layers_cn/cast_cn.rst index 8ce45cef9fe74a6016bf1d4f264696cde94d9e71..ec4a623952d076cd91f177ef959249009e7297e7 100644 --- a/doc/fluid/api_cn/layers_cn/cast_cn.rst +++ b/doc/fluid/api_cn/layers_cn/cast_cn.rst @@ -11,6 +11,9 @@ cast + + + 该OP将 ``x`` 的数据类型转换为 ``dtype`` 并输出。支持输出和输入的数据类型相同。 参数： diff --git a/doc/fluid/api_cn/layers_cn/ceil_cn.rst b/doc/fluid/api_cn/layers_cn/ceil_cn.rst index 27ca3dd547fb43ecf26ce0d499ce39049e2ef1bb..ddf3f2c33183736eae12ed0596465e0a45f63b15 100644 --- a/doc/fluid/api_cn/layers_cn/ceil_cn.rst +++ b/doc/fluid/api_cn/layers_cn/ceil_cn.rst @@ -11,6 +11,9 @@ ceil + + + 向上取整运算函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/center_loss_cn.rst b/doc/fluid/api_cn/layers_cn/center_loss_cn.rst index 82be3da0d52e96c7f9a3d97f1943691513ab4450..bf0758749893ed63714decfd60229ece068322c8 100644 --- a/doc/fluid/api_cn/layers_cn/center_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/center_loss_cn.rst @@ -13,6 +13,9 @@ center_loss + + + 该OP接收一个来自于最后一个隐藏层的输出和目标标签作为输入，返回损失值。为每一个类别提供一个类别中心，计算mini-batch中每个样本与对应类别中心的距离的平均值作为center loss。 对于输入，\(X\)和标签\(Y\)，计算公式为： diff --git a/doc/fluid/api_cn/layers_cn/chunk_eval_cn.rst b/doc/fluid/api_cn/layers_cn/chunk_eval_cn.rst index c264a071ab03ca4a53279da3906db671e499b1d2..aeca33ca5df22c992c4dc0964fde69b11f94f62e 100644 --- a/doc/fluid/api_cn/layers_cn/chunk_eval_cn.rst +++ b/doc/fluid/api_cn/layers_cn/chunk_eval_cn.rst @@ -5,6 +5,12 @@ chunk_eval .. py:function:: paddle.fluid.layers.chunk_eval(input, label, chunk_scheme, num_chunk_types, excluded_chunk_types=None, sqe_length=None) +:alias_main: paddle.metric.chunk_eval +:alias: paddle.metric.chunk_eval +:old_api: paddle.fluid.layers.nn.chunk_eval + + + diff --git a/doc/fluid/api_cn/layers_cn/clip_by_norm_cn.rst b/doc/fluid/api_cn/layers_cn/clip_by_norm_cn.rst index af3467b58d02d54d02dcac5a792c03f3a5db8405..5c90e03f8d37242adb6df1c717e7aa93bfdb0ccb 100644 --- a/doc/fluid/api_cn/layers_cn/clip_by_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/clip_by_norm_cn.rst @@ -11,6 +11,9 @@ clip_by_norm + + + ClipByNorm算子 此算子将输入 ``X`` 的L2范数限制在 ``max_norm`` 内。如果 ``X`` 的L2范数小于或等于 ``max_norm`` ，则输出（Out）将与 ``X`` 相同。如果X的L2范数大于 ``max_norm`` ，则 ``X`` 将被线性缩放，使得输出（Out）的L2范数等于 ``max_norm`` ，如下面的公式所示： diff --git a/doc/fluid/api_cn/layers_cn/clip_cn.rst b/doc/fluid/api_cn/layers_cn/clip_cn.rst index 071fe323ffdf8de41a454669e3b23e2f7f976a4b..675238c6df6dc9061a7204b6f1768afc4750838f 100644 --- a/doc/fluid/api_cn/layers_cn/clip_cn.rst +++ b/doc/fluid/api_cn/layers_cn/clip_cn.rst @@ -11,6 +11,9 @@ clip + + + 该OP对输入Tensor每个元素的数值进行裁剪，使得输出Tensor元素的数值被限制在区间[min, max]内。具体的计算公式为如下。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/collect_fpn_proposals_cn.rst b/doc/fluid/api_cn/layers_cn/collect_fpn_proposals_cn.rst index 9c00888befa5a82ec0296f9f51496bea1697f273..2bb48918cd562b0e8c7ef59b07d02f246e1fef7b 100644 --- a/doc/fluid/api_cn/layers_cn/collect_fpn_proposals_cn.rst +++ b/doc/fluid/api_cn/layers_cn/collect_fpn_proposals_cn.rst @@ -11,6 +11,9 @@ collect_fpn_proposals + + + **该op仅支持LoDTensor输入**。连接多级RoIs（感兴趣区域）并依据multi_scores选择N个RoIs。此操作执行以下步骤： 1、选择num_level个RoIs和scores作为输入：num_level = max_level - min_level 2、连接num_level个RoIs和scores。 diff --git a/doc/fluid/api_cn/layers_cn/concat_cn.rst b/doc/fluid/api_cn/layers_cn/concat_cn.rst index 31f6d2cb67cdc9c718102e31ba5154a66d61e7fb..972c820c1a226523340d6a02db2de580e948d4fb 100644 --- a/doc/fluid/api_cn/layers_cn/concat_cn.rst +++ b/doc/fluid/api_cn/layers_cn/concat_cn.rst @@ -11,6 +11,9 @@ concat + + + 该OP对输入沿 ``axis`` 轴进行联结。 参数： diff --git a/doc/fluid/api_cn/layers_cn/cond_cn.rst b/doc/fluid/api_cn/layers_cn/cond_cn.rst index a72495a7392e8a17695a1eee96e286a7bcfba3dc..4c73000fcc796036ee359c94b97eb2810418260a 100644 --- a/doc/fluid/api_cn/layers_cn/cond_cn.rst +++ b/doc/fluid/api_cn/layers_cn/cond_cn.rst @@ -13,6 +13,9 @@ cond + + + 如果 ``pred`` 是 ``True`` ，该API返回 ``true_fn()`` ，否则返回 ``false_fn()`` 。 用户如果不想在 ``callable`` 中做任何事，可以把 ``true_fn`` 或 ``false_fn`` 设为 ``None`` ，此时本API会把该 ``callable`` 视为简单返回 ``None`` 。 diff --git a/doc/fluid/api_cn/layers_cn/continuous_value_model_cn.rst b/doc/fluid/api_cn/layers_cn/continuous_value_model_cn.rst index bdc610b1739df00f4d04f96ee501cfff7e107a94..07f001fb3e9e14a87390285a46d6871eec0d11bf 100644 --- a/doc/fluid/api_cn/layers_cn/continuous_value_model_cn.rst +++ b/doc/fluid/api_cn/layers_cn/continuous_value_model_cn.rst @@ -11,6 +11,9 @@ continuous_value_model + + + **注意：该OP仅支持在CPU运行。** 该OP在CTR项目中，用于去除或处理 ``input`` 中的展示和点击值。 diff --git a/doc/fluid/api_cn/layers_cn/conv2d_cn.rst b/doc/fluid/api_cn/layers_cn/conv2d_cn.rst index 4ae868dfea111869eaa664cc4ca7a763c86651c3..c2a59ba51c9b5af71247aefea5720090314b1ac4 100644 --- a/doc/fluid/api_cn/layers_cn/conv2d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/conv2d_cn.rst @@ -7,6 +7,12 @@ conv2d .. py:function:: paddle.fluid.layers.conv2d(input, num_filters, filter_size, stride=1, padding=0, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, name=None, data_format="NCHW") :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.conv2d +:alias: paddle.declarative.conv2d,paddle.nn.functional.conv2d,paddle.nn.functional.conv.conv2d +:old_api: paddle.fluid.layers.conv2d + + + diff --git a/doc/fluid/api_cn/layers_cn/conv2d_transpose_cn.rst b/doc/fluid/api_cn/layers_cn/conv2d_transpose_cn.rst index 3223f07188db98723157b6d8a53336dd9291653a..6560c825b1d6d458310ce2ec1973a2aa584fda30 100644 --- a/doc/fluid/api_cn/layers_cn/conv2d_transpose_cn.rst +++ b/doc/fluid/api_cn/layers_cn/conv2d_transpose_cn.rst @@ -7,6 +7,12 @@ conv2d_transpose .. py:function:: paddle.fluid.layers.conv2d_transpose(input, num_filters, output_size=None, filter_size=None, padding=0, stride=1, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, name=None, data_format='NCHW') :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.conv2d_transpose +:alias: paddle.declarative.conv2d_transpose,paddle.nn.functional.conv2d_transpose,paddle.nn.functional.conv.conv2d_transpose +:old_api: paddle.fluid.layers.conv2d_transpose + + + diff --git a/doc/fluid/api_cn/layers_cn/conv3d_cn.rst b/doc/fluid/api_cn/layers_cn/conv3d_cn.rst index 7468274e7a27a5ce3984d4fb1e0d13daa2237b05..b8a97f1dfc831a8309a7982dd7cc452d20dc9354 100644 --- a/doc/fluid/api_cn/layers_cn/conv3d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/conv3d_cn.rst @@ -7,6 +7,12 @@ conv3d .. py:function:: paddle.fluid.layers.conv3d(input, num_filters, filter_size, stride=1, padding=0, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, name=None, data_format="NCDHW") :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.conv3d +:alias: paddle.declarative.conv3d,paddle.nn.functional.conv3d,paddle.nn.functional.conv.conv3d +:old_api: paddle.fluid.layers.conv3d + + + diff --git a/doc/fluid/api_cn/layers_cn/conv3d_transpose_cn.rst b/doc/fluid/api_cn/layers_cn/conv3d_transpose_cn.rst index 0331df5d6a4fab39a78c68190b0b1066ec5681a9..d7de954ffd36953dc5dc4ee2e29abf62301e7878 100644 --- a/doc/fluid/api_cn/layers_cn/conv3d_transpose_cn.rst +++ b/doc/fluid/api_cn/layers_cn/conv3d_transpose_cn.rst @@ -7,6 +7,12 @@ conv3d_transpose .. py:function:: paddle.fluid.layers.conv3d_transpose(input, num_filters, output_size=None, filter_size=None, padding=0, stride=1, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None, name=None, data_format='NCDHW') :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.conv3d_transpose +:alias: paddle.declarative.conv3d_transpose,paddle.nn.functional.conv3d_transpose,paddle.nn.functional.conv.conv3d_transpose +:old_api: paddle.fluid.layers.conv3d_transpose + + + diff --git a/doc/fluid/api_cn/layers_cn/cos_cn.rst b/doc/fluid/api_cn/layers_cn/cos_cn.rst index 4f31c473c95be1f3b4a46915c505fe29250d11e8..5db8aad9dac5b6f17f183f6a54334d90abf9aa63 100644 --- a/doc/fluid/api_cn/layers_cn/cos_cn.rst +++ b/doc/fluid/api_cn/layers_cn/cos_cn.rst @@ -11,6 +11,9 @@ cos + + + 余弦函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/cosine_decay_cn.rst b/doc/fluid/api_cn/layers_cn/cosine_decay_cn.rst index 9117c06dd61c6bef978cde326fd64075fdeb7657..d2a85729ef784c760fffda19eb6536bf42f6d822 100644 --- a/doc/fluid/api_cn/layers_cn/cosine_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/cosine_decay_cn.rst @@ -11,6 +11,9 @@ cosine_decay + + + 使用 cosine decay 的衰减方式进行学习率调整。 在训练模型时，建议一边进行训练一边降低学习率。 通过使用此方法，学习速率将通过如下cosine衰减策略进行衰减： diff --git a/doc/fluid/api_cn/layers_cn/create_parameter_cn.rst b/doc/fluid/api_cn/layers_cn/create_parameter_cn.rst index 4176d7507f80e9767b32755f1169fbcbd502bb6a..708ebc549171d2b6919e7101e18b402e4777e9ea 100644 --- a/doc/fluid/api_cn/layers_cn/create_parameter_cn.rst +++ b/doc/fluid/api_cn/layers_cn/create_parameter_cn.rst @@ -10,6 +10,12 @@ create_parameter + + + + + + 该OP创建一个参数。该参数是一个可学习的变量, 拥有梯度并且可优化。 **注意：这是一个低级别的API。如果您希望自己创建新的op，这个API将非常有用，无需使用layers。** diff --git a/doc/fluid/api_cn/layers_cn/create_py_reader_by_data_cn.rst b/doc/fluid/api_cn/layers_cn/create_py_reader_by_data_cn.rst index ed42dceaa52ef3be13ffc4d2d50d7458fb317584..0e9c523f3857959986ee32a372dc9c2e1cc59bdc 100644 --- a/doc/fluid/api_cn/layers_cn/create_py_reader_by_data_cn.rst +++ b/doc/fluid/api_cn/layers_cn/create_py_reader_by_data_cn.rst @@ -10,6 +10,9 @@ create_py_reader_by_data + + + 创建一个Python端提供数据的reader。该OP与 :ref:`cn_api_fluid_layers_py_reader` 类似，不同点在于它能够从feed变量列表读取数据。 参数： diff --git a/doc/fluid/api_cn/layers_cn/create_tensor_cn.rst b/doc/fluid/api_cn/layers_cn/create_tensor_cn.rst index d00d67ebbe70f10d06e8d4bd1d96cfcb6ff7145a..2c024017f5ced81ff10aaacba4dec9ee1bcf028c 100644 --- a/doc/fluid/api_cn/layers_cn/create_tensor_cn.rst +++ b/doc/fluid/api_cn/layers_cn/create_tensor_cn.rst @@ -11,6 +11,9 @@ create_tensor + + + 创建数据类型为dtype的Tensor。 参数： diff --git a/doc/fluid/api_cn/layers_cn/crf_decoding_cn.rst b/doc/fluid/api_cn/layers_cn/crf_decoding_cn.rst index ea5fd7eb1e56351474a5a72181b8e58e1929811d..444a5401082ed322dc94ee84e98a3f248ed1ba20 100644 --- a/doc/fluid/api_cn/layers_cn/crf_decoding_cn.rst +++ b/doc/fluid/api_cn/layers_cn/crf_decoding_cn.rst @@ -7,6 +7,12 @@ crf_decoding .. py:function:: paddle.fluid.layers.crf_decoding(input, param_attr, label=None, length=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.crf_decoding +:alias: paddle.declarative.crf_decoding +:old_api: paddle.fluid.layers.crf_decoding + + + diff --git a/doc/fluid/api_cn/layers_cn/crop_tensor_cn.rst b/doc/fluid/api_cn/layers_cn/crop_tensor_cn.rst index 5930ad3a8344fba96632ef2579a50e9afca010a6..76f4c73164181ea6d5108ceb0990558e6c8903d5 100644 --- a/doc/fluid/api_cn/layers_cn/crop_tensor_cn.rst +++ b/doc/fluid/api_cn/layers_cn/crop_tensor_cn.rst @@ -11,6 +11,9 @@ crop_tensor + + + 根据偏移量（offsets）和形状（shape），裁剪输入（x）Tensor。 **示例**： diff --git a/doc/fluid/api_cn/layers_cn/cross_entropy_cn.rst b/doc/fluid/api_cn/layers_cn/cross_entropy_cn.rst index be571e656a7ee8cdfbd68af0038fa31a0a7fafc5..629589f82d772e2b3a6d74f4c25623e1fc360cea 100644 --- a/doc/fluid/api_cn/layers_cn/cross_entropy_cn.rst +++ b/doc/fluid/api_cn/layers_cn/cross_entropy_cn.rst @@ -11,6 +11,9 @@ cross_entropy + + + 该OP计算输入input和标签label间的交叉熵，可用于计算硬标签或软标签的交叉熵。 1. 硬标签交叉熵算法：若soft_label = False, :math:`label[i_1, i_2, ..., i_k]` 表示每个样本的硬标签值: diff --git a/doc/fluid/api_cn/layers_cn/cumsum_cn.rst b/doc/fluid/api_cn/layers_cn/cumsum_cn.rst index fd9238e64bd85b90f4a54ced20b6dda1266b4e60..a27398445d07a25f81c73e90c319a0d854c431c5 100644 --- a/doc/fluid/api_cn/layers_cn/cumsum_cn.rst +++ b/doc/fluid/api_cn/layers_cn/cumsum_cn.rst @@ -11,6 +11,9 @@ cumsum + + + 沿给定轴(axis)的元素的累加和。默认结果的第一个元素和输入的第一个元素一致。如果exlusive为True，结果的第一个元素则为0。 参数： diff --git a/doc/fluid/api_cn/layers_cn/data_norm_cn.rst b/doc/fluid/api_cn/layers_cn/data_norm_cn.rst index 4954dfa22a7c67baa441c7a209ab7df87d8cc4d8..8b7b6ff492320498aa4fe085340e703e8fd7e1b1 100644 --- a/doc/fluid/api_cn/layers_cn/data_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/data_norm_cn.rst @@ -7,6 +7,12 @@ data_norm .. py:function:: paddle.fluid.layers.data_norm(input, act=None, epsilon=1e-05, param_attr=None, data_layout='NCHW', in_place=False, name=None, moving_mean_name=None, moving_variance_name=None, do_model_average_for_mean_and_var=False) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.data_norm +:alias: paddle.declarative.data_norm +:old_api: paddle.fluid.layers.data_norm + + + diff --git a/doc/fluid/api_cn/layers_cn/deformable_conv_cn.rst b/doc/fluid/api_cn/layers_cn/deformable_conv_cn.rst index a74315d5ad7fbcc54bef8869c7ebd11433450b2d..9c33dbcc6fd76c272dc7dae84fcec83fe87a2f02 100644 --- a/doc/fluid/api_cn/layers_cn/deformable_conv_cn.rst +++ b/doc/fluid/api_cn/layers_cn/deformable_conv_cn.rst @@ -7,6 +7,12 @@ deformable_conv .. py:function:: paddle.fluid.layers.deformable_conv(input, offset, mask, num_filters, filter_size, stride=1, padding=0, dilation=1, groups=None, deformable_groups=None, im2col_step=None, param_attr=None, bias_attr=None, modulated=True, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.deformable_conv +:alias: paddle.declarative.deformable_conv +:old_api: paddle.fluid.layers.deformable_conv + + + diff --git a/doc/fluid/api_cn/layers_cn/deformable_roi_pooling_cn.rst b/doc/fluid/api_cn/layers_cn/deformable_roi_pooling_cn.rst index e1b19b7ac12a275fabafbef26b8a51dc68553617..c2c10f742ef04f653a773de58bb6de23d1c1925b 100644 --- a/doc/fluid/api_cn/layers_cn/deformable_roi_pooling_cn.rst +++ b/doc/fluid/api_cn/layers_cn/deformable_roi_pooling_cn.rst @@ -11,6 +11,9 @@ deformable_roi_pooling + + + 可变形感兴趣区域（ROI）池化层 该OP对输入进行了可形变的感兴趣区域(ROI)池化操作。如同 `可形变卷积网络 `_ 描述的一样，它将为每个bin中的像素获取一个偏移量，以便于在合适的位置进行池化。在完成可变形感兴趣区域（ROI）池化操作之后，批量数将变为候选框的数量。 diff --git a/doc/fluid/api_cn/layers_cn/density_prior_box_cn.rst b/doc/fluid/api_cn/layers_cn/density_prior_box_cn.rst index c88bff497978ffa81b31b332df065ff2e265c77a..e0a73130c2fc679996520820d4b5f53bc4fdadf5 100644 --- a/doc/fluid/api_cn/layers_cn/density_prior_box_cn.rst +++ b/doc/fluid/api_cn/layers_cn/density_prior_box_cn.rst @@ -12,6 +12,9 @@ density_prior_box + + + 该OP为SSD算法(Single Shot MultiBox Detector)生成density prior box，在每个 ``input`` 的位置产生N个候选框，其中，N由 ``densities`` , ``fixed_sizes`` 和 ``fixed_ratios`` 来计算。生成的每个输入位置附近的候选框中心（网格点）由 ``densities`` 和 ``density prior box`` 的数量计算，其中 ``density prior box`` 的数量由 ``fixed_sizes`` 和 ``fixed_ratios`` 决定。``fixed_sizes`` 和 ``densities`` 的大小一致。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/detection_output_cn.rst b/doc/fluid/api_cn/layers_cn/detection_output_cn.rst index 9d39e7881dc9b191dcec464b3a190404aef933d1..ca0e0c555715d53cd987be5cdac6abaef09350d3 100644 --- a/doc/fluid/api_cn/layers_cn/detection_output_cn.rst +++ b/doc/fluid/api_cn/layers_cn/detection_output_cn.rst @@ -11,6 +11,9 @@ detection_output + + + 给定回归位置偏移、置信度以及先验框信息计算检测的输出，执行步骤如下： 1.根据先验框(``prior_box``)信息和回归位置偏移解码出预测框坐标。 diff --git a/doc/fluid/api_cn/layers_cn/diag_cn.rst b/doc/fluid/api_cn/layers_cn/diag_cn.rst index f08ae61e0e44c620ee20cadc979c91450aec9010..80c1b216a4d5e1d0ae0f10aa803258b1590f0a1b 100644 --- a/doc/fluid/api_cn/layers_cn/diag_cn.rst +++ b/doc/fluid/api_cn/layers_cn/diag_cn.rst @@ -11,6 +11,9 @@ diag + + + 该OP创建一个方阵，使用输入diagonal来指定方阵的对角线元素的值。 参数： diff --git a/doc/fluid/api_cn/layers_cn/dice_loss_cn.rst b/doc/fluid/api_cn/layers_cn/dice_loss_cn.rst index af63877e359bf830d35985556e6e94e215adba75..d6d01b9217d37c1a5579ed73a864aecc80c1ed27 100644 --- a/doc/fluid/api_cn/layers_cn/dice_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/dice_loss_cn.rst @@ -11,6 +11,9 @@ dice_loss + + + 该OP用来比较预测结果跟标签之间的相似度，通常用于二值图像分割，即标签为二值，也可以做多标签的分割。 dice_loss定义为: diff --git a/doc/fluid/api_cn/layers_cn/distribute_fpn_proposals_cn.rst b/doc/fluid/api_cn/layers_cn/distribute_fpn_proposals_cn.rst index 33cbb83a59486ec75eef9962b0af3035f61e3415..11f42ec3c904e944bccf4c7edc73538ba00f839d 100644 --- a/doc/fluid/api_cn/layers_cn/distribute_fpn_proposals_cn.rst +++ b/doc/fluid/api_cn/layers_cn/distribute_fpn_proposals_cn.rst @@ -11,6 +11,9 @@ distribute_fpn_proposals + + + **该op仅支持LoDTensor输入**。在 Feature Pyramid Networks（FPN）模型中，需要依据proposal的尺度和参考尺度与级别将所有proposal分配到不同的FPN级别中。 此外，为了恢复proposals的顺序，我们返回一个数组，该数组表示当前proposals中的原始RoIs索引。 要计算每个RoI的FPN级别，公式如下： .. math:: diff --git a/doc/fluid/api_cn/layers_cn/dropout_cn.rst b/doc/fluid/api_cn/layers_cn/dropout_cn.rst index 8c748ec91af6395405bb46a43b3e94b59ebfa153..e12e07a5f358e1ced64f80a9a8d29c958fdf5b2a 100644 --- a/doc/fluid/api_cn/layers_cn/dropout_cn.rst +++ b/doc/fluid/api_cn/layers_cn/dropout_cn.rst @@ -11,6 +11,9 @@ dropout + + + dropout操作 丢弃或者保持x的每个元素独立。Dropout是一种正则化手段，通过在训练过程中阻止神经元节点间的相关性来减少过拟合。根据给定的丢弃概率，dropout操作符按丢弃概率随机将一些神经元输出设置为0，其他的仍保持不变。 diff --git a/doc/fluid/api_cn/layers_cn/dynamic_decode_cn.rst b/doc/fluid/api_cn/layers_cn/dynamic_decode_cn.rst index 6c439a90a54b5df6be64e743aef1d311d3908f15..ff999190acbee0a51a949c51c893ce14c4a39482 100644 --- a/doc/fluid/api_cn/layers_cn/dynamic_decode_cn.rst +++ b/doc/fluid/api_cn/layers_cn/dynamic_decode_cn.rst @@ -10,6 +10,9 @@ dynamic_decode :api_attr: 声明式编程模式（静态图) + + + 该接口重复执行 :code:`decoder.step()` 直到 其返回的表示完成状态的Tensor中的值全部为True或解码步骤达到 :code:`max_step_num`。 diff --git a/doc/fluid/api_cn/layers_cn/dynamic_gru_cn.rst b/doc/fluid/api_cn/layers_cn/dynamic_gru_cn.rst index 995ac50067ac3dfbf2b0cbbcaaf8ba0a417f8c12..55d1db14b87ee216941731c64a996a4637a4af0c 100644 --- a/doc/fluid/api_cn/layers_cn/dynamic_gru_cn.rst +++ b/doc/fluid/api_cn/layers_cn/dynamic_gru_cn.rst @@ -11,6 +11,9 @@ dynamic_gru + + + **注意：该OP的输入只能是LoDTensor，如果您需要处理的输入是Tensor类型，请使用StaticRNN（fluid.layers.** :ref:`cn_api_fluid_layers_StaticRNN` **）。** 该OP用于在完整序列上逐个时间步的进行单层Gated Recurrent Unit（GRU）的计算，单个时间步内GRU的计算支持以下两种计算方式： diff --git a/doc/fluid/api_cn/layers_cn/dynamic_lstm_cn.rst b/doc/fluid/api_cn/layers_cn/dynamic_lstm_cn.rst index 5c6bc406ba23f5d80dcf6586a9b32ead36019b72..f3844ae61c7da01c91aab8730bf95a6cecc9610a 100644 --- a/doc/fluid/api_cn/layers_cn/dynamic_lstm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/dynamic_lstm_cn.rst @@ -10,6 +10,9 @@ dynamic_lstm + + + 该OP实现了 LSTM，即 Long-Short Term Memory（长短期记忆）运算 - `Hochreiter, S., & Schmidhuber, J. (1997) `_。 .. note:: diff --git a/doc/fluid/api_cn/layers_cn/dynamic_lstmp_cn.rst b/doc/fluid/api_cn/layers_cn/dynamic_lstmp_cn.rst index 2306948c00f814e4cee1aa39e819646ab204a91e..70cd895ce5da01e17e1b7e31fcf5d5090ef12896 100644 --- a/doc/fluid/api_cn/layers_cn/dynamic_lstmp_cn.rst +++ b/doc/fluid/api_cn/layers_cn/dynamic_lstmp_cn.rst @@ -9,6 +9,9 @@ dynamic_lstmp + + + .. note:: 在实现的时候为了提升效率，用户必须将输入先进行线性映射，将维度为 [T, hidden_size] 的输入映射为 [T, 4×hidden_size] 输入，然后再传给该OP。 diff --git a/doc/fluid/api_cn/layers_cn/edit_distance_cn.rst b/doc/fluid/api_cn/layers_cn/edit_distance_cn.rst index 5d35868e1336614c624f5565429537bb6698e146..1dc85918c83fc018467da47ea69c2a7c3d162273 100644 --- a/doc/fluid/api_cn/layers_cn/edit_distance_cn.rst +++ b/doc/fluid/api_cn/layers_cn/edit_distance_cn.rst @@ -12,6 +12,9 @@ edit_distance + + + 该OP计算一批给定字符串及其参照字符串间的编辑距离。编辑距离也称Levenshtein距离，通过计算从一个字符串变成另一个字符串所需的最少操作步骤来衡量两个字符串的相异度。这里的操作包括插入、删除和替换。 比如给定假设字符串A=“kitten”和参照字符串B=“sitting”，从A变换成B编辑距离为3，至少需要两次替换和一次插入： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_add_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_add_cn.rst index 91b9cece85ab1490bc0ff45cb22ba26e6871f060..75c2d78424e1b102649f072b7e55c777cf0e23dc 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_add_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_add_cn.rst @@ -11,6 +11,9 @@ elementwise_add + + + 该OP是逐元素相加算子，输入 ``x`` 与输入 ``y`` 逐元素相加，并将各个位置的输出元素保存到返回结果中。 等式为： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_div_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_div_cn.rst index a5b7544d305db7bd611baee677d223fc9335006e..99f6e0ef7addd2729717260886fa20880156d0c5 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_div_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_div_cn.rst @@ -11,6 +11,9 @@ elementwise_div + + + 该OP是逐元素相除算子，输入 ``x`` 与输入 ``y`` 逐元素相除，并将各个位置的输出元素保存到返回结果中。 等式是： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_floordiv_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_floordiv_cn.rst index bd19626b6dc05d5e7f59571960eb2366ce4dd389..0d860ccef9a6e48778767e68ee05af552e2e6c15 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_floordiv_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_floordiv_cn.rst @@ -11,6 +11,9 @@ elementwise_floordiv + + + 该OP是逐元素整除算子，输入 ``x`` 与输入 ``y`` 逐元素整除，并将各个位置的输出元素保存到返回结果中。 等式为： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_max_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_max_cn.rst index b36097fbc71d17711142628ac985e35bdd415f00..6eb236d6428ab51809bb2ece9ae3a8d8409aa9b1 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_max_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_max_cn.rst @@ -10,6 +10,9 @@ elementwise_max :old_api: paddle.fluid.layers.elementwise_max + + + 该OP逐元素对比输入的两个多维Tensor，并且把各个位置更大的元素保存到返回结果中。 等式是： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_min_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_min_cn.rst index 22669884e0343785de9263c9c5769ee24fce4bdf..87ca482d0ede2a8e8f4254cd2dc30f1f9e6290d9 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_min_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_min_cn.rst @@ -10,6 +10,9 @@ elementwise_min :old_api: paddle.fluid.layers.elementwise_min + + + 该OP逐元素对比输入的两个多维Tensor，并且把各个位置更小的元素保存到返回结果中。 等式是： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_mod_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_mod_cn.rst index 5e53e8379be388a068554986709826b6db7b0cc1..102133fc9d6fbcdc49139d36b063ce3e5fae8c5c 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_mod_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_mod_cn.rst @@ -11,6 +11,9 @@ elementwise_mod + + + 该OP是逐元素取模算子，输入 ``x`` 与输入 ``y`` 逐元素取模，并将各个位置的输出元素保存到返回结果中。 等式为： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_mul_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_mul_cn.rst index 1ba52febf6c11fc514315ef64caf0acad1550700..7fc6e4e69a9772a8bd1611c64b334ab4e9e3ac7d 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_mul_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_mul_cn.rst @@ -11,6 +11,9 @@ elementwise_mul + + + 该OP是逐元素相乘算子，输入 ``x`` 与输入 ``y`` 逐元素相乘，并将各个位置的输出元素保存到返回结果中。 等式是： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_pow_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_pow_cn.rst index 6f08b313a4a95d7ba76aef597fc07a43fcbbe884..406ccd55bdf7355d0fef4727cfc629ec99b05408 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_pow_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_pow_cn.rst @@ -10,6 +10,9 @@ elementwise_pow :old_api: paddle.fluid.layers.elementwise_pow + + + 该OP逐元素对输入Tensor进行幂操作。 等式是： diff --git a/doc/fluid/api_cn/layers_cn/elementwise_sub_cn.rst b/doc/fluid/api_cn/layers_cn/elementwise_sub_cn.rst index 7bd8ac5e0549d6357c834a60d5a8d5a4fff2ef34..a615ffd51876d830556e88b49a7d71a5be858d86 100644 --- a/doc/fluid/api_cn/layers_cn/elementwise_sub_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elementwise_sub_cn.rst @@ -11,6 +11,9 @@ elementwise_sub + + + 该OP是逐元素相减算子，输入 ``x`` 与输入 ``y`` 逐元素相减，并将各个位置的输出元素保存到返回结果中。 等式是： diff --git a/doc/fluid/api_cn/layers_cn/elu_cn.rst b/doc/fluid/api_cn/layers_cn/elu_cn.rst index 6d527ce9359d4b2561e7018b72e79839d158d8c2..ca64bea3589cf1114766541523c85522e8fa61b3 100644 --- a/doc/fluid/api_cn/layers_cn/elu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/elu_cn.rst @@ -11,6 +11,9 @@ elu + + + ELU激活层（ELU Activation Operator） 根据 https://arxiv.org/abs/1511.07289 对输入Tensor中每个元素应用以下计算。 diff --git a/doc/fluid/api_cn/layers_cn/embedding_cn.rst b/doc/fluid/api_cn/layers_cn/embedding_cn.rst index b5ad3607114832a799d763d7d68b05a60d65a55d..5cc117124556785ef63cf97e1f926d2379ac5112 100644 --- a/doc/fluid/api_cn/layers_cn/embedding_cn.rst +++ b/doc/fluid/api_cn/layers_cn/embedding_cn.rst @@ -10,6 +10,9 @@ embedding + + + 嵌入层(Embedding Layer) **注意：此OP将在未来的版本中被移除！该OP要求输入Tensor shape的最后一维必须为1。推荐使用fluid.** :ref:`cn_api_fluid_embedding` 。 diff --git a/doc/fluid/api_cn/layers_cn/erf_cn.rst b/doc/fluid/api_cn/layers_cn/erf_cn.rst index c30dc7175303dc3890049ad49cf5ee39505ece2c..78a86cef9411da8591f7fc1a989088b257aa1976 100644 --- a/doc/fluid/api_cn/layers_cn/erf_cn.rst +++ b/doc/fluid/api_cn/layers_cn/erf_cn.rst @@ -11,6 +11,9 @@ erf + + + 逐元素计算 Erf 激活函数。更多细节请参考 `Error function `_ 。 diff --git a/doc/fluid/api_cn/layers_cn/exp_cn.rst b/doc/fluid/api_cn/layers_cn/exp_cn.rst index 33f053e947410c7be2111cfdb826fdf21295059a..77ffb1492cdbb14f897d54919405006328208204 100644 --- a/doc/fluid/api_cn/layers_cn/exp_cn.rst +++ b/doc/fluid/api_cn/layers_cn/exp_cn.rst @@ -11,6 +11,9 @@ exp + + + 对输入，逐元素进行以自然数e为底指数运算。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/expand_as_cn.rst b/doc/fluid/api_cn/layers_cn/expand_as_cn.rst index 3781c7c9343c5dc73c05f778814b9ca8b4b4bb50..c42bfb609876834197dc77f8f87e971244b55831 100644 --- a/doc/fluid/api_cn/layers_cn/expand_as_cn.rst +++ b/doc/fluid/api_cn/layers_cn/expand_as_cn.rst @@ -11,6 +11,9 @@ expand_as + + + 该OP会根据输入的variable ``target_tensor`` 对输入 ``x`` 的各维度进行广播。通过 ``target_tensor``的维度来为 ``x`` 的每个维度设置广播的次数，使得x 的维度与target_tensor的维度相同。 ``x`` 的秩应小于等于6。注意， ``target_tensor`` 的秩必须与 ``x`` 的秩相同。 注意:``target_tensor`` 对应的每一维必须能整除输入x中对应的维度，否则会报错。比如，target_tensor的维度为[2,6,2],x为[2,3,1],则整除后为[1,2,2]，x广播后维度为[2,6,2]。如果target_tensor的维度为[2,5,2]，第二维5不能整除x的第二维3，则会报错。 diff --git a/doc/fluid/api_cn/layers_cn/expand_cn.rst b/doc/fluid/api_cn/layers_cn/expand_cn.rst index 6bd61b1587e60420df20942a8da8c6382a1eef59..e728391e562c798249856e4ebd9f1a817340390b 100644 --- a/doc/fluid/api_cn/layers_cn/expand_cn.rst +++ b/doc/fluid/api_cn/layers_cn/expand_cn.rst @@ -11,6 +11,9 @@ expand + + + 该OP会根据参数 ``expand_times`` 对输入 ``x`` 的各维度进行复制。通过参数 ``expand_times`` 来为 ``x`` 的每个维度设置复制次数。 ``x`` 的秩应小于等于6。注意， ``expand_times`` 的大小必须与 ``x`` 的秩相同。以下是一个用例： :: diff --git a/doc/fluid/api_cn/layers_cn/exponential_decay_cn.rst b/doc/fluid/api_cn/layers_cn/exponential_decay_cn.rst index edda7f819c0ba67b216aa4c4426e3ebfa0df6ee5..7e21fc6d369d1d8e2138f9e63ed756bf332cc02d 100644 --- a/doc/fluid/api_cn/layers_cn/exponential_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/exponential_decay_cn.rst @@ -11,6 +11,9 @@ exponential_decay + + + 在学习率上运用指数衰减。 训练模型时，在训练过程中降低学习率。每 ``decay_steps`` 步骤中以 ``decay_rate`` 衰减学习率。 diff --git a/doc/fluid/api_cn/layers_cn/eye_cn.rst b/doc/fluid/api_cn/layers_cn/eye_cn.rst index 6fa81619f40dffe5c7a02571d6eb570f4cf32ebe..aab9afae70ccc7a08ead1e2e3e7a6fdc4e0ddb68 100644 --- a/doc/fluid/api_cn/layers_cn/eye_cn.rst +++ b/doc/fluid/api_cn/layers_cn/eye_cn.rst @@ -11,6 +11,9 @@ eye + + + 该OP用来构建单位矩阵，或一个批次的单位矩阵。 参数： diff --git a/doc/fluid/api_cn/layers_cn/fc_cn.rst b/doc/fluid/api_cn/layers_cn/fc_cn.rst index 6613b2d8879ab55272add049cb8461999f52866c..9a2c1158141bd9d484085469689d2582fc908ef7 100644 --- a/doc/fluid/api_cn/layers_cn/fc_cn.rst +++ b/doc/fluid/api_cn/layers_cn/fc_cn.rst @@ -7,6 +7,12 @@ fc .. py:function:: paddle.fluid.layers.fc(input, size, num_flatten_dims=1, param_attr=None, bias_attr=None, act=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.fc +:alias: paddle.declarative.fc +:old_api: paddle.fluid.layers.fc + + + diff --git a/doc/fluid/api_cn/layers_cn/fill_constant_cn.rst b/doc/fluid/api_cn/layers_cn/fill_constant_cn.rst index 1750069f8568850dea0f0028b9398c0809d208fb..ad2d59cc460b12bcbd48f7ddfc96a2b7f30a13d0 100644 --- a/doc/fluid/api_cn/layers_cn/fill_constant_cn.rst +++ b/doc/fluid/api_cn/layers_cn/fill_constant_cn.rst @@ -11,6 +11,9 @@ fill_constant + + + 该OP创建一个形状为shape并且数据类型为dtype的Tensor，同时用 ``value`` 中提供的常量初始化该Tensor。 创建的Tensor的stop_gradient属性默认为True。 diff --git a/doc/fluid/api_cn/layers_cn/filter_by_instag_cn.rst b/doc/fluid/api_cn/layers_cn/filter_by_instag_cn.rst index 212eef72dc7a6b3dc1506270feabc78fcf29c2f1..d8e988d262f1973f447d1fe458a1cb324413d5ca 100644 --- a/doc/fluid/api_cn/layers_cn/filter_by_instag_cn.rst +++ b/doc/fluid/api_cn/layers_cn/filter_by_instag_cn.rst @@ -11,6 +11,9 @@ filter_by_instag + + + 此函数通过instag来过滤ins batch，大量属于同样的tags的样本，我们可以指定我们想要的一些tags，属于这些tags的样本将会被保留在输出中，其余的将会移除。比如，一个batch有4个样本，每个样本都有自己的tag表。 Ins | Ins_Tag | diff --git a/doc/fluid/api_cn/layers_cn/flatten_cn.rst b/doc/fluid/api_cn/layers_cn/flatten_cn.rst index 3e314f655a8cf5b597daeac8507732a9c571d130..0229f7d78cae352047644f7dbd4e43bb824b56ae 100644 --- a/doc/fluid/api_cn/layers_cn/flatten_cn.rst +++ b/doc/fluid/api_cn/layers_cn/flatten_cn.rst @@ -11,6 +11,9 @@ flatten + + + flatten op将输入的多维Tensor展平成2-D Tensor矩阵 例如： diff --git a/doc/fluid/api_cn/layers_cn/floor_cn.rst b/doc/fluid/api_cn/layers_cn/floor_cn.rst index e1dc4edb72600bf63fd26555942c75d69678f7f4..3de11040bd2e4941b95b449b248c116026ed9bb2 100644 --- a/doc/fluid/api_cn/layers_cn/floor_cn.rst +++ b/doc/fluid/api_cn/layers_cn/floor_cn.rst @@ -11,6 +11,9 @@ floor + + + 向下取整函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/fsp_matrix_cn.rst b/doc/fluid/api_cn/layers_cn/fsp_matrix_cn.rst index 97937d7c8225b6be736eb2616a7a220ab35f4b7a..1a1e112f633e749c7d7f465108cbac01563c3242 100644 --- a/doc/fluid/api_cn/layers_cn/fsp_matrix_cn.rst +++ b/doc/fluid/api_cn/layers_cn/fsp_matrix_cn.rst @@ -11,6 +11,9 @@ fsp_matrix + + + **FSP matrix op** fsp_matrix op用于计算两个4-D Tensor特征图的求解过程（FSP）矩阵。假设特征图x的形状为 :math:`[x\_channel，h，w]` ，特征图y的形状为 :math:`[y\_channel，h，w]` ，fsp_matrix op分两步得到x和y的fsp矩阵： diff --git a/doc/fluid/api_cn/layers_cn/gather_nd_cn.rst b/doc/fluid/api_cn/layers_cn/gather_nd_cn.rst index 6c810ad73aa1edff045883f98cd80ffcb2365762..d1bd6b85dca3b47bd2f858fe235bbfaf9f92ee3a 100644 --- a/doc/fluid/api_cn/layers_cn/gather_nd_cn.rst +++ b/doc/fluid/api_cn/layers_cn/gather_nd_cn.rst @@ -11,6 +11,9 @@ gather_nd + + + 该OP是 :code:`gather` 的高维推广，并且支持多轴同时索引。 :code:`index` 是一个K维度的张量，它可以认为是从 :code:`input` 中取K-1维张量，每一个元素是一个切片： .. math:: diff --git a/doc/fluid/api_cn/layers_cn/gather_tree_cn.rst b/doc/fluid/api_cn/layers_cn/gather_tree_cn.rst index 0d8354364fcf965fa0e8a1a81d37a188bb8f0f4b..25c9a3863fdba2510545068d56db78c5f7c27b24 100644 --- a/doc/fluid/api_cn/layers_cn/gather_tree_cn.rst +++ b/doc/fluid/api_cn/layers_cn/gather_tree_cn.rst @@ -11,6 +11,9 @@ gather_tree + + + 该OP在整个束搜索(Beam Search)结束后使用。在搜索结束后，可以获得每个时间步选择的的候选词id及其对应的在搜索树中的parent节点， ``ids`` 和 ``parents`` 的形状布局均为 :math:`[max\_time, batch\_size, beam\_size]` ，该OP从最后一个时间步回溯产生完整的id序列。 diff --git a/doc/fluid/api_cn/layers_cn/gelu_cn.rst b/doc/fluid/api_cn/layers_cn/gelu_cn.rst index c234e3b574b2ee089f6cc39b000f28590ad1630d..eda21c2c8b466917088bc55f012d2214e677d2a6 100644 --- a/doc/fluid/api_cn/layers_cn/gelu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/gelu_cn.rst @@ -11,6 +11,9 @@ gelu + + + 逐元素计算 Gelu激活函数。更多细节请参考 `Gaussian Error Linear Units `_ 。 如果使用近似计算： diff --git a/doc/fluid/api_cn/layers_cn/generate_mask_labels_cn.rst b/doc/fluid/api_cn/layers_cn/generate_mask_labels_cn.rst index 51854d3898e3f968a1f6704b7784edbcc6155755..3f64bd2e150447b14ed323f0bb32c50c4cc25290 100644 --- a/doc/fluid/api_cn/layers_cn/generate_mask_labels_cn.rst +++ b/doc/fluid/api_cn/layers_cn/generate_mask_labels_cn.rst @@ -11,6 +11,9 @@ generate_mask_labels + + + **为Mask-RCNN生成mask标签** 对于给定的 RoI (Regions of Interest) 和 输入ground truth的分类标签和分割的坐标标签，采样出前景RoI，并返回其在输入 ``rois`` 中索引位置，并对每个RoI生成 :math:`K*M^{2}` 的二值mask标签。K为类别个数，M是RoI特征图大小。这些输出目标一般用于计算mask分支的损失。 diff --git a/doc/fluid/api_cn/layers_cn/generate_proposal_labels_cn.rst b/doc/fluid/api_cn/layers_cn/generate_proposal_labels_cn.rst index a957d20deaa3b9f05ce21436c49526c760e5094f..84c3168d35806a2aacc0af651fda2d1f7345d694 100644 --- a/doc/fluid/api_cn/layers_cn/generate_proposal_labels_cn.rst +++ b/doc/fluid/api_cn/layers_cn/generate_proposal_labels_cn.rst @@ -11,6 +11,9 @@ generate_proposal_labels + + + **注意：该OP无对应的反向OP** 该OP根据RPN预测产出的bounding boxes和groundtruth，抽取出用来计算loss的foreground boxes and background boxes。 diff --git a/doc/fluid/api_cn/layers_cn/generate_proposals_cn.rst b/doc/fluid/api_cn/layers_cn/generate_proposals_cn.rst index 7bd143ec306bbeac65430bca235d6dfc7eb32e45..10a56e013a16034a597bf2b610b3adaec2b56e7c 100644 --- a/doc/fluid/api_cn/layers_cn/generate_proposals_cn.rst +++ b/doc/fluid/api_cn/layers_cn/generate_proposals_cn.rst @@ -12,6 +12,9 @@ generate_proposals + + + 该OP根据每个检测框为foreground对象的概率，推选生成用于后续检测网络的RoIs。 其中的检测框根据 ``anchors`` 和 ``bbox_deltas`` 计算得到。 diff --git a/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst b/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst index 607e3ab0b02b3b2bfbdb8e28744c3187f5fd3f00..231915b1ab31ab2a71f8fe570435a3ec684d94c8 100644 --- a/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/greater_equal_cn.rst @@ -11,6 +11,9 @@ greater_equal + + + 该OP逐元素地返回 :math:`x >= y` 的逻辑值，使用重载算子 `>=` 可以有相同的计算函数效果。 diff --git a/doc/fluid/api_cn/layers_cn/greater_than_cn.rst b/doc/fluid/api_cn/layers_cn/greater_than_cn.rst index 29bb93d9284cf69796c51a9ac05b05ba440a1592..c4ed292dcabad08728e25e06113d0bc7143a5465 100644 --- a/doc/fluid/api_cn/layers_cn/greater_than_cn.rst +++ b/doc/fluid/api_cn/layers_cn/greater_than_cn.rst @@ -11,6 +11,9 @@ greater_than + + + 该OP逐元素地返回 :math:`x > y` 的逻辑值，使用重载算子 `>` 可以有相同的计算函数效果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/grid_sampler_cn.rst b/doc/fluid/api_cn/layers_cn/grid_sampler_cn.rst index 8871106520eea576edbddf0b606e8113cfd4e85f..f8884f96c619fcda589d5096aa0558c9c213cbb2 100644 --- a/doc/fluid/api_cn/layers_cn/grid_sampler_cn.rst +++ b/doc/fluid/api_cn/layers_cn/grid_sampler_cn.rst @@ -11,6 +11,9 @@ grid_sampler + + + 该OP基于flow field网格的对输入X进行双线性插值采样。网格通常由affine_grid生成, shape为[N, H, W, 2]，是shape为[N, H, W]的采样点张量的(x, y)坐标。 其中，x坐标是对输入数据X的第四个维度(宽度维度)的索引，y坐标是第三维度(高维度)的索引，最终输出采样值为采样点的4个最接近的角点的双线性插值结果，输出张量的shape为[N, C, H, W]。 diff --git a/doc/fluid/api_cn/layers_cn/group_norm_cn.rst b/doc/fluid/api_cn/layers_cn/group_norm_cn.rst index 049a9e2f0055ca6ce3220c526f25f0abdd335c3d..86b25631b9a88b91347de0da5a92c2bed78a4438 100755 --- a/doc/fluid/api_cn/layers_cn/group_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/group_norm_cn.rst @@ -7,6 +7,12 @@ group_norm .. py:function:: paddle.fluid.layers.group_norm(input, groups, epsilon=1e-05, param_attr=None, bias_attr=None, act=None, data_layout='NCHW', name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.group_norm +:alias: paddle.declarative.group_norm +:old_api: paddle.fluid.layers.group_norm + + + diff --git a/doc/fluid/api_cn/layers_cn/gru_unit_cn.rst b/doc/fluid/api_cn/layers_cn/gru_unit_cn.rst index 679e5dfe42bb6c4a3baad252af83d88c3ff737a7..2458acf711f412fe530d7286ffd335328137ecf3 100644 --- a/doc/fluid/api_cn/layers_cn/gru_unit_cn.rst +++ b/doc/fluid/api_cn/layers_cn/gru_unit_cn.rst @@ -10,6 +10,9 @@ gru_unit + + + Gated Recurrent Unit（GRU）循环神经网络计算单元。该OP用于完成单个时间步内GRU的计算，支持以下两种计算方式： 如果origin_mode为True，则使用的运算公式来自论文 diff --git a/doc/fluid/api_cn/layers_cn/hard_shrink_cn.rst b/doc/fluid/api_cn/layers_cn/hard_shrink_cn.rst index d139a6a8fe52833cfa1e682bdcc7940d613b2270..b5035d59204d00dd4601d382312f7c21c05c2c15 100644 --- a/doc/fluid/api_cn/layers_cn/hard_shrink_cn.rst +++ b/doc/fluid/api_cn/layers_cn/hard_shrink_cn.rst @@ -11,6 +11,9 @@ hard_shrink + + + HardShrink激活函数(HardShrink activation operator) diff --git a/doc/fluid/api_cn/layers_cn/hard_sigmoid_cn.rst b/doc/fluid/api_cn/layers_cn/hard_sigmoid_cn.rst index f015a799c57376ee406cbac16d68d8a98b72dda4..8c35f2391ed25b9a1ec5431495336d5ad56bfe64 100644 --- a/doc/fluid/api_cn/layers_cn/hard_sigmoid_cn.rst +++ b/doc/fluid/api_cn/layers_cn/hard_sigmoid_cn.rst @@ -11,6 +11,9 @@ hard_sigmoid + + + sigmoid的分段线性逼近激活函数，速度比sigmoid快，详细解释参见 https://arxiv.org/abs/1603.00391。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/hard_swish_cn.rst b/doc/fluid/api_cn/layers_cn/hard_swish_cn.rst index 8118ea27a2f2c6f1855e02cd8451a1de6d11151a..bfa8a08f2428aee6de843ab15ed7d1c472dace1e 100644 --- a/doc/fluid/api_cn/layers_cn/hard_swish_cn.rst +++ b/doc/fluid/api_cn/layers_cn/hard_swish_cn.rst @@ -11,6 +11,9 @@ hard_swish + + + 该OP实现了hard_swish激活函数。hard_swish激活函数在MobileNetV3架构中被提出，相较于swish函数，具有数值稳定性好，计算速度快等优点，具体原理请参考: https://arxiv.org/pdf/1905.02244.pdf :math:`out = \frac{x * (min(max(0, x+offset), threshold))}{scale}` diff --git a/doc/fluid/api_cn/layers_cn/has_inf_cn.rst b/doc/fluid/api_cn/layers_cn/has_inf_cn.rst index 8bf1cb7b8bfcdb7e1547f75566f0b641d745baf6..836d08035747ddf2cb6787bc0e7894f48b7d2026 100644 --- a/doc/fluid/api_cn/layers_cn/has_inf_cn.rst +++ b/doc/fluid/api_cn/layers_cn/has_inf_cn.rst @@ -11,6 +11,9 @@ has_inf + + + 检查输入的变量(x)中是否包含无穷数(inf)。 参数： diff --git a/doc/fluid/api_cn/layers_cn/has_nan_cn.rst b/doc/fluid/api_cn/layers_cn/has_nan_cn.rst index 0f66985af75a733ba985155c6fd06255ce46b8cc..b3db118c01e01f30dd47d17e9eb8f9dc1d1890f7 100644 --- a/doc/fluid/api_cn/layers_cn/has_nan_cn.rst +++ b/doc/fluid/api_cn/layers_cn/has_nan_cn.rst @@ -11,6 +11,9 @@ has_nan + + + 检查输入的变量(x)中是否包含NAN。 参数： diff --git a/doc/fluid/api_cn/layers_cn/hash_cn.rst b/doc/fluid/api_cn/layers_cn/hash_cn.rst index 8905028db60e93ccbb00184629eafa5ddb8e8caa..c70e03aac7ab6f4b67718392a39147ca80e36ee1 100644 --- a/doc/fluid/api_cn/layers_cn/hash_cn.rst +++ b/doc/fluid/api_cn/layers_cn/hash_cn.rst @@ -11,6 +11,9 @@ hash + + + 该OP将输入 hash 成为一个整数，该数的值小于给定的 ``hash_size`` 。**仅支持输入为LoDTensor**。 该OP使用的哈希算法是：xxHash - `Extremely fast hash algorithm `_ diff --git a/doc/fluid/api_cn/layers_cn/hsigmoid_cn.rst b/doc/fluid/api_cn/layers_cn/hsigmoid_cn.rst index fa8a9704fe470bea9ceef5c53506ece75b80a44d..af765c091101ef5d309fae7ecb758d7b6096f0fb 100644 --- a/doc/fluid/api_cn/layers_cn/hsigmoid_cn.rst +++ b/doc/fluid/api_cn/layers_cn/hsigmoid_cn.rst @@ -7,6 +7,12 @@ hsigmoid .. py:function:: paddle.fluid.layers.hsigmoid(input, label, num_classes, param_attr=None, bias_attr=None, name=None, path_table=None, path_code=None, is_custom=False, is_sparse=False) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.hsigmoid +:alias: paddle.declarative.hsigmoid,paddle.nn.functional.hsigmoid,paddle.nn.functional.activation.hsigmoid +:old_api: paddle.fluid.layers.hsigmoid + + + diff --git a/doc/fluid/api_cn/layers_cn/huber_loss_cn.rst b/doc/fluid/api_cn/layers_cn/huber_loss_cn.rst index 753e38949351d8d6001d3e6df6799a8c27fa68bf..548485105b3ae3128f447a3c94e79cf165fc5a56 100644 --- a/doc/fluid/api_cn/layers_cn/huber_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/huber_loss_cn.rst @@ -12,6 +12,9 @@ huber_loss + + + 该OP计算输入（input）与标签（label）之间的Huber损失。Huber损失是常用的回归损失之一，相较于平方误差损失，Huber损失减小了对异常点的敏感度，更具鲁棒性。 当输入与标签之差的绝对值大于delta时，计算线性误差: diff --git a/doc/fluid/api_cn/layers_cn/im2sequence_cn.rst b/doc/fluid/api_cn/layers_cn/im2sequence_cn.rst index 88ca3cead90ac752adb9b1326104c0db557c216d..1dbe1b8b6a0147dda9e52dd8795ea09e6ecbb272 100644 --- a/doc/fluid/api_cn/layers_cn/im2sequence_cn.rst +++ b/doc/fluid/api_cn/layers_cn/im2sequence_cn.rst @@ -10,6 +10,9 @@ im2sequence + + + 该OP使用 `filter` 扫描输入的Tensor并将输入Tensor转换成序列，返回值的 `shape={input.batch_size * output_height * output_width, filter_size_height* filter_size_width * input.channels}` 。返回值的timestep的个数为 `output_height * output_width` ， 每个timestep的维度是 `filter_size_height* filter_size_width * input.channels` 。其中 `output_height` 和 `output_width` 由以下式计算: diff --git a/doc/fluid/api_cn/layers_cn/image_resize_cn.rst b/doc/fluid/api_cn/layers_cn/image_resize_cn.rst index e0331de812743e569839bb9aa831b4667f0ce6a3..44e27683e9a94b053bdd6bda48ed3a690ef14b7d 100644 --- a/doc/fluid/api_cn/layers_cn/image_resize_cn.rst +++ b/doc/fluid/api_cn/layers_cn/image_resize_cn.rst @@ -11,6 +11,9 @@ image_resize + + + **注意:** 参数 ``actual_shape`` 将被弃用，请使用 ``out_shape`` 替代。 该OP用于调整一个batch中图片的大小。 diff --git a/doc/fluid/api_cn/layers_cn/image_resize_short_cn.rst b/doc/fluid/api_cn/layers_cn/image_resize_short_cn.rst index 93c8a9583d9329ef27606404b477dacc55bca21d..83996891c3d41402af402a1a4889fc54d1fb1198 100644 --- a/doc/fluid/api_cn/layers_cn/image_resize_short_cn.rst +++ b/doc/fluid/api_cn/layers_cn/image_resize_short_cn.rst @@ -11,6 +11,9 @@ image_resize_short + + + 该OP用于调整一批图片的大小。输入图像的短边将被调整为给定的out_short_len 。输入图像的长边按比例调整大小，最终图像的长宽比保持不变。 参数: diff --git a/doc/fluid/api_cn/layers_cn/increment_cn.rst b/doc/fluid/api_cn/layers_cn/increment_cn.rst index 8edb5db4ab6fb7c7494c40b7bb9e4f2ebac5e04a..88c33f3ac2216be21e79fbe63586ab410f89d6bf 100644 --- a/doc/fluid/api_cn/layers_cn/increment_cn.rst +++ b/doc/fluid/api_cn/layers_cn/increment_cn.rst @@ -11,6 +11,9 @@ increment + + + 使输入Tensor ``x`` 的数据累加 ``value`` , 该OP通常用于循环次数的计数。 参数: diff --git a/doc/fluid/api_cn/layers_cn/instance_norm_cn.rst b/doc/fluid/api_cn/layers_cn/instance_norm_cn.rst index a10ff93900023ad41c2b7e6461764f060eef3293..953b0707ef1b0df5cfc54264310c4498704a13d2 100644 --- a/doc/fluid/api_cn/layers_cn/instance_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/instance_norm_cn.rst @@ -7,6 +7,12 @@ instance_norm .. py:function:: paddle.fluid.layers.instance_norm(input, epsilon=1e-05, param_attr=None, bias_attr=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.instance_norm +:alias: paddle.declarative.instance_norm +:old_api: paddle.fluid.layers.instance_norm + + + diff --git a/doc/fluid/api_cn/layers_cn/inverse_time_decay_cn.rst b/doc/fluid/api_cn/layers_cn/inverse_time_decay_cn.rst index 1b7abf3fab067769c21faf730179f8fc88e32785..b52be89ba51d98da9d8cfb8aa3f08741676e91f1 100644 --- a/doc/fluid/api_cn/layers_cn/inverse_time_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/inverse_time_decay_cn.rst @@ -11,6 +11,9 @@ inverse_time_decay + + + 在初始学习率上运用逆时衰减。 训练模型时，最好在训练过程中降低学习率。通过执行该函数，将对初始学习率运用逆时衰减函数。 diff --git a/doc/fluid/api_cn/layers_cn/iou_similarity_cn.rst b/doc/fluid/api_cn/layers_cn/iou_similarity_cn.rst index befe69f841dcf40fdf4a70e34a91d59673af978d..e82ae72d70393ccf1947c130072ed820dba7bb19 100644 --- a/doc/fluid/api_cn/layers_cn/iou_similarity_cn.rst +++ b/doc/fluid/api_cn/layers_cn/iou_similarity_cn.rst @@ -11,6 +11,9 @@ iou_similarity + + + **IOU Similarity Operator** 计算两个框列表的intersection-over-union(IOU)。框列表 :math:`X` 应为LoDTensor， :math:`Y` 是普通张量， :math:`X` 成批输入的所有实例共享 :math:`Y` 中的框。给定框A和框B，IOU的运算如下： diff --git a/doc/fluid/api_cn/layers_cn/is_empty_cn.rst b/doc/fluid/api_cn/layers_cn/is_empty_cn.rst index 90d4eb57a74fc3d0975f29c058236e4ed2c0f7ee..d2c094678d55263b58e02054dd0ebe921980880c 100644 --- a/doc/fluid/api_cn/layers_cn/is_empty_cn.rst +++ b/doc/fluid/api_cn/layers_cn/is_empty_cn.rst @@ -11,6 +11,9 @@ is_empty + + + 测试变量是否为空 参数： diff --git a/doc/fluid/api_cn/layers_cn/isfinite_cn.rst b/doc/fluid/api_cn/layers_cn/isfinite_cn.rst index c9b5474e809b248141ad4632e5a5aedd1e11fec9..bc23db1d7abd60a6c8ffce9a901063782210ce75 100644 --- a/doc/fluid/api_cn/layers_cn/isfinite_cn.rst +++ b/doc/fluid/api_cn/layers_cn/isfinite_cn.rst @@ -11,6 +11,9 @@ isfinite + + + ``注意：此算子的输入 Tensor / LoDTensor 数据类型必须为 int32 / float / double 之一。`` 测试 x 是否包含无穷值（即 nan 或 inf）。若元素均为有穷数，返回真；否则返回假。 diff --git a/doc/fluid/api_cn/layers_cn/kldiv_loss_cn.rst b/doc/fluid/api_cn/layers_cn/kldiv_loss_cn.rst index 8fc92afbd9748fe5499eb8e8aa0e9add97d24d8b..fe3696bc5dd6f7f964c9f6f1f21effd09c777ba4 100644 --- a/doc/fluid/api_cn/layers_cn/kldiv_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/kldiv_loss_cn.rst @@ -11,6 +11,9 @@ kldiv_loss + + + 该OP计算输入(X)和输入(Target)之间的Kullback-Leibler散度损失。注意其中输入(X)应为对数概率值，输入(Target)应为概率值。 kL发散损失计算如下： diff --git a/doc/fluid/api_cn/layers_cn/l2_normalize_cn.rst b/doc/fluid/api_cn/layers_cn/l2_normalize_cn.rst index f0e50f6af88923236a3ab8661d70ec10fe29ccc0..94e7c095af39e409d0e209caf0d6179fd9d5ef3e 100644 --- a/doc/fluid/api_cn/layers_cn/l2_normalize_cn.rst +++ b/doc/fluid/api_cn/layers_cn/l2_normalize_cn.rst @@ -11,6 +11,9 @@ l2_normalize + + + 该OP计算欧几里得距离之和对x进行归一化。对于1-D张量（系数矩阵的维度固定为0） 计算公式如下： diff --git a/doc/fluid/api_cn/layers_cn/label_smooth_cn.rst b/doc/fluid/api_cn/layers_cn/label_smooth_cn.rst index 62292e20d0bbe1245f67a0f58f57a5941f5a9911..b754985937fdecc4c0ab6c5151980d73dbac72f9 100644 --- a/doc/fluid/api_cn/layers_cn/label_smooth_cn.rst +++ b/doc/fluid/api_cn/layers_cn/label_smooth_cn.rst @@ -11,6 +11,9 @@ label_smooth + + + 该OP实现了标签平滑的功能。标签平滑是一种对分类器层进行正则化的机制，称为标签平滑正则化(LSR)。由于直接优化正确标签的对数似然可能会导致过拟合，降低模型的适应能力，因此提出了标签平滑的方法来降低模型置信度。 标签平滑使用标签 :math:`y` 和一些固定模式随机分布变量 :math:`\mu` 。对 :math:`k` 标签，标签平滑的计算方式如下。 diff --git a/doc/fluid/api_cn/layers_cn/layer_norm_cn.rst b/doc/fluid/api_cn/layers_cn/layer_norm_cn.rst index 477b6e6ba82ebca08e62080ee79c7cb788fecbc0..ef3882fa7918800d3d9495fca719acebd7219a2e 100644 --- a/doc/fluid/api_cn/layers_cn/layer_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/layer_norm_cn.rst @@ -7,6 +7,12 @@ layer_norm .. py:function:: paddle.fluid.layers.layer_norm(input, scale=True, shift=True, begin_norm_axis=1, epsilon=1e-05, param_attr=None, bias_attr=None, act=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.layer_norm +:alias: paddle.declarative.layer_norm +:old_api: paddle.fluid.layers.layer_norm + + + diff --git a/doc/fluid/api_cn/layers_cn/leaky_relu_cn.rst b/doc/fluid/api_cn/layers_cn/leaky_relu_cn.rst index 736a39e0dfded848089f7511031addc5cf71dfe4..41b127fa3c274b8fff4ebda20d823b0eb455f09d 100644 --- a/doc/fluid/api_cn/layers_cn/leaky_relu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/leaky_relu_cn.rst @@ -11,6 +11,9 @@ leaky_relu + + + LeakyRelu激活函数 .. math:: out=max(x,α∗x) diff --git a/doc/fluid/api_cn/layers_cn/less_equal_cn.rst b/doc/fluid/api_cn/layers_cn/less_equal_cn.rst index 88add2c7fb86d395727ffbe16a97fd01dd31d33a..241437ae277ea202ff2eb6a71d8d997a8bd7e4cf 100644 --- a/doc/fluid/api_cn/layers_cn/less_equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/less_equal_cn.rst @@ -11,6 +11,9 @@ less_equal + + + 该OP逐元素地返回 :math:`x <= y` 的逻辑值，使用重载算子 `<=` 可以有相同的计算函数效果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/less_than_cn.rst b/doc/fluid/api_cn/layers_cn/less_than_cn.rst index be39cae55422cb9beb27c040c41704696b01ccdd..65830bc416a989f47bb759d96a8c62edbc696e51 100644 --- a/doc/fluid/api_cn/layers_cn/less_than_cn.rst +++ b/doc/fluid/api_cn/layers_cn/less_than_cn.rst @@ -12,6 +12,9 @@ less_than + + + 该OP逐元素地返回 :math:`x < y` 的逻辑值，使用重载算子 `<` 可以有相同的计算函数效果 diff --git a/doc/fluid/api_cn/layers_cn/linear_chain_crf_cn.rst b/doc/fluid/api_cn/layers_cn/linear_chain_crf_cn.rst index cf38de480033e68c8388e08990a991cf5792bfef..dddcb4e4e03ef71025b6c41af6b9c0cafbbc9466 100755 --- a/doc/fluid/api_cn/layers_cn/linear_chain_crf_cn.rst +++ b/doc/fluid/api_cn/layers_cn/linear_chain_crf_cn.rst @@ -10,6 +10,9 @@ linear_chain_crf + + + 线性链条件随机场（Linear Chain CRF） 条件随机场定义间接概率图，节点代表随机变量，边代表两个变量之间的依赖。CRF学习条件概率 :math:`P\left ( Y|X \right )` ， :math:`X = \left ( x_{1},x_{2},...,x_{n} \right )` 是结构性输入，:math:`Y = \left ( y_{1},y_{2},...,y_{n} \right )` 为输入标签。 diff --git a/doc/fluid/api_cn/layers_cn/linear_lr_warmup_cn.rst b/doc/fluid/api_cn/layers_cn/linear_lr_warmup_cn.rst index c480c68d074b01191296b96e8ec8d506fbfa437f..5da95f2b8cf8d414060080f4409e4580b7aa85a2 100644 --- a/doc/fluid/api_cn/layers_cn/linear_lr_warmup_cn.rst +++ b/doc/fluid/api_cn/layers_cn/linear_lr_warmup_cn.rst @@ -12,6 +12,9 @@ linear_lr_warmup + + + 该OP使用学习率优化策略-线性学习率热身(warm up)对学习率进行初步调整。在正常调整学习率之前，先逐步增大学习率，具体原理可参考： `Bag of Tricks for Image Classification with Convolutional Neural Networks `_ 当训练步数（global_step）小于热身步数（warmup_steps）时，学习率lr按如下方式更新： diff --git a/doc/fluid/api_cn/layers_cn/log_cn.rst b/doc/fluid/api_cn/layers_cn/log_cn.rst index dc8f40a8081d7a7aa2fa6880761031c333edd88d..f83565b11167bcd14f32216819ef139835c3bef7 100644 --- a/doc/fluid/api_cn/layers_cn/log_cn.rst +++ b/doc/fluid/api_cn/layers_cn/log_cn.rst @@ -12,6 +12,9 @@ log + + + Log激活函数（计算自然对数） .. math:: diff --git a/doc/fluid/api_cn/layers_cn/log_loss_cn.rst b/doc/fluid/api_cn/layers_cn/log_loss_cn.rst index aea52ab5f87ec3c61174a6516f10a650037007e5..2491bfd3a11f650621cb14914ad94ff2c8e55f41 100644 --- a/doc/fluid/api_cn/layers_cn/log_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/log_loss_cn.rst @@ -11,6 +11,9 @@ log_loss + + + **负log loss层** 该 OP 对输入的预测结果和目标标签进行计算，返回负对数损失值。 diff --git a/doc/fluid/api_cn/layers_cn/logical_and_cn.rst b/doc/fluid/api_cn/layers_cn/logical_and_cn.rst index ea44c92c01b258c4135eada7cf0a71eb0fc6f96f..d013425ee054167093556d8fbb56877371ef6fce 100644 --- a/doc/fluid/api_cn/layers_cn/logical_and_cn.rst +++ b/doc/fluid/api_cn/layers_cn/logical_and_cn.rst @@ -11,6 +11,9 @@ logical_and + + + 该OP逐元素的对 ``X`` 和 ``Y`` 两LoDTensor/Tensor进行逻辑与运算。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/logical_not_cn.rst b/doc/fluid/api_cn/layers_cn/logical_not_cn.rst index a0a3a2dc5a6b84f3134950273dfb86732fd9d921..0ad81ac5e5889c8853a34016efc74986a3f264e6 100644 --- a/doc/fluid/api_cn/layers_cn/logical_not_cn.rst +++ b/doc/fluid/api_cn/layers_cn/logical_not_cn.rst @@ -11,6 +11,9 @@ logical_not + + + 该OP逐元素的对 ``X`` LoDTensor/Tensor进行逻辑非运算 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/logical_or_cn.rst b/doc/fluid/api_cn/layers_cn/logical_or_cn.rst index b012c7ff4384c2e4193d6a91cdf4d82025103633..bd36d4424754b9ec2eb5fe0e8a6aa1374ec1496e 100644 --- a/doc/fluid/api_cn/layers_cn/logical_or_cn.rst +++ b/doc/fluid/api_cn/layers_cn/logical_or_cn.rst @@ -11,6 +11,9 @@ logical_or + + + 该OP逐元素的对 ``X`` 和 ``Y`` 两LoDTensor/Tensor进行逻辑或运算。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/logical_xor_cn.rst b/doc/fluid/api_cn/layers_cn/logical_xor_cn.rst index 12a8facec23f92d40b353d0942b2ab6f664d0c49..46937b940e23bbede48541d378cbead943f7c2d6 100644 --- a/doc/fluid/api_cn/layers_cn/logical_xor_cn.rst +++ b/doc/fluid/api_cn/layers_cn/logical_xor_cn.rst @@ -11,6 +11,9 @@ logical_xor + + + 该OP逐元素的对 ``X`` 和 ``Y`` 两LoDTensor/Tensor进行逻辑异或运算。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/logsigmoid_cn.rst b/doc/fluid/api_cn/layers_cn/logsigmoid_cn.rst index 94ba6048566ebe86ee6de81466bef0b5dac0d8d8..d48287311d81b8652db58b989944b60afacce62d 100644 --- a/doc/fluid/api_cn/layers_cn/logsigmoid_cn.rst +++ b/doc/fluid/api_cn/layers_cn/logsigmoid_cn.rst @@ -11,6 +11,9 @@ logsigmoid + + + Logsigmoid激活函数 diff --git a/doc/fluid/api_cn/layers_cn/lrn_cn.rst b/doc/fluid/api_cn/layers_cn/lrn_cn.rst index 0465849f1c66e0bb8ce6bbdf3c987e45de01bffb..4f88b0284dd3bf8067b226d76e84ac47472a9e80 100644 --- a/doc/fluid/api_cn/layers_cn/lrn_cn.rst +++ b/doc/fluid/api_cn/layers_cn/lrn_cn.rst @@ -12,6 +12,9 @@ lrn + + + 该OP实现了局部响应正则化层（Local Response Normalization Layer），用于对局部输入区域正则化，执行一种侧向抑制（lateral inhibition）。更多详情参考： `ImageNet Classification with Deep Convolutional Neural Networks `_ 其中 ``input`` 是mini-batch的输入特征。计算过程如下： diff --git a/doc/fluid/api_cn/layers_cn/lstm_cn.rst b/doc/fluid/api_cn/layers_cn/lstm_cn.rst index f42882efaf70c2827f07bc1bbd4f14f0e4710589..d6c183845ffae0c7d0c29143ad479765c198fd26 100644 --- a/doc/fluid/api_cn/layers_cn/lstm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/lstm_cn.rst @@ -10,6 +10,9 @@ lstm + + + .. note:: 该OP仅支持 GPU 设备运行 diff --git a/doc/fluid/api_cn/layers_cn/lstm_unit_cn.rst b/doc/fluid/api_cn/layers_cn/lstm_unit_cn.rst index 7e33fb3b748456950cbc55ac3fef511965bd82cb..ada53c75a47d0714bcea4b5e16c72a2bcf0e4fb2 100644 --- a/doc/fluid/api_cn/layers_cn/lstm_unit_cn.rst +++ b/doc/fluid/api_cn/layers_cn/lstm_unit_cn.rst @@ -11,6 +11,9 @@ lstm_unit + + + Long-Short Term Memory（LSTM）循环神经网络计算单元。该OP用于完成单个时间步内LSTM的计算，基于论文 `RECURRENT NEURAL NETWORK REGULARIZATION `_ 中的描述实现， 并在forget gate（遗忘门）中增加了 ``forget_bias`` 来控制遗忘力度，公式如下： diff --git a/doc/fluid/api_cn/layers_cn/margin_rank_loss_cn.rst b/doc/fluid/api_cn/layers_cn/margin_rank_loss_cn.rst index 0412f85fc6f91c9534d485ab7ac7584d74e80251..916010a603015fa683713c972142ddcd468dea71 100644 --- a/doc/fluid/api_cn/layers_cn/margin_rank_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/margin_rank_loss_cn.rst @@ -11,6 +11,9 @@ margin_rank_loss + + + margin rank loss（间隔排序损失）层。在排序问题中，它可以比较来自排序网络的输入 ``left`` 和输入 ``right`` 的得分。 可用如下等式定义： diff --git a/doc/fluid/api_cn/layers_cn/maxout_cn.rst b/doc/fluid/api_cn/layers_cn/maxout_cn.rst index 2f73289029229de4436d34bb99030a5eb958d1fb..c8a1efd5f70df7068a5a13d30af5fc52a025ae07 100644 --- a/doc/fluid/api_cn/layers_cn/maxout_cn.rst +++ b/doc/fluid/api_cn/layers_cn/maxout_cn.rst @@ -11,6 +11,9 @@ maxout + + + 假设输入形状为(N, Ci, H, W)，输出形状为(N, Co, H, W)，则 :math:`Co=Ci/groups` 运算公式如下: .. math:: diff --git a/doc/fluid/api_cn/layers_cn/mean_cn.rst b/doc/fluid/api_cn/layers_cn/mean_cn.rst index 69363e1c6ba3934a5ea1f5622d5233552b47fc84..fa2dbacd3361ee40ea6967c70560ad6da3a5a677 100644 --- a/doc/fluid/api_cn/layers_cn/mean_cn.rst +++ b/doc/fluid/api_cn/layers_cn/mean_cn.rst @@ -11,6 +11,9 @@ mean + + + 计算 ``x`` 所有元素的平均值。 参数： diff --git a/doc/fluid/api_cn/layers_cn/mse_loss_cn.rst b/doc/fluid/api_cn/layers_cn/mse_loss_cn.rst index 59678570f9e91da8e2ad46212955ea0802f8a462..d593966b490f7f3bc56fd0f300ea0441cff4b3f3 100644 --- a/doc/fluid/api_cn/layers_cn/mse_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/mse_loss_cn.rst @@ -11,6 +11,9 @@ mse_loss + + + 该OP用于计算预测值和目标值的均方差误差。 对于预测值input和目标值label，公式为： diff --git a/doc/fluid/api_cn/layers_cn/multi_box_head_cn.rst b/doc/fluid/api_cn/layers_cn/multi_box_head_cn.rst index a8fb7337f826d00f919a382c0377acbba01b1f5c..9ba983b3c09180cbf60f26ff0b1e37f13536410e 100644 --- a/doc/fluid/api_cn/layers_cn/multi_box_head_cn.rst +++ b/doc/fluid/api_cn/layers_cn/multi_box_head_cn.rst @@ -7,6 +7,12 @@ multi_box_head .. py:function:: paddle.fluid.layers.multi_box_head(inputs, image, base_size, num_classes, aspect_ratios, min_ratio=None, max_ratio=None, min_sizes=None, max_sizes=None, steps=None, step_w=None, step_h=None, offset=0.5, variance=[0.1, 0.1, 0.2, 0.2], flip=True, clip=False, kernel_size=1, pad=0, stride=1, name=None, min_max_aspect_ratios_order=False) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.multi_box_head +:alias: paddle.declarative.multi_box_head +:old_api: paddle.fluid.layers.multi_box_head + + + diff --git a/doc/fluid/api_cn/layers_cn/multiclass_nms_cn.rst b/doc/fluid/api_cn/layers_cn/multiclass_nms_cn.rst index 12e3c804d95d81742116abfbf8bc71090621db1c..e263cf29538684a6af19dff0177ef9d53a665857 100644 --- a/doc/fluid/api_cn/layers_cn/multiclass_nms_cn.rst +++ b/doc/fluid/api_cn/layers_cn/multiclass_nms_cn.rst @@ -11,6 +11,9 @@ multiclass_nms + + + **多分类NMS** 该OP用于对边界框（bounding box）和评分（scores）执行多类非极大值抑制（NMS）。 diff --git a/doc/fluid/api_cn/layers_cn/multiplex_cn.rst b/doc/fluid/api_cn/layers_cn/multiplex_cn.rst index 1cc5bf39c256f14165cbf87df1a15e02cee3a070..a899db389d7569fdeca3241a1897002e226eeff1 100644 --- a/doc/fluid/api_cn/layers_cn/multiplex_cn.rst +++ b/doc/fluid/api_cn/layers_cn/multiplex_cn.rst @@ -11,6 +11,9 @@ multiplex + + + 根据给定的index参数，该OP从每个输入Tensor中选择特定行构造输出Tensor。 设该OP输入包含 :math:`m` 个Tensor，其中 :math:`I_{i}` 代表第i个输入Tensor，:math:`i` 处于区间 :math:`[0,m)`。 diff --git a/doc/fluid/api_cn/layers_cn/natural_exp_decay_cn.rst b/doc/fluid/api_cn/layers_cn/natural_exp_decay_cn.rst index 8fc60de95cc71c793c0d3b825bf63817654fbacc..f1b79b89b470909523ad5a59af9081fb84f3d20f 100644 --- a/doc/fluid/api_cn/layers_cn/natural_exp_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/natural_exp_decay_cn.rst @@ -11,6 +11,9 @@ natural_exp_decay + + + 将自然指数衰减运用到初始学习率上。 训练模型时，在训练过程中降低学习率。 自然指数衰减使用自然指数来计算衰减倍率，每 ``decay_steps`` 步衰减倍率的自然指数幂次项上增加 ``decay_rate`` 。 diff --git a/doc/fluid/api_cn/layers_cn/nce_cn.rst b/doc/fluid/api_cn/layers_cn/nce_cn.rst index aea9b3598281d70b63d20789ec036a9425a35243..bc0a31236edea6e643434b9e0a37687b98c3107d 100644 --- a/doc/fluid/api_cn/layers_cn/nce_cn.rst +++ b/doc/fluid/api_cn/layers_cn/nce_cn.rst @@ -7,6 +7,12 @@ nce .. py:function:: paddle.fluid.layers.nce(input, label, num_total_classes, sample_weight=None, param_attr=None, bias_attr=None, num_neg_samples=None, name=None, sampler='uniform', custom_dist=None, seed=0, is_sparse=False) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.nce +:alias: paddle.declarative.nce +:old_api: paddle.fluid.layers.nce + + + diff --git a/doc/fluid/api_cn/layers_cn/noam_decay_cn.rst b/doc/fluid/api_cn/layers_cn/noam_decay_cn.rst index 00a7ad2321b6864891b8cd1c8d04a32b39c30b5e..14f4f75ebc592580489b4f9a51390ecddb8a1ca9 100644 --- a/doc/fluid/api_cn/layers_cn/noam_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/noam_decay_cn.rst @@ -11,6 +11,9 @@ noam_decay + + + Noam衰减方法 noam衰减的numpy实现如下： diff --git a/doc/fluid/api_cn/layers_cn/not_equal_cn.rst b/doc/fluid/api_cn/layers_cn/not_equal_cn.rst index 9ec0336e9eb3ad320bfb7c842fa96bb7e651e47f..c5d74d51c48345ce6013406076ca62dd4166bff1 100644 --- a/doc/fluid/api_cn/layers_cn/not_equal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/not_equal_cn.rst @@ -11,6 +11,9 @@ not_equal + + + 该OP逐元素地返回 :math:`x != y` 的逻辑值，使用重载算子 `!=` 可以有相同的计算函数效果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/npair_loss_cn.rst b/doc/fluid/api_cn/layers_cn/npair_loss_cn.rst index 2b6c681656b6c7d452fcdf1999d52dd2c2cdcad1..aa4ba29f0f99966b523c2e09aa93cbdad77784b7 100644 --- a/doc/fluid/api_cn/layers_cn/npair_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/npair_loss_cn.rst @@ -11,6 +11,9 @@ npair_loss + + + **Npair Loss Layer** 参考阅读 `Improved Deep Metric Learning with Multi class N pair Loss Objective `_ diff --git a/doc/fluid/api_cn/layers_cn/pad2d_cn.rst b/doc/fluid/api_cn/layers_cn/pad2d_cn.rst index 08e937f50a7eb33bb21adadc2039984ff221cf31..c1fcc763a38b963e2d095091f5f59401c8dedc9f 100644 --- a/doc/fluid/api_cn/layers_cn/pad2d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/pad2d_cn.rst @@ -11,6 +11,9 @@ pad2d + + + 该OP依照 paddings 和 mode 属性对input进行2维 ``pad`` 。 参数： diff --git a/doc/fluid/api_cn/layers_cn/pad_cn.rst b/doc/fluid/api_cn/layers_cn/pad_cn.rst index a9ed06ded042fe47826667b3d70acfe766181c21..d11d230c4e958fd7a18329680f2dc59c99c72b98 100644 --- a/doc/fluid/api_cn/layers_cn/pad_cn.rst +++ b/doc/fluid/api_cn/layers_cn/pad_cn.rst @@ -11,6 +11,9 @@ pad + + + 该OP在Tensor上填充一个由 ``pad_value`` 给出的常数值，填充宽度由 ``paddings`` 指定。 其中，维度 ``i`` 中 ``x`` 内容前填充的值个数用 ``paddings[2*i]`` 表示，维度 ``i`` 中 ``x`` 内容后填充的值个数用 ``paddings[2*i+1]`` 表示。 diff --git a/doc/fluid/api_cn/layers_cn/pad_constant_like_cn.rst b/doc/fluid/api_cn/layers_cn/pad_constant_like_cn.rst index 8f0bad53df1e4c53ef64baa921b1153404d98a5b..0c2bf7a8a055caf205aa74d8c6f2afb3b1025850 100644 --- a/doc/fluid/api_cn/layers_cn/pad_constant_like_cn.rst +++ b/doc/fluid/api_cn/layers_cn/pad_constant_like_cn.rst @@ -11,6 +11,9 @@ pad_constant_like + + + 该OP使用 ``pad_value`` 填充 ``y`` ，填充到每个维度值的数量由x和y的形状而指定，((0，x.shape[0] - y.shape[0]), ..., (0, x.shape[i] - y.shape[i]), ..., (0, x.shape[n] - y.shape[n]))是每个维度填充的宽度，对于维度i，填充宽度 ``(0, x.shape[i] - y.shape[i])`` ，表示在y的第i维开头不填充，而在末尾填充 ``x.shape[i] - y.shape[i]`` 个位置。该OP要求y与x具有相同的秩，并且对每个维度i， ``y.shape[i] <= x.shape[i]`` 。 **示例**： diff --git a/doc/fluid/api_cn/layers_cn/piecewise_decay_cn.rst b/doc/fluid/api_cn/layers_cn/piecewise_decay_cn.rst index ecb2cd6274244631a6390f22a3c09aded78fef1a..bb9a6cf5b84c0f7f1fb0d5a943e4398243780073 100644 --- a/doc/fluid/api_cn/layers_cn/piecewise_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/piecewise_decay_cn.rst @@ -11,6 +11,9 @@ piecewise_decay + + + 对初始学习率进行分段衰减。 该算法可用如下代码描述。 diff --git a/doc/fluid/api_cn/layers_cn/pixel_shuffle_cn.rst b/doc/fluid/api_cn/layers_cn/pixel_shuffle_cn.rst index 07b29dd8892aece514291f781a5e3918dc882834..0de7b8966c0dbbe615be6fb4f127144ec938980f 100644 --- a/doc/fluid/api_cn/layers_cn/pixel_shuffle_cn.rst +++ b/doc/fluid/api_cn/layers_cn/pixel_shuffle_cn.rst @@ -11,6 +11,9 @@ pixel_shuffle + + + 该OP将一个形为[N, C, H, W]的Tensor重新排列成形为 [N, C/r**2, H*r, W*r] 的Tensor。这样做有利于实现步长（stride）为1/r的高效sub-pixel（亚像素）卷积。详见Shi等人在2016年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 .. code-block:: text diff --git a/doc/fluid/api_cn/layers_cn/polygon_box_transform_cn.rst b/doc/fluid/api_cn/layers_cn/polygon_box_transform_cn.rst index 06fa39efbdc758bc5e03dcf64e9554d2f627086b..e013755102212c7730cddd5ef347b409f4e1ac88 100644 --- a/doc/fluid/api_cn/layers_cn/polygon_box_transform_cn.rst +++ b/doc/fluid/api_cn/layers_cn/polygon_box_transform_cn.rst @@ -11,6 +11,9 @@ polygon_box_transform + + + **PolygonBoxTransform 算子** 该op用于将偏移坐标改变为真实的坐标。 diff --git a/doc/fluid/api_cn/layers_cn/polynomial_decay_cn.rst b/doc/fluid/api_cn/layers_cn/polynomial_decay_cn.rst index e03443b0bd7d02177ef045393595f8d06dc4abf5..2d5c5ab48ab0a1fd30ff9780cdf0105e98d886dc 100644 --- a/doc/fluid/api_cn/layers_cn/polynomial_decay_cn.rst +++ b/doc/fluid/api_cn/layers_cn/polynomial_decay_cn.rst @@ -11,6 +11,9 @@ polynomial_decay + + + 对初始学习率使用多项式衰减 .. code-block:: text diff --git a/doc/fluid/api_cn/layers_cn/pool2d_cn.rst b/doc/fluid/api_cn/layers_cn/pool2d_cn.rst index d1990be374c9807f6272937e7e6c6d75e3e89062..ff352c19422dc014911174d044ba8341921dc190 100644 --- a/doc/fluid/api_cn/layers_cn/pool2d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/pool2d_cn.rst @@ -11,6 +11,9 @@ pool2d + + + 该OP使用上述输入参数的池化配置，为二维空间池化操作，根据 ``input`` ，池化核大小 ``pool_size`` ，池化类型 ``pool_type`` ，步长 ``pool_stride`` ，填充 ``pool_padding`` 等参数得到输出。 输入 ``input`` 和输出（out）采用NCHW或NHWC格式，N为批大小，C是通道数，H是特征高度，W是特征宽度。 diff --git a/doc/fluid/api_cn/layers_cn/pool3d_cn.rst b/doc/fluid/api_cn/layers_cn/pool3d_cn.rst index d23d77b7247696b0b6e53b269a6d24b6f59e6b9d..81d2c0b18aa17f5fa0cacde1fd67e03297e9df3d 100644 --- a/doc/fluid/api_cn/layers_cn/pool3d_cn.rst +++ b/doc/fluid/api_cn/layers_cn/pool3d_cn.rst @@ -11,6 +11,9 @@ pool3d + + + 该OP使用上述输入参数的池化配置，为三维空间池化操作，根据 ``input`` ，池化核大小 ``pool_size`` ，池化类型 ``pool_type`` ，步长 ``pool_stride`` 和填充 ``pool_padding`` 等参数计算输出。 输入 ``input`` 和输出（Out）采用NCDHW或NDHWC格式，其中N是批大小，C是通道数，D，H和W分别是特征的深度，高度和宽度。 diff --git a/doc/fluid/api_cn/layers_cn/prelu_cn.rst b/doc/fluid/api_cn/layers_cn/prelu_cn.rst index b1ea4cfb569fac4c885b8292ba07f022886e0934..864e4b6ead210c5c345956d4b4b2d83fbbdb42e2 100644 --- a/doc/fluid/api_cn/layers_cn/prelu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/prelu_cn.rst @@ -7,6 +7,12 @@ prelu .. py:function:: paddle.fluid.layers.prelu(x, mode, param_attr=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.prelu +:alias: paddle.declarative.prelu +:old_api: paddle.fluid.layers.prelu + + + diff --git a/doc/fluid/api_cn/layers_cn/prior_box_cn.rst b/doc/fluid/api_cn/layers_cn/prior_box_cn.rst index 85383fbbe6d7f3a60d449c0db069967a12606785..7e3664e3bd5fd04943c234e6bfed34c04987f3ef 100644 --- a/doc/fluid/api_cn/layers_cn/prior_box_cn.rst +++ b/doc/fluid/api_cn/layers_cn/prior_box_cn.rst @@ -10,6 +10,9 @@ prior_box + + + 该OP为SSD(Single Shot MultiBox Detector)算法生成候选框。输入的每个位产生N个候选框，N由min_sizes,max_sizes和aspect_ratios的数目决定，候选框的尺寸在(min_size,max_size)之间，该尺寸根据aspect_ratios在序列中生成。 参数： diff --git a/doc/fluid/api_cn/layers_cn/prroi_pool_cn.rst b/doc/fluid/api_cn/layers_cn/prroi_pool_cn.rst index 321c390d57ef836e0ab2a8a6f6b073df198bdb86..f69dca6ea9c6db81c3cd73688801d0e45fa3ccf4 100644 --- a/doc/fluid/api_cn/layers_cn/prroi_pool_cn.rst +++ b/doc/fluid/api_cn/layers_cn/prroi_pool_cn.rst @@ -11,6 +11,9 @@ prroi_pool + + + PRROIPool运算 精确区域池化方法（Precise region of interest pooling，也称为PRROIPooling）是对输入的 "感兴趣区域"(RoI)执行插值处理，将离散的特征图数据映射到一个连续空间，使用二重积分再求均值的方式实现Pooling。 diff --git a/doc/fluid/api_cn/layers_cn/psroi_pool_cn.rst b/doc/fluid/api_cn/layers_cn/psroi_pool_cn.rst index 92a246f63c4c04e4955322e73359398f03dd17c6..c7b046e8ee202bd2ce8f9d3b5a02543688b97dc0 100644 --- a/doc/fluid/api_cn/layers_cn/psroi_pool_cn.rst +++ b/doc/fluid/api_cn/layers_cn/psroi_pool_cn.rst @@ -11,6 +11,9 @@ psroi_pool + + + **注意 rois必须为2维LoDTensor，lod_level为1** 该OP执行PSROIPooling运算，是位置敏感的感兴趣区域池化方法（Position sensitive region of interest pooling，也称为PSROIPooling）。输入input是位置敏感的评分图，输入rois是感兴趣区域的位置坐标。PSROIPooling不同于普通ROIPooling的地方在于，输入input特征图的不同通道会跟输出特征图上的位置区域相关联，该方法是在R-FCN模型中首次提出来的，更多详细信息请参阅 https://arxiv.org/abs/1605.06409。 diff --git a/doc/fluid/api_cn/layers_cn/py_func_cn.rst b/doc/fluid/api_cn/layers_cn/py_func_cn.rst index 79d11adef7a0cf8abfd256ad8d81a58945ab7d86..d854f9758260685eaf67a1f021b68304e7214092 100644 --- a/doc/fluid/api_cn/layers_cn/py_func_cn.rst +++ b/doc/fluid/api_cn/layers_cn/py_func_cn.rst @@ -10,6 +10,9 @@ py_func + + + PaddlePaddle Fluid通过py_func在Python端注册OP。py_func的设计原理在于Paddle中的LodTensor与numpy数组可以方便的互相转换，从而可使用Python中的numpy API来自定义一个Python OP。 该自定义的Python OP的前向函数是 ``func``, 反向函数是 ``backward_func`` 。 Paddle将在前向部分调用 ``func`` ，并在反向部分调用 ``backward_func`` （如果 ``backward_func`` 不是None)。 ``x`` 为 ``func`` 的输入，必须为LoDTensor类型； ``out`` 为 ``func`` 的输出， 既可以是LoDTensor类型, 也可以是numpy数组。 diff --git a/doc/fluid/api_cn/layers_cn/py_reader_cn.rst b/doc/fluid/api_cn/layers_cn/py_reader_cn.rst index f302c7891f7debe6f37dac2bc8fa982c6cffccab..8f7a976b3e2c77c2b4fdd3f809adf53904bc1c6c 100644 --- a/doc/fluid/api_cn/layers_cn/py_reader_cn.rst +++ b/doc/fluid/api_cn/layers_cn/py_reader_cn.rst @@ -11,6 +11,9 @@ py_reader + + + 创建一个在Python端提供数据的reader 该OP返回一个Reader Variable。该Reader提供了 ``decorate_paddle_reader()`` 和 ``decorate_tensor_provider()`` 来设置Python generator作为数据源，将数据源中的数据feed到Reader Variable。在c++端调用 ``Executor::Run()`` 时，来自generator的数据将被自动读取。与 ``DataFeeder.feed()`` 不同，数据读取进程和 ``Executor::Run()`` 进程可以使用 ``py_reader`` 并行运行。在每次数据传递开始时调用reader的 ``start()`` ，在传递结束和抛出 ``fluid.core.EOFException`` 异常后执行 ``reset()`` 。 diff --git a/doc/fluid/api_cn/layers_cn/random_crop_cn.rst b/doc/fluid/api_cn/layers_cn/random_crop_cn.rst index e9a229030384d8a9dd28ca0308654510f2326008..c6c4a8be9feb7bbfdab226e7608354824882759e 100644 --- a/doc/fluid/api_cn/layers_cn/random_crop_cn.rst +++ b/doc/fluid/api_cn/layers_cn/random_crop_cn.rst @@ -11,6 +11,9 @@ random_crop + + + 该操作对batch中每个实例进行随机裁剪，即每个实例的裁剪位置不同，裁剪位置由均匀分布随机数生成器决定。所有裁剪后的实例都具有相同的维度，由 ``shape`` 参数决定。 参数: diff --git a/doc/fluid/api_cn/layers_cn/rank_cn.rst b/doc/fluid/api_cn/layers_cn/rank_cn.rst index 0d3aee591f86e84bc4a73fe40e2c31f434b558fa..884920946a2083e1d85deb97e3f00257f377bdd2 100644 --- a/doc/fluid/api_cn/layers_cn/rank_cn.rst +++ b/doc/fluid/api_cn/layers_cn/rank_cn.rst @@ -11,6 +11,9 @@ rank + + + 该OP用于计算输入Tensor的维度（秩）。 参数： diff --git a/doc/fluid/api_cn/layers_cn/rank_loss_cn.rst b/doc/fluid/api_cn/layers_cn/rank_loss_cn.rst index 3f6f5b2a83df84fa477006499891176be909b1bf..fdb5eaa658184f6fc22f59418271f4d6c6dd2ef9 100644 --- a/doc/fluid/api_cn/layers_cn/rank_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/rank_loss_cn.rst @@ -11,6 +11,9 @@ rank_loss + + + 该OP实现了RankNet模型中的排序损失层。RankNet是一种文档对（pairwise）排序模型，训练样本由一对文档（假设用A、B来表示）组成。标签（假设用P来表示）表示A的排名是否高于B。更多详情请参考：`RankNet `_ 排序损失层有三个输入： :math:`o_i` 、 :math:`o_j` 和 :math:`\tilde{P_{ij}}` ，输入分别表示RankNet模型对文档A、B的输出得分和标签P的值；排序损失层的输入是批输入数据（批大小大于等于1）；标签P的取值可以为： {0, 1} 或 {0, 0.5, 1} ，其中，0.5表示输入文档对排序相同。输入数据的排序损失 :math:`C_{i,j}` 计算过程如下： diff --git a/doc/fluid/api_cn/layers_cn/read_file_cn.rst b/doc/fluid/api_cn/layers_cn/read_file_cn.rst index c2ac46e1465712cec6c6c5d7645ce8d4f711cb9f..f097037d1b240bee52b50f7f5a65f5b8540968b1 100644 --- a/doc/fluid/api_cn/layers_cn/read_file_cn.rst +++ b/doc/fluid/api_cn/layers_cn/read_file_cn.rst @@ -10,6 +10,9 @@ read_file + + + 从给定的reader中读取数据 reader是一个Variable，它可以是由函数fluid.layers.py_reader()生成的reader，或者是由函数fluid.layers.double_buffer()生成的装饰Variable。 diff --git a/doc/fluid/api_cn/layers_cn/reciprocal_cn.rst b/doc/fluid/api_cn/layers_cn/reciprocal_cn.rst index 966c82cf90ee0423f37eeb6adbe0871c91caa652..569515c1ec6e98bf7474cfcacf9ba30bc5eae197 100644 --- a/doc/fluid/api_cn/layers_cn/reciprocal_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reciprocal_cn.rst @@ -11,6 +11,9 @@ reciprocal + + + reciprocal 对输入Tensor取倒数 diff --git a/doc/fluid/api_cn/layers_cn/reduce_all_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_all_cn.rst index 88a1ba9e3f9081ec3772e88481a15864c41ee86e..2936182245de854387ceca8c334ceed2ead6fb95 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_all_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_all_cn.rst @@ -11,6 +11,9 @@ reduce_all + + + 该OP是对指定维度上的Tensor元素进行与逻辑（&）计算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/reduce_any_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_any_cn.rst index 13a23b8139886d391641a6a9068879d51b2fd1ee..0b85148e864e40abf876a06d7b2e9b9d4669d1a0 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_any_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_any_cn.rst @@ -11,6 +11,9 @@ reduce_any + + + 该OP是对指定维度上的Tensor元素进行或逻辑（|）计算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/reduce_max_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_max_cn.rst index 37cc3db57a4d12ac01e43fce0e3b9cea8e609b17..8a4174b9cb45bf7f755cc2b3386d8aed03dda45c 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_max_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_max_cn.rst @@ -11,6 +11,9 @@ reduce_max + + + 该OP是对指定维度上的Tensor元素求最大值运算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/reduce_mean_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_mean_cn.rst index c94fed0a80b6a766a57f10ad6c5357428b0c0bd4..2034a5a18b4b64e8d0ed8cd3fcb1fa3c2e6b8d61 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_mean_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_mean_cn.rst @@ -11,6 +11,9 @@ reduce_mean + + + 该OP是对指定维度上的Tensor元素进行平均值算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/reduce_min_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_min_cn.rst index 2517c935e483cff4a2c7686556e6583126e29bb4..cb04e4b483bf9a9e8ac41d705bc4782ede835a7d 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_min_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_min_cn.rst @@ -11,6 +11,9 @@ reduce_min + + + 该OP是对指定维度上的Tensor元素求最小值运算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/reduce_prod_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_prod_cn.rst index a1b65ee1ddb2fe5e59e63df68d7a674a684d6e65..60b30f5b47a34034433bb0e701fbdeffbea55a2e 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_prod_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_prod_cn.rst @@ -11,6 +11,9 @@ reduce_prod + + + 该OP是对指定维度上的Tensor元素进行求乘积运算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/reduce_sum_cn.rst b/doc/fluid/api_cn/layers_cn/reduce_sum_cn.rst index da06baf68be2370b27a1162e24882a615b878589..d81eaa99a29ed4910d151be9377da8c331fdd373 100644 --- a/doc/fluid/api_cn/layers_cn/reduce_sum_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reduce_sum_cn.rst @@ -11,6 +11,9 @@ reduce_sum + + + 该OP是对指定维度上的Tensor元素进行求和运算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/layers_cn/relu6_cn.rst b/doc/fluid/api_cn/layers_cn/relu6_cn.rst index 05c83c7e5e48c6fda17a075dd8bbd13f00c62c02..78362a86460cbbcd25afb12347fd3945799a9d23 100644 --- a/doc/fluid/api_cn/layers_cn/relu6_cn.rst +++ b/doc/fluid/api_cn/layers_cn/relu6_cn.rst @@ -11,6 +11,9 @@ relu6 + + + relu6激活函数 .. math:: out=min(max(0, x), threshold) diff --git a/doc/fluid/api_cn/layers_cn/reshape_cn.rst b/doc/fluid/api_cn/layers_cn/reshape_cn.rst index a5e39dff07f19832e9468f7deea5cc43b366a33d..c52972a0b8bda5320246b15005d70849a4826b8a 100644 --- a/doc/fluid/api_cn/layers_cn/reshape_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reshape_cn.rst @@ -11,6 +11,9 @@ reshape + + + 该OP在保持输入 ``x`` 数据不变的情况下，改变 ``x`` 的形状。 目标形状可由 ``shape`` 或 ``actual_shape`` 给出。当两个属性同时被指定时，``actual_shape`` 的优先级高于 ``shape`` ，但此时 ``shape`` 只能是整数列表或元组，且在编译时仍然应该正确地设置 ``shape`` 以保证形状推断。 diff --git a/doc/fluid/api_cn/layers_cn/resize_bilinear_cn.rst b/doc/fluid/api_cn/layers_cn/resize_bilinear_cn.rst index d0fd0a3f2b04cbf90fe6d4944929b9c93cbaec5f..f641db1b7bbdbcdb574f361c8734b6cd48b4667e 100644 --- a/doc/fluid/api_cn/layers_cn/resize_bilinear_cn.rst +++ b/doc/fluid/api_cn/layers_cn/resize_bilinear_cn.rst @@ -11,6 +11,9 @@ resize_bilinear + + + **注意:** 参数 ``actual_shape`` 将被弃用，请使用 ``out_shape`` 替代。 该OP应用双向性插值法调整输入图片的大小，输出形状按优先级由actual_shape、out_shape和scale指定。 diff --git a/doc/fluid/api_cn/layers_cn/resize_nearest_cn.rst b/doc/fluid/api_cn/layers_cn/resize_nearest_cn.rst index 2d4ff2abf242b745703200a0fb7966486f8faefc..630ef0c3bf837d8c99fd6ae9556f834d91e75b49 100644 --- a/doc/fluid/api_cn/layers_cn/resize_nearest_cn.rst +++ b/doc/fluid/api_cn/layers_cn/resize_nearest_cn.rst @@ -11,6 +11,9 @@ resize_nearest + + + 该OP对输入图片进行大小调整，在高度方向宽度方向进行最邻近插值（nearest neighbor interpolation）操作。 输出形状按优先级顺序依据 ``actual_shape`` , ``out_shape`` 和 ``scale`` 而定。 diff --git a/doc/fluid/api_cn/layers_cn/resize_trilinear_cn.rst b/doc/fluid/api_cn/layers_cn/resize_trilinear_cn.rst index 58c62c6ca849b47d12ff1188b88e3cc3797030d2..959f4e228ede82a732f8f01edf750099f60fd976 100644 --- a/doc/fluid/api_cn/layers_cn/resize_trilinear_cn.rst +++ b/doc/fluid/api_cn/layers_cn/resize_trilinear_cn.rst @@ -11,6 +11,9 @@ resize_trilinear + + + **注意:** 参数 ``actual_shape`` 将被弃用，请使用 ``out_shape`` 替代。 该层对输入进行放缩，基于给定的由 ``actual_shape`` , ``out_shape`` , ``scale`` 确定的输出shape，进行三线插值。三线插值是包含三个参数的线性插值方程（D方向，H方向， W方向）,在一个3D格子上进行三个方向的线性插值。更多细节，请参考维基百科：https://en.wikipedia.org/wiki/Trilinear_interpolation diff --git a/doc/fluid/api_cn/layers_cn/retinanet_detection_output_cn.rst b/doc/fluid/api_cn/layers_cn/retinanet_detection_output_cn.rst index 426ea26b3a675bf121e2ff8e0c8495e715878f52..405cd7c04fb08cc3a1ab12973008d2d858b23992 100644 --- a/doc/fluid/api_cn/layers_cn/retinanet_detection_output_cn.rst +++ b/doc/fluid/api_cn/layers_cn/retinanet_detection_output_cn.rst @@ -11,6 +11,9 @@ retinanet_detection_output + + + 在 `RetinaNet `_ 中，有多个 `FPN `_ 层会输出用于分类的预测值和位置回归的预测值，该OP通过执行以下步骤将这些预测值转换成最终的检测结果： 1. 在每个FPN层上，先剔除分类预测值小于score_threshold的anchor，然后按分类预测值从大到小排序，选出排名前nms_top_k的anchor，并将这些anchor与其位置回归的预测值做解码操作得到检测框。 diff --git a/doc/fluid/api_cn/layers_cn/retinanet_target_assign_cn.rst b/doc/fluid/api_cn/layers_cn/retinanet_target_assign_cn.rst index 895433d93fe0a6d4e10ac85aedb464ab78fe074b..eee66fc77617b1177cbeb4a7dfc3c43613909f31 100644 --- a/doc/fluid/api_cn/layers_cn/retinanet_target_assign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/retinanet_target_assign_cn.rst @@ -11,6 +11,9 @@ retinanet_target_assign + + + 该OP是从输入anchor中找出训练检测模型 `RetinaNet `_ 所需的正负样本，并为每个正负样本分配用于分类的目标值和位置回归的目标值，同时从全部anchor的类别预测值cls_logits、位置预测值bbox_pred中取出属于各正负样本的部分。 正负样本的查找准则如下： diff --git a/doc/fluid/api_cn/layers_cn/reverse_cn.rst b/doc/fluid/api_cn/layers_cn/reverse_cn.rst index d0b724e6c8dbf0c487489741b92b51f21cb6a5c5..1862bede5005f1109e93aa7ef83d89773ea92d5a 100644 --- a/doc/fluid/api_cn/layers_cn/reverse_cn.rst +++ b/doc/fluid/api_cn/layers_cn/reverse_cn.rst @@ -11,6 +11,9 @@ reverse + + + **reverse** 该OP对输入Tensor ``x`` 在指定轴 ``axis`` 上进行数据的逆序操作。 diff --git a/doc/fluid/api_cn/layers_cn/rnn_cn.rst b/doc/fluid/api_cn/layers_cn/rnn_cn.rst index 75faee0a3e3975cc1403cbdec72e187fed7e36ae..d20b34a5e33c0110ff553bb8a379c89a19bf80fc 100644 --- a/doc/fluid/api_cn/layers_cn/rnn_cn.rst +++ b/doc/fluid/api_cn/layers_cn/rnn_cn.rst @@ -10,6 +10,9 @@ rnn :api_attr: 声明式编程模式（静态图) + + + rnn创建一个由RNNCell :code:`cell` 指定的递归神经网络，该神经网络重复执行 :code:`cell.call()` 直至达到 :code:`inputs` 的最大长度。 diff --git a/doc/fluid/api_cn/layers_cn/roi_align_cn.rst b/doc/fluid/api_cn/layers_cn/roi_align_cn.rst index c5c72638bb5979df1767cf4f7eb765060e245bea..262b73a539e62442391b86497c6d9fa70c762f5a 100644 --- a/doc/fluid/api_cn/layers_cn/roi_align_cn.rst +++ b/doc/fluid/api_cn/layers_cn/roi_align_cn.rst @@ -11,6 +11,9 @@ roi_align + + + **实现RoIAlign操作。** Region of Interests align(直译：有意义、有价值选区对齐) 用于实现双线性插值，它可以将不均匀大小的输入 diff --git a/doc/fluid/api_cn/layers_cn/roi_perspective_transform_cn.rst b/doc/fluid/api_cn/layers_cn/roi_perspective_transform_cn.rst index 1c97a18e0b7897d2b0299bc33d70f94e508531d3..8c403350b36d04f44c1a4674c2b26a1b0b5b2fd8 100644 --- a/doc/fluid/api_cn/layers_cn/roi_perspective_transform_cn.rst +++ b/doc/fluid/api_cn/layers_cn/roi_perspective_transform_cn.rst @@ -11,6 +11,9 @@ roi_perspective_transform + + + 该OP对RoI区域做透视变换，将不规则的RoI区域变成固定大小的矩形区域，透视变换是线性代数里面的一种基础变换。 参数： diff --git a/doc/fluid/api_cn/layers_cn/roi_pool_cn.rst b/doc/fluid/api_cn/layers_cn/roi_pool_cn.rst index 616c119d22d5d91e30903d82879975b0733ace87..a5a7c4ca958ac0ba77a36c2f974aab02c8c80253 100644 --- a/doc/fluid/api_cn/layers_cn/roi_pool_cn.rst +++ b/doc/fluid/api_cn/layers_cn/roi_pool_cn.rst @@ -12,6 +12,9 @@ roi_pool + + + 该OP实现了roi池化操作，对非均匀大小的输入执行最大池化，以获得固定大小的特征映射(例如7*7)。 该OP的操作分三个步骤: diff --git a/doc/fluid/api_cn/layers_cn/round_cn.rst b/doc/fluid/api_cn/layers_cn/round_cn.rst index 7de4214b7e9a993490a07b76b28b62142f1d72d2..bd86ffcfc2e16059bff462be70da920ab635b7e4 100644 --- a/doc/fluid/api_cn/layers_cn/round_cn.rst +++ b/doc/fluid/api_cn/layers_cn/round_cn.rst @@ -12,6 +12,9 @@ round + + + 该OP将输入中的数值四舍五入到最接近的整数数值。 .. code-block:: python diff --git a/doc/fluid/api_cn/layers_cn/row_conv_cn.rst b/doc/fluid/api_cn/layers_cn/row_conv_cn.rst index ab16bdbfbb86e42131b331a373b8e66e2a1099c1..f2af7cc078d5060143ed9d5a7f6452197730341d 100644 --- a/doc/fluid/api_cn/layers_cn/row_conv_cn.rst +++ b/doc/fluid/api_cn/layers_cn/row_conv_cn.rst @@ -7,6 +7,12 @@ row_conv .. py:function:: paddle.fluid.layers.row_conv(input, future_context_size, param_attr=None, act=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.row_conv +:alias: paddle.declarative.row_conv,paddle.nn.functional.row_conv,paddle.nn.functional.extension.row_conv +:old_api: paddle.fluid.layers.row_conv + + + diff --git a/doc/fluid/api_cn/layers_cn/rpn_target_assign_cn.rst b/doc/fluid/api_cn/layers_cn/rpn_target_assign_cn.rst index 3edc0ee06ede956fc25791c2c833ea6b473c2c9e..d846ff0ad2f3edf5a4bf231ac9dff74035e9c7c3 100644 --- a/doc/fluid/api_cn/layers_cn/rpn_target_assign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/rpn_target_assign_cn.rst @@ -11,6 +11,9 @@ rpn_target_assign + + + 该OP用于为anchors分配分类标签和回归标签，以便用这些标签对RPN进行训练。 该OP将anchors分为两种类别，正和负。根据Faster-RCNN的paper，正类别anchor包括以下两种anchor: diff --git a/doc/fluid/api_cn/layers_cn/rsqrt_cn.rst b/doc/fluid/api_cn/layers_cn/rsqrt_cn.rst index 0d4a83041be454cdcd2f4e2e6d850d861d3bbbeb..b823b4df26589429cb5b08f7772e344c7c111c40 100644 --- a/doc/fluid/api_cn/layers_cn/rsqrt_cn.rst +++ b/doc/fluid/api_cn/layers_cn/rsqrt_cn.rst @@ -11,6 +11,9 @@ rsqrt + + + 该OP为rsqrt激活函数。 注：输入x应确保为非 **0** 值，否则程序会抛异常退出。 diff --git a/doc/fluid/api_cn/layers_cn/sampled_softmax_with_cross_entropy_cn.rst b/doc/fluid/api_cn/layers_cn/sampled_softmax_with_cross_entropy_cn.rst index 82ca1725079152ea0b411e64ccde808984d8a5a9..cf1907095c6c9f4dcac7de458283cba1b1b33e7a 100644 --- a/doc/fluid/api_cn/layers_cn/sampled_softmax_with_cross_entropy_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sampled_softmax_with_cross_entropy_cn.rst @@ -11,6 +11,9 @@ sampled_softmax_with_cross_entropy + + + **Sampled Softmax With Cross Entropy Operator** 对于较大的输出类，采样的交叉熵损失Softmax被广泛地用作输出层。该运算符为所有示例采样若干个样本，并计算每行采样张量的SoftMax标准化值，然后计算交叉熵损失。 diff --git a/doc/fluid/api_cn/layers_cn/scale_cn.rst b/doc/fluid/api_cn/layers_cn/scale_cn.rst index f9ddd81f88ab446c144559cfc6f92538f7d44d3c..2b382ce4bcb70a1aa4811b0fcd1807be9c87dd34 100644 --- a/doc/fluid/api_cn/layers_cn/scale_cn.rst +++ b/doc/fluid/api_cn/layers_cn/scale_cn.rst @@ -11,6 +11,9 @@ scale + + + 缩放算子。 对输入Tensor进行缩放和偏置，其公式如下： diff --git a/doc/fluid/api_cn/layers_cn/scatter_cn.rst b/doc/fluid/api_cn/layers_cn/scatter_cn.rst index 38824d7fbdd7d3aa250f24e4b8185b3399f53b5b..b9c1966cf628ac9227485d46eba93e9bad2c81be 100644 --- a/doc/fluid/api_cn/layers_cn/scatter_cn.rst +++ b/doc/fluid/api_cn/layers_cn/scatter_cn.rst @@ -11,6 +11,9 @@ scatter + + + 该OP根据index中的索引值将updates数据更新到input中。 .. code-block:: python diff --git a/doc/fluid/api_cn/layers_cn/scatter_nd_add_cn.rst b/doc/fluid/api_cn/layers_cn/scatter_nd_add_cn.rst index 95b26e03a214a8cd04a11ef8b6803c246d9cfcb8..f84d2bdc2a6f6460eb85590e8fcbdd14ad3f24ab 100644 --- a/doc/fluid/api_cn/layers_cn/scatter_nd_add_cn.rst +++ b/doc/fluid/api_cn/layers_cn/scatter_nd_add_cn.rst @@ -11,6 +11,9 @@ scatter_nd_add + + + 该OP通过对Variable中的单个值或切片应用稀疏加法，从而得到输出的Variable。 :code:`ref` 是维度为 :code:`R` 的张量。 :code:`index` 是维度为 :code:`K` 的张量。因此， :code:`index` 的形状是 :math:`[i_0, i_1, ..., i_{K-2}, Q]` ，其中 :math:`Q \leq R` 。:code:`updates` 是一个维度为 :math:`K - 1 + R - Q` 的张量，它的形状是 :math:`index.shape[:-1] + ref.shape[index.shape[-1]:]` 。 diff --git a/doc/fluid/api_cn/layers_cn/scatter_nd_cn.rst b/doc/fluid/api_cn/layers_cn/scatter_nd_cn.rst index 60a0b84a5d774638cf99589cdc78fb42a0cd7d22..a1d94da9cbc3f5357331ee2ea530fe5ed4ffbee1 100644 --- a/doc/fluid/api_cn/layers_cn/scatter_nd_cn.rst +++ b/doc/fluid/api_cn/layers_cn/scatter_nd_cn.rst @@ -11,6 +11,9 @@ scatter_nd + + + 该OP根据 :code:`index` ，将 :code:`updates` 添加到一个新的张量中，从而得到输出的Variable。这个操作与 :code:`scatter_nd_add` 类似，除了形状为 :code:`shape` 的张量是通过零初始化的。相应地， :code:`scatter_nd(index, updates, shape)` 等价于 :code:`scatter_nd_add(fluid.layers.zeros(shape, updates.dtype), index, updates)` 。如果 :code:`index` 有重复元素，则将累积相应的更新，因此，由于数值近似问题，索引中重复元素的顺序不同可能会导致不同的输出结果。具体的计算方法可以参见 :code:`scatter_nd_add` 。该OP是 :code:`gather_nd` 的反函数。 参数： diff --git a/doc/fluid/api_cn/layers_cn/selu_cn.rst b/doc/fluid/api_cn/layers_cn/selu_cn.rst index 4aee591bcc8dd87d0df0e9f0ef8faed224d5c5f1..0232469dbcfaa59ab335e680c312ca9e01c4d7e1 100644 --- a/doc/fluid/api_cn/layers_cn/selu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/selu_cn.rst @@ -11,6 +11,9 @@ selu + + + SeLU激活函数，其公式如下： .. math:: diff --git a/doc/fluid/api_cn/layers_cn/sequence_concat_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_concat_cn.rst index 8bb16a4524400184880e1ee3cd36e570d048901d..8171a541b957a0d6ac43f6460bd1f3c0edcf0b1d 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_concat_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_concat_cn.rst @@ -10,6 +10,9 @@ sequence_concat + + + **注意：该OP的输入只能是LoDTensor，如果您需要处理的输入是Tensor类型，请使用concat函数（fluid.layers.** :ref:`cn_api_fluid_layers_concat` **）。** **该OP仅支持LoDTensor** ，通过LoDTensor的LoD信息将输入的多个LoDTensor进行连接（concat），输出连接后的LoDTensor。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_conv_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_conv_cn.rst index 9bf232beca7000c5a42c552814aa5ab70179a559..8172bf7084592ab9b22c52a9a381950052f5a552 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_conv_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_conv_cn.rst @@ -10,6 +10,9 @@ sequence_conv + + + **注意：该OP的输入只能是LoDTensor，如果您需要处理的输入是Tensor类型，请使用conv2d函数（fluid.layers.** :ref:`cn_api_fluid_layers_conv2d` **）。** 该OP在给定的卷积参数下（如卷积核数目、卷积核大小等），对输入的变长序列（sequence）LoDTensor进行卷积操作。默认情况下，该OP会自适应地在每个输入序列的两端等长地填充全0数据，以确保卷积后的序列输出长度和输入长度一致。支持通过配置 ``padding_start`` 参数来指定序列填充的行为。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_enumerate_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_enumerate_cn.rst index 5ac0470fa3a199296d246361c7e4c5528a7e37bc..c01c32e806a5c5811863b6bcb1d228a67ee0e73d 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_enumerate_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_enumerate_cn.rst @@ -10,6 +10,9 @@ sequence_enumerate + + + 枚举形状为 ``[d_1, 1]`` 的输入序列所有长度为 ``win_size`` 的子序列，生成一个形状为 ``[d_1, win_size]`` 的新序列，需要时以 ``pad_value`` 填充。 注意,该OP的输入 ``input`` 只能是LodTensor。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_expand_as_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_expand_as_cn.rst index c76d64fe47934ec7a52a125b07a14ce2e1fd1442..d0eb3d35dac944b77715e0babfc7a95584b8b4fa 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_expand_as_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_expand_as_cn.rst @@ -10,6 +10,9 @@ sequence_expand_as + + + Sequence Expand As Layer，该OP根据输入 ``y`` 的第0级lod对输入 ``x`` 进行扩展。当前实现要求 ``y`` 的lod层数（level）必须为1，且 ``x`` 的第一维必须和 ``y`` 的第0层lod大小相同，所以扩展后的LodTensor具有和 ``y`` 相同的lod。扩展结果与输入 ``x`` 的lod无关，所以无需考虑 ``x`` 的lod。 注意，该OP的输入 ``x`` 可以是Tensor或LoDTensor， ``y`` 只能是LodTensor。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_expand_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_expand_cn.rst index 81bbbe60230a1c14f09e8c066ba957bac8c054b9..7c7658df56842dad72663fb1ffc7c171ab96d3aa 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_expand_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_expand_cn.rst @@ -10,6 +10,9 @@ sequence_expand + + + 序列扩张层（Sequence Expand Layer)，根据输入 ``y`` 的第 ``ref_level`` 层lod对输入 ``x`` 进行扩展。 ``x`` 的lod level最多为1，若 ``x`` 的lod level为1，则 ``x`` 的lod大小必须与 ``y`` 的第 ``ref_level`` 层lod大小相等；若 ``x`` 的lod level为0，则 ``x`` 的第一维大小必须与 ``y`` 第 ``ref_level`` 层大小相等。 ``x`` 的秩最少为2，当 ``x`` 的秩大于2时，将被当作是一个二维张量处理。 注意，该OP的输入 ``x`` 可以是Tensor或LodTensor， ``y`` 只能是LodTensor。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_first_step_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_first_step_cn.rst index bdc2afbba3f1ffe770b9dfc5364b248b6d44d6da..57dda3748309d296dde327a1f6ad79b97b64b2d0 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_first_step_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_first_step_cn.rst @@ -10,6 +10,9 @@ sequence_first_step + + + 该OP **仅支持LoDTensor类型的输入** ，将对输入的LoDTensor，在最后一层lod_level上，选取其每个序列（sequence）的第一个时间步（time_step）的特征向量作为池化后的输出向量。 :: diff --git a/doc/fluid/api_cn/layers_cn/sequence_last_step_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_last_step_cn.rst index c2f4604c51ef494f4e374ba0efb88d73a1e1b778..3a5ffa1cfbc1d015183f9c4cf697a23f828192b1 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_last_step_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_last_step_cn.rst @@ -10,6 +10,9 @@ sequence_last_step + + + 该OP **仅支持LoDTensor类型的输入** ，将对输入的LoDTensor，在最后一层lod_level上，选取其每个序列（sequence）的最后一个时间步（time-step）的特征向量作为池化后的输出向量。 :: diff --git a/doc/fluid/api_cn/layers_cn/sequence_pad_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_pad_cn.rst index 12ddf6eb2ecd59afe5700187479a636d33cd7fe7..4f47e8afa07b4954d78837a0f24ea1149a6a34f8 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_pad_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_pad_cn.rst @@ -10,6 +10,9 @@ sequence_pad + + + 序列填充操作符（Sequence Pad Operator）,该OP将同一batch中的序列填充到一个一致的长度（由 ``maxlen`` 指定）。填充的新元素的值具体由输入 ``pad_value`` 指定，并会添加到每一个序列的末尾，使得他们最终的长度保持一致。最后返回一个Python tuple ``(Out, Length)`` ，其中LodTensor ``Out`` 为填充后的序列，LodTensor ``Length`` 为填充前的原序列长度信息。 注意，该OP的输入 ``x`` 只能是LodTensor。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_pool_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_pool_cn.rst index 480bc75c92f9d5412861391bbcb5ce94361a1701..845c9ed9687c0fc0416276b1c37ee6ac452134a9 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_pool_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_pool_cn.rst @@ -10,6 +10,9 @@ sequence_pool + + + **注意：该OP的输入只能是LoDTensor，如果您需要处理的输入是Tensor类型，请使用pool2d函数（fluid.layers.** :ref:`cn_api_fluid_layers_pool2d` **）。** 该OP **仅支持LoDTensor类型的输入** ，将对输入的LoDTensor进行指定方式的池化（pooling）操作。通过指定pool_type参数，将输入的每个序列（sequence）在最后一层lod_level上或时间步（time-step）上对特征进行诸如sum、average、sqrt等池化操作。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_reshape_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_reshape_cn.rst index 78385efd975cc5c88768fe787c552b782688e6cb..45c1255538f93b9a1a05c86084d0a8496962ab61 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_reshape_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_reshape_cn.rst @@ -10,6 +10,9 @@ sequence_reshape + + + **注意：该OP的输入只能是LoDTensor，如果您需要处理的输入是Tensor类型，请使用reshape函数（fluid.layers.** :ref:`cn_api_fluid_layers_reshape` **）。** **该OP仅支持LoDTensor** ，在指定 ``new_dim`` 参数下，通过序列原始长度、和原始shape计算出新的shape，以输出包含新维度（new_dim）下的LoDTensor。目前仅支持1-level LoDTensor，请确保(原长度*原维数)可以除以新的维数，且每个序列没有余数。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_scatter_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_scatter_cn.rst index aaae0735e5ac837e744f7c87a3c7447a894e8e4c..7e9e960aa8b8976bfb559928e31fe3e0540d3ecd 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_scatter_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_scatter_cn.rst @@ -10,6 +10,9 @@ sequence_scatter + + + .. note:: 该OP的输入index，updates必须是LoDTensor。 diff --git a/doc/fluid/api_cn/layers_cn/sequence_slice_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_slice_cn.rst index 4281741274a644ed90949de219105be69e5729b8..8af96e2d0aa8efe6d38a834c3818dd6e1fc6ccf7 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_slice_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_slice_cn.rst @@ -10,6 +10,9 @@ sequence_slice + + + **实现Sequence Slice(序列切片)运算** **该OP输入只能是LoDTensor, 如果您需要处理的是Tensor类型，请使用 :ref:`cn_api_fluid_layers_slice` 。** diff --git a/doc/fluid/api_cn/layers_cn/sequence_softmax_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_softmax_cn.rst index e59c1fbc8d1925860cbe2f38eba343244f20ce68..c726188c937010f1ca266926e941ce24a234d3d0 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_softmax_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_softmax_cn.rst @@ -10,6 +10,9 @@ sequence_softmax + + + .. note:: 该OP的输入只能是LoDTensor，如果要处理的输入是Tensor类型，请使用 :ref:`cn_api_fluid_layers_softmax` diff --git a/doc/fluid/api_cn/layers_cn/sequence_unpad_cn.rst b/doc/fluid/api_cn/layers_cn/sequence_unpad_cn.rst index 8a1587c733d3341dcc21009a72c700bfc9fe2fe3..f66f075799fe738708c5f2f7d6b3e26ce000a9b6 100644 --- a/doc/fluid/api_cn/layers_cn/sequence_unpad_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sequence_unpad_cn.rst @@ -10,6 +10,9 @@ sequence_unpad + + + .. note:: 该OP的输入为Tensor，输出为LoDTensor。该OP用于移除填充元素，与之对应，还存在进行数据填充的OP sequence_pad，详情见： :ref:`cn_api_fluid_layers_sequence_pad` diff --git a/doc/fluid/api_cn/layers_cn/shape_cn.rst b/doc/fluid/api_cn/layers_cn/shape_cn.rst index 5f5c2e67002fb0fe9091c92c77775deea6a8afb6..be7711a0da96c301dddc78dafecff2de616c277b 100644 --- a/doc/fluid/api_cn/layers_cn/shape_cn.rst +++ b/doc/fluid/api_cn/layers_cn/shape_cn.rst @@ -11,6 +11,9 @@ shape + + + shape层。 获得输入Tensor的shape。 diff --git a/doc/fluid/api_cn/layers_cn/shard_index_cn.rst b/doc/fluid/api_cn/layers_cn/shard_index_cn.rst index 2bf72254ca86f7559f30f3dcec891248a0a64e6b..f9762fcba9497ac898b37c9b18bca0f79f5c04d6 100644 --- a/doc/fluid/api_cn/layers_cn/shard_index_cn.rst +++ b/doc/fluid/api_cn/layers_cn/shard_index_cn.rst @@ -11,6 +11,9 @@ shard_index + + + 该函数对输入的索引根据分片（shard）的偏移量重新计算。 索引长度被均分为N个分片，如果输入索引所在的分片跟分片ID对应，则该索引以分片的偏移量为界重新计算，否则更新为默认值（ignore_value）。具体计算为： :: diff --git a/doc/fluid/api_cn/layers_cn/shuffle_channel_cn.rst b/doc/fluid/api_cn/layers_cn/shuffle_channel_cn.rst index fffbae0a48f36c1cfa80a37ea91fdddf139d75b9..d7a964e8ad9ebeeb147707d832a4cb9df9c9fc74 100644 --- a/doc/fluid/api_cn/layers_cn/shuffle_channel_cn.rst +++ b/doc/fluid/api_cn/layers_cn/shuffle_channel_cn.rst @@ -11,6 +11,9 @@ shuffle_channel + + + 该OP将输入 ``x`` 的通道混洗重排。 它将每个组中的输入通道分成 ``group`` 个子组，并通过逐一从每个子组中选择元素来获得新的顺序。 请参阅 https://arxiv.org/pdf/1707.01083.pdf diff --git a/doc/fluid/api_cn/layers_cn/sigmoid_cn.rst b/doc/fluid/api_cn/layers_cn/sigmoid_cn.rst index fb5ccd21da695a2f3c840663797b66a5ccaff54c..218b69c5bc289c6d2f33c7fcc5c1280e31a41286 100755 --- a/doc/fluid/api_cn/layers_cn/sigmoid_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sigmoid_cn.rst @@ -5,6 +5,11 @@ sigmoid .. py:function:: paddle.fluid.layers.sigmoid(x, name=None) +:alias_main: paddle.nn.functional.sigmoid +:alias: paddle.nn.functional.sigmoid,paddle.nn.functional.activation.sigmoid + + + diff --git a/doc/fluid/api_cn/layers_cn/sigmoid_cross_entropy_with_logits_cn.rst b/doc/fluid/api_cn/layers_cn/sigmoid_cross_entropy_with_logits_cn.rst index 18506b0f583475bad23de7f9b3c1e805ca9ada16..bcdac95442df64d6a21187f625e9a2813fa48d1a 100644 --- a/doc/fluid/api_cn/layers_cn/sigmoid_cross_entropy_with_logits_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sigmoid_cross_entropy_with_logits_cn.rst @@ -11,6 +11,9 @@ sigmoid_cross_entropy_with_logits + + + 在每个类别独立的分类任务中，该OP可以计算按元素的概率误差。可以将其视为预测数据点的标签，其中标签不是互斥的。例如，一篇新闻文章可以同时关于政治，科技，体育或者同时不包含这些内容。 logistic loss可通过下式计算： diff --git a/doc/fluid/api_cn/layers_cn/sigmoid_focal_loss_cn.rst b/doc/fluid/api_cn/layers_cn/sigmoid_focal_loss_cn.rst index 27820b77e54dadc0da6230294736fee8c7ba307e..5a7bf4e8961ab4331f5dba8f3ed4c0032b2c03f9 100644 --- a/doc/fluid/api_cn/layers_cn/sigmoid_focal_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sigmoid_focal_loss_cn.rst @@ -11,6 +11,9 @@ sigmoid_focal_loss + + + `Focal Loss `_ 被提出用于解决计算机视觉任务中前景-背景不平衡的问题。该OP先计算输入x中每个元素的sigmoid值，然后计算sigmoid值与类别目标值label之间的Focal Loss。 Focal Loss的计算过程如下： diff --git a/doc/fluid/api_cn/layers_cn/sign_cn.rst b/doc/fluid/api_cn/layers_cn/sign_cn.rst index 5559e7a7bef67ed07aa58e3162e6c501867a803f..3bb5fa3bee4b4b223b702d8e6cad04acd40f8bce 100644 --- a/doc/fluid/api_cn/layers_cn/sign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sign_cn.rst @@ -11,6 +11,9 @@ sign + + + 此OP对输入x中每个元素进行正负判断，并且输出正负判断值：1代表正，-1代表负，0代表零。 参数： diff --git a/doc/fluid/api_cn/layers_cn/similarity_focus_cn.rst b/doc/fluid/api_cn/layers_cn/similarity_focus_cn.rst index 5024493c825ea66ac0ed63ec35f05cc73e2e45e9..fa4d60290f9ff298e56595b81f123c5b081e4ff0 100644 --- a/doc/fluid/api_cn/layers_cn/similarity_focus_cn.rst +++ b/doc/fluid/api_cn/layers_cn/similarity_focus_cn.rst @@ -11,6 +11,9 @@ similarity_focus + + + **实现SimilarityFocus(相似度聚焦)运算** 通过以下三个步骤，该层生成一个和输入 ``input`` 同形的 similarity focus mask（相似度聚焦掩码）： diff --git a/doc/fluid/api_cn/layers_cn/slice_cn.rst b/doc/fluid/api_cn/layers_cn/slice_cn.rst index ed77cc9498273ed264dd97a052fd35c1327a647a..bab6a7f45ea437ef9c797df7c7db56365ab3fdc5 100644 --- a/doc/fluid/api_cn/layers_cn/slice_cn.rst +++ b/doc/fluid/api_cn/layers_cn/slice_cn.rst @@ -11,6 +11,9 @@ slice + + + 该OP沿多个轴生成 ``input`` 的切片。与numpy类似： https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html 该OP使用 ``axes`` 、 ``starts`` 和 ``ends`` 属性来指定轴列表中每个轴的起点和终点位置，并使用此信息来对 ``input`` 切片。如果向 ``starts`` 或 ``ends`` 传递负值如 :math:`-i`，则表示该轴的反向第 :math:`i-1` 个位置（这里以0为初始位置）。如果传递给 ``starts`` 或 ``end`` 的值大于n（维度中的元素数目），则表示n。当切片一个未知数量的维度时，建议传入 ``INT_MAX``。 ``axes`` 、 ``starts`` 和 ``ends`` 三个参数的元素数目必须相等。以下示例将解释切片如何工作： :: diff --git a/doc/fluid/api_cn/layers_cn/smooth_l1_cn.rst b/doc/fluid/api_cn/layers_cn/smooth_l1_cn.rst index 8b19838d11e7bc0687873b8a880c0d407328cbdd..6f7a91c609fada7163488079bdb5ce32a6ef0e75 100755 --- a/doc/fluid/api_cn/layers_cn/smooth_l1_cn.rst +++ b/doc/fluid/api_cn/layers_cn/smooth_l1_cn.rst @@ -11,6 +11,9 @@ smooth_l1 + + + 该layer计算变量 ``x`` 和 ``y`` 的smooth L1 loss，它以 ``x`` 和 ``y`` 的第一维大小作为批处理大小。对于每个实例，按元素计算smooth L1 loss，然后计算所有loss。输出变量的形状是[batch_size, 1] diff --git a/doc/fluid/api_cn/layers_cn/soft_relu_cn.rst b/doc/fluid/api_cn/layers_cn/soft_relu_cn.rst index dc8912ca4f15478b703df53a3f1a58f7e97c5668..718ea0b0c19a71689405fa3859af44efd0945610 100644 --- a/doc/fluid/api_cn/layers_cn/soft_relu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/soft_relu_cn.rst @@ -11,6 +11,9 @@ soft_relu + + + SoftReLU 激活函数. .. math:: out=ln(1+exp(max(min(x,threshold),-threshold))) diff --git a/doc/fluid/api_cn/layers_cn/softmax_cn.rst b/doc/fluid/api_cn/layers_cn/softmax_cn.rst index a11f955072ab19183abde10ce55469e81bc1c696..fdaf425db6519333d04445e4fa47b52a1870a886 100755 --- a/doc/fluid/api_cn/layers_cn/softmax_cn.rst +++ b/doc/fluid/api_cn/layers_cn/softmax_cn.rst @@ -11,6 +11,9 @@ softmax + + + 该OP实现了softmax层。OP的计算过程如下： 步骤1：输入 ``input`` 的 ``axis`` 维会被置换到最后一维； diff --git a/doc/fluid/api_cn/layers_cn/softmax_with_cross_entropy_cn.rst b/doc/fluid/api_cn/layers_cn/softmax_with_cross_entropy_cn.rst index 9b3539fac66fb03c84eead625c1096dce81af80c..929626306eb1d74a5f2617914a7c17949a91ade3 100644 --- a/doc/fluid/api_cn/layers_cn/softmax_with_cross_entropy_cn.rst +++ b/doc/fluid/api_cn/layers_cn/softmax_with_cross_entropy_cn.rst @@ -11,6 +11,9 @@ softmax_with_cross_entropy + + + 该OP实现了softmax交叉熵损失函数。该函数会将softmax操作、交叉熵损失函数的计算过程进行合并，从而提供了数值上更稳定的梯度值。 因为该运算对 ``logits`` 的 ``axis`` 维执行softmax运算，所以它需要未缩放的 ``logits`` 。该运算不应该对softmax运算的输出进行操作，否则会产生错误的结果。 diff --git a/doc/fluid/api_cn/layers_cn/softplus_cn.rst b/doc/fluid/api_cn/layers_cn/softplus_cn.rst index 34ffe22854ec38f6e4d6379ff4925f002005901a..2924c30f7d52fb1283d282b3f412146756e06be2 100644 --- a/doc/fluid/api_cn/layers_cn/softplus_cn.rst +++ b/doc/fluid/api_cn/layers_cn/softplus_cn.rst @@ -11,6 +11,9 @@ softplus + + + softplus激活函数 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/softshrink_cn.rst b/doc/fluid/api_cn/layers_cn/softshrink_cn.rst index b3a1af822dfe31a96ad9802e5b4795f1ea10624c..8660907f5769733864dd62b091872d8d3374b435 100644 --- a/doc/fluid/api_cn/layers_cn/softshrink_cn.rst +++ b/doc/fluid/api_cn/layers_cn/softshrink_cn.rst @@ -11,6 +11,9 @@ softshrink + + + Softshrink激活函数 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/softsign_cn.rst b/doc/fluid/api_cn/layers_cn/softsign_cn.rst index ca46bf270800dd0764d000c9b3275a45553c0bb1..f8e4860d3dc2dcdcf35e1a0e9dc67c9a11b93f5b 100644 --- a/doc/fluid/api_cn/layers_cn/softsign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/softsign_cn.rst @@ -12,6 +12,9 @@ softsign + + + softsign激活函数 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/space_to_depth_cn.rst b/doc/fluid/api_cn/layers_cn/space_to_depth_cn.rst index bfa5dbbf5308f4d347effcbef18f55f131181653..b799f9d11f7ef19d51b9e2c2433836408847bdf3 100644 --- a/doc/fluid/api_cn/layers_cn/space_to_depth_cn.rst +++ b/doc/fluid/api_cn/layers_cn/space_to_depth_cn.rst @@ -11,6 +11,9 @@ space_to_depth + + + 该OP对成块的空间数据进行重组，输出一个输入张量的拷贝，其高度和宽度维度上的值移至通道维度。 重组时，依据 ``blocksize`` 指明的数据块大小, 对形为 ``[batch, channel, height, width]`` 的输入张量进行space_to_depth（广度至深度）运算，生成形为 ``[batch, channel * blocksize * blocksize, height/blocksize, width/blocksize]`` 的输出： diff --git a/doc/fluid/api_cn/layers_cn/spectral_norm_cn.rst b/doc/fluid/api_cn/layers_cn/spectral_norm_cn.rst index 9ca240e3c7758177fba78b97db6b27d046091340..cc342a48c5ee596637b66ac64342e0d381dfceb5 100644 --- a/doc/fluid/api_cn/layers_cn/spectral_norm_cn.rst +++ b/doc/fluid/api_cn/layers_cn/spectral_norm_cn.rst @@ -7,6 +7,12 @@ spectral_norm .. py:function:: paddle.fluid.layers.spectral_norm(weight, dim=0, power_iters=1, eps=1e-12, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.declarative.spectral_norm +:alias: paddle.declarative.spectral_norm +:old_api: paddle.fluid.layers.spectral_norm + + + diff --git a/doc/fluid/api_cn/layers_cn/square_cn.rst b/doc/fluid/api_cn/layers_cn/square_cn.rst index 8c2a73306c51ca5ac4fd3d67f7f54549e7e3d222..9d0e10ef9bd068961669c79dc24d3d943e94fe56 100644 --- a/doc/fluid/api_cn/layers_cn/square_cn.rst +++ b/doc/fluid/api_cn/layers_cn/square_cn.rst @@ -11,6 +11,9 @@ square + + + 该OP执行逐元素取平方运算。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/square_error_cost_cn.rst b/doc/fluid/api_cn/layers_cn/square_error_cost_cn.rst index 8fbec73a269091f9d671e11d1f182a98140272ed..f947020fe387e050fc775112eff78a6513df7259 100644 --- a/doc/fluid/api_cn/layers_cn/square_error_cost_cn.rst +++ b/doc/fluid/api_cn/layers_cn/square_error_cost_cn.rst @@ -11,6 +11,9 @@ square_error_cost + + + 该OP用于计算预测值和目标值的方差估计。 对于预测值input和目标值label，公式为： diff --git a/doc/fluid/api_cn/layers_cn/ssd_loss_cn.rst b/doc/fluid/api_cn/layers_cn/ssd_loss_cn.rst index da9949a0eea3405be4372eecb2e673e0ad0166d0..93c9751b855f551d306882ae0db05cd19f0e56e2 100644 --- a/doc/fluid/api_cn/layers_cn/ssd_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/ssd_loss_cn.rst @@ -11,6 +11,9 @@ ssd_loss + + + 该OP用于SSD物体检测算法的多窗口损失层 该层用于计算SSD的损失，给定位置偏移预测，置信度预测，候选框和真实框标签，以及难样本挖掘的类型。通过执行以下步骤，返回的损失是本地化损失（或回归损失）和置信度损失（或分类损失）的加权和： diff --git a/doc/fluid/api_cn/layers_cn/stanh_cn.rst b/doc/fluid/api_cn/layers_cn/stanh_cn.rst index d592060093583d3791ba6d4ed3f0d038c603ded5..ee4721a26acf245e693c48414875cf25763b9d2a 100644 --- a/doc/fluid/api_cn/layers_cn/stanh_cn.rst +++ b/doc/fluid/api_cn/layers_cn/stanh_cn.rst @@ -11,6 +11,9 @@ stanh + + + STanh 激活算子（STanh Activation Operator.） .. math:: diff --git a/doc/fluid/api_cn/layers_cn/strided_slice_cn.rst b/doc/fluid/api_cn/layers_cn/strided_slice_cn.rst index 164559652c31746cd9e77d182e43263839fc5451..cc42372043a0ed907b5b252f1e1607b521554277 100644 --- a/doc/fluid/api_cn/layers_cn/strided_slice_cn.rst +++ b/doc/fluid/api_cn/layers_cn/strided_slice_cn.rst @@ -9,6 +9,9 @@ strided_slice :old_api: paddle.fluid.layers.strided_slice + + + strided_slice算子。 该OP沿多个轴生成 ``input`` 的切片，与numpy类似： https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html。该OP使用 ``axes`` 、 ``starts`` 和 ``ends`` 属性来指定轴列表中每个轴的起点和终点位置，并使用此信息来对 ``input`` 切片。如果向 ``starts`` 或 ``ends`` 传递负值如 :math:`-i`，则表示该轴的反向第 :math:`i-1` 个位置（这里以0为初始位置）， ``strides`` 表示切片的步长， ``strides`` 如果为负数，则按照反方向进行切片。如果传递给 ``starts`` 或 ``ends`` 的值大于n（维度中的元素数目），则表示n。当切片一个未知数量的维度时，建议传入 ``INT_MAX``。 ``axes`` 、 ``starts`` 和 ``ends`` 以及 ``strides`` 四个参数的元素数目必须相等。以下示例将解释切片如何工作： diff --git a/doc/fluid/api_cn/layers_cn/sums_cn.rst b/doc/fluid/api_cn/layers_cn/sums_cn.rst index 7bec1960d2a080198cf59f74ca997883cb935e94..0d125797014f0899eb39d7d549ea3612235fbb8e 100644 --- a/doc/fluid/api_cn/layers_cn/sums_cn.rst +++ b/doc/fluid/api_cn/layers_cn/sums_cn.rst @@ -11,6 +11,9 @@ sums + + + 该OP计算多个输入Tensor逐个元素相加的和。 - 示例：3个Tensor求和 diff --git a/doc/fluid/api_cn/layers_cn/swish_cn.rst b/doc/fluid/api_cn/layers_cn/swish_cn.rst index 85ab54d4c1830bdac80f80e1e1454dc3e0308808..721ba12099376d1b4fa31bcc90bcfc42c7b58cab 100644 --- a/doc/fluid/api_cn/layers_cn/swish_cn.rst +++ b/doc/fluid/api_cn/layers_cn/swish_cn.rst @@ -11,6 +11,9 @@ swish + + + 逐元素计算 Swish 激活函数，参考 `Searching for Activation Functions `_ 。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/switch_case_cn.rst b/doc/fluid/api_cn/layers_cn/switch_case_cn.rst index a5b2766d722610d14738c437a485a660eb6e1c66..b7bed65103506135b969819e07699cc708d2e2a5 100644 --- a/doc/fluid/api_cn/layers_cn/switch_case_cn.rst +++ b/doc/fluid/api_cn/layers_cn/switch_case_cn.rst @@ -13,6 +13,9 @@ switch_case + + + 该OP的运行方式类似于c++的switch/case。 参数： diff --git a/doc/fluid/api_cn/layers_cn/tanh_shrink_cn.rst b/doc/fluid/api_cn/layers_cn/tanh_shrink_cn.rst index 6002d1216918b363c9c7a890d40456c37e9b88f5..5da11c8e88e52232735b6940135f311461bb623e 100644 --- a/doc/fluid/api_cn/layers_cn/tanh_shrink_cn.rst +++ b/doc/fluid/api_cn/layers_cn/tanh_shrink_cn.rst @@ -11,6 +11,9 @@ tanh_shrink + + + tanh_shrink激活函数 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/target_assign_cn.rst b/doc/fluid/api_cn/layers_cn/target_assign_cn.rst index 61bd9787dad47e8778d9259dd2d2c4dbbefeddd8..34fc6ab91f087c920b674508629c88c006f54c3a 100644 --- a/doc/fluid/api_cn/layers_cn/target_assign_cn.rst +++ b/doc/fluid/api_cn/layers_cn/target_assign_cn.rst @@ -11,6 +11,9 @@ target_assign + + + 对于每个实例，根据 ``match_indices`` 和 ``negative_indices`` 位置索引, 给输入 ``out`` 和 ``out_weight`` 赋值。输入 ``input`` 和 ``negative_indices`` 均为2-D LoDTensor。假如 ``input`` 中每个实例的行偏移称作lod，该操作计算步骤如下： 1.根据match_indices赋值: diff --git a/doc/fluid/api_cn/layers_cn/teacher_student_sigmoid_loss_cn.rst b/doc/fluid/api_cn/layers_cn/teacher_student_sigmoid_loss_cn.rst index 84d1000cf3ee645af81f4f1588043c349fe30d0a..2c60c127a8690c35de2d855ef850d8cee71d173c 100644 --- a/doc/fluid/api_cn/layers_cn/teacher_student_sigmoid_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/teacher_student_sigmoid_loss_cn.rst @@ -11,6 +11,9 @@ teacher_student_sigmoid_loss + + + **Teacher Student Log Loss Layer（教师--学生对数损失层）** 定制化需求，用于student萃取teacher的值。此图层接受输入预测和目标标签，并返回teacher_student损失。 diff --git a/doc/fluid/api_cn/layers_cn/temporal_shift_cn.rst b/doc/fluid/api_cn/layers_cn/temporal_shift_cn.rst index acde7a2951aeaec7760094c27332bbe023da3cdc..2173ebf523c85490ee7e509676d9dd1c281d504c 100644 --- a/doc/fluid/api_cn/layers_cn/temporal_shift_cn.rst +++ b/doc/fluid/api_cn/layers_cn/temporal_shift_cn.rst @@ -10,6 +10,9 @@ temporal_shift + + + 该OP用于对输入X做时序通道T上的位移操作，为TSM(Temporal Shift Module)中使用的操作。 输入（X）的形状应为[N*T, C, H, W]，N是批大小，T是 ``seg_num`` 指定的时间段号，C是通道号，H和W是特征的高度和宽度。 diff --git a/doc/fluid/api_cn/layers_cn/thresholded_relu_cn.rst b/doc/fluid/api_cn/layers_cn/thresholded_relu_cn.rst index e4942697680025e6145c476612d3a1668e643f47..98f94ddd7548fcd3d426ae509174ebd07a9e874c 100644 --- a/doc/fluid/api_cn/layers_cn/thresholded_relu_cn.rst +++ b/doc/fluid/api_cn/layers_cn/thresholded_relu_cn.rst @@ -11,6 +11,9 @@ thresholded_relu + + + 逐元素计算 ThresholdedRelu激活函数。 .. math:: diff --git a/doc/fluid/api_cn/layers_cn/topk_cn.rst b/doc/fluid/api_cn/layers_cn/topk_cn.rst index acef758bbb5c06c5734742830c2b046f372495af..b0bc26b746244b9dcadb5730a5472b08a339b31b 100644 --- a/doc/fluid/api_cn/layers_cn/topk_cn.rst +++ b/doc/fluid/api_cn/layers_cn/topk_cn.rst @@ -10,6 +10,9 @@ topk + + + 此OP用于查找输入Tensor的最后一维的前k个最大项，返回它们的值和索引。 如果输入是1-D Tensor，则找到Tensor的前k个最大项，并输出前k个最大项的值和索引。如果输入是更高阶的Tensor，则该OP会基于最后一维计算前k项。 diff --git a/doc/fluid/api_cn/layers_cn/transpose_cn.rst b/doc/fluid/api_cn/layers_cn/transpose_cn.rst index b9d6bfb644cbd2210c2ab22818c4ca0609eba906..45cf56e28b3e2cbe8e3690b6c6fb22f0aa8bc0ad 100644 --- a/doc/fluid/api_cn/layers_cn/transpose_cn.rst +++ b/doc/fluid/api_cn/layers_cn/transpose_cn.rst @@ -11,6 +11,9 @@ transpose + + + 该OP根据perm对输入的多维Tensor进行数据重排。返回多维Tensor的第i维对应输入Tensor的perm[i]维。 参数： diff --git a/doc/fluid/api_cn/layers_cn/unfold_cn.rst b/doc/fluid/api_cn/layers_cn/unfold_cn.rst index 4422467062eb9865d286f8a08faf834b4d256c76..8353f7888a7e0ac481b354f209e84a781e0aff0a 100644 --- a/doc/fluid/api_cn/layers_cn/unfold_cn.rst +++ b/doc/fluid/api_cn/layers_cn/unfold_cn.rst @@ -11,6 +11,9 @@ unfold + + + 该OP实现的功能与卷积中用到的im2col函数一样，通常也被称作为im2col过程。对于每一个卷积核覆盖下的区域，元素会被重新排成一列。当卷积核在整个图片上滑动时，将会形成一系列的列向量。对于每一个输入形状为[N, C, H, W]的 ``x`` ，都将会按照下面公式计算出一个形状为[N, Cout, Lout]的输出。 diff --git a/doc/fluid/api_cn/layers_cn/unique_cn.rst b/doc/fluid/api_cn/layers_cn/unique_cn.rst index 6dcf44005f5a55eda5f2f2b8f5377321a7a1807c..fa5c1e73514f837b461b1ce56dc0e8702f4e13b9 100644 --- a/doc/fluid/api_cn/layers_cn/unique_cn.rst +++ b/doc/fluid/api_cn/layers_cn/unique_cn.rst @@ -11,6 +11,9 @@ unique + + + unique为 ``x`` 返回一个unique张量和一个指向该unique张量的索引。 参数： diff --git a/doc/fluid/api_cn/layers_cn/unique_with_counts_cn.rst b/doc/fluid/api_cn/layers_cn/unique_with_counts_cn.rst index 906ff316a3f77ab6756b36543bd0ca6e4b55fcf4..4b5db1a69fbdf99ca011e43e7b5e01652eec4c2e 100644 --- a/doc/fluid/api_cn/layers_cn/unique_with_counts_cn.rst +++ b/doc/fluid/api_cn/layers_cn/unique_with_counts_cn.rst @@ -10,6 +10,9 @@ unique_with_counts :old_api: paddle.fluid.layers.unique_with_counts + + + 该OP对输入Tensor元素进行去重，获取去重后结果Tensor，同时获取去重后结果在原始输入中的计数Tensor以及在原始输入中的索引Tensor。 注:该OP仅支持 **CPU** ，同时仅支持 **Tensor** diff --git a/doc/fluid/api_cn/layers_cn/unstack_cn.rst b/doc/fluid/api_cn/layers_cn/unstack_cn.rst index cc4324c6b5764b7a03cfe509345e14aa43e505ee..dbec2407f123400f64d76d041f8fcf4aab59f36c 100644 --- a/doc/fluid/api_cn/layers_cn/unstack_cn.rst +++ b/doc/fluid/api_cn/layers_cn/unstack_cn.rst @@ -11,6 +11,9 @@ unstack + + + 该OP将单个dim为 ``D`` 的Tensor沿 ``axis`` 轴unpack为 ``num`` 个dim为 ``(D-1)`` 的Tensor 参数: diff --git a/doc/fluid/api_cn/layers_cn/warpctc_cn.rst b/doc/fluid/api_cn/layers_cn/warpctc_cn.rst index dbb4c4ca829330844170359127680fe870ac618c..b30f3f61de07604cca8089316e9f871ca72da3c7 100644 --- a/doc/fluid/api_cn/layers_cn/warpctc_cn.rst +++ b/doc/fluid/api_cn/layers_cn/warpctc_cn.rst @@ -11,6 +11,9 @@ warpctc + + + 该OP用于计算 `CTC loss `_ 。该OP的底层调用了第三方 `baidu-research::warp-ctc `_ 的实现。 参数： diff --git a/doc/fluid/api_cn/layers_cn/while_loop_cn.rst b/doc/fluid/api_cn/layers_cn/while_loop_cn.rst index 5cfb1f648a2210683736d8786f55eead04f991db..1cc6b54e2792acb9ec399829bb88e75cd8c79c28 100644 --- a/doc/fluid/api_cn/layers_cn/while_loop_cn.rst +++ b/doc/fluid/api_cn/layers_cn/while_loop_cn.rst @@ -14,6 +14,9 @@ ____________________________________ + + + 该API用于实现类似while的循环控制功能，只要循环条件 ``cond`` 的返回值为True，``while_loop`` 则会循环执行循环体 ``body`` ，直到 ``cond`` 的返回值为False。 **注意：** diff --git a/doc/fluid/api_cn/layers_cn/yolo_box_cn.rst b/doc/fluid/api_cn/layers_cn/yolo_box_cn.rst index 5d1d7db4f14d31e5ad33eb6854c21740322a1088..c27d6ead59242bc832af9322a2a82dc9ed5c01e4 100644 --- a/doc/fluid/api_cn/layers_cn/yolo_box_cn.rst +++ b/doc/fluid/api_cn/layers_cn/yolo_box_cn.rst @@ -12,6 +12,9 @@ yolo_box + + + 该运算符基于YOLOv3网络的输出结果，生成YOLO检测框。 连接 yolo_box 网络的输出形状应为[N，C，H，W]，其中 H 和 W 相同，用来指定网格大小。对每个网格点预测给定的数目的框，这个数目记为 S ，由 anchor 的数量指定。 在第二维（通道维度）中，C应该等于S *（5 + class_num），class_num是源数据集中对象类别数目（例如coco数据集中的80），此外第二个（通道）维度中还有4个框位置坐标x，y，w，h，以及anchor box的one-hot key的置信度得分。 diff --git a/doc/fluid/api_cn/layers_cn/yolov3_loss_cn.rst b/doc/fluid/api_cn/layers_cn/yolov3_loss_cn.rst index 020dd2cc7d0843b62213141a2033cb2dc3834e41..f392ad9e92e1ee555549ef35ea167cab211a9bbd 100644 --- a/doc/fluid/api_cn/layers_cn/yolov3_loss_cn.rst +++ b/doc/fluid/api_cn/layers_cn/yolov3_loss_cn.rst @@ -11,6 +11,9 @@ yolov3_loss + + + 该运算通过给定的预测结果和真实框计算yolov3损失。 yolov3 loss前的网络输出形状为[N，C，H，W]，H和W应该相同，用来指定网格(grid)大小。每个网格点预测S个边界框(bounding boxes)，S由每个尺度中 ``anchors`` 簇的个数指定。在第二维（表示通道的维度）中，C的值应为S *（class_num + 5），class_num是源数据集的对象种类数（如coco中为80），另外，除了存储4个边界框位置坐标x，y，w，h，还包括边界框以及每个anchor框的one-hot关键字的置信度得分。 diff --git a/doc/fluid/api_cn/metrics_cn/Accuracy_cn.rst b/doc/fluid/api_cn/metrics_cn/Accuracy_cn.rst index 0cb6ea087033b21afd2cea5838f6d1366868b92f..dfe7c983dd1007ca72ae33d6139b471827803332 100644 --- a/doc/fluid/api_cn/metrics_cn/Accuracy_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/Accuracy_cn.rst @@ -4,6 +4,15 @@ Accuracy ------------------------------- .. py:class:: paddle.fluid.metrics.Accuracy(name=None) +:alias_main: paddle.metric.accuracy +:alias: paddle.metric.accuracy +:old_api: paddle.fluid.layers.metric_op.accuracy + + + + + + diff --git a/doc/fluid/api_cn/metrics_cn/Auc_cn.rst b/doc/fluid/api_cn/metrics_cn/Auc_cn.rst index 8e6b7bfea5ec381b7af051ba39fc080291b4fcba..9a85f14d9da6be4478cc763129bd7e6395453dca 100644 --- a/doc/fluid/api_cn/metrics_cn/Auc_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/Auc_cn.rst @@ -4,6 +4,15 @@ Auc ------------------------------- .. py:class:: paddle.fluid.metrics.Auc(name, curve='ROC', num_thresholds=4095) +:alias_main: paddle.metric.auc +:alias: paddle.metric.auc +:old_api: paddle.fluid.layers.metric_op.auc + + + + + + diff --git a/doc/fluid/api_cn/metrics_cn/ChunkEvaluator_cn.rst b/doc/fluid/api_cn/metrics_cn/ChunkEvaluator_cn.rst index c289db61aed83e2e4a33f8603e70c280a63b2fb2..e538660ce8024f66603fd7ac31c9b9f60a1779a8 100644 --- a/doc/fluid/api_cn/metrics_cn/ChunkEvaluator_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/ChunkEvaluator_cn.rst @@ -5,6 +5,12 @@ ChunkEvaluator .. py:class:: paddle.fluid.metrics.ChunkEvaluator(name=None) +:alias_main: paddle.metric.ChunkEvaluator +:alias: paddle.metric.ChunkEvaluator +:old_api: paddle.fluid.metrics.ChunkEvaluator + + + 该接口使用mini-batch的chunk_eval累计的counter numbers，来计算准确率、召回率和F1值。ChunkEvaluator有三个状态num_infer_chunks，num_label_chunks和num_correct_chunks，分别对应语块数目、标签中的语块数目、正确识别的语块数目。对于chunking的基础知识，请参考 https://www.aclweb.org/anthology/N01-1025 。ChunkEvalEvaluator计算块检测（chunk detection）的准确率，召回率和F1值，支持IOB, IOE, IOBES和IO标注方案。 diff --git a/doc/fluid/api_cn/metrics_cn/CompositeMetric_cn.rst b/doc/fluid/api_cn/metrics_cn/CompositeMetric_cn.rst index 2b9382f7870ca4a104a6e63fb0e0ddb5e67b64d0..508b626796c583da1075d4dc5b131223baa8a32a 100644 --- a/doc/fluid/api_cn/metrics_cn/CompositeMetric_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/CompositeMetric_cn.rst @@ -5,6 +5,12 @@ CompositeMetric .. py:class:: paddle.fluid.metrics.CompositeMetric(name=None) +:alias_main: paddle.metric.CompositeMetric +:alias: paddle.metric.CompositeMetric +:old_api: paddle.fluid.metrics.CompositeMetric + + + diff --git a/doc/fluid/api_cn/metrics_cn/DetectionMAP_cn.rst b/doc/fluid/api_cn/metrics_cn/DetectionMAP_cn.rst index 44d3700e5535c485a78361ba82c97c7c5b81ca87..2e8fc315e9ea2573106fcc53e9e5638db85576ed 100644 --- a/doc/fluid/api_cn/metrics_cn/DetectionMAP_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/DetectionMAP_cn.rst @@ -5,6 +5,12 @@ DetectionMAP .. py:class:: paddle.fluid.metrics.DetectionMAP(input, gt_label, gt_box, gt_difficult=None, class_num=None, background_label=0, overlap_threshold=0.5, evaluate_difficult=True, ap_version='integral') +:alias_main: paddle.metric.DetectionMAP +:alias: paddle.metric.DetectionMAP +:old_api: paddle.fluid.metrics.DetectionMAP + + + diff --git a/doc/fluid/api_cn/metrics_cn/EditDistance_cn.rst b/doc/fluid/api_cn/metrics_cn/EditDistance_cn.rst index 9ffd2a0165d7e718d1cf08d15be5e90f64cf916b..62e3355ccd44a805352e353b0a328ac7730f9b45 100644 --- a/doc/fluid/api_cn/metrics_cn/EditDistance_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/EditDistance_cn.rst @@ -5,6 +5,12 @@ EditDistance .. py:class:: paddle.fluid.metrics.EditDistance(name) +:alias_main: paddle.metric.EditDistance +:alias: paddle.metric.EditDistance +:old_api: paddle.fluid.metrics.EditDistance + + + diff --git a/doc/fluid/api_cn/metrics_cn/Precision_cn.rst b/doc/fluid/api_cn/metrics_cn/Precision_cn.rst index 29a1cb89a9ebc7185c8ddb596fe8e1494ece800d..229de89bbbd8fcb6d25e9a18a45f30b417e01aa4 100644 --- a/doc/fluid/api_cn/metrics_cn/Precision_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/Precision_cn.rst @@ -5,6 +5,12 @@ Precision .. py:class:: paddle.fluid.metrics.Precision(name=None) +:alias_main: paddle.metric.Precision +:alias: paddle.metric.Precision +:old_api: paddle.fluid.metrics.Precision + + + diff --git a/doc/fluid/api_cn/metrics_cn/Recall_cn.rst b/doc/fluid/api_cn/metrics_cn/Recall_cn.rst index 3d4975fc55e42f251e983fd551c760511407f003..13a5e766cf34bb0213f01a3592a72e3b3534e0ae 100644 --- a/doc/fluid/api_cn/metrics_cn/Recall_cn.rst +++ b/doc/fluid/api_cn/metrics_cn/Recall_cn.rst @@ -5,6 +5,12 @@ Recall .. py:class:: paddle.fluid.metrics.Recall(name=None) +:alias_main: paddle.metric.Recall +:alias: paddle.metric.Recall +:old_api: paddle.fluid.metrics.Recall + + + diff --git a/doc/fluid/api_cn/nets_cn/glu_cn.rst b/doc/fluid/api_cn/nets_cn/glu_cn.rst index 7da9b516b272355ef2ca2825153cc4c604cc1a99..f405f77788c7b6f588777716810e9d94d29d8ddc 100644 --- a/doc/fluid/api_cn/nets_cn/glu_cn.rst +++ b/doc/fluid/api_cn/nets_cn/glu_cn.rst @@ -9,6 +9,9 @@ glu + + + 门控线性单元 Gated Linear Units (GLU) 由 :ref:`cn_api_fluid_layers_split` ，:ref:`cn_api_fluid_layers_sigmoid` 和 :ref:`cn_api_fluid_layers_elementwise_mul` 组成。特定的，沿着给定维度将输入拆分成两个大小相同的部分，:math:`a` 和 :math:`b` ，按如下方式计算： .. math:: diff --git a/doc/fluid/api_cn/nets_cn/img_conv_group_cn.rst b/doc/fluid/api_cn/nets_cn/img_conv_group_cn.rst index 3647169f78351371afb57920f0b3d91b5dbdd3b6..954e666d85338fb11cc5b71cc12db8507a88d859 100644 --- a/doc/fluid/api_cn/nets_cn/img_conv_group_cn.rst +++ b/doc/fluid/api_cn/nets_cn/img_conv_group_cn.rst @@ -10,6 +10,9 @@ img_conv_group + + + Image Convolution Group由Convolution2d，BatchNorm，DropOut和Pool2d组成。根据输入参数，img_conv_group将使用Convolution2d，BatchNorm，DropOut对Input进行连续计算，得到最后结果。 参数： diff --git a/doc/fluid/api_cn/nets_cn/scaled_dot_product_attention_cn.rst b/doc/fluid/api_cn/nets_cn/scaled_dot_product_attention_cn.rst index 5356e1ebd230df40ef27786287d71cfeed5a4ff8..9140c281628a43763dbdf2761e52d4e10f355411 100644 --- a/doc/fluid/api_cn/nets_cn/scaled_dot_product_attention_cn.rst +++ b/doc/fluid/api_cn/nets_cn/scaled_dot_product_attention_cn.rst @@ -10,6 +10,9 @@ scaled_dot_product_attention + + + 该接口实现了的基于点积（并进行了缩放）的多头注意力（Multi-Head Attention）机制。attention可以表述为将一个查询（query）和一组键值对（key-value pair）映射为一个输出；Multi-Head Attention则是使用多路进行attention，而且对attention的输入进行了线性变换。公式如下： diff --git a/doc/fluid/api_cn/nets_cn/sequence_conv_pool_cn.rst b/doc/fluid/api_cn/nets_cn/sequence_conv_pool_cn.rst index 2caeffc74a7adf7552ca5cff63f90b20320dfcc3..d8ffca86b00e06e880d7017c55beb93e553e9bfb 100644 --- a/doc/fluid/api_cn/nets_cn/sequence_conv_pool_cn.rst +++ b/doc/fluid/api_cn/nets_cn/sequence_conv_pool_cn.rst @@ -10,6 +10,9 @@ sequence_conv_pool + + + **注意：该OP的输入** ``input`` **必须是2维LoDTensor, lod_level为1，如果输入是Tensor，建议使用** :ref:`cn_api_fluid_nets_simple_img_conv_pool` **代替** 该接口由序列卷积( :ref:`cn_api_fluid_layers_sequence_conv` )和池化( :ref:`cn_api_fluid_layers_sequence_pool` )组成 diff --git a/doc/fluid/api_cn/nets_cn/simple_img_conv_pool_cn.rst b/doc/fluid/api_cn/nets_cn/simple_img_conv_pool_cn.rst index 0b48604e608f30ec5631df02a9795434749e1bca..82308b69b8a11df7c3ef1fc1eb16e533c3eb77b1 100644 --- a/doc/fluid/api_cn/nets_cn/simple_img_conv_pool_cn.rst +++ b/doc/fluid/api_cn/nets_cn/simple_img_conv_pool_cn.rst @@ -10,6 +10,9 @@ simple_img_conv_pool + + + ``simple_img_conv_pool`` 由一个conv2d( :ref:`cn_api_fluid_layers_conv2d` )和一个pool2d( :ref:`cn_api_fluid_layers_pool2d` ) OP组成。 参数： diff --git a/doc/fluid/api_cn/nn_cn/Conv2D_cn.rst b/doc/fluid/api_cn/nn_cn/Conv2D_cn.rst index b374e34f3ccf40c97d8164fd4795cb19457d33ec..97cc948930065fad750050c958d98bc5a20c2095 100644 --- a/doc/fluid/api_cn/nn_cn/Conv2D_cn.rst +++ b/doc/fluid/api_cn/nn_cn/Conv2D_cn.rst @@ -8,6 +8,9 @@ Conv2D + + + **二维卷积层** 该OP是二维卷积层（convolution2D layer），根据输入、滤波器、步长（stride）、填充（padding）、膨胀比例（dilations）一组参数计算输出特征层大小。输入和输出是NCHW或NHWC格式，其中N是批尺寸，C是通道数，H是特征高度，W是特征宽度。滤波器是MCHW格式，M是输出图像通道数，C是输入图像通道数，H是滤波器高度，W是滤波器宽度。如果组数(groups)大于1，C等于输入图像通道数除以组数的结果。详情请参考UFLDL's : `卷积 `_ 。如果bias_attr不为False，卷积计算会添加偏置项。如果指定了激活函数类型，相应的激活函数会作用在最终结果上。 diff --git a/doc/fluid/api_cn/nn_cn/LogSoftmax_cn.rst b/doc/fluid/api_cn/nn_cn/LogSoftmax_cn.rst index 72ed06ecc1caa1b4e7296274e50df6dc623da1e3..4f2aa9b7b05886b35554ed271f372064ffe82d40 100644 --- a/doc/fluid/api_cn/nn_cn/LogSoftmax_cn.rst +++ b/doc/fluid/api_cn/nn_cn/LogSoftmax_cn.rst @@ -10,6 +10,9 @@ LogSoftmax + + + **LogSoftmax激活层：** .. math:: diff --git a/doc/fluid/api_cn/nn_cn/ReLU_cn.rst b/doc/fluid/api_cn/nn_cn/ReLU_cn.rst index 2e8640fa3796d6e7cfcfcb13600b38d08209cfcb..1ec8d23a5c2723d9212902a620683862ab5d6532 100644 --- a/doc/fluid/api_cn/nn_cn/ReLU_cn.rst +++ b/doc/fluid/api_cn/nn_cn/ReLU_cn.rst @@ -11,6 +11,9 @@ ReLU + + + **ReLU（Rectified Linear Unit）激活层：** .. math:: diff --git a/doc/fluid/api_cn/nn_cn/Upsample_cn.rst b/doc/fluid/api_cn/nn_cn/Upsample_cn.rst index 3038eb1827983331dfac7c4c7ab43381587e8ae5..957864b73b4e85e2fb8010afae9dbb23c7c27fea 100644 --- a/doc/fluid/api_cn/nn_cn/Upsample_cn.rst +++ b/doc/fluid/api_cn/nn_cn/Upsample_cn.rst @@ -5,6 +5,11 @@ UpSample .. py:class:: paddle.nn.UpSample(out_shape=None, scale=None, resample='BILINEAR', actual_shape=None, align_corners=True, align_mode=1, data_format='NCHW') +:alias_main: paddle.nn.UpSample +:alias: paddle.nn.UpSample,paddle.nn.layer.UpSample,paddle.nn.layer.common.UpSample + + + **注意:** 参数 ``actual_shape`` 将被弃用，请使用 ``out_shape`` 替代。 该OP用于调整一个batch中图片的大小。 diff --git a/doc/fluid/api_cn/nn_cn/diag_embed_cn.rst b/doc/fluid/api_cn/nn_cn/diag_embed_cn.rst index f41a82046486ffc2f9229c5d20def7a8bf648d4b..d06965a08f7e60cb1a97c7f8ceb6656a3e93c8e8 100644 --- a/doc/fluid/api_cn/nn_cn/diag_embed_cn.rst +++ b/doc/fluid/api_cn/nn_cn/diag_embed_cn.rst @@ -10,6 +10,9 @@ diag_embed + + + 该 OP 创建一个 Tensor，其在指定的 2D 平面（由 ``dim1`` 和 ``dim2`` 指定）上的对角线由输入 ``input`` 填充。 默认的，指定的 2D 平面由返回 Tensor 的最后两维组成。 diff --git a/doc/fluid/api_cn/nn_cn/interpolate_cn.rst b/doc/fluid/api_cn/nn_cn/interpolate_cn.rst index 1b1c1e3a629fcb38be1ec0c49fb580e1c8313962..abdc81bc4c6e5c682009265f34313be94b2be92d 100644 --- a/doc/fluid/api_cn/nn_cn/interpolate_cn.rst +++ b/doc/fluid/api_cn/nn_cn/interpolate_cn.rst @@ -10,6 +10,9 @@ Inerpolate + + + **注意:** 参数 ``actual_shape`` 将被弃用，请使用 ``out_shape`` 替代。 该OP用于调整一个batch中图片的大小。 diff --git a/doc/fluid/api_cn/nn_cn/loss_cn/BCELoss_cn.rst b/doc/fluid/api_cn/nn_cn/loss_cn/BCELoss_cn.rst index 78cd4fb635e65cfb216a37e83679650e0f88197d..22343a60db1fb2e3478625a6d31a22918f46cc4e 100644 --- a/doc/fluid/api_cn/nn_cn/loss_cn/BCELoss_cn.rst +++ b/doc/fluid/api_cn/nn_cn/loss_cn/BCELoss_cn.rst @@ -5,6 +5,11 @@ BCELoss .. py:function:: paddle.nn.BCELoss(input, label, weight=None, reduction='mean') +:alias_main: paddle.nn.BCELoss +:alias: paddle.nn.BCELoss,paddle.nn.layer.BCELoss,paddle.nn.layer.loss.BCELoss + + + 该接口用于创建一个BCELoss的可调用类，用于计算输入和标签之间的二值交叉熵损失值。二值交叉熵损失函数公式如下： 当 `weight` 不为空时，公式为： diff --git a/doc/fluid/api_cn/nn_cn/loss_cn/CrossEntropyLoss_cn.rst b/doc/fluid/api_cn/nn_cn/loss_cn/CrossEntropyLoss_cn.rst index 5e85d3a50dba92772a068ee8dc0e0beaaf3ddc73..2da8d028f6ff866fd8b0040e9941cd25607c872a 100644 --- a/doc/fluid/api_cn/nn_cn/loss_cn/CrossEntropyLoss_cn.rst +++ b/doc/fluid/api_cn/nn_cn/loss_cn/CrossEntropyLoss_cn.rst @@ -3,6 +3,14 @@ CrossEntropyLoss .. py:function:: paddle.nn.loss.CrossEntropyLoss(weight=None, reduction='mean', ignore_index=-100) +:alias_main: paddle.nn.CrossEntropyLoss +:alias: paddle.nn.CrossEntropyLoss,paddle.nn.layer.CrossEntropyLoss,paddle.nn.layer.loss.CrossEntropyLoss + + + + + + 该OP计算输入input和标签label间的交叉熵损失 ，它结合了`LogSoftmax` 和 `NLLLoss` 的OP计算，可用于训练一个 `n` 类分类器。 如果提供 `weight` 参数的话，它是一个 `1-D` 的tensor, 每个值对应每个类别的权重。 diff --git a/doc/fluid/api_cn/nn_cn/loss_cn/L1Loss_cn.rst b/doc/fluid/api_cn/nn_cn/loss_cn/L1Loss_cn.rst index c2cc4e38e6ffbb6322dce8ca29656b49cd12705a..a9aecaaa51ccd09f191c5ade38d45af45b853af2 100644 --- a/doc/fluid/api_cn/nn_cn/loss_cn/L1Loss_cn.rst +++ b/doc/fluid/api_cn/nn_cn/loss_cn/L1Loss_cn.rst @@ -3,6 +3,11 @@ L1Loss .. py:function:: paddle.nn.loss.L1Loss(reduction='mean') +:alias_main: paddle.nn.L1Loss +:alias: paddle.nn.L1Loss,paddle.nn.layer.L1Loss,paddle.nn.layer.loss.L1Loss + + + 该接口用于创建一个L1Loss的可调用类，L1Loss计算输入input和标签label间的 `L1 loss` 损失。 该损失函数的数学计算公式如下： diff --git a/doc/fluid/api_cn/nn_cn/loss_cn/MSELoss_cn.rst b/doc/fluid/api_cn/nn_cn/loss_cn/MSELoss_cn.rst index 4dfa7bfba423c2a12005da89c07fe562442b6a5a..f90675c29746b3203a9123892d921973d67f5251 100644 --- a/doc/fluid/api_cn/nn_cn/loss_cn/MSELoss_cn.rst +++ b/doc/fluid/api_cn/nn_cn/loss_cn/MSELoss_cn.rst @@ -3,6 +3,11 @@ MSELoss .. py:function:: paddle.nn.loss.MSELoss(input,label) +:alias_main: paddle.nn.MSELoss +:alias: paddle.nn.MSELoss,paddle.nn.layer.MSELoss,paddle.nn.layer.loss.MSELoss + + + 该OP用于计算预测值和目标值的均方差误差。 对于预测值input和目标值label： diff --git a/doc/fluid/api_cn/nn_cn/loss_cn/NLLLoss_cn.rst b/doc/fluid/api_cn/nn_cn/loss_cn/NLLLoss_cn.rst index 7d3e46dc66a0a6587f786de999cae3ddbcc9c5fc..26e3076b52aaad3e1ce54e96c2cfc56496d043dc 100644 --- a/doc/fluid/api_cn/nn_cn/loss_cn/NLLLoss_cn.rst +++ b/doc/fluid/api_cn/nn_cn/loss_cn/NLLLoss_cn.rst @@ -3,6 +3,11 @@ NLLLoss .. py:function:: paddle.nn.loss.NLLLoss(weight=None, reduction='mean', ignore_index=-100) +:alias_main: paddle.nn.NLLLoss +:alias: paddle.nn.NLLLoss,paddle.nn.layer.NLLLoss,paddle.nn.layer.loss.NLLLoss + + + 该OP计算输入input和标签label间的 `negative log likelihood loss` 损失 ，可用于训练一个 `n` 类分类器。 如果提供 `weight` 参数的话，它是一个 `1-D` 的tensor, 里面的值对应类别的权重。当你的训练集样本 diff --git a/doc/fluid/api_cn/optimizer_cn/AdadeltaOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/AdadeltaOptimizer_cn.rst index 2f05a9e4b119006348f75796b70c1d947895e897..322cfed84ee98e6f0a58c1d17bea154fa9d31765 100644 --- a/doc/fluid/api_cn/optimizer_cn/AdadeltaOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/AdadeltaOptimizer_cn.rst @@ -5,6 +5,12 @@ AdadeltaOptimizer .. py:class:: paddle.fluid.optimizer.AdadeltaOptimizer(learning_rate, epsilon=1.0e-6, rho=0.95, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.AdadeltaOptimizer +:alias: paddle.optimizer.AdadeltaOptimizer +:old_api: paddle.fluid.optimizer.AdadeltaOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Adadelta_cn.rst b/doc/fluid/api_cn/optimizer_cn/Adadelta_cn.rst index fabe7b81fa54401bea6e21de5cfa5cce4bc5a701..e0a28963be51bf3fb9ffe1d5a821e51dfd55bb34 100644 --- a/doc/fluid/api_cn/optimizer_cn/Adadelta_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Adadelta_cn.rst @@ -5,6 +5,12 @@ Adadelta .. py:attribute:: paddle.fluid.optimizer.Adadelta +:alias_main: paddle.optimizer.Adadelta +:alias: paddle.optimizer.Adadelta +:old_api: paddle.fluid.optimizer.Adadelta + + + diff --git a/doc/fluid/api_cn/optimizer_cn/AdagradOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/AdagradOptimizer_cn.rst index 8c3179c447340e0dfb6be1bb20bdb1dc17470ed4..9b16afe432eefcf3658e6d57d0d82f025d555810 100644 --- a/doc/fluid/api_cn/optimizer_cn/AdagradOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/AdagradOptimizer_cn.rst @@ -5,6 +5,12 @@ AdagradOptimizer .. py:class:: paddle.fluid.optimizer.AdagradOptimizer(learning_rate, epsilon=1e-06, parameter_list=None, regularization=None, grad_clip=None, name=None, initial_accumulator_value=0.0) +:alias_main: paddle.optimizer.AdagradOptimizer +:alias: paddle.optimizer.AdagradOptimizer +:old_api: paddle.fluid.optimizer.AdagradOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Adagrad_cn.rst b/doc/fluid/api_cn/optimizer_cn/Adagrad_cn.rst index f4304ba8b4d89f0d1b446cf31e487e6c9ebb4c34..5f02b70fb1c70d7d2d6b8d2bc947d1afc55bbf2c 100644 --- a/doc/fluid/api_cn/optimizer_cn/Adagrad_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Adagrad_cn.rst @@ -5,6 +5,12 @@ Adagrad .. py:attribute:: paddle.fluid.optimizer.Adagrad +:alias_main: paddle.optimizer.Adagrad +:alias: paddle.optimizer.Adagrad +:old_api: paddle.fluid.optimizer.Adagrad + + + diff --git a/doc/fluid/api_cn/optimizer_cn/AdamOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/AdamOptimizer_cn.rst index 208209f0267b6eec070491bb3e76550c0bac7b54..da834ad1895974c112c0270e908419ae090e3734 100644 --- a/doc/fluid/api_cn/optimizer_cn/AdamOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/AdamOptimizer_cn.rst @@ -5,6 +5,12 @@ AdamOptimizer .. py:class:: paddle.fluid.optimizer.AdamOptimizer(learning_rate=0.001, beta1=0.9, beta2=0.999, epsilon=1e-08, parameter_list=None, regularization=None, grad_clip=None, name=None, lazy_mode=False) +:alias_main: paddle.optimizer.AdamOptimizer +:alias: paddle.optimizer.AdamOptimizer +:old_api: paddle.fluid.optimizer.AdamOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Adam_cn.rst b/doc/fluid/api_cn/optimizer_cn/Adam_cn.rst index 2c8f8e567ab30678e7e346733c4f9b2928df4623..99ccbb955a6c5a7f5115e5adcf241af45fa42120 100644 --- a/doc/fluid/api_cn/optimizer_cn/Adam_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Adam_cn.rst @@ -5,6 +5,12 @@ Adam .. py:attribute:: paddle.fluid.optimizer.Adam +:alias_main: paddle.optimizer.Adam +:alias: paddle.optimizer.Adam +:old_api: paddle.fluid.optimizer.Adam + + + diff --git a/doc/fluid/api_cn/optimizer_cn/AdamaxOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/AdamaxOptimizer_cn.rst index e1cef76dd4470357ea8ffd6aac7161cbb6c441e0..1075ba5a0588df6d14b5ebb18b93b0c660655a01 100644 --- a/doc/fluid/api_cn/optimizer_cn/AdamaxOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/AdamaxOptimizer_cn.rst @@ -5,6 +5,12 @@ AdamaxOptimizer .. py:class:: paddle.fluid.optimizer.AdamaxOptimizer(learning_rate=0.001, beta1=0.9, beta2=0.999, epsilon=1e-08, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.AdamaxOptimizer +:alias: paddle.optimizer.AdamaxOptimizer +:old_api: paddle.fluid.optimizer.AdamaxOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Adamax_cn.rst b/doc/fluid/api_cn/optimizer_cn/Adamax_cn.rst index 0413d5b109548833548752b8b9e22934633e5d42..8e27a04ce396278b9bccfabfedf99e8cafc1cac6 100644 --- a/doc/fluid/api_cn/optimizer_cn/Adamax_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Adamax_cn.rst @@ -5,6 +5,12 @@ Adamax .. py:attribute:: paddle.fluid.optimizer.Adamax +:alias_main: paddle.optimizer.Adamax +:alias: paddle.optimizer.Adamax +:old_api: paddle.fluid.optimizer.Adamax + + + diff --git a/doc/fluid/api_cn/optimizer_cn/DGCMomentumOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/DGCMomentumOptimizer_cn.rst index be5b5640c37c0e59658ec09600d62cb3fb61d4f4..076b8644d495ae16e20d34ce5f80a577d7c84228 100644 --- a/doc/fluid/api_cn/optimizer_cn/DGCMomentumOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/DGCMomentumOptimizer_cn.rst @@ -7,6 +7,12 @@ DGCMomentumOptimizer .. py:class:: paddle.fluid.optimizer.DGCMomentumOptimizer(learning_rate, momentum, rampup_begin_step, rampup_step=1, sparsity=[0.999], use_nesterov=False, local_grad_clip_norm=None, num_trainers=None, regularization=None, grad_clip=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.optimizer.DGCMomentumOptimizer +:alias: paddle.optimizer.DGCMomentumOptimizer +:old_api: paddle.fluid.optimizer.DGCMomentumOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/DecayedAdagradOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/DecayedAdagradOptimizer_cn.rst index 62d2d1cb79d18d96e123f2e8dbe6286e79d305a3..8f202de453c6c7361b364baffc134f97cd53dd16 100644 --- a/doc/fluid/api_cn/optimizer_cn/DecayedAdagradOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/DecayedAdagradOptimizer_cn.rst @@ -5,6 +5,12 @@ DecayedAdagradOptimizer .. py:class:: paddle.fluid.optimizer.DecayedAdagradOptimizer(learning_rate, decay=0.95, epsilon=1e-06, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.DecayedAdagradOptimizer +:alias: paddle.optimizer.DecayedAdagradOptimizer +:old_api: paddle.fluid.optimizer.DecayedAdagradOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/DecayedAdagrad_cn.rst b/doc/fluid/api_cn/optimizer_cn/DecayedAdagrad_cn.rst index 215758e1f13843b4f60d299c229bac6b7721c5c4..4f554410244841b6c71dc780374a38c17bc642b4 100644 --- a/doc/fluid/api_cn/optimizer_cn/DecayedAdagrad_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/DecayedAdagrad_cn.rst @@ -5,6 +5,12 @@ DecayedAdagrad .. py:attribute:: paddle.fluid.optimizer.DecayedAdagrad +:alias_main: paddle.optimizer.DecayedAdagrad +:alias: paddle.optimizer.DecayedAdagrad +:old_api: paddle.fluid.optimizer.DecayedAdagrad + + + diff --git a/doc/fluid/api_cn/optimizer_cn/DpsgdOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/DpsgdOptimizer_cn.rst index 6bfeeec2248ee46f5f118aa73905996fd2982bac..b5cdd6b4bd08f1bc3225d9972b2241480900159d 100644 --- a/doc/fluid/api_cn/optimizer_cn/DpsgdOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/DpsgdOptimizer_cn.rst @@ -5,6 +5,12 @@ DpsgdOptimizer .. py:class:: paddle.fluid.optimizer.DpsgdOptimizer(learning_rate=0.001, clip=0.9, batch_size=0.999, sigma=1e-8) +:alias_main: paddle.optimizer.DpsgdOptimizer +:alias: paddle.optimizer.DpsgdOptimizer +:old_api: paddle.fluid.optimizer.DpsgdOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Dpsgd_cn.rst b/doc/fluid/api_cn/optimizer_cn/Dpsgd_cn.rst index a6fde680ba5c3c0e82913e85b1bac83aa8d7623c..4053148eb4df732f2ce766c69db08305b84c25bd 100644 --- a/doc/fluid/api_cn/optimizer_cn/Dpsgd_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Dpsgd_cn.rst @@ -5,6 +5,12 @@ Dpsgd .. py:attribute:: paddle.fluid.optimizer.Dpsgd +:alias_main: paddle.optimizer.Dpsgd +:alias: paddle.optimizer.Dpsgd +:old_api: paddle.fluid.optimizer.Dpsgd + + + diff --git a/doc/fluid/api_cn/optimizer_cn/ExponentialMovingAverage_cn.rst b/doc/fluid/api_cn/optimizer_cn/ExponentialMovingAverage_cn.rst index f2e6bfa7d4533a26c8c7d83f4b15f72fead6b459..3edb9a3e3c97e2d0cfad48bcd970f980485b9c83 100644 --- a/doc/fluid/api_cn/optimizer_cn/ExponentialMovingAverage_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/ExponentialMovingAverage_cn.rst @@ -7,6 +7,12 @@ ExponentialMovingAverage .. py:class:: paddle.fluid.optimizer.ExponentialMovingAverage(decay=0.999, thres_steps=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.optimizer.ExponentialMovingAverage +:alias: paddle.optimizer.ExponentialMovingAverage +:old_api: paddle.fluid.optimizer.ExponentialMovingAverage + + + diff --git a/doc/fluid/api_cn/optimizer_cn/FtrlOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/FtrlOptimizer_cn.rst index 494937baf094f1578321b2c43e3b7ce9f7a800c3..0721e78e1eb34e3db1b54874ccd72a998a010ac5 100644 --- a/doc/fluid/api_cn/optimizer_cn/FtrlOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/FtrlOptimizer_cn.rst @@ -5,6 +5,12 @@ FtrlOptimizer .. py:class:: paddle.fluid.optimizer.FtrlOptimizer(learning_rate, l1=0.0, l2=0.0, lr_power=-0.5, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.FtrlOptimizer +:alias: paddle.optimizer.FtrlOptimizer +:old_api: paddle.fluid.optimizer.FtrlOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Ftrl_cn.rst b/doc/fluid/api_cn/optimizer_cn/Ftrl_cn.rst index 51856bf25d8165751d74df062408e21a517af929..3e5d12b700f31b6a13762bcb272c6af875db8ab5 100644 --- a/doc/fluid/api_cn/optimizer_cn/Ftrl_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Ftrl_cn.rst @@ -5,6 +5,12 @@ Ftrl .. py:attribute:: paddle.fluid.optimizer.Ftrl +:alias_main: paddle.optimizer.Ftrl +:alias: paddle.optimizer.Ftrl +:old_api: paddle.fluid.optimizer.Ftrl + + + diff --git a/doc/fluid/api_cn/optimizer_cn/LambOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/LambOptimizer_cn.rst index 13eebf27ef0d48be970d296a1a2dda28ca78221c..5d614fafe3f397faee1899c7f286bd5837dc2150 100644 --- a/doc/fluid/api_cn/optimizer_cn/LambOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/LambOptimizer_cn.rst @@ -5,6 +5,12 @@ LambOptimizer .. py:class:: paddle.fluid.optimizer.LambOptimizer(learning_rate=0.001, lamb_weight_decay=0.01, beta1=0.9, beta2=0.999, epsilon=1e-06, parameter_list=None, regularization=None, grad_clip=None, exclude_from_weight_decay_fn=None, name=None) +:alias_main: paddle.optimizer.LambOptimizer +:alias: paddle.optimizer.LambOptimizer +:old_api: paddle.fluid.optimizer.LambOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/LarsMomentumOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/LarsMomentumOptimizer_cn.rst index dee1f6fda7c8e053e992c581ac08976de6b3390c..74b71497f77de065b42740a8eba01e10a51236da 100644 --- a/doc/fluid/api_cn/optimizer_cn/LarsMomentumOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/LarsMomentumOptimizer_cn.rst @@ -5,6 +5,12 @@ LarsMomentumOptimizer .. py:class:: paddle.fluid.optimizer.LarsMomentumOptimizer(learning_rate, momentum, lars_coeff=0.001, lars_weight_decay=0.0005, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.LarsMomentumOptimizer +:alias: paddle.optimizer.LarsMomentumOptimizer +:old_api: paddle.fluid.optimizer.LarsMomentumOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/LarsMomentum_cn.rst b/doc/fluid/api_cn/optimizer_cn/LarsMomentum_cn.rst index d5d4db1b2d8fc6eb306b40ab6d24a58418aa69e2..2a435c7ad0f811696841a0577f4ba568dff30889 100644 --- a/doc/fluid/api_cn/optimizer_cn/LarsMomentum_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/LarsMomentum_cn.rst @@ -5,6 +5,12 @@ LarsMomentum .. py:attribute:: paddle.fluid.optimizer.LarsMomentum +:alias_main: paddle.optimizer.LarsMomentum +:alias: paddle.optimizer.LarsMomentum +:old_api: paddle.fluid.optimizer.LarsMomentum + + + diff --git a/doc/fluid/api_cn/optimizer_cn/LookaheadOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/LookaheadOptimizer_cn.rst index d4bd795a5ccbc5aa0ddb1eb6da6ca07a2e4516ef..8cd8bab2c1acea4e65cebb77c8529d1d59c08ab7 100644 --- a/doc/fluid/api_cn/optimizer_cn/LookaheadOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/LookaheadOptimizer_cn.rst @@ -7,6 +7,12 @@ LookaheadOptimizer .. py:class:: paddle.fluid.optimizer.LookaheadOptimizer(inner_optimizer, alpha=0.5, k=5) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.optimizer.LookaheadOptimizer +:alias: paddle.optimizer.LookaheadOptimizer +:old_api: paddle.fluid.optimizer.LookaheadOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/ModelAverage_cn.rst b/doc/fluid/api_cn/optimizer_cn/ModelAverage_cn.rst index 9ef6dfeae328669f5f385d7db0bb8a2249f5f2ad..f6dd49a91eff35a4bdb875572560f18a04a82568 100644 --- a/doc/fluid/api_cn/optimizer_cn/ModelAverage_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/ModelAverage_cn.rst @@ -7,6 +7,12 @@ ModelAverage .. py:class:: paddle.fluid.optimizer.ModelAverage(average_window_rate, min_average_window=10000, max_average_window=10000, regularization=None, name=None) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.optimizer.ModelAverage +:alias: paddle.optimizer.ModelAverage +:old_api: paddle.fluid.optimizer.ModelAverage + + + diff --git a/doc/fluid/api_cn/optimizer_cn/MomentumOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/MomentumOptimizer_cn.rst index baf3df7ac0378a6939b8d8d3204cce0234def083..dc30b807b0ce7db729c31e243ef095a8ae339954 100644 --- a/doc/fluid/api_cn/optimizer_cn/MomentumOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/MomentumOptimizer_cn.rst @@ -5,6 +5,12 @@ MomentumOptimizer .. py:class:: paddle.fluid.optimizer.MomentumOptimizer(learning_rate, momentum, parameter_list=None, use_nesterov=False, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.MomentumOptimizer +:alias: paddle.optimizer.MomentumOptimizer +:old_api: paddle.fluid.optimizer.MomentumOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/Momentum_cn.rst b/doc/fluid/api_cn/optimizer_cn/Momentum_cn.rst index 80e940e19f2fbc1a92e60f20fe32a3200c8ba94b..4c157581f591dd96f0f44c53189b581fb7e96c66 100644 --- a/doc/fluid/api_cn/optimizer_cn/Momentum_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/Momentum_cn.rst @@ -5,6 +5,12 @@ Momentum .. py:attribute:: paddle.fluid.optimizer.Momentum +:alias_main: paddle.optimizer.Momentum +:alias: paddle.optimizer.Momentum +:old_api: paddle.fluid.optimizer.Momentum + + + diff --git a/doc/fluid/api_cn/optimizer_cn/PipelineOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/PipelineOptimizer_cn.rst index 5da5dc780d2c94e960961a62816686b93f91b3d7..99df307eda86fc0776e0d0a098c71582aa3986f0 100644 --- a/doc/fluid/api_cn/optimizer_cn/PipelineOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/PipelineOptimizer_cn.rst @@ -7,6 +7,12 @@ PipelineOptimizer .. py:class:: paddle.fluid.optimizer.PipelineOptimizer(optimizer, cut_list=None, place_list=None, concurrency_list=None, queue_size=30, sync_steps=1, start_cpu_core_id=0) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.optimizer.PipelineOptimizer +:alias: paddle.optimizer.PipelineOptimizer +:old_api: paddle.fluid.optimizer.PipelineOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/RMSPropOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/RMSPropOptimizer_cn.rst index 5017529d71b9c1c58d150b1c93efa3c787ca61a1..7b89a1e84121f1a2955d9c91615724f2fab666da 100644 --- a/doc/fluid/api_cn/optimizer_cn/RMSPropOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/RMSPropOptimizer_cn.rst @@ -5,6 +5,12 @@ RMSPropOptimizer .. py:class:: paddle.fluid.optimizer.RMSPropOptimizer(learning_rate, rho=0.95, epsilon=1e-06, momentum=0.0, centered=False, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.RMSPropOptimizer +:alias: paddle.optimizer.RMSPropOptimizer +:old_api: paddle.fluid.optimizer.RMSPropOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/RecomputeOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/RecomputeOptimizer_cn.rst index d521b74471a50245f85085500ca9f716e9ba5d62..dea8fee3ee338282b54e6e124797812671bc8ff0 100644 --- a/doc/fluid/api_cn/optimizer_cn/RecomputeOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/RecomputeOptimizer_cn.rst @@ -7,6 +7,12 @@ RecomputeOptimizer .. py:class:: paddle.fluid.optimizer.RecomputeOptimizer(optimizer) :api_attr: 声明式编程模式（静态图) +:alias_main: paddle.optimizer.RecomputeOptimizer +:alias: paddle.optimizer.RecomputeOptimizer +:old_api: paddle.fluid.optimizer.RecomputeOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/SGDOptimizer_cn.rst b/doc/fluid/api_cn/optimizer_cn/SGDOptimizer_cn.rst index 0691a8c9e0f2f676e87d2a9b0bd72a6ae0b97fda..cec3db64c8c9204cb6c8fe7e1655585abe0f3226 100644 --- a/doc/fluid/api_cn/optimizer_cn/SGDOptimizer_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/SGDOptimizer_cn.rst @@ -5,6 +5,12 @@ SGDOptimizer .. py:class:: paddle.fluid.optimizer.SGDOptimizer(learning_rate, parameter_list=None, regularization=None, grad_clip=None, name=None) +:alias_main: paddle.optimizer.SGDOptimizer +:alias: paddle.optimizer.SGDOptimizer +:old_api: paddle.fluid.optimizer.SGDOptimizer + + + diff --git a/doc/fluid/api_cn/optimizer_cn/SGD_cn.rst b/doc/fluid/api_cn/optimizer_cn/SGD_cn.rst index 8810f79d267ab312ae682332240e047ad10771e6..f9a505c1f41396d8076c7d7f77659ae1180f89fc 100644 --- a/doc/fluid/api_cn/optimizer_cn/SGD_cn.rst +++ b/doc/fluid/api_cn/optimizer_cn/SGD_cn.rst @@ -5,6 +5,12 @@ SGD .. py:attribute:: paddle.fluid.optimizer.SGD +:alias_main: paddle.optimizer.SGD +:alias: paddle.optimizer.SGD +:old_api: paddle.fluid.optimizer.SGD + + + diff --git a/doc/fluid/api_cn/tensor_cn/add_cn.rst b/doc/fluid/api_cn/tensor_cn/add_cn.rst index 5673e801092d6af999465df5073fa22efad24779..df058e4d75b166ee2f2abf06eb060c0c31e8256a 100644 --- a/doc/fluid/api_cn/tensor_cn/add_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/add_cn.rst @@ -11,6 +11,9 @@ add + + + 该OP是逐元素相加算子，输入 ``x`` 与输入 ``y`` 逐元素相加，并将各个位置的输出元素保存到返回结果中。 等式为： diff --git a/doc/fluid/api_cn/tensor_cn/addcmul_cn.rst b/doc/fluid/api_cn/tensor_cn/addcmul_cn.rst index 53ac51e9c7e9b13e2d1731c468681dbab981fb56..23b32847b05d1be0d20f66c9a554e423d74bb2b5 100644 --- a/doc/fluid/api_cn/tensor_cn/addcmul_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/addcmul_cn.rst @@ -10,6 +10,9 @@ addcmul + + + 计算tensor1和tensor2的逐元素乘积，然后将结果乘以标量value，再加到input上输出。其中input, tensor1, tensor2的维度必须是可广播的。 计算过程的公式为： diff --git a/doc/fluid/api_cn/tensor_cn/addmm_cn.rst b/doc/fluid/api_cn/tensor_cn/addmm_cn.rst index 0b2fc8802e137c328f4b37643b900d5417bdd733..ae0dadb586217574327f688ffa7d4fd77c9cf437 100644 --- a/doc/fluid/api_cn/tensor_cn/addmm_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/addmm_cn.rst @@ -11,6 +11,9 @@ addmm + + + 计算x和y的乘积，将结果乘以标量alpha，再加上input与beta的乘积，得到输出。其中input与x、y乘积的维度必须是可广播的。 计算过程的公式为： diff --git a/doc/fluid/api_cn/tensor_cn/allclose_cn.rst b/doc/fluid/api_cn/tensor_cn/allclose_cn.rst index e580aa233a340115835a263bf893422f055dc6b7..1eda2c7dbfdc332792b806924177bfca721f6524 100644 --- a/doc/fluid/api_cn/tensor_cn/allclose_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/allclose_cn.rst @@ -10,6 +10,9 @@ allclose + + + 逐个检查input和other的所有元素是否均满足如下条件： .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/arange_cn.rst b/doc/fluid/api_cn/tensor_cn/arange_cn.rst index 727d071a75b11de3ea274cdb601088ef022ca80c..b4956a41d72aa5d9509f8bd075dde7d1243ea080 100644 --- a/doc/fluid/api_cn/tensor_cn/arange_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/arange_cn.rst @@ -11,6 +11,9 @@ arange + + + 该API根据step均匀分隔给定数值区间[start, end)，并返回该分隔结果。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/argmax_cn.rst b/doc/fluid/api_cn/tensor_cn/argmax_cn.rst index 2b3a7857b80b29ecffbccb5f697267ef05afd81b..4879dd079340760f1c0430d0396d6694c250d0ad 100644 --- a/doc/fluid/api_cn/tensor_cn/argmax_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/argmax_cn.rst @@ -12,6 +12,9 @@ argmax + + + 该OP沿 ``axis`` 计算输入 ``input`` 的最大元素的索引。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/bmm_cn.rst b/doc/fluid/api_cn/tensor_cn/bmm_cn.rst index 8e83f59cf3477c007cdfd8f5b8aef0f56c0f7be4..615eeb2250103f646230b808d0d4699537561aa5 100644 --- a/doc/fluid/api_cn/tensor_cn/bmm_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/bmm_cn.rst @@ -10,6 +10,9 @@ bmm + + + 对输入x及输入y进行矩阵相乘。 两个输入的维度必须等于3，并且矩阵x和矩阵y的第一维必须相等 diff --git a/doc/fluid/api_cn/tensor_cn/clamp_cn.rst b/doc/fluid/api_cn/tensor_cn/clamp_cn.rst index 6584ec3695594ac5d93ccaeaf3ea35d8ebd7e95f..863fc03c8a7313a9048ca88861df3f5cd4779b14 100644 --- a/doc/fluid/api_cn/tensor_cn/clamp_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/clamp_cn.rst @@ -10,6 +10,9 @@ clamp + + + 该OP将输入的所有元素进行剪裁，使得输出元素限制在[min, max]内，具体公式如下： .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/cross_cn.rst b/doc/fluid/api_cn/tensor_cn/cross_cn.rst index 9541c6ef690a97e2f637a5cfc5d09be4990859ff..c341ca60fe547c50d0a40b36f596dbfc46b4bf97 100644 --- a/doc/fluid/api_cn/tensor_cn/cross_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/cross_cn.rst @@ -10,6 +10,9 @@ cross + + + 该OP返回在 ``dim`` 维度上，两个张量 ``input`` 和 ``other`` 的向量积（叉积）。 ``input`` 和 ``other`` 必须有相同的形状， 且指定的 ``dim`` 维上 ``size`` 必须为3，如果 ``dim`` 未指定，默认选取第一个 ``size`` 等于3的维度。 diff --git a/doc/fluid/api_cn/tensor_cn/dist_cn.rst b/doc/fluid/api_cn/tensor_cn/dist_cn.rst index 836567b87ca004af13417245badff3c8014dd0ac..07b62bb45c5c55567a063f7cc7cfedebf9648a7d 100644 --- a/doc/fluid/api_cn/tensor_cn/dist_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/dist_cn.rst @@ -10,6 +10,9 @@ dist + + + 该OP用于计算 `(x-y)` 的 p 范数（p-norm），需要注意这不是严格意义上的范数，仅作为距离的度量。输入 `x` 和 `y` 的形状（shape）必须是可广播的（broadcastable）。其含义如下，详情请参考 `numpy的广播概念 `_ ： - 每个输入都至少有1维 diff --git a/doc/fluid/api_cn/tensor_cn/div_cn.rst b/doc/fluid/api_cn/tensor_cn/div_cn.rst index 14a6e051659f44d3a62c8b474eced5fe22681d1c..a93ac989e40629d586a404118eab46cdc237f0db 100755 --- a/doc/fluid/api_cn/tensor_cn/div_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/div_cn.rst @@ -11,6 +11,9 @@ div + + + 该OP是逐元素相除算子，输入 ``x`` 与输入 ``y`` 逐元素相除，并将各个位置的输出元素保存到返回结果中。 等式是： diff --git a/doc/fluid/api_cn/tensor_cn/dot_cn.rst b/doc/fluid/api_cn/tensor_cn/dot_cn.rst index 6d6d56c88aff94097cc6acfc79508cc500ce34c9..697fa7d5e5d8d698ce691ed477bdf17f183532a4 100644 --- a/doc/fluid/api_cn/tensor_cn/dot_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/dot_cn.rst @@ -10,6 +10,9 @@ dot + + + 该OP计算向量的内积 .. note:: diff --git a/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst b/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst index c7006ffda4aefe7bc10a8ece96d2b3ed2f30f883..0c98d4f2e2f3cd341a1baa9ff62b1eb09d5e51ea 100644 --- a/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/elementwise_equal_cn.rst @@ -11,6 +11,9 @@ elementwise_equal + + + 该OP返回 :math:`x==y` 逐元素比较x和y是否相等。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/elementwise_sum_cn.rst b/doc/fluid/api_cn/tensor_cn/elementwise_sum_cn.rst index 0fa2c794769ce9cf1abc202ac13babaf7dbec557..30c1263a1d37e0453421976e79f27d9947c65d2e 100644 --- a/doc/fluid/api_cn/tensor_cn/elementwise_sum_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/elementwise_sum_cn.rst @@ -10,6 +10,9 @@ elementwise_sum + + + 该OP用于对输入的一至多个Tensor或LoDTensor求和。如果输入的是LoDTensor，输出仅与第一个输入共享LoD信息（序列信息）。 例1： diff --git a/doc/fluid/api_cn/tensor_cn/equal_cn.rst b/doc/fluid/api_cn/tensor_cn/equal_cn.rst index d25ec01088b79dea39cb3f9af2930f650660feb7..023618d40dede2c81a06ff2725d0ed255ec25d90 100644 --- a/doc/fluid/api_cn/tensor_cn/equal_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/equal_cn.rst @@ -9,6 +9,9 @@ equal + + + 该OP返回 :math:`x==y` 逐元素比较x和y是否相等，所有的元素都相同则返回True，否则返回False。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/flip_cn.rst b/doc/fluid/api_cn/tensor_cn/flip_cn.rst index b70ecf28bbffb083a276d777f2923983a0af6ce4..9ff8cd5b440d5b59526c0a40047cb8b57f935f8b 100644 --- a/doc/fluid/api_cn/tensor_cn/flip_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/flip_cn.rst @@ -10,6 +10,9 @@ flip + + + 该OP沿指定轴反转n维tensor. 参数： diff --git a/doc/fluid/api_cn/tensor_cn/full_cn.rst b/doc/fluid/api_cn/tensor_cn/full_cn.rst index 529c7403646dd7c675381d1de132871d31724cc7..74f22100447e8d6fc4c6ff84125f8edc30c0c5a5 100644 --- a/doc/fluid/api_cn/tensor_cn/full_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/full_cn.rst @@ -11,6 +11,9 @@ full + + + 该OP创建一个和具有相同的形状和数据类型的Tensor，其中元素值均为fill_value。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/full_like_cn.rst b/doc/fluid/api_cn/tensor_cn/full_like_cn.rst index bba7b101ed9ede3d881ec2be12121b7f6a8edafa..74cc6f4f664b652b9c1f32a8c972b61eca84e070 100644 --- a/doc/fluid/api_cn/tensor_cn/full_like_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/full_like_cn.rst @@ -10,6 +10,9 @@ full_like + + + 该OP创建一个和input具有相同的形状和数据类型的Tensor，其中元素值均为fill_value。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/gather_cn.rst b/doc/fluid/api_cn/tensor_cn/gather_cn.rst index 74bc1946571a82ba6582752992f80fd3d6587cf1..67b285952ea0fd9bf321fe84305aa917cfa3b5c6 100644 --- a/doc/fluid/api_cn/tensor_cn/gather_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/gather_cn.rst @@ -10,6 +10,9 @@ gather + + + 根据索引 index 获取输入（input）的最外层维度的条目，并将它们拼接在一起。 .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/index_sample_cn.rst b/doc/fluid/api_cn/tensor_cn/index_sample_cn.rst index d11aef519753bf0543b984b4b76539e5fd76f8ce..1871786f7cc7788a5ef3c2a4b0f6eda7a48e52b8 100644 --- a/doc/fluid/api_cn/tensor_cn/index_sample_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/index_sample_cn.rst @@ -10,6 +10,9 @@ index_sample + + + 该OP实现对输入 ``x`` 中的元素进行批量抽样，取 ``index`` 指定的对应下标的元素，按index中出现的先后顺序组织，填充为一个新的张量。 该OP中 ``x`` 与 ``index`` 都是 ``2-D`` 张量。 ``index`` 的第一维度与输入 ``x`` 的第一维度必须相同， ``index`` 的第二维度没有大小要求，可以重复索引相同下标元素。 diff --git a/doc/fluid/api_cn/tensor_cn/index_select_cn.rst b/doc/fluid/api_cn/tensor_cn/index_select_cn.rst index 5177558d16883287430f4ebeb2404d3e52f0cc0c..f657b3c8b3db500af84dcc8135d2a4577f7da9bf 100644 --- a/doc/fluid/api_cn/tensor_cn/index_select_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/index_select_cn.rst @@ -10,6 +10,9 @@ index_select + + + 该OP沿着指定维度 ``dim`` 对输入 ``input`` 进行索引，取 ``index`` 中指定的相应项，然后返回到一个新的张量。这里 ``index`` 是一个 ``1-D`` 张量。除 ``dim`` 维外，返回的张量其余维度大小同输入 ``input`` ， ``dim`` 维大小等于 ``index`` 的大小。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/inverse_cn.rst b/doc/fluid/api_cn/tensor_cn/inverse_cn.rst index 131b041378dfc91da94486491c99d7225d8a6116..27e93e3655bdaedea2ca3a38905833f9938ddd2c 100644 --- a/doc/fluid/api_cn/tensor_cn/inverse_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/inverse_cn.rst @@ -10,6 +10,9 @@ inverse + + + 计算方阵的逆。方阵是行数和列数相等的矩阵。输入可以是一个方阵（2-D张量），或者是批次方阵（维数大于2时）。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/kron_cn.rst b/doc/fluid/api_cn/tensor_cn/kron_cn.rst index 74cd64a5c59cef931a5727dff05d9c181853cec4..93e676b0343316322eec578c9ba83ced5cd8e33e 100644 --- a/doc/fluid/api_cn/tensor_cn/kron_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/kron_cn.rst @@ -11,6 +11,9 @@ kron + + + Kronecker Product 算子。 该 OP 计算两个张量的克罗内克积，结果是一个合成的张量，由第二个张量经过第一个张量中的元素缩放 diff --git a/doc/fluid/api_cn/tensor_cn/linspace_cn.rst b/doc/fluid/api_cn/tensor_cn/linspace_cn.rst index c38617e3a3beb81d2b68ec526fefe7d1575babe2..5f69238356d501240365a50b8aed9a108c1833d6 100644 --- a/doc/fluid/api_cn/tensor_cn/linspace_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/linspace_cn.rst @@ -11,6 +11,9 @@ linspace + + + 该OP在给定区间内返回固定数目的均匀间隔的值。 **注意：该OP不进行梯度计算** diff --git a/doc/fluid/api_cn/tensor_cn/log1p_cn.rst b/doc/fluid/api_cn/tensor_cn/log1p_cn.rst index dab3f158a2d20ee31db2d492f647140ec80eea6f..007c244f18be16b78b3b53de731e191a2e1ec270 100644 --- a/doc/fluid/api_cn/tensor_cn/log1p_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/log1p_cn.rst @@ -11,6 +11,9 @@ log1p + + + 该OP计算Log1p（加一的自然对数）结果。 .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst b/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst index a339972f9c24ebacdd555a3f04580957e2ad01a8..3c76867b0a69f087312119811f9e814e3d997399 100644 --- a/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/logsumexp_cn.rst @@ -10,6 +10,9 @@ logsumexp + + + 该OP对输入Tensor的元素以e为底做指数运算，然后根据指定维度做求和之后取自然对数 .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/matmul_cn.rst b/doc/fluid/api_cn/tensor_cn/matmul_cn.rst index 7df1247c2c4e891904f41f36becfbe73ce5cffe1..013bf09eb9a3205f2f4d90b329b071de17250af1 100644 --- a/doc/fluid/api_cn/tensor_cn/matmul_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/matmul_cn.rst @@ -10,6 +10,9 @@ matmul + + + 输入 ``x`` 和输入 ``y`` 矩阵相乘。 两个输入的形状可为任意维度，但当任一输入维度大于3时，两个输入的维度必须相等。 diff --git a/doc/fluid/api_cn/tensor_cn/max_cn.rst b/doc/fluid/api_cn/tensor_cn/max_cn.rst index 24eb34761ef45323fa211f954bdf77b4d8c9d020..c38423f23350e3530295c177f916ce05bcf3cfd7 100644 --- a/doc/fluid/api_cn/tensor_cn/max_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/max_cn.rst @@ -12,6 +12,9 @@ max + + + 该OP是对指定维度上的Tensor元素求最大值运算，并输出相应的计算结果。等价于 :ref:`cn_api_fluid_layers_reduce_max` 参数： diff --git a/doc/fluid/api_cn/tensor_cn/meshgrid_cn.rst b/doc/fluid/api_cn/tensor_cn/meshgrid_cn.rst index fc65f330c1b29cc400605390d113ad15ca4d6600..844963bc227b5ca8df67fbd61528be088751b091 100644 --- a/doc/fluid/api_cn/tensor_cn/meshgrid_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/meshgrid_cn.rst @@ -11,6 +11,9 @@ meshgrid + + + 该OP的输入是tensor list, 包含 k 个一维Tensor，对每个Tensor做扩充操作，输出 k 个 k 维tensor。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/min_cn.rst b/doc/fluid/api_cn/tensor_cn/min_cn.rst index d3417080c79bcc5df682feff99fd29c8d4a1057f..fcc878028928939c6429e713cddf0e35c84a538c 100644 --- a/doc/fluid/api_cn/tensor_cn/min_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/min_cn.rst @@ -11,6 +11,9 @@ min + + + 该OP是对指定维度上的Tensor元素求最小值运算，并输出相应的计算结果。等价于 :ref:`cn_api_fluid_layers_reduce_min` 参数： diff --git a/doc/fluid/api_cn/tensor_cn/mm_cn.rst b/doc/fluid/api_cn/tensor_cn/mm_cn.rst index 083f02ea991a5d6aff06198a41dc127cd9f5f4c3..4db78ae49f6db4a4214a0dd508faa98500392354 100644 --- a/doc/fluid/api_cn/tensor_cn/mm_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/mm_cn.rst @@ -11,6 +11,9 @@ mm + + + 用于两个输入矩阵的相乘。 两个输入的形状可为任意维度，但当任一输入维度大于3时，两个输入的维度必须相等。 diff --git a/doc/fluid/api_cn/tensor_cn/mul_cn.rst b/doc/fluid/api_cn/tensor_cn/mul_cn.rst index 6e5fea3571adf9ca98948b6bbb38c44cfd44ad9d..2964e83ced1f50995c86133b588e4ca9db00e563 100644 --- a/doc/fluid/api_cn/tensor_cn/mul_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/mul_cn.rst @@ -12,6 +12,9 @@ mul + + + mul算子 此运算是用于对输入x和y执行矩阵乘法。 公式是： diff --git a/doc/fluid/api_cn/tensor_cn/nonzero_cn.rst b/doc/fluid/api_cn/tensor_cn/nonzero_cn.rst index 79cdb2e56c7c56af7192fe2ece7af56e42b3a6f1..bd2ae0048fd915c028e1d8d7d6192c092bb488a2 100644 --- a/doc/fluid/api_cn/tensor_cn/nonzero_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/nonzero_cn.rst @@ -10,6 +10,9 @@ nonzero + + + 该OP返回输入 ``input`` 中非零元素的坐标。如果输入 ``input`` 有 ``n`` 维，共包含 ``z`` 个非零元素，当 ``as_tuple = False`` 时， 返回结果是一个 ``shape`` 等于 ``[z x n]`` 的 ``Tensor`` , 第 ``i`` 行代表输入中第 ``i`` 个非零元素的坐标；当 ``as_tuple = True`` 时， 返回结果是由 ``n`` 个大小为 ``z`` 的 ``1-D Tensor`` 构成的元组，第 ``i`` 个 ``1-D Tensor`` 记录输入的非零元素在第 ``i`` 维的坐标。 diff --git a/doc/fluid/api_cn/tensor_cn/norm_cn.rst b/doc/fluid/api_cn/tensor_cn/norm_cn.rst index 5fed454842b9292b2240cd8d3b575143064b0597..ff9c97674e18537a42df2f7d4c23e5817bbd2f4c 100644 --- a/doc/fluid/api_cn/tensor_cn/norm_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/norm_cn.rst @@ -11,6 +11,9 @@ norm + + + 该OP将计算给定Tensor的矩阵范数（Frobenius 范数）和向量范数（向量1范数、2范数、或者通常的p范数）. 参数： diff --git a/doc/fluid/api_cn/tensor_cn/ones_cn.rst b/doc/fluid/api_cn/tensor_cn/ones_cn.rst index dc07e0970bd8bad63a51d4a2af94e20f7fd710f1..22479a9d336f5c6642ebed180366bedd11b7db1b 100644 --- a/doc/fluid/api_cn/tensor_cn/ones_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/ones_cn.rst @@ -12,6 +12,9 @@ ones + + + 该OP创建形状为 ``shape`` 、数据类型为 ``dtype`` 且值全为1的Tensor。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst b/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst index 6eebf69ebdf2fbb8c6b59c1d17355fa9aa64321c..8c1769f56e20f2530ab7b96478713c46f2e8d56e 100644 --- a/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/ones_like_cn.rst @@ -12,6 +12,9 @@ ones_like + + + 该OP创建一个和input具有相同的形状和数据类型的全1Tensor。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/pow_cn.rst b/doc/fluid/api_cn/tensor_cn/pow_cn.rst index 01987cc7993054a6afbef41c49a7d8b82d49fd56..1595d52b5b9103ddf2da7e7d585dc08e64b30206 100644 --- a/doc/fluid/api_cn/tensor_cn/pow_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/pow_cn.rst @@ -11,6 +11,9 @@ pow + + + 该OP是指数激活算子： .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/randint_cn.rst b/doc/fluid/api_cn/tensor_cn/randint_cn.rst index 083fff351fd0d64fb44c8f5ad85a487a779feb9f..f50b4372373aff57098df7aee6316d327cfa70bc 100644 --- a/doc/fluid/api_cn/tensor_cn/randint_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/randint_cn.rst @@ -10,6 +10,9 @@ randint + + + 该OP使用从区间[low，high)内均匀分布采样的随机整数初始化一个Tensor。当high为None时（默认），均匀采样的区间为[0,low)。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/randn_cn.rst b/doc/fluid/api_cn/tensor_cn/randn_cn.rst index 5acbf1d611e8b5ca12dba6ab4de2e5262d79d772..adf0548674cd8cf3f62b8249aae8419c11b57d0f 100644 --- a/doc/fluid/api_cn/tensor_cn/randn_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/randn_cn.rst @@ -10,6 +10,9 @@ randn + + + 该 API 用于生成数据符合标准正态随机分布（均值为 0，方差为 1 的正态随机分布）的 Tensor。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/roll_cn.rst b/doc/fluid/api_cn/tensor_cn/roll_cn.rst index 0c4a1a3edc1a35d31e12a0da092232937033782b..8d73895b70952e0618d1fd61dabc2c955a33f3de 100644 --- a/doc/fluid/api_cn/tensor_cn/roll_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/roll_cn.rst @@ -10,6 +10,9 @@ roll + + + 该OP沿着指定维度对输入 ``input`` 进行循环滚动，当元素移动到最后位置时，会从第一个位置重新插入。如果 ``dims`` 为 ``None`` ，则输入在被循环滚动之前，会先展平成 ``1-D Tensor`` ，滚动操作完成后恢复成原来的形状。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/sin_cn.rst b/doc/fluid/api_cn/tensor_cn/sin_cn.rst index 97d3fec0fdae36058f1403c054a8cbfa21587faa..be611530cd26acc1de0487aada7f527f13b91990 100644 --- a/doc/fluid/api_cn/tensor_cn/sin_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/sin_cn.rst @@ -11,6 +11,9 @@ sin + + + 计算输入的正弦值。 .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/sort_cn.rst b/doc/fluid/api_cn/tensor_cn/sort_cn.rst index 9f627143f3ce7834c17c065280e53129c827c475..78ce460234850b79ba4854d874ad9cbe77e4d0fb 100644 --- a/doc/fluid/api_cn/tensor_cn/sort_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/sort_cn.rst @@ -11,6 +11,9 @@ sort + + + 对输入变量沿给定轴进行排序，输出排序好的数据和相应的索引，其维度和输入相同。**默认升序排列，如果需要降序排列设置** ``descending=True`` 。 diff --git a/doc/fluid/api_cn/tensor_cn/split_cn.rst b/doc/fluid/api_cn/tensor_cn/split_cn.rst index 4f3aca783c3bd2ca5cf105dce727c3475fc7a06b..7344588534fb45ec44f94f7ec8901c2e887a9fcf 100644 --- a/doc/fluid/api_cn/tensor_cn/split_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/split_cn.rst @@ -10,6 +10,9 @@ split + + + 该OP将输入Tensor分割成多个子Tensor。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst b/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst index fd64d0cb368dfbbd30dc741f50dacab64428a484..c7ce534b19ff505c467e78bba4474004000b35e2 100644 --- a/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/sqrt_cn.rst @@ -11,6 +11,9 @@ sqrt + + + 计算输入的算数平方根。 .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/squeeze_cn.rst b/doc/fluid/api_cn/tensor_cn/squeeze_cn.rst index e8b85a221061dd923ad2a1714b8dde671a23d8b7..2c9363cdb715388e5803b052a630f247e6d84233 100644 --- a/doc/fluid/api_cn/tensor_cn/squeeze_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/squeeze_cn.rst @@ -10,6 +10,9 @@ squeeze + + + 该OP会根据axes压缩输入Tensor的维度。如果指定了axes，则会删除axes中指定的维度，axes指定的维度要等于1。如果没有指定axes，那么所有等于1的维度都会被删除。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/stack_cn.rst b/doc/fluid/api_cn/tensor_cn/stack_cn.rst index 67d4cc022102d4d33c48bb23d299c2c40ec3e98b..d28e464350275a6eb4b4f2afebc7bd115ef2d09e 100644 --- a/doc/fluid/api_cn/tensor_cn/stack_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/stack_cn.rst @@ -10,6 +10,9 @@ stack + + + 该OP沿 axis 轴对输入 x 进行堆叠操作。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/std_cn.rst b/doc/fluid/api_cn/tensor_cn/std_cn.rst index 30aa83d07a730c336e7f1ca7c6df79a88dd93778..9aff92fc9f7c9d81a7899fc9fdce13e92741344e 100644 --- a/doc/fluid/api_cn/tensor_cn/std_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/std_cn.rst @@ -8,6 +8,9 @@ std + + + 根据指定的axis计算input的标准差。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/sum_cn.rst b/doc/fluid/api_cn/tensor_cn/sum_cn.rst index 89825e0b4254f68efd155310f7db1edbd391c82e..537c8cb05d179be3752ec9aa4d2e3af0d058fe86 100644 --- a/doc/fluid/api_cn/tensor_cn/sum_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/sum_cn.rst @@ -11,6 +11,9 @@ sum + + + 该OP是对指定维度上的Tensor元素进行求和运算，并输出相应的计算结果。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/t_cn.rst b/doc/fluid/api_cn/tensor_cn/t_cn.rst index cc36c5729ba55a76687836d71c577a7bdbf415ba..70e36dc2515c9e7c1cc1441b2f19932089048552 100644 --- a/doc/fluid/api_cn/tensor_cn/t_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/t_cn.rst @@ -10,6 +10,9 @@ t + + + 该OP对小于等于2维的Tensor进行数据转置。0维和1维Tensor返回本身，2维Tensor等价于perm设置为0，1的 :ref:`cn_api_fluid_layers_transpose` 函数。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/tanh_cn.rst b/doc/fluid/api_cn/tensor_cn/tanh_cn.rst index 84e295cb73c3be0d40d43ca571500232d0dbc7ac..ccf5b2a03f4f2c7fdb27fcc99a64b899b5c57064 100644 --- a/doc/fluid/api_cn/tensor_cn/tanh_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/tanh_cn.rst @@ -11,6 +11,9 @@ tanh + + + tanh 激活函数 .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/trace_cn.rst b/doc/fluid/api_cn/tensor_cn/trace_cn.rst index e2f0e3b9456672c2b848f6eac3915045aa976606..137e3b6a91c2cd1b1212fcb83301aacdfe63f678 100644 --- a/doc/fluid/api_cn/tensor_cn/trace_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/trace_cn.rst @@ -10,6 +10,9 @@ trace + + + 该 OP 计算输入 Tensor 在指定平面上的对角线元素之和，并输出相应的计算结果。 如果输入是 2D Tensor，则返回对角线元素之和。 diff --git a/doc/fluid/api_cn/tensor_cn/tril_cn.rst b/doc/fluid/api_cn/tensor_cn/tril_cn.rst index 6ee8e4195d54432c58e7a024743ceda84334a23c..732dd880ad3a361cde98a3c2120c45f5e62d62a9 100644 --- a/doc/fluid/api_cn/tensor_cn/tril_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/tril_cn.rst @@ -10,6 +10,9 @@ tril + + + 返回输入矩阵 `input` 的下三角部分，其余部分被设为0。 矩形的下三角部分被定义为对角线上和下方的元素。 diff --git a/doc/fluid/api_cn/tensor_cn/triu_cn.rst b/doc/fluid/api_cn/tensor_cn/triu_cn.rst index 06775bf379c63cf31ec540bb28e62c9909636e37..80667e3fc31e2aeec9fb6b2378a94432149a5172 100644 --- a/doc/fluid/api_cn/tensor_cn/triu_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/triu_cn.rst @@ -10,6 +10,9 @@ triu + + + 返回输入矩阵 `input` 的上三角部分，其余部分被设为0。 矩形的上三角部分被定义为对角线上和上方的元素。 diff --git a/doc/fluid/api_cn/tensor_cn/unbind_cn.rst b/doc/fluid/api_cn/tensor_cn/unbind_cn.rst index 1ed191175d7e85592225ffc3c19c8faeda8c83d2..2809b6c53294d7e5bca1736ec952b4579a5f1fcf 100644 --- a/doc/fluid/api_cn/tensor_cn/unbind_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/unbind_cn.rst @@ -9,6 +9,9 @@ unbind + + + 该OP将输入Tensor按照指定的维度分割成多个子Tensor。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/unsqueeze_cn.rst b/doc/fluid/api_cn/tensor_cn/unsqueeze_cn.rst index 77b72b1b322515c5de2ec7a04b546f6e4e21e10a..00d904e1631074f25bf9dceca2073798aa6ec685 100644 --- a/doc/fluid/api_cn/tensor_cn/unsqueeze_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/unsqueeze_cn.rst @@ -10,6 +10,9 @@ unsqueeze + + + 该OP向输入（input）的shape中一个或多个位置（axes）插入维度。 **参数**： diff --git a/doc/fluid/api_cn/tensor_cn/var_cn.rst b/doc/fluid/api_cn/tensor_cn/var_cn.rst index a0ee9e9b7edb2da0371c43bfc160a1ae33c46699..40562baca42aa5d4ef3dd13b0629729e69eee9f6 100644 --- a/doc/fluid/api_cn/tensor_cn/var_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/var_cn.rst @@ -8,6 +8,9 @@ var + + + 沿给定的轴 axis 计算输入变量所有元素的方差。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/where_cn.rst b/doc/fluid/api_cn/tensor_cn/where_cn.rst index bcfabfab33a23f1e56e23bc922c59b965564155e..433a8283e0291810ff40ac687fffeebf6fed583d 100644 --- a/doc/fluid/api_cn/tensor_cn/where_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/where_cn.rst @@ -11,6 +11,9 @@ where + + + 该OP返回一个根据输入 ``condition``, 选择 ``x`` 或 ``y`` 的元素组成的多维 ``Tensor`` ： .. math:: diff --git a/doc/fluid/api_cn/tensor_cn/zeros_cn.rst b/doc/fluid/api_cn/tensor_cn/zeros_cn.rst index 0734e744979b08b8bed3dd8724242fbb325d9eb3..3e1b8063dd5948c1d23d1d31d2c3c8a5c2b4ba45 100644 --- a/doc/fluid/api_cn/tensor_cn/zeros_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/zeros_cn.rst @@ -11,6 +11,9 @@ zeros + + + 该OP创建形状为 ``shape`` 、数据类型为 ``dtype`` 且值全为0的Tensor。 参数： diff --git a/doc/fluid/api_cn/tensor_cn/zeros_like_cn.rst b/doc/fluid/api_cn/tensor_cn/zeros_like_cn.rst index bf1c923573df4a0eab94c291a267d5324edd3013..b1f6b87ff3c62974d611432312a75b07a17a14f8 100644 --- a/doc/fluid/api_cn/tensor_cn/zeros_like_cn.rst +++ b/doc/fluid/api_cn/tensor_cn/zeros_like_cn.rst @@ -12,6 +12,9 @@ zeros_like + + + 该OP创建一个和input具有相同的形状和数据类型的全零Tensor。 参数： diff --git a/doc/fluid/api_cn/transpiler_cn/DistributeTranspilerConfig_cn.rst b/doc/fluid/api_cn/transpiler_cn/DistributeTranspilerConfig_cn.rst index 4a95daa6428ad1d9be20ae1edc6dd1a0a0549920..ad940dbaa9024277eef7de501960a1f1ff3cdf1b 100644 --- a/doc/fluid/api_cn/transpiler_cn/DistributeTranspilerConfig_cn.rst +++ b/doc/fluid/api_cn/transpiler_cn/DistributeTranspilerConfig_cn.rst @@ -10,6 +10,9 @@ DistributeTranspilerConfig + + + 单机任务切换为分布式任务的配置类，用户可根据需求进行配置，如指定同步/异步训练，指定节点个数及模型切分逻辑。 返回：None diff --git a/doc/fluid/api_cn/transpiler_cn/DistributeTranspiler_cn.rst b/doc/fluid/api_cn/transpiler_cn/DistributeTranspiler_cn.rst index 92ea6dfbfd198334767f5f0afc6c958dd38d23ea..30ceebf0e23b9f1535a1c8d5185d0ccc01b50529 100644 --- a/doc/fluid/api_cn/transpiler_cn/DistributeTranspiler_cn.rst +++ b/doc/fluid/api_cn/transpiler_cn/DistributeTranspiler_cn.rst @@ -11,6 +11,9 @@ DistributeTranspiler + + + 该类可以把fluid program转变为分布式数据并行计算的program, 有PServer和NCCL2两种模式。 在Pserver（全称：parameter server）模式下， 通过 ``transpile`` 将用于单机训练的 ``program`` 转译为可用于parameter server的分布式架构(即PServer,参数服务器)来进行训练的program。 在NCCL2模式下, 通过 ``transpile`` 将用于单机训练的 ``program`` 转译为可用于NCCL2的分布式架构来进行训练的program。在NCCL2模式下，transpiler会在 ``startup_program`` 中附加一个 ``NCCL_ID`` 广播算子（broadcasting operators）来实现在该集群中所有工作结点共享``NCCL_ID`` 。 调用 ``transpile_nccl2`` 后， 你 **必须** 将 ``trainer_id`` , ``num_trainers`` 参数提供给 ``Executor`` 来启动NCCL2分布式模式。 diff --git a/doc/fluid/api_cn/transpiler_cn/HashName_cn.rst b/doc/fluid/api_cn/transpiler_cn/HashName_cn.rst index 9b4d019cbec11dba1a818c95afe81342e2e284b6..4d95c844f7908c5b0a108ec508081e3549beb7d5 100644 --- a/doc/fluid/api_cn/transpiler_cn/HashName_cn.rst +++ b/doc/fluid/api_cn/transpiler_cn/HashName_cn.rst @@ -10,6 +10,9 @@ HashName + + + 该方法使用 python ``Hash()`` 函数将变量散列到多个parameter server节点。 参数: diff --git a/doc/fluid/api_cn/transpiler_cn/RoundRobin_cn.rst b/doc/fluid/api_cn/transpiler_cn/RoundRobin_cn.rst index aa4b7d3890d40c58ca568ece75d9e5d26a311559..42e8afc9462fa83c9a58563b025e74e89a146061 100644 --- a/doc/fluid/api_cn/transpiler_cn/RoundRobin_cn.rst +++ b/doc/fluid/api_cn/transpiler_cn/RoundRobin_cn.rst @@ -10,6 +10,9 @@ RoundRobin + + + 该方法使用 ``RoundRobin`` 的方式将变量散列到多个parameter server终端。 `RondRobin `_ diff --git a/doc/fluid/api_cn/transpiler_cn/memory_optimize_cn.rst b/doc/fluid/api_cn/transpiler_cn/memory_optimize_cn.rst index d9a5a2b023fc6f1d578d254b5057a9c01d6940b9..fe0795b71944ee9699d9daa86093db743550fa44 100644 --- a/doc/fluid/api_cn/transpiler_cn/memory_optimize_cn.rst +++ b/doc/fluid/api_cn/transpiler_cn/memory_optimize_cn.rst @@ -10,4 +10,7 @@ memory_optimize + + + **从1.6版本开始此接口不再推荐使用，请不要在新写的代码中使用它，1.6+版本已默认开启更优的存储优化策略** \ No newline at end of file diff --git a/doc/fluid/api_cn/transpiler_cn/release_memory_cn.rst b/doc/fluid/api_cn/transpiler_cn/release_memory_cn.rst index 724589bf79cd77f11c3ec9431019d31f08ffd74f..ea18b30b3fc392096d4e56c4df68ab9f71397ae3 100644 --- a/doc/fluid/api_cn/transpiler_cn/release_memory_cn.rst +++ b/doc/fluid/api_cn/transpiler_cn/release_memory_cn.rst @@ -10,4 +10,7 @@ release_memory + + + **从1.6版本开始此接口不再推荐使用，请不要在新写的代码中使用它，1.6+版本已默认开启更优的存储优化策略** \ No newline at end of file