トレーニングチェックポイント

TensorFlow.orgで見る

Google Colabで実行

GitHubでソースを表示する

ノートブックをダウンロード

「TensorFlowモデルを保存する」というフレーズは通常、次の2つのいずれかを意味します。

1. チェックポイント、または
2. SavedModel。

チェックポイントは、モデルで使用されるすべてのパラメーター（ tf.Variableオブジェクト）の正確な値をキャプチャします。チェックポイントには、モデルによって定義された計算の説明が含まれていないため、通常、保存されたパラメーター値を使用するソースコードが利用可能な場合にのみ役立ちます。

一方、SavedModel形式には、パラメーター値（チェックポイント）に加えて、モデルによって定義された計算のシリアル化された記述が含まれています。この形式のモデルは、モデルを作成したソースコードから独立しています。したがって、TensorFlow Serving、TensorFlow Lite、TensorFlow.js、または他のプログラミング言語のプログラム（C、C ++、Java、Go、Rust、C＃などのTensorFlow API）を介したデプロイに適しています。

このガイドでは、チェックポイントの書き込みと読み取りのためのAPIについて説明します。

セットアップ

import tensorflow as tf

class Net(tf.keras.Model):
  """A simple linear model."""

  def __init__(self):
    super(Net, self).__init__()
    self.l1 = tf.keras.layers.Dense(5)

  def call(self, x):
    return self.l1(x)

net = Net()

tf.kerasトレーニングAPIからの保存

保存と復元については、 tf.kerasガイドを参照してください。

tf.keras.Model.save_weightsはTensorFlowチェックポイントを保存します。

net.save_weights('easy_checkpoint')

チェックポイントの作成

TensorFlowモデルの永続的な状態は、 tf.Variableオブジェクトに格納されます。これらは直接構築できますが、多くの場合、 tf.keras.layersやtf.keras.Modelなどの高レベルAPIを介して作成されます。

変数を管理する最も簡単な方法は、変数をPythonオブジェクトにアタッチし、それらのオブジェクトを参照することです。

tf.train.Checkpoint 、 tf.keras.layers.Layer 、およびtf.keras.Modelサブクラスは、それらの属性に割り当てられた変数を自動的に追跡します。次の例では、単純な線形モデルを作成し、モデルのすべての変数の値を含むチェックポイントを書き込みます。

Model.save_weightsモデルチェックポイントを簡単に保存できます

手動チェックポイント

セットアップ

tf.train.Checkpointすべての機能をtf.train.Checkpointするために、おもちゃのデータセットと最適化ステップを定義します。

def toy_dataset():
  inputs = tf.range(10.)[:, None]
  labels = inputs * 5. + tf.range(5.)[None, :]
  return tf.data.Dataset.from_tensor_slices(
    dict(x=inputs, y=labels)).repeat().batch(2)

def train_step(net, example, optimizer):
  """Trains `net` on `example` using `optimizer`."""
  with tf.GradientTape() as tape:
    output = net(example['x'])
    loss = tf.reduce_mean(tf.abs(output - example['y']))
  variables = net.trainable_variables
  gradients = tape.gradient(loss, variables)
  optimizer.apply_gradients(zip(gradients, variables))
  return loss

チェックポイントオブジェクトを作成する

チェックポイントを手動で作成するには、 tf.train.Checkpointオブジェクトが必要です。チェックポイントを設定するオブジェクトがオブジェクトの属性として設定されている場所。

tf.train.CheckpointManagerは、複数のチェックポイントの管理にも役立ちます。

opt = tf.keras.optimizers.Adam(0.1)
dataset = toy_dataset()
iterator = iter(dataset)
ckpt = tf.train.Checkpoint(step=tf.Variable(1), optimizer=opt, net=net, iterator=iterator)
manager = tf.train.CheckpointManager(ckpt, './tf_ckpts', max_to_keep=3)

モデルのトレーニングとチェックポイント

次のトレーニングループは、モデルとオプティマイザのインス​​タンスを作成し、それらをtf.train.Checkpointオブジェクトに収集します。データの各バッチでループ内のトレーニングステップを呼び出し、定期的にチェックポイントをディスクに書き込みます。

def train_and_checkpoint(net, manager):
  ckpt.restore(manager.latest_checkpoint)
  if manager.latest_checkpoint:
    print("Restored from {}".format(manager.latest_checkpoint))
  else:
    print("Initializing from scratch.")

  for _ in range(50):
    example = next(iterator)
    loss = train_step(net, example, opt)
    ckpt.step.assign_add(1)
    if int(ckpt.step) % 10 == 0:
      save_path = manager.save()
      print("Saved checkpoint for step {}: {}".format(int(ckpt.step), save_path))
      print("loss {:1.2f}".format(loss.numpy()))

train_and_checkpoint(net, manager)

