Class LocalCLIDebugWrapperSession
Defined in tensorflow/python/debug/wrappers/local_cli_wrapper.py
.
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.
__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.
Properties
graph
The underlying TensorFlow graph, to be used in building Operations.
graph_def
run_call_count
sess_str
The TensorFlow process to which this session will connect.
session
Methods
tfdbg.LocalCLIDebugWrapperSession.__enter__
__enter__()
tfdbg.LocalCLIDebugWrapperSession.__exit__
__exit__(
exec_type,
exec_value,
exec_tb
)
tfdbg.LocalCLIDebugWrapperSession.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.
tfdbg.LocalCLIDebugWrapperSession.as_default
as_default()
tfdbg.LocalCLIDebugWrapperSession.close
close()
tfdbg.LocalCLIDebugWrapperSession.increment_run_call_count
increment_run_call_count()
tfdbg.LocalCLIDebugWrapperSession.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.
tfdbg.LocalCLIDebugWrapperSession.list_devices
list_devices(
*args,
**kwargs
)
tfdbg.LocalCLIDebugWrapperSession.make_callable
make_callable(
fetches,
feed_list=None,
accept_options=False
)
tfdbg.LocalCLIDebugWrapperSession.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.
tfdbg.LocalCLIDebugWrapperSession.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
.
tfdbg.LocalCLIDebugWrapperSession.on_session_init
on_session_init(request)
Overrides on-session-init callback.
Args:
request
: An instance ofOnSessionInitRequest
.
Returns:
An instance of OnSessionInitResponse
.
tfdbg.LocalCLIDebugWrapperSession.partial_run
partial_run(
handle,
fetches,
feed_dict=None
)
Continues the execution with additional feeds and fetches.
tfdbg.LocalCLIDebugWrapperSession.partial_run_setup
partial_run_setup(
fetches,
feeds=None
)
Sets up the feeds and fetches for partial runs in the session.
tfdbg.LocalCLIDebugWrapperSession.reset
reset(
*args,
**kwargs
)
tfdbg.LocalCLIDebugWrapperSession.run
run(
fetches,
feed_dict=None,
options=None,
run_metadata=None,
callable_runner=None,
callable_runner_args=None,
callable_options=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()
.callable_runner
: Acallable
returned bySession.make_callable()
. If notNone
,fetches
andfeed_dict
must both beNone
. Mutually exclusive withcallable_options
.callable_runner_args
: An optional list of arguments tocallable_runner
or forcallable_options
.callable_options
: An instance ofconfig_pb2.CallableOptions
, to be used withSession._make_callable_from_options()
. Mutually exclusive withcallable_runner
.
Returns:
Simply forwards the output of the wrapped Session.run()
call.
Raises:
ValueError
: On invalidOnRunStartAction
value. Or ifcallable_runner
is notNone
and either or both offetches
andfeed_dict
isNone
.
tfdbg.LocalCLIDebugWrapperSession.run_step_fn
run_step_fn(step_fn)
tfdbg.LocalCLIDebugWrapperSession.should_stop
should_stop()