Sequential 模型 API

在阅读这片文档前,请先阅读 Keras Sequential 模型指引


Sequential 模型方法

compile

compile(optimizer, loss=None, metrics=None, loss_weights=None, sample_weight_mode=None, weighted_metrics=None, target_tensors=None)

用于配置训练模型。

参数

  • optimizer: 字符串(优化器名)或者优化器对象。详见 optimizers
  • loss: 字符串(目标函数名)或目标函数或 Loss 实例。详见 losses。 如果模型具有多个输出,则可以通过传递损失函数的字典或列表,在每个输出上使用不同的损失。模型将最小化的损失值将是所有单个损失的总和。
  • metrics: 在训练和测试期间的模型评估标准。 通常你会使用 metrics = ['accuracy']。要为多输出模型的不同输出指定不同的评估标准, 还可以传递一个字典,如 metrics={'output_a': 'accuracy', 'output_b': ['accuracy', 'mse']}。 你也可以传递一个评估指标序列的序列 (len = len(outputs)) 例如 metrics=[['accuracy'], ['accuracy', 'mse']]metrics=['accuracy', ['accuracy', 'mse']]
  • loss_weights: 指定标量系数(Python浮点数)的可选列表或字典,用于加权不同模型输出的损失贡献。 模型将要最小化的损失值将是所有单个损失的加权和,由 loss_weights 系数加权。 如果是列表,则期望与模型的输出具有 1:1 映射。 如果是字典,则期望将输出名称(字符串)映射到标量系数。
  • sample_weight_mode: 如果你需要执行按时间步采样权重(2D 权重),请将其设置为 temporal。 默认为 None,为采样权重(1D)。如果模型有多个输出,则可以通过传递 mode 的字典或列表,以在每个输出上使用不同的 sample_weight_mode
  • weighted_metrics: 在训练和测试期间,由 sample_weight 或 class_weight 评估和加权的度量标准列表。
  • target_tensors: 默认情况下,Keras 将为模型的目标创建一个占位符,在训练过程中将使用目标数据。 相反,如果你想使用自己的目标张量(反过来说,Keras 在训练期间不会载入这些目标张量的外部 Numpy 数据), 您可以通过 target_tensors 参数指定它们。它应该是单个张量(对于单输出 Sequential 模型)。
  • **kwargs: 当使用 Theano/CNTK 后端时,这些参数被传入 K.function。当使用 TensorFlow 后端时,这些参数被传递到 tf.Session.run

异常

  • ValueError: 如果 optimizer, loss, metricssample_weight_mode 这些参数不合法。

fit

fit(x=None, y=None, batch_size=None, epochs=1, verbose=1, callbacks=None, validation_split=0.0, validation_data=None, shuffle=True, class_weight=None, sample_weight=None, initial_epoch=0, steps_per_epoch=None, validation_steps=None, validation_freq=1, max_queue_size=10, workers=1, use_multiprocessing=False)

以固定数量的轮次(数据集上的迭代)训练模型。

