fluid.dygraph

SourceEnglish

BackwardStrategy

• class paddle.fluid.dygraph.BackwardStrategy

• BackwardStrategy是描述反向过程的描述符，现有如下功能:

• sort_sum_gradient 按回溯逆序将梯度加和代码示例

import numpy as np
import paddle.fluid as fluid
from paddle.fluid import FC
 
x = np.ones([2, 2], np.float32)
with fluid.dygraph.guard():
    inputs2 = []
    for _ in range(10):
        inputs2.append(fluid.dygraph.base.to_variable(x))
    ret2 = fluid.layers.sums(inputs2)
    loss2 = fluid.layers.reduce_sum(ret2)
    backward_strategy = fluid.dygraph.BackwardStrategy()
    backward_strategy.sort_sum_gradient = True
    loss2.backward(backward_strategy)

BatchNorm

SourceEnglish

• class paddle.fluid.dygraph.BatchNorm(name_scope, num_channels, act=None, is_test=False, momentum=0.9, epsilon=1e-05, param_attr=None, bias_attr=None, dtype='float32', data_layout='NCHW', in_place=False, moving_mean_name=None, moving_variance_name=None, do_model_average_for_mean_and_var=False, fuse_with_relu=False, use_global_stats=False, trainable_statistics=False)
• 批正则化层（Batch Normalization Layer）

可用作conv2d和全连接操作的正则化函数。该层需要的数据格式如下：

1.NHWC[batch,in_height,in_width,in_channels]2.NCHW[batch,in_channels,in_height,in_width]

更多详情请参考 : Batch Normalization: Accelerating Deep Network Training by Reducing Internal Covariate Shift

input 是mini-batch的输入特征。

当use_global_stats = True时，

和 不是一个minibatch的统计数据。 它们是全局（或运行）统计数据。 （它通常来自预训练模型）。训练和测试（或预测）具有相同的行为：

• 参数：
• • name_scope (str) - 该类的名称
  • act （string，默认None）- 激活函数类型，linear|relu|prelu|…
  • is_test （bool,默认False） - 指示它是否在测试阶段。
  • momentum （float，默认0.9）- 此值用于计算 moving_mean and moving_var. 更新公式为:

， 默认值0.9.

• epsilon （float，默认1e-05）- 加在分母上为了数值稳定的值。默认值为1e-5。
• param_attr （ParamAttr|None） - batch_norm参数范围的属性，如果设为None或者是ParamAttr的一个属性，batch_norm创建ParamAttr为param_attr。如果没有设置param_attr的初始化函数，参数初始化为Xavier。默认：None
• bias_attr （ParamAttr|None） - batch_norm bias参数的属性，如果设为None或者是ParamAttr的一个属性，batch_norm创建ParamAttr为bias_attr。如果没有设置bias_attr的初始化函数，参数初始化为0。默认：None
• data_layout （string,默认NCHW) - NCHW|NHWC。默认NCHW
• in_place （bool，默认False）- 得出batch norm可复用记忆的输入和输出
• moving_mean_name （string，默认None）- moving_mean的名称，存储全局Mean均值。
• moving_variance_name （string，默认None）- moving_variance的名称，存储全局方差。
• do_model_average_for_mean_and_var （bool，默认False）- 是否为mean和variance做模型均值
• fuse_with_relu （bool）- 如果为True，batch norm后该操作符执行relu。默认为False。
• use_global_stats （bool, Default False） – 是否使用全局均值和方差。 在预测或测试模式下，将use_global_stats设置为true或将is_test设置为true，并且行为是等效的。 在训练模式中，当设置use_global_stats为True时，在训练期间也使用全局均值和方差。
• trainable_statistics （bool）- eval模式下是否计算mean均值和var方差。eval模式下，trainable_statistics为True时，由该批数据计算均值和方差。默认为False。返回： 张量，在输入中运用批正则后的结果

返回类型：变量（Variable）

代码示例

import paddle.fluid as fluid
 
with fluid.dygraph.guard():
    fc = fluid.FC('fc', size=200, param_attr='fc1.w')
    hidden1 = fc(x)
    batch_norm = fluid.BatchNorm("batch_norm", 10)
    hidden2 = batch_norm(hidden1)

BilinearTensorProduct

SourceEnglish

• class paddle.fluid.dygraph.BilinearTensorProduct(name_scope, size, name=None, act=None, param_attr=None, bias_attr=None)
• 该层可将一对张量进行双线性乘积计算，例如：

式中，

• ： 第一个输入，分别包含M个元素，形为[batch_size, M]
• ：第二个输入，分别包含N个元素，形为[batch_size, N]
• ：第i个学习到的权重，形为[M,N]
• ：输出的第i个元素
• ：的转置
• 参数：
• • name_scope (str) – 类的名称。
  • size (int) – 该层的维度大小。
  • act (str) – 对输出应用的激励函数。默认:None。
  • name (str) – 该层的名称。 默认: None。
  • param_attr (ParamAttr) – 该层中可学习权重/参数w的参数属性。默认: None.
  • bias_attr (ParamAttr) – 该层中偏置(bias)的参数属性。若为False, 则输出中不应用偏置。如果为None, 偏置默认为0。默认: None.返回：形为 [batch_size, size]的二维张量

返回类型： Variable

代码示例

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    layer1 = numpy.random.random((5, 5)).astype('float32')
    layer2 = numpy.random.random((5, 4)).astype('float32')
    bilinearTensorProduct = fluid.dygraph.nn.BilinearTensorProduct(
           'BilinearTensorProduct', size=1000)
    ret = bilinearTensorProduct(fluid.dygraph.base.to_variable(layer1),
                       fluid.dygraph.base.to_variable(layer2))

Conv2D

SourceEnglish

• class paddle.fluid.dygraph.Conv2D(name_scope, 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')
• 卷积二维层（convolution2D layer）根据输入、滤波器（filter）、步长（stride）、填充（padding）、dilations、一组参数计算输出。输入和输出是NCHW格式，N是批尺寸，C是通道数，H是特征高度，W是特征宽度。滤波器是MCHW格式，M是输出图像通道数，C是输入图像通道数，H是滤波器高度，W是滤波器宽度。如果组数大于1，C等于输入图像通道数除以组数的结果。详情请参考UFLDL’s : 卷积 。如果提供了bias属性和激活函数类型，bias会添加到卷积（convolution）的结果中相应的激活函数会作用在最终结果上。

对每个输入X，有等式：

• 其中：
• • ：输入值，NCHW格式的张量（Tensor）
  • ：滤波器值，MCHW格式的张量（Tensor）
  • ： 卷积操作
  • ：Bias值，二维张量（Tensor），shape为 [M,1]
  • ：激活函数
  • ：输出值，Out 和 X 的shape可能不同示例

• 输入：

输入shape：

滤波器shape：

• 输出：

输出shape：

其中

• 参数：
• • name_scope (str) - 该类的名称
  • num_fliters (int) - 滤波器数。和输出图像通道相同
  • filter_size (int|tuple|None) - 滤波器大小。如果filter_size是一个元组，则必须包含两个整型数，（filter_size，filter_size_W）。否则，滤波器为square
  • stride (int|tuple) - 步长(stride)大小。如果步长（stride）为元组，则必须包含两个整型数，（stride_H,stride_W）。否则，stride_H = stride_W = stride。默认：stride = 1
  • padding (int|tuple) - 填充（padding）大小。如果填充（padding）为元组，则必须包含两个整型数，（padding_H,padding_W)。否则，padding_H = padding_W = padding。默认：padding = 0
  • dilation (int|tuple) - 膨胀（dilation）大小。如果膨胀（dialation）为元组，则必须包含两个整型数，（dilation_H,dilation_W）。否则，dilation_H = dilation_W = dilation。默认：dilation = 1
  • groups (int) - 卷积二维层（Conv2D Layer）的组数。根据Alex Krizhevsky的深度卷积神经网络（CNN）论文中的成组卷积：当group=2，滤波器的前一半仅和输入通道的前一半连接。滤波器的后一半仅和输入通道的后一半连接。默认：groups = 1
  • param_attr (ParamAttr|None) - conv2d的可学习参数/权重的参数属性。如果设为None或者ParamAttr的一个属性，conv2d创建ParamAttr为param_attr。如果param_attr的初始化函数未设置，参数则初始化为，并且std为。默认为None
  • bias_attr (ParamAttr|bool|None) - conv2d bias的参数属性。如果设为False，则没有bias加到输出。如果设为None或者ParamAttr的一个属性，conv2d创建ParamAttr为bias_attr。如果bias_attr的初始化函数未设置，bias初始化为0.默认为None
  • use_cudnn （bool） - 是否用cudnn核，仅当下载cudnn库才有效。默认：True
  • act (str) - 激活函数类型，如果设为None，则未添加激活函数。默认：None
