LoggingTensorHook と StopAtStepHook を Keras コールバックに移行する

TensorFlow 1 では、tf.estimator.LoggingTensorHook を使用してテンソルを監視および記録しますが、tf.estimator.StopAtStepHook は tf.estimator.Estimator でトレーニングする場合に指定されたステップでトレーニングを停止するのに役立ちます。このノートブックは、Model.fit でカスタム Keras コールバック（tf.keras.callbacks.Callback）を使用して、これらの API から TensorFlow 2 の同等のものに移行する方法を示しています。

Keras コールバックは、組み込みの Keras Model.fit/Model.evaluate/Model.predict API でのトレーニング/評価/予測中のさまざまな時点で呼び出されるオブジェクトです。tf.keras.callbacks.Callback API ドキュメントでコールバックの詳細を学ぶことができます。また、独自のコールバックの作成および組み込みメソッドを使用したトレーニングと評価（コールバックの使用セクション）ガイドも参照してください。 TensorFlow 1 の SessionRunHook から TensorFlow 2 の Keras コールバックへの移行については、支援ロジック付きトレーニングの移行ガイドをご覧ください。

セットアップ

インポートとデモンストレーション用の単純なデータセットから始めます。

import tensorflow as tf
import tensorflow.compat.v1 as tf1

2022-12-14 22:35:05.753254: W tensorflow/compiler/xla/stream_executor/platform/default/dso_loader.cc:64] Could not load dynamic library 'libnvinfer.so.7'; dlerror: libnvinfer.so.7: cannot open shared object file: No such file or directory
2022-12-14 22:35:05.753360: W tensorflow/compiler/xla/stream_executor/platform/default/dso_loader.cc:64] Could not load dynamic library 'libnvinfer_plugin.so.7'; dlerror: libnvinfer_plugin.so.7: cannot open shared object file: No such file or directory
2022-12-14 22:35:05.753369: W tensorflow/compiler/tf2tensorrt/utils/py_utils.cc:38] TF-TRT Warning: Cannot dlopen some TensorRT libraries. If you would like to use Nvidia GPU with TensorRT, please make sure the missing libraries mentioned above are installed properly.

features = [[1., 1.5], [2., 2.5], [3., 3.5]]
labels = [[0.3], [0.5], [0.7]]

# Define an input function.
def _input_fn():
  return tf1.data.Dataset.from_tensor_slices((features, labels)).batch(1)

TensorFlow 1: テンソルをログに記録し、tf.estimator API でトレーニングを停止する

TensorFlow 1 では、さまざまなフックを定義してトレーニング動作を制御します。次に、これらのフックを tf.estimator.EstimatorSpec に渡します。

以下に例を示します。

テンソル（モデルの重みや損失など）を監視/記録するには、tf.estimator.LoggingTensorHook（ tf.train.LoggingTensorHook はそのエイリアスです）を使用します。
特定のステップでトレーニングを停止するには、tf.estimator.StopAtStepHook を使用します（
tf.train.StopAtStepHook はそのエイリアスです）。

def _model_fn(features, labels, mode):
  dense = tf1.layers.Dense(1)
  logits = dense(features)
  loss = tf1.losses.mean_squared_error(labels=labels, predictions=logits)
  optimizer = tf1.train.AdagradOptimizer(0.05)
  train_op = optimizer.minimize(loss, global_step=tf1.train.get_global_step())

  # Define the stop hook.
  stop_hook = tf1.train.StopAtStepHook(num_steps=2)

  # Access tensors to be logged by names.
  kernel_name = tf.identity(dense.weights[0])
  bias_name = tf.identity(dense.weights[1])
  logging_weight_hook = tf1.train.LoggingTensorHook(
      tensors=[kernel_name, bias_name],
      every_n_iter=1)
  # Log the training loss by the tensor object.
  logging_loss_hook = tf1.train.LoggingTensorHook(
      {'loss from LoggingTensorHook': loss},
      every_n_secs=3)

  # Pass all hooks to `EstimatorSpec`.
  return tf1.estimator.EstimatorSpec(mode,
                                     loss=loss,
                                     train_op=train_op,
                                     training_hooks=[stop_hook,
                                                     logging_weight_hook,
                                                     logging_loss_hook])

estimator = tf1.estimator.Estimator(model_fn=_model_fn)

# Begin training.
# The training will stop after 2 steps, and the weights/loss will also be logged.
estimator.train(_input_fn)

