tfdbg.LocalCLIDebugWrapperSession
tfdbg.LocalCLIDebugWrapperSession
class tfdbg.LocalCLIDebugWrapperSession
Defined in tensorflow/python/debug/wrappers/local_cli_wrapper.py
.
See the guide: TensorFlow Debugger > Session wrapper class and SessionRunHook
implementations
Concrete subclass of BaseDebugWrapperSession implementing a local CLI.
This class has all the methods that a session.Session
object has, in order to support debugging with minimal code changes. Invoking its run()
method will launch the command-line interface (CLI) of tfdbg.
Properties
graph
graph_def
sess_str
session
Methods
__init__
__init__( sess, dump_root=None, log_usage=True, ui_type='curses', thread_name_filter=None )
Constructor of LocalCLIDebugWrapperSession.
Args:
-
sess
: The TensorFlowSession
object being wrapped. -
dump_root
: (str
) optional path to the dump root directory. Must be a directory that does not exist or an empty directory. If the directory does not exist, it will be created by the debugger core during debugrun()
calls and removed afterwards. IfNone
, the debug dumps will be at tfdbg_under the system temp directory. -
log_usage
: (bool
) whether the usage of this class is to be logged. -
ui_type
: (str
) requested UI type. Currently supported: (curses | readline) -
thread_name_filter
: Regular-expression white list for thread name. See the doc ofBaseDebugWrapperSession
for details.
Raises:
-
ValueError
: If dump_root is an existing and non-empty directory or if dump_root is a file.
__enter__
__enter__()
__exit__
__exit__( exec_type, exec_value, exec_tb )
add_tensor_filter
add_tensor_filter( filter_name, tensor_filter )
Add a tensor filter.
Args:
-
filter_name
: (str
) name of the filter. -
tensor_filter
: (callable
) the filter callable. See the doc string ofDebugDumpDir.find()
for more details about its signature.
as_default
as_default()
close
close()
invoke_node_stepper
invoke_node_stepper( node_stepper, restore_variable_values_on_exit=True )
Overrides method in base class to implement interactive node stepper.
Args:
-
node_stepper
: (stepper.NodeStepper
) The underlying NodeStepper API object. -
restore_variable_values_on_exit
: (bool
) Whether any variables whose values have been altered during this node-stepper invocation should be restored to their old values when this invocation ends.
Returns:
The same return values as the Session.run()
call on the same fetches as the NodeStepper.
on_run_end
on_run_end(request)
Overrides on-run-end callback.
Actions taken: 1) Load the debug dump. 2) Bring up the Analyzer CLI.
Args:
-
request
: An instance of OnSessionInitRequest.
Returns:
An instance of OnSessionInitResponse.
on_run_start
on_run_start(request)
Overrides on-run-start callback.
Invoke the CLI to let user choose what action to take: run
/ invoke_stepper
.
Args:
-
request
: An instance ofOnRunStartRequest
.
Returns:
An instance of OnRunStartResponse
.
on_session_init
on_session_init(request)
Overrides on-session-init callback.
Args:
-
request
: An instance ofOnSessionInitRequest
.
Returns:
An instance of OnSessionInitResponse
.
partial_run
partial_run( handle, fetches, feed_dict=None )
partial_run_setup
partial_run_setup( fetches, feeds=None )
Sets up the feeds and fetches for partial runs in the session.
run
run( fetches, feed_dict=None, options=None, run_metadata=None )
Wrapper around Session.run() that inserts tensor watch options.
Args:
-
fetches
: Same as thefetches
arg to regularSession.run()
. -
feed_dict
: Same as thefeed_dict
arg to regularSession.run()
. -
options
: Same as theoptions
arg to regularSession.run()
. -
run_metadata
: Same as therun_metadata
arg to regularSession.run()
.
Returns:
Simply forwards the output of the wrapped Session.run()
call.
Raises:
-
ValueError
: On invalidOnRunStartAction
value.
© 2017 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/api_docs/python/tfdbg/LocalCLIDebugWrapperSession