Initializing from scratch.
Saved checkpoint for step 10: ./tf_ckpts/ckpt-1
loss 28.15
Saved checkpoint for step 20: ./tf_ckpts/ckpt-2
loss 21.56
Saved checkpoint for step 30: ./tf_ckpts/ckpt-3
loss 15.00
Saved checkpoint for step 40: ./tf_ckpts/ckpt-4
loss 8.52
Saved checkpoint for step 50: ./tf_ckpts/ckpt-5
loss 3.25

復元してトレーニングを続ける

最初の後で、新しいモデルとマネージャーを渡すことができますが、中断したところにトレーニングをピックアップします。

opt = tf.keras.optimizers.Adam(0.1)
net = Net()
dataset = toy_dataset()
iterator = iter(dataset)
ckpt = tf.train.Checkpoint(step=tf.Variable(1), optimizer=opt, net=net, iterator=iterator)
manager = tf.train.CheckpointManager(ckpt, './tf_ckpts', max_to_keep=3)

train_and_checkpoint(net, manager)

Restored from ./tf_ckpts/ckpt-5
Saved checkpoint for step 60: ./tf_ckpts/ckpt-6
loss 1.76
Saved checkpoint for step 70: ./tf_ckpts/ckpt-7
loss 0.65
Saved checkpoint for step 80: ./tf_ckpts/ckpt-8
loss 0.51
Saved checkpoint for step 90: ./tf_ckpts/ckpt-9
loss 0.34
Saved checkpoint for step 100: ./tf_ckpts/ckpt-10
loss 0.25

tf.train.CheckpointManagerオブジェクトは、古いチェックポイントを削除します。上記では、最新の3つのチェックポイントのみを保持するように構成されています。

print(manager.checkpoints)  # List the three remaining checkpoints

['./tf_ckpts/ckpt-8', './tf_ckpts/ckpt-9', './tf_ckpts/ckpt-10']

これらのパス、例えば'./tf_ckpts/ckpt-10'はディスク上のファイルではありません。代わりに、これらは変数値を含むindexファイルと1つ以上のデータファイルのプレフィックスです。これらのプレフィックスは、単一のcheckpointファイル（ './tf_ckpts/checkpoint' ）にグループ化され、 CheckpointManagerがその状態を保存します。

ls ./tf_ckpts

checkpoint           ckpt-8.data-00000-of-00001  ckpt-9.index
ckpt-10.data-00000-of-00001  ckpt-8.index
ckpt-10.index            ckpt-9.data-00000-of-00001

力学の読み込み

TensorFlowは、ロードされているオブジェクトから始めて、名前付きエッジを持つ有向グラフをトラバースすることにより、変数をチェックポイントされた値と照合します。エッジ名は通常、オブジェクトの属性名に由来します。たとえば、 self.l1 = tf.keras.layers.Dense(5)の"l1"です。 tf.train.Checkpoint tf.train.Checkpoint(step=...)の"step"ように、 tf.train.Checkpointはキーワード引数名​​を使用しtf.train.Checkpoint(step=...) 。

上記の例のディペンデンシーグラフは次のようになります。

オプティマイザが赤、通常の変数が青、オプティマイザスロット変数がオレンジになっています。たとえばtf.train.Checkpoint表す他のノードは黒です。

スロット変数はオプティマイザの状態の一部ですが、特定の変数に対して作成されます。たとえば、上記の'm'エッジは、Adamオプティマイザーが各変数を追跡する運動量に対応しています。スロット変数は、変数とオプティマイザの両方が保存される場合、つまり破線のエッジである場合にのみチェックポイントに保存されます。

tf.train.Checkpointオブジェクトでrestore()を呼び出すと、要求された復元がキューに入れられ、 Checkpointオブジェクトから一致するパスがtf.train.Checkpointとすぐに変数値が復元されます。たとえば、ネットワークとレイヤーを介して1つのパスを再構築することにより、上記で定義したモデルからバイアスのみをロードできます。

to_restore = tf.Variable(tf.zeros([5]))
print(to_restore.numpy())  # All zeros
fake_layer = tf.train.Checkpoint(bias=to_restore)
fake_net = tf.train.Checkpoint(l1=fake_layer)
new_root = tf.train.Checkpoint(net=fake_net)
status = new_root.restore(tf.train.latest_checkpoint('./tf_ckpts/'))
print(to_restore.numpy())  # We get the restored value now

[0. 0. 0. 0. 0.]
[3.5548685 2.8931093 2.3509905 3.5525272 4.017799 ]

これらの新しいオブジェクトの依存関係グラフは、上で書いた大きなチェックポイントのはるかに小さなサブグラフです。これには、 tf.train.Checkpointがチェックポイントの番号tf.train.Checkpoint使用するバイアスと保存カウンターのみが含まれます。

