ML Community Day is November 9! Join us for updates from TensorFlow, JAX, and more Learn more

tf.estimator.SummarySaverHook

Saves summaries every N steps.

Inherits From: SessionRunHook

save_steps int, save summaries every N steps. Exactly one of save_secs and save_steps should be set.
save_secs int, save summaries every N seconds.
output_dir string, the directory to save the summaries to. Only used if no summary_writer is supplied.
summary_writer SummaryWriter. If None and an output_dir was passed, one will be created accordingly.
scaffold Scaffold to get summary_op if it's not provided.
summary_op Tensor of type string containing the serialized Summary protocol buffer or a list of Tensor. They are most likely an output by TF summary methods like tf.compat.v1.summary.scalar or tf.compat.v1.summary.merge_all. It can be passed in as one tensor; if more than one, they must be passed in as a list.

ValueError Exactly one of scaffold or summary_op should be set.

Methods

after_create_session

View source

Called when new TensorFlow session is created.

This is called to signal the hooks that a new session has been created. This has two essential differences with the situation in which begin is called:

  • When this is called, the graph is finalized and ops can no longer be added to the graph.
  • This method will also be called as a result of recovering a wrapped session, not only at the beginning of the overall session.

Args
session A TensorFlow Session that has been created.
coord A Coordinator object which keeps track of all threads.

after_run

View source

Called after each call to run().

The run_values argument contains results of requested ops/tensors by before_run().

The run_context argument is the same one send to before_run call. run_context.request_stop() can be called to stop the iteration.

If session.run() raises any exceptions then after_run() is not called.

Args
run_context A SessionRunContext object.
run_values A SessionRunValues object.

before_run

View source

Called before each call to run().

You can return from this call a SessionRunArgs object indicating ops or tensors to add to the upcoming run() call. These ops/tensors will be run toge