• 抛出异常:
• • ValueError - 如果输入shape和filter_size，stride,padding和groups不匹配。代码示例

from paddle.fluid.dygraph.base import to_variable
import paddle.fluid as fluid
from paddle.fluid.dygraph import Conv2D
import numpy as np
 
data = np.random.uniform( -1, 1, [10, 3, 32, 32] ).astype('float32')
with fluid.dygraph.guard():
    conv2d = Conv2D( "conv2d", 2, 3)
    data = to_variable( data )
    conv = conv2d( data )

Conv2DTranspose

SourceEnglish

• class paddle.fluid.dygraph.Conv2DTranspose(name_scope, 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)
• 2-D卷积转置层（Convlution2D transpose layer）

该层根据 输入（input）、滤波器（filter）和卷积核膨胀（dilations）、步长（stride）、填充（padding）来计算输出。输入(Input)和输出(Output)为NCHW格式，其中 N 为batch大小， C 为通道数（channel），H 为特征高度， W 为特征宽度。参数(膨胀、步长、填充)分别都包含两个元素。这两个元素分别表示高度和宽度。欲了解卷积转置层细节，请参考下面的说明和 参考文献 。如果参数 bias_attr 和 act 不为 None，则在卷积的输出中加入偏置，并对最终结果应用相应的激活函数。

输入

和输出 函数关系如下：

• 其中：
• • : 输入张量，具有 NCHW 格式
  • : 滤波器张量，具有 NCHW 格式
  • : 卷积操作
  • : 偏置（bias），二维张量，shape为 [M,1]
  • : 激活函数
  • : 输出值，Out和 X 的 shape 可能不一样样例：

输入：

输出：

其中

• 参数:
• • name_scope (str) - 该类的名称
  • num_filters (int) - 滤波器（卷积核）的个数，与输出的图片的通道数（ channel ）相同
  • output_size (int|tuple|None) - 输出图片的大小。如果output_size是一个元组（tuple），则该元形式为（image_H,image_W),这两个值必须为整型。如果output_size=None,则内部会使用filter_size、padding和stride来计算output_size。如果output_size和filter_size是同时指定的，那么它们应满足上面的公式。默认为None。
  • filter_size (int|tuple|None) - 滤波器大小。如果filter_size是一个tuple，则形式为(filter_size_H, filter_size_W)。否则，滤波器将是一个方阵。如果filter_size=None，则内部会计算输出大小。默认为None。
  • padding (int|tuple) - 填充大小。如果padding是一个元组，它必须包含两个整数(padding_H、padding_W)。否则，padding_H = padding_W = padding。默认:padding = 0。
  • stride (int|tuple) - 步长大小。如果stride是一个元组，那么元组的形式为(stride_H、stride_W)。否则，stride_H = stride_W = stride。默认:stride = 1。
  • dilation (int|元组) - 膨胀(dilation)大小。如果dilation是一个元组，那么元组的形式为(dilation_H, dilation_W)。否则，dilation_H = dilation_W = dilation_W。默认:dilation= 1。
  • groups (int) - Conv2d转置层的groups个数。从Alex Krizhevsky的CNN Deep论文中的群卷积中受到启发，当group=2时，前半部分滤波器只连接到输入通道的前半部分，而后半部分滤波器只连接到输入通道的后半部分。默认值:group = 1。
  • param_attr (ParamAttr|None) - conv2d_transfer中可学习参数/权重的属性。如果param_attr值为None或ParamAttr的一个属性，conv2d_transfer使用ParamAttrs作为param_attr的值。如果没有设置的param_attr初始化器，那么使用Xavier初始化。默认值:None。
  • bias_attr (ParamAttr|bool|None) - conv2d_tran_bias中的bias属性。如果设置为False，则不会向输出单元添加偏置。如果param_attr值为None或ParamAttr的一个属性，将conv2d_transfer使用ParamAttrs作为，bias_attr。如果没有设置bias_attr的初始化器，bias将初始化为零。默认值:None。
  • use_cudnn (bool) - 是否使用cudnn内核，只有已安装cudnn库时才有效。默认值:True。
  • act (str) - 激活函数类型，如果设置为None，则不使用激活函数。默认值:None。返回： 存储卷积转置结果的张量。

返回类型: 变量（variable）

• 抛出异常:
• • ValueError : 如果输入的shape、filter_size、stride、padding和groups不匹配，抛出ValueError代码示例

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    data = numpy.random.random((3, 32, 32)).astype('float32')
    conv2DTranspose = fluid.dygraph.nn.Conv2DTranspose(
          'Conv2DTranspose', num_filters=2, filter_size=3)
    ret = conv2DTranspose(fluid.dygraph.base.to_variable(data))

Conv3D

SourceEnglish

• class paddle.fluid.dygraph.Conv3D(name_scope, num_filters, filter_size, stride=1, padding=0, dilation=1, groups=None, param_attr=None, bias_attr=None, use_cudnn=True, act=None)
• 3D卷积层（convolution3D layer）根据输入、滤波器（filter）、步长（stride）、填充（padding）、膨胀（dilations）、组数参数计算得到输出。输入和输出是NCHW格式，N是批尺寸，C是通道数，H是特征高度，W是特征宽度。卷积三维（Convlution3D）和卷积二维（Convlution2D）相似，但多了一维深度（depth）。如果提供了bias属性和激活函数类型，bias会添加到卷积（convolution）的结果中相应的激活函数会作用在最终结果上。

对每个输入X，有等式：

• 其中：
• • ：输入值，NCDHW格式的张量（Tensor）
  • ：滤波器值，MCDHW格式的张量（Tensor）
  • ： 卷积操作
  • ：Bias值，二维张量（Tensor），形为 [M,1]
  • ：激活函数
  • ：输出值, 和 X 的形状可能不同示例
• • 输入：
  • 输入shape：

