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() 進行的訓練結合使用,以一定的間隔儲存模型或權重(在檢查點檔案中),以便稍後可以載入模型或權重,從儲存的狀態繼續訓練。

此回呼函式提供的一些選項包括:

  • 是否只保留到目前為止達到「最佳效能」的模型,或者是否在每個週期結束時儲存模型,無論效能如何。
  • 「最佳」的定義;要監控的數量以及應該最大化還是最小化。
  • 應該儲存的頻率。目前,此回呼函式支援在每個週期結束時或在固定數量的訓練批次之後儲存。
  • 是否僅儲存權重,還是儲存整個模型。

範例

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"`,則模型檢查點將以週期編號和驗證損失儲存在檔案名稱中。檔案路徑的目錄不應由任何其他回呼函式重複使用,以避免衝突。
  • monitor:要監控的評估指標名稱。通常,評估指標由 Model.compile 方法設定。注意:
    • 在名稱前面加上 "val_" 來監控驗證評估指標。
    • 使用 "loss""val_loss" 來監控模型的總損失。
    • 如果您將評估指標指定為字串,例如 "accuracy",則傳遞相同的字串(帶或不帶 "val_" 前綴)。
    • 如果您傳遞 metrics.Metric 物件,則 monitor 應設定為 metric.name
    • 如果您不確定評估指標名稱,可以檢查 history = model.fit() 返回的 history.history 字典的內容。
    • 多輸出模型會在評估指標名稱上設定額外的前綴。
  • 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" 時,回呼函式會在每個週期之後儲存模型。使用整數時,回呼函式會在這麼多批次結束時儲存模型。如果 Model 是使用 steps_per_execution=N 編譯的,則每第 N 個批次都會檢查儲存條件。請注意,如果儲存未與週期對齊,則監控的評估指標可能不太可靠(它可能僅反映 1 個批次,因為評估指標會在每個週期重設)。預設值為 "epoch"
  • initial_value_threshold:要監控的評估指標的浮點數初始「最佳」值。僅在 save_best_value=True 時適用。只有當目前模型的效能優於此值時,才會覆蓋已儲存的模型權重。