restore()は、オプションのアサーションを持つステータスオブジェクトを返します。新しいCheckpoint作成したすべてのオブジェクトが復元されたため、 status.assert_existing_objects_matched()が渡されます。

status.assert_existing_objects_matched()

<tensorflow.python.training.tracking.util.CheckpointLoadStatus at 0x7fea0c3c3860>

チェックポイントには、層のカーネルやオプティマイザの変数など、一致しないオブジェクトが多数あります。 status.assert_consumed()は、チェックポイントとプログラムが正確に一致する場合にのみ通過し、ここで例外をスローします。

復元の遅延

TensorFlowのLayerオブジェクトは、入力形状が利用可能な場合、最初の呼び出しに対する変数の作成を遅らせる可能性があります。たとえば、 Denseレイヤーのカーネルの形状は、レイヤーの入力形状と出力形状の両方に依存するため、コンストラクター引数として必要な出力形状は、変数を独自に作成するのに十分な情報ではありません。 Layer呼び出すと、変数の値も読み取られるため、変数を作成してから最初に使用するまでの間に復元を行う必要があります。

このイディオムをサポートするために、 tf.train.Checkpointは、一致する変数がまだないリストアをキューにtf.train.Checkpointます。

delayed_restore = tf.Variable(tf.zeros([1, 5]))
print(delayed_restore.numpy())  # Not restored; still zeros
fake_layer.kernel = delayed_restore
print(delayed_restore.numpy())  # Restored

[[0. 0. 0. 0. 0.]]
[[4.453001  4.6668463 4.9372597 4.90143   4.9549575]]

チェックポイントを手動で検査する

tf.train.list_variablesは、チェックポイントキーとチェックポイント内の変数の形状をリストします。チェックポイントキーは、上記のグラフのパスです。

tf.train.list_variables(tf.train.latest_checkpoint('./tf_ckpts/'))

[('_CHECKPOINTABLE_OBJECT_GRAPH', []),
 ('iterator/.ATTRIBUTES/ITERATOR_STATE', [1]),
 ('net/l1/bias/.ATTRIBUTES/VARIABLE_VALUE', [5]),
 ('net/l1/bias/.OPTIMIZER_SLOT/optimizer/m/.ATTRIBUTES/VARIABLE_VALUE', [5]),
 ('net/l1/bias/.OPTIMIZER_SLOT/optimizer/v/.ATTRIBUTES/VARIABLE_VALUE', [5]),
 ('net/l1/kernel/.ATTRIBUTES/VARIABLE_VALUE', [1, 5]),
 ('net/l1/kernel/.OPTIMIZER_SLOT/optimizer/m/.ATTRIBUTES/VARIABLE_VALUE',
  [1, 5]),
 ('net/l1/kernel/.OPTIMIZER_SLOT/optimizer/v/.ATTRIBUTES/VARIABLE_VALUE',
  [1, 5]),
 ('optimizer/beta_1/.ATTRIBUTES/VARIABLE_VALUE', []),
 ('optimizer/beta_2/.ATTRIBUTES/VARIABLE_VALUE', []),
 ('optimizer/decay/.ATTRIBUTES/VARIABLE_VALUE', []),
 ('optimizer/iter/.ATTRIBUTES/VARIABLE_VALUE', []),
 ('optimizer/learning_rate/.ATTRIBUTES/VARIABLE_VALUE', []),
 ('save_counter/.ATTRIBUTES/VARIABLE_VALUE', []),
 ('step/.ATTRIBUTES/VARIABLE_VALUE', [])]

リストと辞書の追跡

self.l1 = tf.keras.layers.Dense(5)ような属性の直接割り当てと同様に、リストと辞書を属性に割り当てると、その内容が追跡されます。

save = tf.train.Checkpoint()
save.listed = [tf.Variable(1.)]
save.listed.append(tf.Variable(2.))
save.mapped = {'one': save.listed[0]}
save.mapped['two'] = save.listed[1]
save_path = save.save('./tf_list_example')

restore = tf.train.Checkpoint()
v2 = tf.Variable(0.)
assert 0. == v2.numpy()  # Not restored yet
restore.mapped = {'two': v2}
restore.restore(save_path)
assert 2. == v2.numpy()

リストと辞書のラッパーオブジェクトに気付くでしょう。これらのラッパーは、基になるデータ構造のチェックポイント可能なバージョンです。属性ベースのロードと同様に、これらのラッパーは変数がコンテナーに追加されるとすぐに変数の値を復元します。

restore.listed = []
print(restore.listed)  # ListWrapper([])
v1 = tf.Variable(0.)
restore.listed.append(v1)  # Restores v1, from restore() in the previous cell
assert 1. == v1.numpy()

ListWrapper([])