滤波器shape：

• • 输出：
  • 输出shape：

其中

• 参数：
• • name_scope (str) - 该类的名称
  • num_fliters (int) - 滤波器数。和输出图像通道相同
  • filter_size (int|tuple|None) - 滤波器大小。如果filter_size是一个元组，则必须包含三个整型数，(filter_size_D, filter_size_H, filter_size_W)。否则，滤波器为棱长为int的立方体形。
  • stride (int|tuple) - 步长(stride)大小。如果步长（stride）为元组，则必须包含三个整型数， (stride_D, stride_H, stride_W)。否则，stride_D = stride_H = stride_W = stride。默认：stride = 1
  • padding (int|tuple) - 填充（padding）大小。如果填充（padding）为元组，则必须包含三个整型数，(padding_D, padding_H, padding_W)。否则， padding_D = padding_H = padding_W = padding。默认：padding = 0
  • dilation (int|tuple) - 膨胀（dilation）大小。如果膨胀（dialation）为元组，则必须包含两个整型数， (dilation_D, dilation_H, dilation_W)。否则，dilation_D = dilation_H = dilation_W = dilation。默认：dilation = 1
  • groups (int) - 卷积二维层（Conv2D Layer）的组数。根据Alex Krizhevsky的深度卷积神经网络（CNN）论文中的成组卷积：当group=2，滤波器的前一半仅和输入通道的前一半连接。滤波器的后一半仅和输入通道的后一半连接。默认：groups = 1
  • param_attr (ParamAttr|None) - conv2d的可学习参数/权重的参数属性。如果设为None或者ParamAttr的一个属性，conv2d创建ParamAttr为param_attr。如果param_attr的初始化函数未设置，参数则初始化为，并且std为。默认为None
  • bias_attr (ParamAttr|bool|None) - conv2d bias的参数属性。如果设为False，则没有bias加到输出。如果设为None或者ParamAttr的一个属性，conv2d创建ParamAttr为bias_attr。如果bias_attr的初始化函数未设置，bias初始化为0.默认为None
  • use_cudnn （bool） - 是否用cudnn核，仅当下载cudnn库才有效。默认：True
  • act (str) - 激活函数类型，如果设为None，则未添加激活函数。默认：None返回：张量，存储卷积和非线性激活结果

返回类型：变量（Variable）

• 抛出异常：
• • ValueError - 如果 input 的形和 filter_size ， stride , padding 和 groups 不匹配。代码示例：

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    data = numpy.random.random((5, 3, 12, 32, 32)).astype('float32')
    conv3d = fluid.dygraph.nn.Conv3D(
          'Conv3D', num_filters=2, filter_size=3, act="relu")
    ret = conv3d(fluid.dygraph.base.to_variable(data))

Conv3DTranspose

SourceEnglish

• class paddle.fluid.dygraph.Conv3DTranspose(name_scope, 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)
• 3-D卷积转置层（Convlution3D transpose layer)

该层根据 输入（input）、滤波器（filter）和卷积核膨胀（dilations）、步长（stride）、填充来计算输出。输入(Input)和输出(Output)为NCDHW格式。其中 N 为batch大小， C 为通道数（channel）, D 为特征深度, H 为特征高度， W 为特征宽度。参数(膨胀、步长、填充)分别包含两个元素。这两个元素分别表示高度和宽度。欲了解卷积转置层细节，请参考下面的说明和 参考文献 。如果参数 bias_attr 和 act 不为None，则在卷积的输出中加入偏置，并对最终结果应用相应的激活函数

输入X和输出Out函数关系X，有等式如下：

• 其中：
• • : 输入张量，具有 NCDHW 格式
  • : 滤波器张量，，具有 NCDHW 格式
  • : 卷积操作
  • : 偏置（bias），二维张量，shape为 [M,1]
  • : 激活函数
  • : 输出值， Out 和 X 的 shape可能不一样样例

输入:

输入形状:

Filter形状:

输出:

输出形状:

其中：

• 参数:
• • name_scope （str）- 该类的名称
  • num_filters (int) - 滤波器（卷积核）的个数，与输出的图片的通道数（channel）相同
  • output_size (int|tuple|None) - 输出图片的大小。如果 output_size 是一个元组（tuple），则该元形式为（image_H,image_W),这两个值必须为整型。如果 output_size=None ,则内部会使用filter_size、padding和stride来计算output_size。如果 output_size 和 filter_size 是同时指定的，那么它们应满足上面的公式。
  • filter_size (int|tuple|None) - 滤波器大小。如果 filter_size 是一个tuple，则形式为(filter_size_H, filter_size_W)。否则，滤波器将是一个方阵。如果 filter_size=None ，则内部会计算输出大小。
  • padding (int|tuple) - 填充大小。如果 padding 是一个元组，它必须包含两个整数(padding_H、padding_W)。否则，padding_H = padding_W = padding。默认:padding = 0。
  • stride (int|tuple) - 步长大小。如果 stride 是一个元组，那么元组的形式为(stride_H、stride_W)。否则，stride_H = stride_W = stride。默认:stride = 1。
  • dilation (int|元组) - 膨胀大小。如果 dilation 是一个元组，那么元组的形式为(dilation_H, dilation_W)。否则，dilation_H = dilation_W = dilation_W。默认:dilation= 1。
  • groups (int) - Conv2d转置层的groups个数。从Alex Krizhevsky的CNN Deep论文中的群卷积中受到启发，当group=2时，前半部分滤波器只连接到输入通道的前半部分，而后半部分滤波器只连接到输入通道的后半部分。默认值:group = 1。
  • param_attr (ParamAttr|None) - conv2d_transfer中可学习参数/权重的属性。如果param_attr值为None或ParamAttr的一个属性，conv2d_transfer使用ParamAttrs作为param_attr的值。如果没有设置的param_attr初始化器，那么使用Xavier初始化。默认值:None。
  • bias_attr (ParamAttr|bool|None) - conv2d_tran_bias中的bias属性。如果设置为False，则不会向输出单元添加偏置。如果param_attr值为None或ParamAttr的一个属性，将conv2d_transfer使用ParamAttrs作为，bias_attr。如果没有设置bias_attr的初始化器，bias将初始化为零。默认值:None。
  • use_cudnn (bool) - 是否使用cudnn内核，只有已安装cudnn库时才有效。默认值:True。
  • act (str) - 激活函数类型，如果设置为None，则不使用激活函数。默认值:None。
  • name (str|None) - 该layer的名称(可选)。如果设置为None， 将自动命名该layer。默认值:True。返回： 存储卷积转置结果的张量。

返回类型: 变量（variable）

• 抛出异常:
• • ValueError - 如果输入的shape、filter_size、stride、padding和groups不匹配，抛出ValueError代码示例

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    data = numpy.random.random((5, 3, 12, 32, 32)).astype('float32')
 
    conv3dTranspose = fluid.dygraph.nn.Conv3DTranspose(
           'Conv3DTranspose',
           num_filters=12,
           filter_size=12,
           use_cudnn=False)
    ret = conv3dTranspose(fluid.dygraph.base.to_variable(data))

CosineDecay

SourceEnglish

• class paddle.fluid.dygraph.CosineDecay(learning_rate, step_each_epoch, epochs, begin=0, step=1, dtype='float32')
• 使用 cosine decay 的衰减方式进行学习率调整。