参数

  • x: 输入数据。可以是:
    • 一个 Numpy 数组(或类数组),或者数组的序列(如果模型有多个输入)。
    • 一个将名称匹配到对应数组/张量的字典,如果模型具有命名输入。
    • 一个返回 (inputs, targets)(inputs, targets, sample weights) 的生成器或 keras.utils.Sequence
    • None(默认),如果从本地框架张量馈送(例如 TensorFlow 数据张量)。
  • y: 目标数据。与输入数据 x 类似,它可以是 Numpy 数组(序列)、 本地框架张量(序列)、Numpy数组序列(如果模型有多个输出) 或 None(默认)如果从本地框架张量馈送(例如 TensorFlow 数据张量)。 如果模型输出层已命名,你也可以传递一个名称匹配 Numpy 数组的字典。 如果 x 是一个生成器,或 keras.utils.Sequence 实例,则不应该 指定 y(因为目标可以从 x 获得)。
  • batch_size: 整数或 None。每次梯度更新的样本数。如果未指定,默认为 32。 如果你的数据是符号张量、生成器或 Sequence 实例形式,不要指定 batch_size, 因为它们会生成批次。
  • epochs: 整数。训练模型迭代轮次。一个轮次是在整个 xy 上的一轮迭代。 请注意,与 initial_epoch 一起,epochs 被理解为「最终轮次」。 模型并不是训练了 epochs 轮,而是到第 epochs 轮停止训练。
  • verbose: 整数,0, 1 或 2。日志显示模式。 0 = 安静模式, 1 = 进度条, 2 = 每轮一行。
  • callbacks: 一系列的 keras.callbacks.Callback 实例。一系列可以在训练和验证(如果有)时使用的回调函数。 详见 callbacks
  • validation_split: 0 和 1 之间的浮点数。用作验证集的训练数据的比例。 模型将分出一部分不会被训练的验证数据,并将在每一轮结束时评估这些验证数据的误差和任何其他模型指标。 验证数据是混洗之前 xy 数据的最后一部分样本中。 这个参数在 x 是生成器或 Sequence 实例时不支持。
  • validation_data: 用于在每个轮次结束后评估损失和任意指标的数据。 模型不会在这个数据上训练。validation_data 会覆盖 validation_splitvalidation_data 可以是:

    • 元组 (x_val, y_val) 或 Numpy 数组或张量
    • 元组 (x_val, y_val, val_sample_weights) 或 Numpy 数组。
    • 数据集或数据集迭代器。

    对于前两种情况,必须提供 batch_size。 对于最后一种情况,必须提供 validation_steps

  • shuffle: 布尔值(是否在每轮迭代之前混洗数据)或者字符串 (batch)。 batch 是处理 HDF5 数据限制的特殊选项,它对一个 batch 内部的数据进行混洗。 当 steps_per_epochNone 时,这个参数无效。

  • class_weight: 可选的字典,用来映射类索引(整数)到权重(浮点)值,用于加权损失函数(仅在训练期间)。 这可能有助于告诉模型「更多关注」来自代表性不足的类的样本。
  • sample_weight: 训练样本的可选 Numpy 权重数组,用于对损失函数进行加权(仅在训练期间)。 你可以传递与输入样本长度相同的平坦(1D)Numpy 数组(权重和样本之间的 1:1 映射), 或者在时序数据的情况下,可以传递尺寸为 (samples, sequence_length) 的 2D 数组,以对每个样本的每个时间步施加不同的权重。 在这种情况下,你应该确保在 compile() 中指定 sample_weight_mode="temporal"。 这个参数在 x 是生成器或 Sequence 实例时不支持,应该提供 sample_weights 作为 x 的第 3 元素。
  • initial_epoch: 整数。开始训练的轮次(有助于恢复之前的训练)。
  • steps_per_epoch: 整数或 None。 在声明一个轮次完成并开始下一个轮次之前的总步数(样品批次)。 使用 TensorFlow 数据张量等输入张量进行训练时,默认值 None 等于数据集中样本的数量除以 batch 的大小,如果无法确定,则为 1。
  • validation_steps: 只有在提供了 validation_data 并且时一个生成器时才有用。 表示在每个轮次结束时执行验证时,在停止之前要执行的步骤总数(样本批次)。
  • validation_freq: 只有在提供了验证数据时才有用。整数或列表/元组/集合。 如果是整数,指定在新的验证执行之前要执行多少次训练,例如,validation_freq=2 在每 2 轮训练后执行验证。 如果是列表、元组或集合,指定执行验证的轮次,例如,validation_freq=[1, 2, 10] 表示在第 1、2、10 轮训练后执行验证。
  • max_queue_size: 整数。仅用于生成器或 keras.utils.Sequence 输入。 生成器队列的最大尺寸。若未指定,max_queue_size 将默认为 10。
  • workers: 整数。仅用于生成器或 keras.utils.Sequence 输入。 当使用基于进程的多线程时的最大进程数。若未指定,workers 将默认为 1。若为 0,将在主线程执行生成器。
  • use_multiprocessing: 布尔值。仅用于生成器或 keras.utils.Sequence 输入。 如果是 True,使用基于进程的多线程。若未指定,use_multiprocessing 将默认为 False。 注意由于这个实现依赖于 multiprocessing,你不应该像生成器传递不可选的参数,因为它们不能轻松地传递给子进程。
  • **kwargs: 用于向后兼容。

返回

一个 History 对象。其 History.history 属性是连续 epoch 训练损失和评估值,以及验证集损失和评估值的记录(如果适用)。

