► Keras 3 API 文档 / 层 API / 循环层 / 基本 RNN 层

基本 RNN 层

`RNN` 类

keras.layers.RNN(
    cell,
    return_sequences=False,
    return_state=False,
    go_backwards=False,
    stateful=False,
    unroll=False,
    zero_output_for_mask=False,
    **kwargs
)

循环层基类。

参数

cell：一个 RNN 单元实例或一个 RNN 单元实例列表。RNN 单元是一个具有以下功能的类：
- 一个 call(input_at_t, states_at_t) 方法，返回 (output_at_t, states_at_t_plus_1)。单元的 call 方法还可以接受可选参数 constants，详见下文“关于传递外部常量”部分。
- 一个 state_size 属性。这可以是一个单一整数（单一状态），在这种情况下它表示循环状态的大小。这也可以是一个整数列表/元组（每个状态一个大小）。
- 一个 output_size 属性，一个单一整数。
- 一个 get_initial_state(batch_size=None) 方法，用于创建要作为初始状态输入到 call() 的张量，如果用户没有通过其他方式指定任何初始状态。返回的初始状态应具有形状 (batch_size, cell.state_size)。单元可以选择创建一个全零张量，或根据单元的实现创建其他值。inputs 是 RNN 层的输入张量，形状为 (batch_size, timesteps, features)。如果单元未实现此方法，则 RNN 层将创建一个形状为 (batch_size, cell.state_size) 的全零张量。如果 cell 是一个 RNN 单元实例列表，则这些单元将在 RNN 中堆叠在一起，从而形成高效的堆叠 RNN。
return_sequences：布尔值（默认为 False）。是否返回输出序列中的最后一个输出，或返回完整序列。
return_state：布尔值（默认为 False）。除了输出之外，是否返回最后一个状态。
go_backwards：布尔值（默认为 False）。如果为 True，则反向处理输入序列并返回反向序列。
stateful：布尔值（默认为 False）。如果为 True，则批次中索引 i 处每个样本的最后一个状态将用作下一个批次中索引 i 处样本的初始状态。
unroll：布尔值（默认为 False）。如果为 True，则网络将被展开，否则将使用符号循环。展开可以加速 RNN，尽管它往往更占用内存。展开只适用于短序列。
zero_output_for_mask：布尔值（默认为 False）。掩码时间步的输出是否应使用零。请注意，此字段仅在 return_sequences 为 True 且提供了 mask 时使用。如果您希望在不受掩码时间步干扰的情况下重用 RNN 的原始输出序列（例如，合并双向 RNN），这会很有用。

调用参数

sequences：一个形状为 (batch_size, timesteps, features) 的 3D 张量。
initial_state：要传递给单元第一次调用的初始状态张量列表。
mask：形状为 [batch_size, timesteps] 的二元张量，指示是否应掩码给定时间步。单个 True 条目表示应使用相应的时间步，而 False 条目表示应忽略相应的时间步。
training：Python 布尔值，指示该层应在训练模式还是推断模式下运行。此参数在调用单元时传递给单元。这适用于使用 dropout 的单元。

输出形状

如果 return_state 为 True：张量列表。第一个张量是输出。其余张量是最后一个状态，每个状态的形状为 (batch_size, state_size)，其中 state_size 可以是高维张量形状。
如果 return_sequences 为 True：形状为 (batch_size, timesteps, output_size) 的 3D 张量。

掩码

此层支持对具有可变时间步数的输入数据进行掩码。要为数据引入掩码，请使用 keras.layers.Embedding 层，并将 mask_zero 参数设置为 True。

关于在 RNN 中使用有状态性的注意事项

您可以将 RNN 层设置为“有状态”，这意味着为一个批次中的样本计算的状态将作为下一个批次中样本的初始状态重复使用。这假定不同连续批次中的样本之间存在一对一映射。

启用有状态性

在层构造函数中指定 stateful=True。
通过将 batch_size=... 传递给模型的 Input 层，为模型指定固定批次大小。请记住在调用 fit() 时也要指定相同的 batch_size=...，或者使用类似生成器的数据源，例如 keras.utils.PyDataset 或 tf.data.Dataset。
调用 fit() 时指定 shuffle=False，因为您的批次预计是按时间顺序排列的。

要重置模型的状态，请在特定层或整个模型上调用 .reset_state()。

关于指定 RNN 初始状态的注意事项

您可以通过使用关键字参数 initial_state 调用 RNN 层来符号化地指定它们的初始状态。initial_state 的值应该是一个张量或张量列表，表示 RNN 层的初始状态。

您可以通过使用关键字参数 states 调用 reset_state() 来数值化地指定 RNN 层的初始状态。states 的值应该是一个 numpy 数组或 numpy 数组列表，表示 RNN 层的初始状态。

示例

from keras.layers import RNN
from keras import ops

# First, let's define a RNN Cell, as a layer subclass.
class MinimalRNNCell(keras.Layer):

    def __init__(self, units, **kwargs):
        super().__init__(**kwargs)
        self.units = units
        self.state_size = units

    def build(self, input_shape):
        self.kernel = self.add_weight(shape=(input_shape[-1], self.units),
                                      initializer='uniform',
                                      name='kernel')
        self.recurrent_kernel = self.add_weight(
            shape=(self.units, self.units),
            initializer='uniform',
            name='recurrent_kernel')

    def call(self, inputs, states):
        prev_output = states[0]
        h = ops.matmul(inputs, self.kernel)
        output = h + ops.matmul(prev_output, self.recurrent_kernel)
        return output, [output]

# Let's use this cell in a RNN layer:

cell = MinimalRNNCell(32)
x = keras.Input((None, 5))
layer = RNN(cell)
y = layer(x)

# Here's how to use the cell to build a stacked RNN:

cells = [MinimalRNNCell(32), MinimalRNNCell(64)]
x = keras.Input((None, 5))
layer = RNN(cells)
y = layer(x)

基本 RNN 层

RNN 类

基本 RNN 层

RNN 类

`RNN` 类