在训练模型时，建议一边进行训练一边降低学习率。 通过使用此方法，学习率将通过如下cosine衰减策略进行衰减：

• 参数：
• • learning_rate (Variable | float) - 初始学习率。
  • step_each_epoch （int） - 一次迭代中的步数。
  • begin (int) - 起始步，默认为0。
  • step (int) - 步大小，默认为1。
  • dtype (str) - 学习率的dtype，默认为‘float32’代码示例

base_lr = 0.1
with fluid.dygraph.guard():
    optimizer  = fluid.optimizer.SGD(
        learning_rate = fluid.dygraph.CosineDecay(
                base_lr, 10000, 120) )

Embedding

SourceEnglish

• class paddle.fluid.dygraph.Embedding(name_scope, size, is_sparse=False, is_distributed=False, padding_idx=None, param_attr=None, dtype='float32')
• Embedding层

该层用于在查找表中查找 input 中的ID对应的embeddings。查找的结果是input里每个ID对应的embedding。所有的输入变量都作为局部变量传入LayerHelper构造器

• 参数：
• • name_scope (str)-该类的名称。
  • size (tuple|list)-查找表参数的维度。应当有两个参数，一个代表嵌入矩阵字典的大小，一个代表每个嵌入向量的大小。
  • is_sparse (bool)-代表是否用稀疏更新的标志。
  • is_distributed (bool)-是否从远程参数服务端运行查找表。
  • padding_idx (int|long|None)-如果为 None ，对查找结果无影响。如果 padding_idx 不为空，表示一旦查找表中找到input中对应的 padding_idx，则用0填充输出结果。如果 padding_idx <0 ,则在查找表中使用的 padding_idx 值为。默认：None。
  • param_attr (ParamAttr)-该层参数。默认为None。
  • dtype (np.dtype|core.VarDesc.VarType|str)-数据类型：float32,float_16,int等。默认:‘float32’返回：张量，存储已有输入的嵌入矩阵。

返回类型：变量(Variable)

代码示例

import paddle.fluid as fluid
import paddle.fluid.dygraph.base as base
import numpy as np
 
inp_word = np.array([[[1]]]).astype('int64')
dict_size = 20
with fluid.dygraph.guard():
    emb = fluid.dygraph.Embedding(
        name_scope='embedding',
        size=[dict_size, 32],
        param_attr='emb.w',
        is_sparse=False)
    static_rlt3 = emb(base.to_variable(inp_word))

ExponentialDecay

SourceEnglish

• class paddle.fluid.dygraph.ExponentialDecay(learning_rate, decay_steps, decay_rate, staircase=False, begin=0, step=1, dtype='float32')
• 对学习率应用指数衰减。

在学习率上运用指数衰减。训练模型时，推荐在训练过程中降低学习率。每次 decay_steps 步骤中用 decay_rate 衰减学习率。

if staircase == True:
    decayed_learning_rate = learning_rate * decay_rate ^ floor(global_step / decay_steps)
else:
    decayed_learning_rate = learning_rate * decay_rate ^ (global_step / decay_steps)

• 参数：
• • learning_rate (Variable|float)-初始学习率
  • decay_steps (int)-见以上衰减运算
  • decay_rate (float)-衰减率。见以上衰减运算
  • staircase (Boolean)-若为True,按离散区间衰减学习率。默认：False
  • begin (int) - 起始步，默认为0。
  • step (int) - 步大小，默认为1。
  • dtype (str) - 学习率的dtype，默认为‘float32’代码示例

import paddle.fluid as fluid
base_lr = 0.1
with fluid.dygraph.guard():
    sgd_optimizer = fluid.optimizer.SGD(
          learning_rate=fluid.dygraph.ExponentialDecay(
              learning_rate=base_lr,
              decay_steps=10000,
              decay_rate=0.5,
              staircase=True))

FC

SourceEnglish

• class paddle.fluid.dygraph.FC(name_scope, size, num_flatten_dims=1, param_attr=None, bias_attr=None, act=None, is_test=False, dtype='float32')
• 全连接层

该函数在神经网络中建立一个全连接层。 它可以将一个或多个tensor（ input 可以是一个list或者Variable，详见参数说明）作为自己的输入，并为每个输入的tensor创立一个变量，称为“权”（weights），等价于一个从每个输入单元到每个输出单元的全连接权矩阵。FC层用每个tensor和它对应的权相乘得到形状为[M, size]输出tensor，M是批大小。如果有多个输入tensor，那么形状为[M, size]的多个输出张量的结果将会被加起来。如果 bias_attr 非空，则会新创建一个偏向变量（bias variable），并把它加入到输出结果的运算中。最后，如果 act 非空，它也会加入最终输出的计算中。

当输入为单个张量：

当输入为多个张量：

• 上述等式中：
• • ：输入的数目,如果输入是变量列表，N等于len（input）
  • ：第i个输入的tensor
  • ：对应第i个输入张量的第i个权重矩阵
  • ：该层创立的bias参数
  • ：activation function(激励函数)
  • ：输出tensor

Given:
    data_1.data = [[[0.1, 0.2],
                   [0.3, 0.4]]]
    data_1.shape = (1, 2, 2) # 1 is batch_size
 
    data_2 = [[[0.1, 0.2, 0.3]]]
    data_2.shape = (1, 1, 3)
 
    out = fluid.layers.fc(input=[data_1, data_2], size=2)
 
Then:
    out.data = [[0.18669507, 0.1893476]]
    out.shape = (1, 2)

• 参数:
• • name_scope (str) – 该类的名称
  • size (int) – 该层输出单元的数目
  • num_flatten_dims (int, 默认为1) – fc层可以接受一个维度大于2的tensor。此时， 它首先会被扁平化(flattened)为一个二维矩阵。 参数 num_flatten_dims 决定了输入tensor的flattened方式: 前 num_flatten_dims (包含边界，从1开始数) 个维度会被扁平化为最终矩阵的第一维 (维度即为矩阵的高), 剩下的 rank(X) - num_flatten_dims 维被扁平化为最终矩阵的第二维 (即矩阵的宽)。 例如， 假设X是一个五维tensor，其形可描述为(2, 3, 4, 5, 6), 且num_flatten_dims = 3。那么扁平化的矩阵形状将会如此： (2 x 3 x 4, 5 x 6) = (24, 30)
  • param_attr (ParamAttr|list of ParamAttr|None) – 该层可学习的参数/权的参数属性
  • bias_attr (ParamAttr|list of ParamAttr, default None) – 该层bias变量的参数属性。如果值为False， 则bias变量不参与输出单元运算。 如果值为None，bias变量被初始化为0。默认为 None。
  • act (str|None) – 应用于输出的Activation（激励函数）
  • is_test (bool) – 表明当前执行是否处于测试阶段的标志
  • dtype (str) – 权重的数据类型弹出异常：ValueError - 如果输入tensor的维度小于2

代码示例

from paddle.fluid.dygraph.base import to_variable
import paddle.fluid as fluid
from paddle.fluid.dygraph import FC
import numpy as np
 
data = np.random.uniform( -1, 1, [30, 10, 32] ).astype('float32')
with fluid.dygraph.guard():
    fc = FC( "fc", 64, num_flatten_dims=2)
    data = to_variable( data )
    conv = fc( data )

GroupNorm