异常

  • RuntimeError: 如果模型从未编译。
  • ValueError: 在提供的输入数据与模型期望的不匹配的情况下。

evaluate

evaluate(x=None, y=None, batch_size=None, verbose=1, sample_weight=None, steps=None, callbacks=None, max_queue_size=10, workers=1, use_multiprocessing=False)

在测试模式,返回误差值和评估标准值。

计算逐批次进行。

参数

  • x: 输入数据。可以是:
    • 一个 Numpy 数组(或类数组),或者数组的序列(如果模型有多个输入)。
    • 一个将名称匹配到对应数组/张量的字典,如果模型具有命名输入。
    • 一个返回 (inputs, targets)(inputs, targets, sample weights) 的生成器或 keras.utils.Sequence
    • None(默认),如果从本地框架张量馈送(例如 TensorFlow 数据张量)。
  • y: 目标数据。与输入数据 x 类似,它可以是 Numpy 数组(序列)、 本地框架张量(序列)、Numpy数组序列(如果模型有多个输出) 或 None(默认)如果从本地框架张量馈送(例如 TensorFlow 数据张量)。 如果模型输出层已命名,你也可以传递一个名称匹配 Numpy 数组的字典。 如果 x 是一个生成器,或 keras.utils.Sequence 实例,则不应该 指定 y(因为目标可以从 x 获得)。
  • batch_size: 整数或 None。每次梯度更新的样本数。如果未指定,默认为 32。 如果你的数据是符号张量、生成器或 Sequence 实例形式,不要指定 batch_size, 因为它们会生成批次。
  • verbose: 0, 1。日志显示模式。0 = 安静模式, 1 = 进度条。
  • sample_weight: 训练样本的可选 Numpy 权重数组,用于对损失函数进行加权。 你可以传递与输入样本长度相同的平坦(1D)Numpy 数组(权重和样本之间的 1:1 映射), 或者在时序数据的情况下,可以传递尺寸为 (samples, sequence_length) 的 2D 数组,以对每个样本的每个时间步施加不同的权重。 在这种情况下,你应该确保在 compile() 中指定 sample_weight_mode="temporal"
  • steps: 整数或 None。 声明评估结束之前的总步数(批次样本)。默认值 None 时被忽略。
  • callbacks: 一系列的 keras.callbacks.Callback 实例。一系列可以在评估时使用的回调函数。 详见 callbacks
  • max_queue_size: 整数。仅用于生成器或 keras.utils.Sequence 输入。 生成器队列的最大尺寸。若未指定,max_queue_size 将默认为 10。
  • workers: 整数。仅用于生成器或 keras.utils.Sequence 输入。 当使用基于进程的多线程时的最大进程数。若未指定,workers 将默认为 1。若为 0,将在主线程执行生成器。
  • use_multiprocessing: 布尔值。仅用于生成器或 keras.utils.Sequence 输入。 如果是 True,使用基于进程的多线程。若未指定,use_multiprocessing 将默认为 False。 注意由于这个实现依赖于 multiprocessing,你不应该像生成器传递不可选的参数,因为它们不能轻松地传递给子进程。

异常

  • ValueError: 若参数非法。

返回

标量测试误差(如果模型只有单个输出且没有评估指标)或标量列表(如果模型具有多个输出和/或指标)。 属性 model.metrics_names 将提供标量输出的显示标签。


predict

predict(x, batch_size=None, verbose=0, steps=None, callbacks=None, max_queue_size=10, workers=1, use_multiprocessing=False)

为输入样本生成输出预测。

计算逐批次进行。

