Run Hooks


SessionRunHooks are useful to track training, report progress, request early stopping and more. Users can attach an arbitrary number of hooks to an estimator. SessionRunHooks use the observer pattern and notify at the following points:

  • when a session starts being used
  • before a call to the
  • after a call to the
  • when the session closed

A SessionRunHook encapsulates a piece of reusable/composable computation that can piggyback a call to A hook can add any ops-or-tensor/feeds to the run call, and when the run call finishes with success gets the outputs it requested. Hooks are allowed to add ops to the graph in hook.begin(). The graph is finalized after the begin() method is called.

Built-in Run Hooks

There are a few pre-defined SessionRunHooks available, for example: Run hooks are useful for tracking training, reporting progress, requesting early stopping, and more. Users can attach an arbitrary number of hooks to an estimator. Some built-in run hooks include:

Method Description
hook_checkpoint_saver() Saves checkpoints every N steps or seconds.
hook_global_step_waiter() Delay execution until global step reaches to wait_until_step.
hook_logging_tensor() Prints the given tensors once every N local steps or once every N seconds.
hook_nan_tensor() NaN Loss monitor.
hook_step_counter() Steps per second monitor.
hook_stop_at_step() Monitor to request stop at a specified step.
hook_summary_saver() Saves summaries every N steps.

Similarly to feature columns, all available SessionRunHooks are named with hook_xxx to utilize the autocomplete functionality to speed up searching for available types of SessionRunHooks.

For example, in order to customize the checkpoint saving mechanism, users can initialize a monitor using hook_checkpoint_saver() that defines the checkpoint directory and the frequency of saving new checkpoint.

monitor <- hook_checkpoint_saver(
  checkpoint_dir = "/tmp/ckpt_dir",
  save_secs = 2)

Once monitor and an estimator are defined, the monitor can be attached to the estimator via the argument monitors when fitting the model.

lr <- linear_dnn_combined_regressor(
  linear_feature_columns = linear_feature_columns,
  dnn_feature_columns = dnn_feature_columns,
  dnn_hidden_units = c(1L, 1L),
  dnn_optimizer = "Adagrad"

lr %>% train(
  input_fn = custom_input_fn,
  steps = 10L,
  monitors = monitor)

Custom Run Hooks

Users can also create custom run hooks by defining the behaviors of the hook in different phases of a session in object-oriented programming style.

For example, the following code defines a custom run hook that prints out some information at the end of each session run by overriding the end() function in EstimatorSessionRunHook R6 class.

CustomSessionRunHook <- R6::R6Class(
  inherit = EstimatorSessionRunHook,
  public = list(
    end = function(session) {
      cat("Running custom session run hook at the end of a session")
custom_hook <- CustomSessionRunHook$new()

The following functions can be overridden from the EstimatorSessionRunHook class to implement fully customized run hook:

  • begin() - Called once before using the session.
  • after_create_session() - Called when new TensorFlow session is created.
  • before_run() - Called before each call to session run().
  • after_run() - Called after each call to session run().
  • end() - Called at the end of session.