SourceEnglish

• class paddle.fluid.dygraph.GroupNorm(name_scope, groups, epsilon=1e-05, param_attr=None, bias_attr=None, act=None, data_layout='NCHW')
• Group Normalization层

请参考 Group Normalization 。

• 参数：
• • name_scope (str) - 该类名称
  • groups (int) - 从 channel 中分离出来的 group 的数目
  • epsilon (float) - 为防止方差除零，增加一个很小的值
  • param_attr (ParamAttr|None) - 可学习标度的参数属性,如果设置为False，则不会向输出单元添加标度。如果设置为0，偏差初始化为1。默认值:None
  • bias_attr (ParamAttr|None) - 可学习偏置的参数属性 :math:`b ` , 如果设置为False，则不会向输出单元添加偏置量。如果设置为零，偏置初始化为零。默认值:None。
  • act (str) - 将激活应用于输出的 group normalizaiton
  • data_layout (string|NCHW) - 只支持NCHW。返回： 一个张量变量，它是对输入进行 group normalization 后的结果。

返回类型：Variable

代码示例

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    x = numpy.random.random((8, 32, 32)).astype('float32')
    groupNorm = fluid.dygraph.nn.GroupNorm('GroupNorm', groups=4)
    ret = groupNorm(fluid.dygraph.base.to_variable(x))

GRUUnit

SourceEnglish

• class paddle.fluid.dygraph.GRUUnit(name_scope, size, param_attr=None, bias_attr=None, activation='tanh', gate_activation='sigmoid', origin_mode=False, dtype='float32')
• GRU单元层。GRU执行步骤基于如下等式：

如果origin_mode为True，则该运算公式来自论文Empirical Evaluation of Gated Recurrent Neural Networks on Sequence Modeling 。

公式如下:

如果origin_mode为False，则该运算公式来自论文Learning Phrase Representations using RNN Encoder Decoder for Statistical Machine Translation 。

GRU单元的输入包括

， 。在上述等式中， 会被分割成三部分： 、 和 。这意味着要为一批输入实现一个全GRU层，我们需要采用一个全连接层，才能得到 。 和 分别代表了GRU神经元的update gates（更新门）和reset gates(重置门)。和LSTM不同，GRU少了一个门（它没有LSTM的forget gate）。但是它有一个叫做中间候选隐藏状态（intermediate candidate hidden output）的输出，记为 。 该层有三个输出： 以及 的连结(concatenation)。

• 参数:
• • name_scope (str) – 该类的名称
  • size (int) – 输入数据的维度
  • param_attr (ParamAttr|None) – 可学习的隐藏层权重矩阵的参数属性。
  • 注意：
  • • 该权重矩阵形为，是隐藏状态的规模（hidden size）
    • 该权重矩阵的所有元素由两部分组成， 一是update gate和reset gate的权重，形为；二是候选隐藏状态（candidate hidden state）的权重矩阵，形为

如果该函数参数值为None或者 ParamAttr 类中的属性之一，gru_unit则会创建一个 ParamAttr 类的对象作为param_attr。如果param_attr没有被初始化，那么会由Xavier来初始化它。默认值为None

• bias_attr (ParamAttr|bool|None) - GRU的bias变量的参数属性。形为的bias连结（concatenate）在update gates（更新门），reset gates(重置门)以及candidate calculations（候选隐藏状态计算）中的bias。如果值为False，那么上述三者将没有bias参与运算。若值为None或者 ParamAttr 类中的属性之一，gru_unit则会创建一个 ParamAttr 类的对象作为 bias_attr。如果bias_attr没有被初始化，那它会被默认初始化为0。默认值为None。
• activation (str) – 神经元 “actNode” 的激励函数（activation）类型。默认类型为‘tanh’
• gate_activation (str) – 门 “actGate” 的激励函数（activation）类型。 默认类型为 ‘sigmoid’。
• dtype (str) – 该层的数据类型，默认为‘float32’。返回： hidden value（隐藏状态的值），reset-hidden value(重置隐藏状态值)，gate values(门值)

返回类型: 元组（tuple）

代码示例

import paddle.fluid as fluid
import paddle.fluid.dygraph.base as base
import numpy
 
lod = [[2, 4, 3]]
D = 5
T = sum(lod[0])
 
hidden_input = numpy.random.rand(T, D).astype('float32')
with fluid.dygraph.guard():
    x = numpy.random.random((3, 32, 32)).astype('float32')
    gru = fluid.dygraph.GRUUnit('gru', size=D * 3)
    dy_ret = gru(
      base.to_variable(input), base.to_variable(hidden_input))

guard

SourceEnglish

• paddle.fluid.dygraph.guard(place=None)

• 创建一个dygraph上下文，用于运行dygraph。

• 参数：

• • place (fluid.CPUPlace|fluid.CUDAPlace|None) – 执行场所返回： None

代码示例

import numpy as np
import paddle.fluid as fluid
 
with fluid.dygraph.guard():
    inp = np.ones([3, 32, 32], dtype='float32')
    t = fluid.dygraph.base.to_variable(inp)
    fc1 = fluid.FC('fc1', size=4, bias_attr=False, num_flatten_dims=1)
    fc2 = fluid.FC('fc2', size=4)
    ret = fc1(t)
    dy_ret = fc2(ret)

InverseTimeDecay

SourceEnglish

• class paddle.fluid.dygraph.InverseTimeDecay(learning_rate, decay_steps, decay_rate, staircase=False, begin=0, step=1, dtype='float32')
• 在初始学习率上运用逆时衰减。

训练模型时，最好在训练过程中降低学习率。通过执行该函数，将对初始学习率运用逆向衰减函数。

if staircase == True:
     decayed_learning_rate = learning_rate / (1 + decay_rate * floor(global_step / decay_step))
else:
     decayed_learning_rate = learning_rate / (1 + decay_rate * global_step / decay_step)

• 参数：
• • learning_rate (Variable|float)-初始学习率
  • decay_steps (int)-见以上衰减运算
  • decay_rate (float)-衰减率。见以上衰减运算
  • staircase (Boolean)-若为True，按间隔区间衰减学习率。默认：False
  • begin (int) - 起始步，默认为0。
  • step (int) - 步大小，默认为1。
  • dtype (str) - 学习率的dtype，默认为‘float32’代码示例

import paddle.fluid as fluid
base_lr = 0.1
with fluid.dygraph.guard():
    sgd_optimizer = fluid.optimizer.SGD(
        learning_rate=fluid.dygraph.InverseTimeDecay(
              learning_rate=base_lr,
              decay_steps=10000,
              decay_rate=0.5,
              staircase=True))

Layer

SourceEnglish

• class paddle.fluid.dygraph.Layer(name_scope, dtype=VarType.FP32)

• 由多个算子组成的层。

• 参数：

• • name_scope - 层为其参数命名而采用的名称前缀。如果前缀为“my_model/layer_1”，在一个名为MyLayer的层中，参数名为“my_model/layer_1/MyLayer/w_n”，其中w是参数的基础名称，n为自动生成的具有唯一性的后缀。
  • dtype - 层中变量的数据类型
• full_name()
• 层的全名。

组成方式如下：

namescope + “/” + MyLayer.class._name

返回： 层的全名

• createparameter(_attr, shape, dtype, is_bias=False, default_initializer=None)

• 为层(layers)创建参数。