参数

  • x: 输入数据。可以是:
    • 一个 Numpy 数组(或类数组),或者数组的序列(如果模型有多个输入)。
    • 一个将名称匹配到对应数组/张量的字典,如果模型具有命名输入。
    • 一个返回 (inputs, targets)(inputs, targets, sample weights) 的生成器或 keras.utils.Sequence
    • None(默认),如果从本地框架张量馈送(例如 TensorFlow 数据张量)。
  • batch_size: 整数或 None。每次梯度更新的样本数。如果未指定,默认为 32。 如果你的数据是符号张量、生成器或 Sequence 实例形式,不要指定 batch_size, 因为它们会生成批次。
  • verbose: 日志显示模式,0 或 1。
  • steps: 声明预测结束之前的总步数(批次样本)。默认值 None 时被忽略。
  • callbacks: 一系列的 keras.callbacks.Callback 实例。一系列可以在预测时使用的回调函数。 详见 callbacks
  • max_queue_size: 整数。仅用于生成器或 keras.utils.Sequence 输入。 生成器队列的最大尺寸。若未指定,max_queue_size 将默认为 10。
  • workers: 整数。仅用于生成器或 keras.utils.Sequence 输入。 当使用基于进程的多线程时的最大进程数。若未指定,workers 将默认为 1。若为 0,将在主线程执行生成器。
  • use_multiprocessing: 布尔值。仅用于生成器或 keras.utils.Sequence 输入。 如果是 True,使用基于进程的多线程。若未指定,use_multiprocessing 将默认为 False。 注意由于这个实现依赖于 multiprocessing,你不应该像生成器传递不可选的参数,因为它们不能轻松地传递给子进程。

返回

预测的 Numpy 数组。

异常

  • ValueError: 如果提供的输入数据与模型的期望数据不匹配,或者有状态模型收到的数量不是批量大小的倍数。

train_on_batch

train_on_batch(x, y, sample_weight=None, class_weight=None, reset_metrics=True)

一批样品的单次梯度更新。

Arguments

  • x: 训练数据的 Numpy 数组(如果模型只有一个输入), 或者是 Numpy 数组的列表(如果模型有多个输入)。 如果模型中的输入层被命名,你也可以传递一个字典,将输入层名称映射到 Numpy 数组。
  • y: 目标(标签)数据的 Numpy 数组,或 Numpy 数组的列表(如果模型具有多个输出)。 如果模型中的输出层被命名,你也可以传递一个字典,将输出层名称映射到 Numpy 数组。
  • sample_weight: 可选数组,与 x 长度相同,包含应用到模型损失函数的每个样本的权重。 如果是时域数据,你可以传递一个尺寸为 (samples, sequence_length) 的 2D 数组, 为每一个样本的每一个时间步应用不同的权重。 在这种情况下,你应该在 compile() 中指定 sample_weight_mode="temporal"
  • class_weight: 可选的字典,用来映射类索引(整数)到权重(浮点)值,以在训练时对模型的损失函数加权。 这可能有助于告诉模型 「更多关注」来自代表性不足的类的样本。
  • reset_metrics: 如果为 True,返回的指标仅适用于该批次。 如果为 False,则指标将在批次之间有状态地累积。

返回

标量训练误差(如果模型只有单个输出且没有评估指标)或标量列表(如果模型具有多个输出和/或指标)。 属性 model.metrics_names 将提供标量输出的显示标签。


test_on_batch

test_on_batch(x, y, sample_weight=None)

在一批样本上评估模型。

参数

  • x: 测试数据的 Numpy 数组(如果模型只有一个输入), 或者是 Numpy 数组的列表(如果模型有多个输入)。 如果模型中的输入层被命名,你也可以传递一个字典,将输入层名称映射到 Numpy 数组。
  • y: 目标(标签)数据的 Numpy 数组,或 Numpy 数组的列表(如果模型具有多个输出)。 如果模型中的输出层被命名,你也可以传递一个字典,将输出层名称映射到 Numpy 数组。
  • sample_weight: 可选数组,与 x 长度相同,包含应用到模型损失函数的每个样本的权重。 如果是时域数据,你可以传递一个尺寸为 (samples, sequence_length) 的 2D 数组, 为每一个样本的每一个时间步应用不同的权重。
  • reset_metrics: 如果为 True,返回的指标仅适用于该批次。 如果为 False,则指标将在批次之间有状态地累积。

返回

标量测试误差(如果模型只有单个输出且没有评估指标)或标量列表(如果模型具有多个输出和/或指标)。 属性 model.metrics_names 将提供标量输出的显示标签。


predict_on_batch

predict_on_batch(x)

返回一批样本的模型预测值。

参数

  • x: 输入数据,Numpy 数组或列表(如果模型有多输入)。

返回

预测值的 Numpy 数组。


fit_generator

fit_generator(generator, steps_per_epoch=None, epochs=1, verbose=1, callbacks=None, validation_data=None, validation_steps=None, validation_freq=1, class_weight=None, max_queue_size=10, workers=1, use_multiprocessing=False, shuffle=True, initial_epoch=0)

