DynamicRNN
- class
paddle.fluid.layers.
DynamicRNN
(name=None)[源代码]
注意:该类型的输入仅支持LoDTensor,如果您需要处理的输入数据是Tensor类型, 请使用StaticRNN( fluid.layers. StaticRNN )。
DynamicRNN可以处理一批序列数据,其中每个样本序列的长度可以不同,每个序列的长度信息记录在LoD里面。 DynamicRNN会按照时间步 (time step) 将输入序列展开,用户可以在 block
中定义每个时间步要进行的运算。 由于每个输入样本的序列长度不相同,RNN执行的step数由最长的序列决定。 DynamicRNN的实现采用非padding的方式,每个时间步都会对输入数据进行收缩处理,移除已经处理完的序列的信息。 因此,随着时间步的增加,每个时间步处理的样本数(batch size)会逐渐减少。
警告
目前不支持在DynamicRNN的 block
中任何层上配置 is_sparse = True
。
- 参数:
- name (str,可选) - 具体用法参见 Name ,一般无需设置,默认值为None。
- 成员函数列表:
- 成员函数 step_input ,设置输入变量
- 成员函数 static_input ,设置静态输入变量
- 成员函数 block ,定义每个时间步执行的运算
- 成员函数 memory ,创建用于在时间步之间传递信息的变量
- 成员函数 update_memory ,更新需要传递的时间步信息
- 成员函数 output ,设置时间步的输出变量
- 成员函数 call ,获取RNN的输出序列
成员函数 step_input
step_input
(x, level=0)
将序列x设置为DynamicRNN输入。输入序列中最长的序列长度,将决定了RNN运算的长度。 必须至少为DynamicRNN设置一个输入,也可以设置多个输入。 如果多个输入x的 x.lod_level
都为1,则要求多个输入LoDTensor携带完全相同的LoD信息。 当输入x的 x.lod_level >= 2
时,输入序列将按指定level进行展开,每个时间步携带 x.lod_level - level - 1
层LoD信息, 此时要求多个输入序列的LoD在指定level上的信息完全一样。
- 示例1
- # 输入,其中Si代表维度为[1, N]的数据
- level = 0
- x.lod = [[2, 1, 3]]
- x.shape = [6, N]
- x.data = [[S0],
- [S0],
- [S1],
- [S2],
- [S2],
- [S2]]
- # 输出
- # step 0,持有3个序列的time step数据
- out.lod = [[]]
- out.shape = [3, N]
- out.data = [[S2],
- [S0],
- [S1]]
- # step 1,持有2个序列的time step数据
- out.lod = [[]]
- out.shape = [2, N]
- out.data = [[S2],
- [S0]]
- # step 2,持有1个序列的time step数据
- out.lod = [[]]
- out.shape = [1, N]
- out.data = [[S2]]
- 参数:
- x (Variable) - 输入序列LoDTensor,代表由长度不同的多个序列组成的minibatch,要求
x.lod_level >= 1
。输入x第一个维度的值等于minibatch内所有序列的长度之和。RNN有多个输入序列时,多个输入LoDTensor的第一个维度必须相同,其它维度可以不同。支持的数据类型有:bool,float16,float32,float64,int8,int16,int32,int64,uint8。 - level (int,可选) - 用于拆分输入序列的LoD层级,取值范围是 ,默认值是0。
- x (Variable) - 输入序列LoDTensor,代表由长度不同的多个序列组成的minibatch,要求
返回: 输入序列每个时间步的数据。执行第 step_idx
个时间步时,若输入 x
中有 num_sequences
个长度不小于 step_idx
的序列,则这个时间步返回值中只包含了这 num_sequences
个序列第 step_idx
时间步的数据。数据类型和输入一致。如果 x.lod_level == 1
,返回值的维度是
。否则,返回值也是一个变长的LoDTensor。
返回类型:Variable
- 抛出异常:
ValueError
:当step_input()
接口在RNNblock()
接口外面被调用时。TypeError
:当输入x类型不是Variable时。
代码示例
- import paddle.fluid as fluid
- sentence = fluid.data(name='sentence', shape=[None, 1], dtype='int64', lod_level=1)
- embedding = fluid.layers.embedding(input=sentence, size=[65536, 32], is_sparse=True)
- drnn = fluid.layers.DynamicRNN()
- with drnn.block():
- # 将embedding标记为RNN的输入,每个时间步取句子中的一个字进行处理
- word = drnn.step_input(embedding)
- # 将memory初始化为一个值为0的常量Tensor,shape=[batch_size, 200],其中batch_size由输入embedding决定
- memory = drnn.memory(shape=[200])
- hidden = fluid.layers.fc(input=[word, memory], size=200, act='relu')
- # 用hidden更新memory
- drnn.update_memory(ex_mem=memory, new_mem=hidden)
- # 将hidden标记为RNN的输出
- drnn.output(hidden)
- # 获得RNN的计算结果
- rnn_output = drnn()
成员函数 static_input
static_input
(x)
将变量设置为RNN的静态输入。
- 示例1,静态输入携带LoD信息
- # RNN的输入见step_input中的示例
- # 静态输入,其中Si代表维度为[1, M]的数据
- x.lod = [[3, 1, 2]]
- x.shape = [6, M]
- x.data = [[S0],
- [S0],
- [S0],
- [S1],
- [S2],
- [S2]]
- # step 0,持有3个序列对应的数据
- out.lod = [[2, 3, 1]]
- out.shape = [6, M]
- out.data = [[S2],
- [S2],
- [S0],
- [S0],
- [S0],
- [S1]]
- # step 1,持有2个序列对应的数据
- out.lod = [[2, 3]]
- out.shape = [5, M]
- out.data = [[S2],
- [S2],
- [S0],
- [S0],
- [S0]]
- # step 2,持有1个序列对应的数据
- out.lod = [[2]]
- out.shape = [2, M]
- out.data = [[S2],
- [S2]]
- 示例2,静态输入不携带LoD信息
- # RNN的输入见step_input中的示例
- # 静态输入,其中Si代表维度为[1, M]的数据
- x.lod = [[]]
- x.shape = [3, M]
- x.data = [[S0],
- [S1],
- [S2]]
- # step 0,持有3个序列对应的数据
- out.lod = [[]]
- out.shape = [3, M]
- out.data = [[S2],
- [S0],
- [S1]]
- # step 1,持有2个序列对应的数据
- out.lod = [[]]
- out.shape = [2, M]
- out.data = [[S2],
- [S0]]
- # step 2,持有1个序列对应的数据
- out.lod = [[]]
- out.shape = [1, M]
- out.data = [[S2]]
- 参数:
- x (Variable) - 静态输入序列LoDTensor,要求持有与输入LoDTensor(通过
step_input
设置的输入)相同的序列个数。如果输入x的LoD信息为空,则会被当成由x.shape[0]
个长度为1序列组成。支持的数据类型有:bool,float16,float32,float64,int8,int16,int32,int64,uint8。
- x (Variable) - 静态输入序列LoDTensor,要求持有与输入LoDTensor(通过
返回: 经过按照RNN输入LoD信息重排序、且收缩处理后的静态输入LoDTensor。执行第 step_idx
个时间步时,如果输入序列中只有 num_sequences
长度不小于 step_idx
的序列,静态输入也会进行收缩处理,只返回对应的 num_sequences
个序列对应的数据。数据类型和输入一致。如果 x.lod == None
,返回值的维度是
。否则,返回值是一个变长的LoDTensor。
返回类型:Variable
- 抛出异常:
ValueError
:当static_input()
接口在RNNblock()
接口外面被调用时。TypeError
:当输入x类型不是Variable类型时。RuntimeError
:当static_input()
接口在step_input()
接口之前被调用时。
代码示例
- import paddle.fluid as fluid
- sentence = fluid.data(name='sentence', shape=[None, 32], dtype='float32', lod_level=1)
- encoder_proj = fluid.data(name='encoder_proj', shape=[None, 32], dtype='float32', lod_level=1)
- decoder_boot = fluid.data(name='boot', shape=[None, 10], dtype='float32')
- drnn = fluid.layers.DynamicRNN()
- with drnn.block():
- # 将sentence标记为RNN的输入,每个时间步取句子中的一个字进行处理
- current_word = drnn.step_input(sentence)
- # 将encode_proj标记为RNN的静态输入
- encoder_word = drnn.static_input(encoder_proj)
- # 使用boot_memory初始化memory,并且需要依据输入序列进行重排序
- memory = drnn.memory(init=decoder_boot, need_reorder=True)
- fc_1 = fluid.layers.fc(input=encoder_word, size=30)
- fc_2 = fluid.layers.fc(input=current_word, size=30)
- decoder_inputs = fc_1 + fc_2
- hidden, _, _ = fluid.layers.gru_unit(input=decoder_inputs, hidden=memory, size=30)
- # 用hidden更新memory
- drnn.update_memory(ex_mem=memory, new_mem=hidden)
- out = fluid.layers.fc(input=hidden, size=10, bias_attr=True, act='softmax')
- # 将out标记为RNN的输出
- drnn.output(out)
- # 获得RNN的计算结果
- rnn_output = drnn()
成员函数 block
block
()
定义每个时间步执行的操作。 block
语句里面定义的算子序列,将会被执行 max_sequence_len
次( max_sequence_len
是输入序列中大的序列长度)。
- 抛出异常:
ValueError
:当RNNblock()
接口被多次调用时。
成员函数 memory
memory
(init=None, shape=None, value=0.0, need_reorder=False, dtype='float32')
为RNN创建一个memory变量,用于在时间步之间传递信息。 它可以用一个已有的Tensor来初始化,也可以初始化为一个特定维度的常量Tensor。
- 参数:
- init (Variable,可选) – 设置memory初始值的LoDTensor。如果init不是None,将使用init来初始化memory,要求持有与输入LoDTensor(通过
step_input
设置的输入)相同的序列个数。如果输入init的LoD信息为空,则会被当成由init.shape[0]
个长度为1序列组成。默认值是None。 - shape (list|tuple,可选) – 当init是None时,用来设置memory的维度。注意:shape中不包含batch_size。若设置 ,memory Tensor的实际维度为 ,其中batch_size由输入序列决定。默认值是None。
- value (float,可选) – 当init是None时,用来设置memory的初始值。默认值是0.0。
- need_reorder (bool,可选) – 当init不是None时,用来决定init是否需要重新排序。动态RNN在计算时,会按照输入LoDTensor中序列的长度对输入进行排序,因此当init中的信息与输入序列样本紧密关联时,需要设置
need_reorder=True
。默认值是False。 - dtype (str|numpy.dtype,可选) – 当init是None是,初始化memory的数据类型。默认值是"float32"。可设置的字符串值有:"float32","float64","int32","int64"。
- init (Variable,可选) – 设置memory初始值的LoDTensor。如果init不是None,将使用init来初始化memory,要求持有与输入LoDTensor(通过
返回:经过收缩处理后的memory LoDTensor。执行第 step_idx
个时间步时,如果输入序列中只有 num_sequences
长度不小于 step_idx
的序列,memory也会进行收缩处理,只返回对应的 num_sequences
个序列对应的数据。
返回类型:Variable
- 抛出异常:
ValueError
:当memory()
接口在RNNblock()
接口外面被调用时。TypeError
:当init被设置了,但是不是Variable类型时。ValueError
:当memory()
接口在step_input()
接口之前被调用时。
代码示例一
- import paddle.fluid as fluid
- sentence = fluid.data(name='sentence', shape=[None, 32], dtype='float32', lod_level=1)
- boot_memory = fluid.data(name='boot', shape=[None, 10], dtype='float32')
- drnn = fluid.layers.DynamicRNN()
- with drnn.block():
- # 将sentence标记为RNN的输入,每个时间步取句子中的一个字进行处理
- word = drnn.step_input(sentence)
- # 使用boot_memory初始化memory,并且需要依据输入序列进行重排序
- memory = drnn.memory(init=boot_memory, need_reorder=True)
- hidden = fluid.layers.fc(input=[word, memory], size=10, act='tanh')
- # 用hidden更新memory
- drnn.update_memory(ex_mem=memory, new_mem=hidden)
- # 将hidden标记为RNN的输出
- drnn.output(hidden)
- # 获得RNN的计算结果
- rnn_output = drnn()
代码示例二
- import paddle.fluid as fluid
- sentence = fluid.data(name='sentence', shape=[None, 32], dtype='float32', lod_level=1)
- drnn = fluid.layers.DynamicRNN()
- with drnn.block():
- # 将sentence标记为RNN的输入,每个时间步取句子中的一个字进行处理
- word = drnn.step_input(sentence)
- # 将memory初始化为一个值为0的常量Tensor,shape=[batch_size, 10],其中batch_size由输入sentence决定
- memory = drnn.memory(shape=[10], dtype='float32', value=0)
- hidden = fluid.layers.fc(input=[word, memory], size=10, act='tanh')
- # 用hidden更新memory
- drnn.update_memory(ex_mem=memory, new_mem=hidden)
- # 将hidden标记为RNN的输出
- drnn.output(hidden)
- # 获得RNN的计算结果
- rnn_output = drnn()
成员函数 update_memory
update_memory
(ex_mem, new_mem)
将需要在时间步之间传递的信息更新。
- 参数:
- ex_mem (Variable) - 上一个时间步的信息。
- new_mem (Variable) - 新的时间步信息。
new_mem
的维度和数据类型必须与ex_mem
一致。
返回:无
- 抛出异常:
ValueError
:当update_memory()
接口在RNNblock()
接口外面被调用时。TypeError
:当ex_mem
或new_mem
不是Variable类型时。ValueError
:当ex_mem
不是使用memory()
接口定义的memory时。ValueError
:当update_memory()
接口在step_input()
接口之前被调用时。
成员函数 output
output
(*outputs)
设置outputs为RNN每个时间步的输出变量。
- 参数:
- *outputs (Variable …) - 输出Tensor,可同时将多个Variable标记为输出。
返回:无
- 抛出异常:
ValueError
:当output()
接口在RNNblock()
接口外面被调用时。
成员函数 call
__call__
()
获取RNN计算的输出序列。
若定义了 drnn = DynamicRNN()
,则可以调用 drnn()
获得输出序列,该输出序列是通过将每一个时间步的output数据合并得到的一个LoDTensor。 当RNN的输入x(通过 step_input()
接口设置)的 x.lod_level
为1时,该输出LoDTensor将会和输入x持有完全相同的LoD信息。 通过 drnn()
获取的RNN输出LoDTensor中包含了所有时间步的计算结果,可调用 sequence_last_step 获取最后一个时间步的计算结果。
- 参数:
- 无
返回:RNN的输出序列。
返回类型:Variable或Variable list
- 抛出异常:
ValueError
:当__call__()
接口在RNNblock()
定义之前被调用时。
代码示例
- import paddle.fluid as fluid
- sentence = fluid.data(name='sentence', shape=[None, 32], dtype='float32', lod_level=1)
- encoder_proj = fluid.data(name='encoder_proj', shape=[None, 32], dtype='float32', lod_level=1)
- decoder_boot = fluid.data(name='boot', shape=[None, 10], dtype='float32')
- drnn = fluid.layers.DynamicRNN()
- with drnn.block():
- # 将sentence标记为RNN的输入,每个时间步取句子中的一个字进行处理
- current_word = drnn.step_input(sentence)
- # 将encode_proj标记为RNN的静态输入
- encoder_word = drnn.static_input(encoder_proj)
- # 使用boot_memory初始化memory,并且需要依据输入序列进行重排序
- memory = drnn.memory(init=decoder_boot, need_reorder=True)
- fc_1 = fluid.layers.fc(input=encoder_word, size=30)
- fc_2 = fluid.layers.fc(input=current_word, size=30)
- decoder_inputs = fc_1 + fc_2
- hidden, _, _ = fluid.layers.gru_unit(input=decoder_inputs, hidden=memory, size=30)
- # 用hidden更新memory
- drnn.update_memory(ex_mem=memory, new_mem=hidden)
- out = fluid.layers.fc(input=hidden, size=10, bias_attr=True, act='softmax')
- # 将hidden和out标记为RNN的输出
- drnn.output(hidden, out)
- # 获得RNN的计算结果
- hidden, out = drnn()
- # 提取RNN最后一个时间步的计算结果
- last = fluid.layers.sequence_last_step(out)