• 参数：

• • attr (ParamAttr)- 参数的参数属性
  • shape - 参数的形状
  • dtype - 参数的数据类型
  • is_bias - 是否为偏置bias参数
  • default_initializer - 设置参数的默认初始化方法返回： 创建的参数变量

• createvariable(_name=None, persistable=None, dtype=None, type=VarType.LOD_TENSOR)

• 为层创建变量

• 参数：

• • name - 变量名
  • persistable - 是否为持久性变量
  • dtype - 变量中的数据类型
  • type - 变量类型返回： 创建的变量(Variable)

• parameters(include_sublayers=True)

• 返回一个由当前层及其子层的参数组成的列表。

• 参数：

• • include_sublayers - 如果为True，返回的列表中包含子层的参数返回： 一个由当前层及其子层的参数组成的列表

• sublayers(include_sublayers=True)

• 返回一个由所有子层组成的列表。

• 参数：

• • include_sublayers - 如果为True，则包括子层中的各层返回： 一个由所有子层组成的列表

• addsublayer(_name, sublayer)

• 添加子层实例。被添加的子层实例的访问方式和self.name类似。

• 参数：

• • name - 该子层的命名
  • sublayer - Layer实例返回： 传入的子层

• addparameter(_name, parameter)

• 添加参数实例。被添加的参数实例的访问方式和self.name类似。

• 参数：

• • name - 该子层的命名
  • parameter - Parameter实例返回： 传入的参数实例

LayerNorm

SourceEnglish

