Skip to content

Latest commit

 

History

History
125 lines (77 loc) · 3.01 KB

DumpingDebugHook.md

File metadata and controls

125 lines (77 loc) · 3.01 KB

page_type: reference

<style> table img { max-width: 100%; } </style>

tfdbg.DumpingDebugHook

Class DumpingDebugHook

Inherits From: SessionRunHook

Defined in tensorflow/python/debug/wrappers/hooks.py.

See the guide: TensorFlow Debugger > Session wrapper class and SessionRunHook implementations

A debugger hook that dumps debug data to filesystem.

Can be used as a hook for tf.train.MonitoredSessions and tf.estimator.Estimators.

Methods

__init__

__init__(
    session_root,
    watch_fn=None,
    thread_name_filter=None,
    log_usage=True
)

Create a local debugger command-line interface (CLI) hook.

Args:

  • session_root: See doc of dumping_wrapper.DumpingDebugWrapperSession.__init__.
  • watch_fn: See doc of dumping_wrapper.DumpingDebugWrapperSession.__init__.
  • thread_name_filter: Regular-expression white list for threads on which the wrapper session will be active. See doc of BaseDebugWrapperSession for more details.
  • log_usage: (bool) Whether usage is to be logged.

after_create_session

after_create_session(
    session,
    coord
)

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

after_run(
    run_context,
    run_values
)

before_run

before_run(run_context)

begin

begin()

end

end(session)

Called at the end of session.

The session argument can be used in case the hook wants to run final ops, such as saving a last checkpoint.

If session.run() raises exception other than OutOfRangeError or StopIteration then end() is not called. Note the difference between end() and after_run() behavior when session.run() raises OutOfRangeError or StopIteration. In that case end() is called but after_run() is not called.

Args:

  • session: A TensorFlow Session that will be soon closed.