tfdbg: usability improvement: register the has_inf_or_nan filter by default

caisq · tensorflower-gardener · commit 73a8755cdfd7 · 2017-09-20T13:58:41.000-07:00
This saves users an extra line to add during debugging. has_inf_or_nan is a common use case.

PiperOrigin-RevId: 169445420
diff --git a/tensorflow/docs_src/programmers_guide/debugger.md b/tensorflow/docs_src/programmers_guide/debugger.md
@@ -64,7 +64,6 @@ so you can activate tfdbg CLI with the `--debug` flag at the command line.
 from tensorflow.python import debug as tf_debug
 
 sess = tf_debug.LocalCLIDebugWrapperSession(sess)
-sess.add_tensor_filter("has_inf_or_nan", tf_debug.has_inf_or_nan)
 ```
 
 This wrapper has the same interface as Session, so enabling debugging requires
@@ -246,13 +245,18 @@ some procedural-language debuggers:
 tfdbg> run -f has_inf_or_nan
 ```
 
-> NOTE: The preceding command works properly because we have registered a filter
-> for `nan`s and `inf`s called `has_inf_or_nan` (as explained previously).
+> NOTE: The preceding command works properly because a tensor filter called
+> `has_inf_or_nan` has been registered for you when the wrapped session is
+> created. This filter detects `nan`s and `inf`s (as explained previously).
 > If you have registered any other filters, you can
 > use "run -f" to have tfdbg run until any tensor triggers that filter (cause
 > the filter to return True).
 >
 > ``` python
+> def my_filter_callable(datum, tensor):
+>   # A filter that detects zero-valued scalars.
+>   return len(tensor.shape) == 0 and tensor == 0.0
+>
 > sess.add_tensor_filter('my_filter', my_filter_callable)
 > ```
 >
diff --git a/tensorflow/python/debug/examples/debug_mnist.py b/tensorflow/python/debug/examples/debug_mnist.py
@@ -122,7 +122,6 @@ def nn_layer(input_tensor, input_dim, output_dim, layer_name, act=tf.nn.relu):
 
   if FLAGS.debug:
     sess = tf_debug.LocalCLIDebugWrapperSession(sess, ui_type=FLAGS.ui_type)
-    sess.add_tensor_filter("has_inf_or_nan", tf_debug.has_inf_or_nan)
 
   # Add this point, sess is a debug wrapper around the actual Session if
   # FLAGS.debug is true. In that case, calling run() will launch the CLI.
diff --git a/tensorflow/python/debug/examples/debug_tflearn_iris.py b/tensorflow/python/debug/examples/debug_tflearn_iris.py
@@ -113,7 +113,6 @@ def main(_):
   if FLAGS.debug:
     debug_hook = tf_debug.LocalCLIDebugHook(ui_type=FLAGS.ui_type,
                                             dump_root=FLAGS.dump_root)
-    debug_hook.add_tensor_filter("has_inf_or_nan", tf_debug.has_inf_or_nan)
     hooks = [debug_hook]
 
   if not FLAGS.use_experiment:
diff --git a/tensorflow/python/debug/wrappers/local_cli_wrapper.py b/tensorflow/python/debug/wrappers/local_cli_wrapper.py
@@ -95,6 +95,8 @@ def __init__(self,
 
     # Registered tensor filters.
     self._tensor_filters = {}
+    # Register frequently-used filter(s).
+    self.add_tensor_filter("has_inf_or_nan", debug_data.has_inf_or_nan)
 
     # Below are the state variables of this wrapper object.
     # _active_tensor_filter: what (if any) tensor filter is in effect. If such
diff --git a/tensorflow/python/debug/wrappers/local_cli_wrapper_test.py b/tensorflow/python/debug/wrappers/local_cli_wrapper_test.py
@@ -421,6 +421,11 @@ def testRunTillFilterPassesShouldLaunchCLIAtCorrectRun(self):
 
     def v_greater_than_twelve(datum, tensor):
       return datum.node_name == "v" and tensor > 12.0
+
+    # Verify that adding the same tensor filter more than once is tolerated
+    # (i.e., as if it were added only once).
+    wrapped_sess.add_tensor_filter("v_greater_than_twelve",
+                                   v_greater_than_twelve)
     wrapped_sess.add_tensor_filter("v_greater_than_twelve",
                                    v_greater_than_twelve)
 