• class paddle.fluid.dygraph.LayerNorm(name_scope, scale=True, shift=True, begin_norm_axis=1, epsilon=1e-05, param_attr=None, bias_attr=None, act=None)
• 假设特征向量存在于维度 begin_norm_axis … rank (input） 上，计算大小为 H 的特征向量a在该维度上的矩统计量，然后使用相应的统计量对每个特征向量进行归一化。 之后，如果设置了 scale 和 shift ，则在标准化的张量上应用可学习的增益和偏差以进行缩放和移位。

请参考 Layer Normalization

公式如下

• : 该层神经元输入总和的向量表示
• : 层中隐藏的神经元个数
• : 可训练的缩放因子参数
• : 可训练的bias参数
• 参数:
• • name_scope (str) – 该类的名称
  • scale （bool） - 是否在归一化后学习自适应增益g。默认为True。
  • shift （bool） - 是否在归一化后学习自适应偏差b。默认为True。
  • begin_norm_axis （int） - begin_norm_axis 到 rank（input） 的维度执行规范化。默认1。
  • epsilon （float） - 添加到方差的很小的值，以防止除零。默认1e-05。
  • param_attr （ParamAttr | None） - 可学习增益g的参数属性。如果 scale 为False，则省略 param_attr 。如果 scale 为True且 param_attr 为None，则默认 ParamAttr 将作为比例。如果添加了 param_attr， 则将其初始化为1。默认None。
  • bias_attr （ParamAttr | None） - 可学习偏差的参数属性b。如果 shift 为False，则省略 bias_attr 。如果 shift 为True且 param_attr 为None，则默认 ParamAttr 将作为偏差。如果添加了 bias_attr ，则将其初始化为0。默认None。
  • act （str） - 激活函数。默认 None返回： 标准化后的结果

代码示例

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    x = numpy.random.random((3, 32, 32)).astype('float32')
    layerNorm = fluid.dygraph.nn.LayerNorm(
          'LayerNorm', begin_norm_axis=1)
   ret = layerNorm(fluid.dygraph.base.to_variable(x))

load_persistables

SourceEnglish

• paddle.fluid.dygraph.loadpersistables(_dirname='save_dir')

• 该函数尝试从dirname中加载持久性变量。

• 参数:

• • dirname (str) – 目录路径。默认为save_dir返回: 两个字典:从文件中恢复的参数字典;从文件中恢复的优化器字典

返回类型: dict

代码示例

my_layer = layer(fluid.Layer)
param_path = "./my_paddle_model"
sgd = SGDOptimizer(learning_rate=1e-3)
param_dict, optimizer_dict = fluid.dygraph.load_persistables(my_layer.parameters(), param_path)
param_1 = param_dict['PtbModel_0.w_1']
sgd.load(optimizer_dict)

NaturalExpDecay

SourceEnglish

• class paddle.fluid.dygraph.NaturalExpDecay(learning_rate, decay_steps, decay_rate, staircase=False, begin=0, step=1, dtype='float32')
• 为初始学习率应用指数衰减策略。

if not staircase:
    decayed_learning_rate = learning_rate * exp(- decay_rate * (global_step / decay_steps))
else:
    decayed_learning_rate = learning_rate * exp(- decay_rate * (global_step / decay_steps))

• 参数：
• • learning_rate (Variable|float)- 类型为float32的标量值或为一个Variable。它是训练的初始学习率。
  • decay_steps (int)-一个Python int32 数。
  • decay_rate (float)- 一个Python float数。
  • staircase (Boolean)-布尔型。若为True,每隔decay_steps衰减学习率。
  • begin – Python ‘int32’ 数，起始步(默认为0)。
  • step – Python ‘int32’ 数, 步大小(默认为1)。
  • dtype – Python ‘str’ 类型, 初始化学习率变量的dtype(默认为‘float32’)。代码示例

import paddle.fluid as fluid
base_lr = 0.1
with fluid.dygraph.guard():
    sgd_optimizer = fluid.optimizer.SGD(
            learning_rate=fluid.dygraph.NaturalExpDecay(
                  learning_rate=base_lr,
                  decay_steps=10000,
                  decay_rate=0.5,
                  staircase=True))

NCE

SourceEnglish

• class paddle.fluid.dygraph.NCE(name_scope, num_total_classes, param_attr=None, bias_attr=None, num_neg_samples=None, sampler='uniform', custom_dist=None, seed=0, is_sparse=False)
• 计算并返回噪音对比估计（ noise-contrastive estimation training loss）。请参考Noise-contrastive estimation: A new estimation principle for unnormalized statistical models

该operator默认使用均匀分布进行抽样。

• 参数:
• • name_scope (str) – 该类的名称
  • num_total_classes (int) - 所有样本中的类别的总数
  • sample_weight (Variable|None) - 存储每个样本权重，shape为[batch_size, 1]存储每个样本的权重。每个样本的默认权重为1.0
  • param_attr (ParamAttr|None) -的参数属性。如果它没有被设置为ParamAttr的一个属性，nce将创建ParamAttr为param_attr。如没有设置param_attr的初始化器，那么参数将用Xavier初始化。默认值:None
  • bias_attr (ParamAttr|bool|None) - nce偏置的参数属性。如果设置为False，则不会向输出添加偏置（bias）。如果值为None或ParamAttr的一个属性，则bias_attr=ParamAtt。如果没有设置bias_attr的初始化器，偏置将被初始化为零。默认值:None
  • num_neg_samples (int) - 负样例的数量。默认值是10
  • name (str|None) - 该layer的名称(可选)。如果设置为None，该层将被自动命名
  • sampler (str) – 取样器，用于从负类别中进行取样。可以是 ‘uniform’, ‘log_uniform’ 或 ‘custom_dist’。 默认 ‘uniform’
  • custom_dist (float[]) – 一个 float[] 并且它的长度为 num_total_classes 。 如果取样器类别为‘custom_dist’，则使用此参数。 custom_dist[i] 是第i个类别被取样的概率。默认为 None
  • seed (int) – 取样器使用的seed。默认为0
  • is_sparse (bool) – 标志位，指明是否使用稀疏更新,和会变为 SelectedRows返回： nce loss

返回类型: 变量（Variable）

代码示例

import numpy as np
import paddle.fluid as fluid
 
window_size = 5
dict_size = 20
label_word = int(window_size // 2) + 1
inp_word = np.array([[[1]], [[2]], [[3]], [[4]], [[5]]]).astype('int64')
nid_freq_arr = np.random.dirichlet(np.ones(20) * 1000).astype('float32')
 
with fluid.dygraph.guard():
    words = []
    for i in range(window_size):
        words.append(fluid.dygraph.base.to_variable(inp_word[i]))
 
    emb = fluid.Embedding(
        'embedding',
        size=[dict_size, 32],
        param_attr='emb.w',
        is_sparse=False)
 
    embs3 = []
    for i in range(window_size):
        if i == label_word:
            continue
 
        emb_rlt = emb(words[i])
        embs3.append(emb_rlt)
 
    embs3 = fluid.layers.concat(input=embs3, axis=1)
    nce = fluid.NCE('nce',
                 num_total_classes=dict_size,
                 num_neg_samples=2,
                 sampler="custom_dist",
                 custom_dist=nid_freq_arr.tolist(),
                 seed=1,
                 param_attr='nce.w',
                 bias_attr='nce.b')
 
    nce_loss3 = nce(embs3, words[label_word])

NoamDecay

SourceEnglish

• class paddle.fluid.dygraph.NoamDecay(d_model, warmup_steps, begin=1, step=1, dtype='float32')
• Noam衰减方法。noam衰减的numpy实现如下。

import numpy as np
# 设置超参数
d_model = 2
current_steps = 20
warmup_steps = 200
# 计算
lr_value = np.power(d_model, -0.5) * np.min([
                       np.power(current_steps, -0.5),
                       np.power(warmup_steps, -1.5) * current_steps])

请参照 attention is all you need

• 参数：
• • d_model (Variable)-模型的输入和输出维度
  • warmup_steps (Variable)-超参数
  • begin – 起始步(默认为0)。
  • step – 步大小(默认为1)。
  • dtype – 初始学习率的dtype(默认为‘float32’)。代码示例

import paddle.fluid as fluid
warmup_steps = 100
learning_rate = 0.01
with fluid.dygraph.guard():
    optimizer  = fluid.optimizer.SGD(
        learning_rate = fluid.dygraph.NoamDecay(
               1/(warmup_steps *(learning_rate ** 2)),
               warmup_steps) )

PiecewiseDecay

SourceEnglish

• class paddle.fluid.dygraph.PiecewiseDecay(boundaries, values, begin, step=1, dtype='float32')
• 对初始学习率进行分段(piecewise)衰减。

该算法可用如下代码描述。

boundaries = [10000, 20000]
values = [1.0, 0.5, 0.1]
if step < 10000:
    learning_rate = 1.0
elif 10000 <= step < 20000:
    learning_rate = 0.5
else:
    learning_rate = 0.1

• 参数：
• • boundaries -一列代表步数的数字
  • values -一列学习率的值，从不同的步边界中挑选
  • begin – 用于初始化self.step_num的起始步(默认为0)。
  • step – 计算新的step_num步号时使用的步大小(默认为1)。
  • dtype – 初始化学习率变量的dtype代码示例

import paddle.fluid as fluid
boundaries = [10000, 20000]
values = [1.0, 0.5, 0.1]
with fluid.dygraph.guard():
    optimizer = fluid.optimizer.SGD(
       learning_rate=fluid.dygraph.PiecewiseDecay(boundaries, values, 0) )

PolynomialDecay

SourceEnglish

• class paddle.fluid.dygraph.PolynomialDecay(learning_rate, decay_steps, end_learning_rate=0.0001, power=1.0, cycle=False, begin=0, step=1, dtype='float32')
• 为初始学习率应用多项式衰减。

if cycle:
    decay_steps = decay_steps * ceil(global_step / decay_steps)
else:
    global_step = min(global_step, decay_steps)
    decayed_learning_rate = (learning_rate - end_learning_rate) *
        (1 - global_step / decay_steps) ^ power + end_learning_rate

• 参数：
• • learning_rate (Variable|float32)-标量float32值或变量。是训练过程中的初始学习率
  • decay_steps (int32)-Python int32数
  • end_learning_rate (float)-Python float数
  • power (float)-Python float数
  • cycle (bool)-若设为true，每decay_steps衰减学习率
  • begin (int) – 起始步(默认为0)
  • step (int) – 步大小(默认为1)
  • dtype (str)– 初始化学习率变量的dtype(默认为‘float32’)返回：衰减的学习率

返回类型：变量（Variable）

代码示例

import paddle.fluid as fluid
start_lr = 0.01
total_step = 5000
end_lr = 0
with fluid.dygraph.guard():
    optimizer  = fluid.optimizer.SGD(
        learning_rate = fluid.dygraph.PolynomialDecay(
        start_lr, total_step, end_lr, power=1.0) )

Pool2D

SourceEnglish

• class paddle.fluid.dygraph.Pool2D(name_scope, pool_size=-1, pool_type='max', pool_stride=1, pool_padding=0, global_pooling=False, use_cudnn=True, ceil_mode=False, exclusive=True, dtype=VarType.FP32)
• pooling2d操作符根据 input ， 池化类型 pooling_type ， 池化核大小 ksize , 步长 strides ，填充 paddings 这些参数得到输出。

输入X和输出Out是NCHW格式，N为batch尺寸，C是通道数，H是特征高度，W是特征宽度。

参数（ksize,strides,paddings）含有两个元素。这两个元素分别代表高度和宽度。输入X的大小和输出Out的大小可能不一致。

• 参数：
• • name_scope (str) - 该类的名称
  • pool_size (int|list|tuple) - 池化核的大小。如果它是一个元组或列表，它必须包含两个整数值， (pool_size_Height, pool_size_Width)。其他情况下，若为一个整数，则它的平方值将作为池化核大小，比如若pool_size=2, 则池化核大小为2x2，默认值为-1。
  • pool_type (string) - 池化类型，可以是“max”对应max-pooling，“avg”对应average-pooling，默认值为max。
  • pool_stride (int|list|tuple) - 池化层的步长。如果它是一个元组或列表，它将包含两个整数，(pool_stride_Height, pool_stride_Width)。否则它是一个整数的平方值。默认值为1。
  • pool_padding (int|list|tuple) - 填充大小。如果它是一个元组，它必须包含两个整数值，(pool_padding_on_Height, pool_padding_on_Width)。否则它是一个整数的平方值。默认值为0。
  • global_pooling （bool）- 是否用全局池化。如果global_pooling = true， ksize 和 paddings 将被忽略。默认值为false
  • use_cudnn （bool）- 只在cudnn核中用，需要安装cudnn，默认值为True。
  • ceil_mode （bool）- 是否用ceil函数计算输出高度和宽度。默认False。如果设为False，则使用floor函数。默认值为false。
  • exclusive (bool) - 是否在平均池化模式忽略填充值。默认为True。返回：池化结果

返回类型：变量（Variable）

• 抛出异常：
• • ValueError - 如果 pool_type 既不是“max”也不是“avg”
  • ValueError - 如果 global_pooling 为False并且‘pool_size’为-1
  • ValueError - 如果 use_cudnn 不是bool值代码示例

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
   data = numpy.random.random((3, 32, 32)).astype('float32')
 
   pool2d = fluid.dygraph.Pool2D("pool2d",pool_size=2,
                  pool_type='max',
                  pool_stride=1,
                  global_pooling=False)
   pool2d_res = pool2d(data)

PRelu

SourceEnglish

• class paddle.fluid.dygraph.PRelu(name_scope, mode, param_attr=None)
• 等式：

• 参数：

• • name_scope （string）- 该类的名称。

  • mode (string) - 权重共享模式。共提供三种激活方式：

all: 所有元素使用同一个权值channel: 在同一个通道中的元素使用同一个权值element: 每一个元素有一个独立的权值

• param_attr (ParamAttr|None) - 可学习权重

的参数属性。

返回： 输出Tensor与输入tensor的shape相同。

返回类型： 变量（Variable）

代码示例：

import paddle.fluid as fluid
import numpy as np
 
inp_np = np.ones([5, 200, 100, 100]).astype('float32')
with fluid.dygraph.guard():
    mode = 'channel'
    prelu = fluid.PRelu(
       'prelu',
       mode=mode,
       param_attr=fluid.ParamAttr(initializer=fluid.initializer.Constant(1.0)))
    dy_rlt = prelu(fluid.dygraph.base.to_variable(inp_np))

save_persistables

SourceEnglish

• paddle.fluid.dygraph.savepersistables(_model_dict, dirname='save_dir', optimizers=None)
• 该函数把传入的层中所有参数以及优化器进行保存。

dirname 用于指定保存长期变量的目录。

• 参数:
• • model_dict (dict of Parameters) – 参数将会被保存，如果设置为None，不会处理。
  • dirname (str) – 目录路径
  • optimizers (fluid.Optimizer|list(fluid.Optimizer)|None) – 要保存的优化器。返回: None

代码示例

import paddle.fluid as fluid
 
ptb_model = PtbModel(
      hidden_size=hidden_size,
      vocab_size=vocab_size,
      num_layers=num_layers,
      num_steps=num_steps,
      init_scale=init_scale)
sgd = fluid.optimizer.SGD(learning_rate=0.01)
x_data = np.arange(12).reshape(4, 3).astype('int64')
y_data = np.arange(1, 13).reshape(4, 3).astype('int64')
x_data = x_data.reshape((-1, num_steps, 1))
y_data = y_data.reshape((-1, 1))
init_hidden_data = np.zeros(
      (num_layers, batch_size, hidden_size), dtype='float32')
init_cell_data = np.zeros(
      (num_layers, batch_size, hidden_size), dtype='float32')
x = to_variable(x_data)
y = to_variable(y_data)
init_hidden = to_variable(init_hidden_data)
init_cell = to_variable(init_cell_data)
dy_loss, last_hidden, last_cell = ptb_model(x, y, init_hidden,
                                              init_cell)
dy_loss.backward()
sgd.minimize(dy_loss)
ptb_model.clear_gradient()
param_path = "./my_paddle_model"
fluid.dygraph.save_persistables(ptb_model.state_dict(), dirname=param_path, sgd)

SpectralNorm

SourceEnglish

• class paddle.fluid.dygraph.SpectralNorm(name_scope, dim=0, power_iters=1, eps=1e-12, name=None)
• 该层计算了fc、conv1d、conv2d、conv3d层的权重参数的谱正则值，其参数应分别为2-D, 3-D, 4-D, 5-D。计算结果如下。

步骤1：生成形状为[H]的向量U,以及形状为[W]的向量V,其中H是输入权重的第 dim 个维度，W是剩余维度的乘积。

步骤2： power_iters 应该是一个正整数，用U和V迭代计算 power_iters 轮。

步骤3：计算 sigma(mathbf{W}) 并权重值归一化。

可参考: Spectral Normalization

• 参数：
• • name_scope (str)-该类的名称。
  • dim (int)-将输入（weight）重塑为矩阵之前应排列到第一个的维度索引，如果input（weight）是fc层的权重，则应设置为0；如果input（weight）是conv层的权重，则应设置为1，默认为0。
  • power_iters (int)-将用于计算spectral norm的功率迭代次数，默认值1。
  • eps (float)-epsilon用于计算规范中的数值稳定性，默认值为1e-12
  • name (str)-此层的名称，可选。返回：谱正则化后权重参数的张量变量

返回类型：Variable

代码示例：

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    x = numpy.random.random((2, 8, 32, 32)).astype('float32')
    spectralNorm = fluid.dygraph.nn.SpectralNorm('SpectralNorm', dim=1, power_iters=2)
    ret = spectralNorm(fluid.dygraph.base.to_variable(x))

to_variable

SourceEnglish

• paddle.fluid.dygraphto_variable(_value, block=None, name=None)

• 该函数会从ndarray创建一个variable。

• 参数：

• • value (ndarray) – 需要转换的numpy值
  • block (fluid.Block) – variable所在的block，默认为None
  • name (str) – variable的名称，默认为None返回： 从指定numpy创建的variable

返回类型：Variable

代码示例:

import numpy as np
import paddle.fluid as fluid
 
with fluid.dygraph.guard():
    x = np.ones([2, 2], np.float32)
    y = fluid.dygraph.to_variable(x)

TreeConv

SourceEnglish

• class paddle.fluid.dygraph.TreeConv(name_scope, output_size, num_filters=1, max_depth=2, act='tanh', param_attr=None, bias_attr=None, name=None)
• 基于树结构的卷积Tree-Based Convolution运算。

基于树的卷积是基于树的卷积神经网络（TBCNN，Tree-Based Convolution Neural Network）的一部分，它用于对树结构进行分类，例如抽象语法树。 Tree-Based Convolution提出了一种称为连续二叉树的数据结构，它将多路（multiway）树视为二叉树。提出 基于树的卷积论文

• 参数：
• • name_scope (str) – 该类的名称
  • output_size (int) – 输出特征宽度
  • num_filters (int) – filter数量，默认值1
  • max_depth (int) – filter的最大深度，默认值2
  • act (str) – 激活函数，默认 tanh
  • param_attr (ParamAttr) – filter的参数属性，默认None
  • bias_attr (ParamAttr) – 此层bias的参数属性，默认None
  • name (str) – 此层的名称（可选）。如果设置为None，则将自动命名层，默认为None返回： （Tensor）子树的特征向量。输出张量的形状是[max_tree_node_size，output_size，num_filters]。输出张量可以是下一个树卷积层的新特征向量

返回类型：out（Variable）

代码示例:

import paddle.fluid as fluid
import numpy
 
with fluid.dygraph.guard():
    nodes_vector = numpy.random.random((1, 10, 5)).astype('float32')
    edge_set = numpy.random.random((1, 9, 2)).astype('int32')
    treeConv = fluid.dygraph.nn.TreeConv(
      'TreeConv', output_size=6, num_filters=1, max_depth=2)
    ret = treeConv(fluid.dygraph.base.to_variable(nodes_vector), fluid.dygraph.base.to_variable(edge_set))