使用 Python 生成器或 Sequence 实例逐批生成的数据,按批次训练模型。

生成器与模型并行运行,以提高效率。 例如,这可以让你在 CPU 上对图像进行实时数据增强,以在 GPU 上训练模型。

keras.utils.Sequence 的使用可以保证数据的顺序, 以及当 use_multiprocessing=True 时 ,保证每个输入在每个 epoch 只使用一次。

参数

  • generator: 一个生成器,或者一个 Sequence (keras.utils.Sequence) 对象的实例, 以在使用多进程时避免数据的重复。 生成器的输出应该为以下之一:

    • (inputs, targets) 元组
    • (inputs, targets, sample_weights) 元组。

    这个元组(生成器的单个输出)组成了单个的 batch。 因此,这个元组中的所有数组长度必须相同(与这一个 batch 的大小相等)。 不同的 batch 可能大小不同。 例如,一个 epoch 的最后一个 batch 往往比其他 batch 要小, 如果数据集的尺寸不能被 batch size 整除。 生成器将无限地在数据集上循环。当运行到第 steps_per_epoch 时,记一个 epoch 结束。

  • steps_per_epoch: 整数。在声明一个 epoch 完成并开始下一个 epoch 之前从 generator 产生的总步数(批次样本)。 它通常应该等于 ceil(num_samples / batch_size)。 对于 Sequence,它是可选的:如果未指定,将使用len(generator) 作为步数。

  • epochs: 整数。训练模型的迭代总轮数。一个 epoch 是对所提供的整个数据的一轮迭代, 如 steps_per_epoch 所定义。注意,与 initial_epoch 一起使用, epoch 应被理解为「最后一轮」。模型没有经历由 epochs 给出的多次迭代的训练, 而仅仅是直到达到索引 epoch 的轮次。
  • verbose: 整数,0, 1 或 2。日志显示模式。 0 = 安静模式, 1 = 进度条, 2 = 每轮一行。
  • callbacks: 一系列的 keras.callbacks.Callback 实例。一系列可以在训练时使用的回调函数。 详见 callbacks
  • validation_data: 它可以是以下之一:

    • 验证数据的生成器或 Sequence 实例
    • (inputs, targets) 元组
    • (inputs, targets, sample_weights) 元组。

    在每个 epoch 结束时评估损失和任何模型指标。该模型不会对此数据进行训练。

  • validation_steps: 仅当 validation_data 是一个生成器时才可用。 表示在每一轮迭代末尾停止前从 validation_data 生成器生成地总步数(样本批次)。 它应该等于由 batch size 分割的验证数据集的样本数。 对于 Sequence 它是可选的:若未指定,将会使用 len(validation_data) 作为步数。

  • validation_freq: 只有在提供了验证数据时才有用。整数或 collections.Container 实例(例如列表、元组等)。 如果是整数,指定在新的验证执行之前要执行多少次训练,例如,validation_freq=2 在每 2 轮训练后执行验证。 如果是 Container,指定执行验证的轮次,例如,validation_freq=[1, 2, 10] 表示在第 1、2、10 轮训练后执行验证。
  • class_weight: 可选的将类索引(整数)映射到权重(浮点)值的字典,用于加权损失函数(仅在训练期间)。 这可以用来告诉模型「更多地关注」来自代表性不足的类的样本。
  • max_queue_size: 整数。仅用于生成器或 keras.utils.Sequence 输入。 生成器队列的最大尺寸。若未指定,max_queue_size 将默认为 10。
  • workers: 整数。仅用于生成器或 keras.utils.Sequence 输入。 当使用基于进程的多线程时的最大进程数。若未指定,workers 将默认为 1。若为 0,将在主线程执行生成器。
  • use_multiprocessing: 布尔值。仅用于生成器或 keras.utils.Sequence 输入。 如果是 True,使用基于进程的多线程。若未指定,use_multiprocessing 将默认为 False。 注意由于这个实现依赖于 multiprocessing,你不应该像生成器传递不可选的参数,因为它们不能轻松地传递给子进程。
  • shuffle: 布尔值。是否在每轮迭代之前打乱 batch 的顺序。 只能与 Sequence (keras.utils.Sequence) 实例同用。 当 steps_per_epochNone 是无效。
  • initial_epoch: 整数。开始训练的轮次(有助于恢复之前的训练)。

