Keras 3 API 文档 / 回调 API / ModelCheckpoint

ModelCheckpoint

[源代码]

ModelCheckpoint

keras.callbacks.ModelCheckpoint(
    filepath,
    monitor="val_loss",
    verbose=0,
    save_best_only=False,
    save_weights_only=False,
    mode="auto",
    save_freq="epoch",
    initial_value_threshold=None,
)

用于按一定频率保存 Keras 模型或模型权重的回调。

ModelCheckpoint 回调与使用 model.fit() 进行训练结合使用,以按一定间隔保存模型或权重(在检查点文件中),以便稍后加载模型或权重,从保存的状态继续训练。

此回调提供的一些选项包括:

  • 是否仅保留到目前为止已实现“最佳性能”的模型,或者是否在每个 epoch 结束时保存模型,而无论性能如何。
  • “最佳”的定义;要监控的量以及应最大化还是最小化。
  • 应保存的频率。目前,回调支持在每个 epoch 结束时或在固定数量的训练批次后保存。
  • 是仅保存权重,还是保存整个模型。

示例

model.compile(loss=..., optimizer=...,
              metrics=['accuracy'])

EPOCHS = 10
checkpoint_filepath = '/tmp/ckpt/checkpoint.model.keras'
model_checkpoint_callback = keras.callbacks.ModelCheckpoint(
    filepath=checkpoint_filepath,
    monitor='val_accuracy',
    mode='max',
    save_best_only=True)

# Model is saved at the end of every epoch, if it's the best seen so far.
model.fit(epochs=EPOCHS, callbacks=[model_checkpoint_callback])

# The model (that are considered the best) can be loaded as -
keras.models.load_model(checkpoint_filepath)

# Alternatively, one could checkpoint just the model weights as -
checkpoint_filepath = '/tmp/ckpt/checkpoint.weights.h5'
model_checkpoint_callback = keras.callbacks.ModelCheckpoint(
    filepath=checkpoint_filepath,
    save_weights_only=True,
    monitor='val_accuracy',
    mode='max',
    save_best_only=True)

# Model weights are saved at the end of every epoch, if it's the best seen
# so far.
model.fit(epochs=EPOCHS, callbacks=[model_checkpoint_callback])

# The model weights (that are considered the best) can be loaded as -
model.load_weights(checkpoint_filepath)

参数

  • filepath:字符串或 PathLike,用于保存模型文件的路径。filepath 可以包含命名格式化选项,这些选项将填充 epoch 的值和 logs 中的键(在 on_epoch_end 中传递)。当 save_weights_only=True 时,filepath 名称需要以 ".weights.h5" 结尾;当检查点保存整个模型(默认)时,应以 ".keras"".h5" 结尾。例如:如果 filepath"{epoch:02d}-{val_loss:.2f}.keras" 或 "{epoch:02d}-{val_loss:.2f}.weights.h5"`,则模型检查点将与 epoch 编号和验证损失保存在文件名中。filepath 的目录不应被任何其他回调重用,以避免冲突。
  • monitor:要监控的指标名称。通常,指标由 Model.compile 方法设置。注意:
    • 在名称前加上 "val_" 以监控验证指标。
    • 使用 "loss""val_loss" 监控模型的总损失。
    • 如果将指标指定为字符串,例如 "accuracy",请传递相同的字符串(带或不带 "val_" 前缀)。
    • 如果传递 metrics.Metric 对象,则应将 monitor 设置为 metric.name
    • 如果不确定指标名称,可以检查 history = model.fit() 返回的 history.history 字典的内容。
    • 多输出模型在指标名称上设置额外的 prefixes(前缀)。
  • verbose:Verbose 模式,0 或 1。模式 0 为静默模式,模式 1 在回调采取操作时显示消息。
  • save_best_only:如果 save_best_only=True,则仅在模型被认为是“最佳”时保存,并且根据监控的量,最新的最佳模型将不会被覆盖。如果 filepath 不包含像 {epoch} 这样的格式化选项,则 filepath 将被每个新的更好模型覆盖。
  • mode:{"auto", "min", "max"} 之一。如果 save_best_only=True,则基于监控量的最大化或最小化来决定是否覆盖当前保存文件。对于 val_acc,这应为 "max";对于 val_loss,这应为 "min",等等。在 "auto" 模式下,如果监控的量为 "acc" 或以 "fmeasure" 开头,则模式设置为 "max";对于其余量,则设置为 "min"
  • save_weights_only:如果为 True,则仅保存模型的权重 (model.save_weights(filepath));否则,保存整个模型 (model.save(filepath))。
  • save_freq"epoch" 或整数。当使用 "epoch" 时,回调在每个 epoch 后保存模型。当使用整数时,回调在此批次数结束后保存模型。如果 Model 使用 steps_per_execution=N 编译,则每 N 个批次检查一次保存标准。请注意,如果保存未与 epoch 对齐,则监控的指标可能不太可靠(它可能仅反映 1 个批次,因为指标在每个 epoch 都会重置)。默认为 "epoch"
  • initial_value_threshold:浮点型初始“最佳”值,用于监控的指标。仅在 save_best_value=True 时适用。仅当当前模型的性能优于此值时,才会覆盖已保存的模型权重。