INFO:tensorflow:Using default config.
WARNING:tensorflow:Using temporary folder as model directory: /tmpfs/tmp/tmpnls8yefw
INFO:tensorflow:Using config: {'_model_dir': '/tmpfs/tmp/tmpnls8yefw', '_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, '_checkpoint_save_graph_def': True, '_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.9/site-packages/tensorflow/python/training/training_util.py:396: 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.
WARNING:tensorflow:From /tmpfs/src/tf_docs_env/lib/python3.9/site-packages/tensorflow/python/training/adagrad.py:138: calling Constant.__init__ (from tensorflow.python.ops.init_ops) with dtype is deprecated and will be removed in a future version.
Instructions for updating:
Call initializer instance with the dtype argument instead of passing it to the constructor
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 /tmpfs/tmp/tmpnls8yefw/model.ckpt.
INFO:tensorflow:Calling checkpoint listeners after saving checkpoint 0...
INFO:tensorflow:loss = 0.15147454, step = 0
INFO:tensorflow:Tensor("Identity:0", shape=(2, 1), dtype=float32) = [[ 0.7482141 ]
 [-0.03934455]], Tensor("Identity_1:0", shape=(1,), dtype=float32) = [0.]
INFO:tensorflow:loss from LoggingTensorHook = 0.15147454
INFO:tensorflow:Tensor("Identity:0", shape=(2, 1), dtype=float32) = [[ 0.7018909 ]
 [-0.08760582]], Tensor("Identity_1:0", shape=(1,), dtype=float32) = [-0.04632322] (0.028 sec)
INFO:tensorflow:Calling checkpoint listeners before saving checkpoint 2...
INFO:tensorflow:Saving checkpoints for 2 into /tmpfs/tmp/tmpnls8yefw/model.ckpt.
INFO:tensorflow:Calling checkpoint listeners after saving checkpoint 2...
INFO:tensorflow:Loss for final step: 0.40761083.
<tensorflow_estimator.python.estimator.estimator.Estimator at 0x7fd8e2fd8af0>

TensorFlow 2: カスタムコールバックと Model.fit を使用してテンソルをログに記録し、トレーニングを停止する

TensorFlow 2 では、組み込みの Keras Model.fit（または Model.evaluate）をトレーニング/評価に使用する場合、カスタム tf.keras.callbacks.Callback を定義することで、テンソルの監視とトレーニングの停止を構成できます。次に、それらを Model.fit（またはModel.evaluate）の callbacks パラメータに渡します。 (詳細については、独自のコールバックの作成ガイドを参照してください。)

以下に例を示します。

StopAtStepHook の機能を再作成するには、on_batch_end メソッドをオーバーライドして特定のステップ数の後にトレーニングを停止するカスタムコールバック（以下では StopAtStepCallback という名前）を定義します。
LoggingTensorHook の動作を再作成するには、名前によるテンソルへのアクセスがサポートされていないため、ログに記録されたテンソルを手動で記録および出力するカスタムコールバック（LoggingTensorCallback）を定義します。カスタムコールバック内にログ記録の頻度を実装することもできます。以下の例では、2 ステップごとに重みを出力します。 N 秒ごとにログを記録するなどの他のストラテジーも可能です。

class StopAtStepCallback(tf.keras.callbacks.Callback):
  def __init__(self, stop_step=None):
    super().__init__()
    self._stop_step = stop_step

  def on_batch_end(self, batch, logs=None):
    if self.model.optimizer.iterations >= self._stop_step:
      self.model.stop_training = True
      print('\nstop training now')

class LoggingTensorCallback(tf.keras.callbacks.Callback):
  def __init__(self, every_n_iter):
      super().__init__()
      self._every_n_iter = every_n_iter
      self._log_count = every_n_iter

  def on_batch_end(self, batch, logs=None):
    if self._log_count > 0:
      self._log_count -= 1
      print("Logging Tensor Callback: dense/kernel:",
            model.layers[0].weights[0])
      print("Logging Tensor Callback: dense/bias:",
            model.layers[0].weights[1])
      print("Logging Tensor Callback loss:", logs["loss"])
    else:
      self._log_count -= self._every_n_iter

終了したら、新しいコールバック（StopAtStepCallback と LoggingTensorCallback）を Model.fit の callbacks パラメータに渡します。

dataset = tf.data.Dataset.from_tensor_slices((features, labels)).batch(1)
model = tf.keras.models.Sequential([tf.keras.layers.Dense(1)])
optimizer = tf.keras.optimizers.Adagrad(learning_rate=0.05)
model.compile(optimizer, "mse")

# Begin training.
# The training will stop after 2 steps, and the weights/loss will also be logged.
model.fit(dataset, callbacks=[StopAtStepCallback(stop_step=2),
                              LoggingTensorCallback(every_n_iter=2)])

Logging Tensor Callback: dense/kernel: <tf.Variable 'dense/kernel:0' shape=(2, 1) dtype=float32, numpy=
array([[-0.28938037],
       [ 1.1400542 ]], dtype=float32)>
Logging Tensor Callback: dense/bias: <tf.Variable 'dense/bias:0' shape=(1,) dtype=float32, numpy=array([-0.04960161], dtype=float32)>
Logging Tensor Callback loss: 1.5501126050949097
1/3 [=========>....................] - ETA: 0s - loss: 1.5501
stop training now
Logging Tensor Callback: dense/kernel: <tf.Variable 'dense/kernel:0' shape=(2, 1) dtype=float32, numpy=
array([[-0.3363576],
       [ 1.0942115]], dtype=float32)>
Logging Tensor Callback: dense/bias: <tf.Variable 'dense/bias:0' shape=(1,) dtype=float32, numpy=array([-0.09000673], dtype=float32)>
Logging Tensor Callback loss: 2.257307767868042
3/3 [==============================] - 0s 4ms/step - loss: 2.2573
<keras.callbacks.History at 0x7fd8d03920a0>

Next steps

コールバックの詳細については、次を参照してください。

API ドキュメント: tf.keras.callbacks.Callback
ガイド: 独自のコールバックの作成
ガイド: 組み込みメソッドを使用したトレーニングと評価（コールバックの使用セクション）

次の移行関連のリソースも役立つ場合があります。

早期停止移行ガイド: tf.keras.callbacks.EarlyStopping は組み込みの早期停止コールバックです
TensorBoard 移行ガイド: TensorBoard により、指標の追跡と表示が可能になります
支援ロジック付きトレーニングの移行ガイド: TensorFlow 1 の SessionRunHook から TensorFlow 2 の Keras コールバックへ