同じトラッキングがtf.keras.Modelサブクラスに自動的に適用され、たとえばレイヤーのリストをトラッキングするために使用できます。

Estimatorを使用したオブジェクトベースのチェックポイントの保存

見積もりガイドをご覧ください。

デフォルトでは、推定器は、前のセクションで説明したオブジェクトグラフではなく、変数名でチェックポイントを保存します。 tf.train.Checkpointは名前ベースのチェックポイントを受け入れますが、モデルの一部をEstimatorのmodel_fn外に移動すると、変数名が変わる可能性があります。オブジェクトベースのチェックポイントを保存すると、Estimator内でモデルをトレーニングし、Estimatorの外で使用することが簡単になります。

import tensorflow.compat.v1 as tf_compat

def model_fn(features, labels, mode):
  net = Net()
  opt = tf.keras.optimizers.Adam(0.1)
  ckpt = tf.train.Checkpoint(step=tf_compat.train.get_global_step(),
                             optimizer=opt, net=net)
  with tf.GradientTape() as tape:
    output = net(features['x'])
    loss = tf.reduce_mean(tf.abs(output - features['y']))
  variables = net.trainable_variables
  gradients = tape.gradient(loss, variables)
  return tf.estimator.EstimatorSpec(
    mode,
    loss=loss,
    train_op=tf.group(opt.apply_gradients(zip(gradients, variables)),
                      ckpt.step.assign_add(1)),
    # Tell the Estimator to save "ckpt" in an object-based format.
    scaffold=tf_compat.train.Scaffold(saver=ckpt))

tf.keras.backend.clear_session()
est = tf.estimator.Estimator(model_fn, './tf_estimator_example/')
est.train(toy_dataset, steps=10)

INFO:tensorflow:Using default config.
INFO:tensorflow:Using config: {'_model_dir': './tf_estimator_example/', '_tf_random_seed': None, '_save_summary_steps': 100, '_save_checkpoints_steps': None, '_save_checkpoints_secs': 600, '_session_config': allow_soft_placement: true
graph_options {
  rewrite_options {
    meta_optimizer_iterations: ONE
  }
}
, '_keep_checkpoint_max': 5, '_keep_checkpoint_every_n_hours': 10000, '_log_step_count_steps': 100, '_train_distribute': None, '_device_fn': None, '_protocol': None, '_eval_distribute': None, '_experimental_distribute': None, '_experimental_max_worker_delay_secs': None, '_session_creation_timeout_secs': 7200, '_service': None, '_cluster_spec': ClusterSpec({}), '_task_type': 'worker', '_task_id': 0, '_global_id_in_cluster': 0, '_master': '', '_evaluation_master': '', '_is_chief': True, '_num_ps_replicas': 0, '_num_worker_replicas': 1}
WARNING:tensorflow:From /tmpfs/src/tf_docs_env/lib/python3.6/site-packages/tensorflow/python/training/training_util.py:236: Variable.initialized_value (from tensorflow.python.ops.variables) is deprecated and will be removed in a future version.
Instructions for updating:
Use Variable.read_value. Variables in 2.X are initialized automatically both in eager and graph (inside tf.defun) contexts.
INFO:tensorflow:Calling model_fn.
INFO:tensorflow:Done calling model_fn.
INFO:tensorflow:Create CheckpointSaverHook.
INFO:tensorflow:Graph was finalized.
INFO:tensorflow:Running local_init_op.
INFO:tensorflow:Done running local_init_op.
INFO:tensorflow:Calling checkpoint listeners before saving checkpoint 0...
INFO:tensorflow:Saving checkpoints for 0 into ./tf_estimator_example/model.ckpt.
INFO:tensorflow:Calling checkpoint listeners after saving checkpoint 0...
INFO:tensorflow:loss = 4.388644, step = 0
INFO:tensorflow:Calling checkpoint listeners before saving checkpoint 10...
INFO:tensorflow:Saving checkpoints for 10 into ./tf_estimator_example/model.ckpt.
INFO:tensorflow:Calling checkpoint listeners after saving checkpoint 10...
INFO:tensorflow:Loss for final step: 34.98601.

<tensorflow_estimator.python.estimator.estimator.EstimatorV2 at 0x7fea648fbf60>

その後、 tf.train.CheckpointはEstimatorのチェックポイントをそのmodel_dirからロードできます。

opt = tf.keras.optimizers.Adam(0.1)
net = Net()
ckpt = tf.train.Checkpoint(
  step=tf.Variable(1, dtype=tf.int64), optimizer=opt, net=net)
ckpt.restore(tf.train.latest_checkpoint('./tf_estimator_example/'))
ckpt.step.numpy()  # From est.train(..., steps=10)

10

概要

TensorFlowオブジェクトは、使用する変数の値を保存および復元するための簡単な自動メカニズムを提供します。