返回

一个 History 对象。其 History.history 属性是连续 epoch 训练损失和评估值,以及验证集损失和评估值的记录(如果适用)。

异常

  • ValueError: 如果生成器生成的数据格式不正确。

示例

def generate_arrays_from_file(path):
    while True:
        with open(path) as f:
            for line in f:
                # 从文件中的每一行生成输入数据和标签的 numpy 数组
                x1, x2, y = process_line(line)
                    yield ({'input_1': x1, 'input_2': x2}, {'output': y})

model.fit_generator(generate_arrays_from_file('/my_file.txt'),
                    steps_per_epoch=10000, epochs=10)

evaluate_generator

evaluate_generator(generator, steps=None, callbacks=None, max_queue_size=10, workers=1, use_multiprocessing=False, verbose=0)

在数据生成器上评估模型。

这个生成器应该返回与 test_on_batch 所接收的同样的数据。

参数

  • generator: 一个生成 (inputs, targets)(inputs, targets, sample_weights) 的生成器, 或一个 Sequence (keras.utils.Sequence) 对象的实例,以避免在使用多进程时数据的重复。
  • steps: 在声明一个 epoch 完成并开始下一个 epoch 之前从 generator 产生的总步数(批次样本)。 它通常应该等于你的数据集的样本数量除以批量大小。 对于 Sequence,它是可选的:如果未指定,将使用len(generator) 作为步数。
  • callbacks: 一系列的 keras.callbacks.Callback 实例。一系列可以在评估时使用的回调函数。 详见 callbacks
  • max_queue_size: 生成器队列的最大尺寸。
  • workers: 整数。使用的最大进程数量,如果使用基于进程的多线程。 如未指定,workers 将默认为 1。如果为 0,将在主线程上执行生成器。
  • use_multiprocessing: 布尔值。如果 True,则使用基于进程的多线程。 请注意,由于此实现依赖于多进程,所以不应将不可传递的参数传递给生成器,因为它们不能被轻易地传递给子进程。
  • verbose: 日志显示模式,0 或 1。

返回

标量测试误差(如果模型只有单个输出且没有评估指标)或标量列表(如果模型具有多个输出和/或指标)。 属性 model.metrics_names 将提供标量输出的显示标签。

异常

  • ValueError: 如果生成器生成的数据格式不正确。

predict_generator

predict_generator(generator, steps=None, callbacks=None, max_queue_size=10, workers=1, use_multiprocessing=False, verbose=0)

为来自数据生成器的输入样本生成预测。

这个生成器应该返回与 predict_on_batch 所接收的同样的数据。

参数

  • generator: 生成器,返回批量输入样本, 或一个 Sequence (keras.utils.Sequence) 对象的实例,以避免在使用多进程时数据的重复。
  • steps: 在声明一个 epoch 完成并开始下一个 epoch 之前从 generator 产生的总步数(批次样本)。 它通常应该等于你的数据集的样本数量除以批量大小。 对于 Sequence,它是可选的:如果未指定,将使用len(generator) 作为步数。
  • callbacks: 一系列的 keras.callbacks.Callback 实例。一系列可以在预测时使用的回调函数。 详见 callbacks
  • max_queue_size: 生成器队列的最大尺寸。
  • max_queue_size: 生成器队列的最大尺寸。
  • workers: 整数。使用的最大进程数量,如果使用基于进程的多线程。 如未指定,workers 将默认为 1。如果为 0,将在主线程上执行生成器。
  • use_multiprocessing: 如果 True,则使用基于进程的多线程。 请注意,由于此实现依赖于多进程,所以不应将不可传递的参数传递给生成器,因为它们不能被轻易地传递给子进程。
  • verbose: 日志显示模式,0 或 1。

返回

预测值的 Numpy 数组。

异常

  • ValueError: 如果生成器生成的数据格式不正确。

get_layer

get_layer(name=None, index=None)

根据名称(唯一)或索引值查找网络层。

如果同时提供了 nameindex,则 index 将优先。

根据网络层的名称(唯一)或其索引返回该层。索引是基于水平图遍历的顺序(自下而上)。

参数

  • name: 字符串,层的名字。
  • index: 整数,层的索引。

返回

一个层实例。

异常

  • ValueError: 如果层的名称或索引不正确。