由于Tensorflow使用静态图,先build graph然后run graph, 所以用一般的python debugger不能单步跟踪计算过程。如果想要debug 计算的中间过程, 一种简单的办法是在fetches中加入想要查看的tensor, 但是在调试中如果需要查看很多个tensor的值,这种方法不是很方便。 Tensorflow官方提供了tfdbg这个命令行工具来解决这个问题。

准备工作

使用tfdbg来包装Session

对一般使用Session的Tensorflow程序,可以使用

1
LocalCLIDebugWrapperSession
来启用tfdbg,例如

1
2
from tensorflow.python import debug as tf_debug
sess = tf_debug.LocalCLIDebugWrapperSession(sess)

使用hook来注入Estimator

如果使用Estimator, 那么需要使用

1
LocalCLIDebugHook
来启用tfdbg, 例如

1
2
3
4
from tensorflow.python import debug as tf_debug

# Create a LocalCLIDebugHook and use it as a monitor when calling fit().
hooks = [tf_debug.LocalCLIDebugHook()]

tfdbg的使用

debug_mnist.py这个脚本为例。 首先运行脚本:

1
python debug_mnist.py --debug

进入tfdbg的主界面:

tfdbg-main

上面一行

1
run #1: 1 fetch (accuracy/accuracy/Mean:0); 2 feeds
表示当前这次
1
Session.run
的信息, 对应到代码里:

1
2
3
135   for i in range(FLAGS.max_steps):
136     acc = sess.run(accuracy, feed_dict=feed_dict(False))
137     print("Accuracy at step %d: %s" % (i, acc))

在run_info里可以看到fetch是

1
accuracy/accuracy/Mean:0
, feed有两个:
1
x-input:0
1
y-input:0
.

使用run命令运行一个完整的step

1
tfdbg> run

使用

1
run
命令可以进行一次
1
Session.run
. 执行后的结果如图:

tfdbg-run 在这个界面可以看到运行这个step中所有的Operation, tensor的大小,以及运行时间。 点击其中的Tensor或者运行命令

1
pt <tensor_name>
,可以看见某个Tensor的值。例如点击
1
Softmax:0
以后,出现如下界面:

tfdbg-printtensor

点击

1
node_info
查看该节点的输入输出,以及在代码的什么位置被定义.

点击

1
list_inputs
1
list_outputs
可以查看输入输出的依赖树.

1
print_tensor
界面可以看到这个Softmax的函数输出的形状是
1
(10000, 10)
, 因为这是一个test batch, batch size是10000.

使用

1
pf
命令可以打印feed, 从而验证这一点:

1
tfdbg> pf input/x-input:0

tfdbg-pf

导出Tensor到文件

当Tensor比较大的时候,如果希望把Tensor导出进行进一步分析, 例如我们想导出

1
hidden/weights/Variables:0
, 可以用如下命令:

1
2
3
tfdbg> eval -a '`hidden/weights/Variable:0`' -w '/tmp/variable.npy'
或者
tfdbg> pt -s hidden/weights/Variable:0 -w '/tmp/variable.npy'

tfdbg-dump

之后可以用numpy来读取这个变量, 例如

1
2
import numpy as np
var = np.load('/tmp/variable.npy')

1
eval
命令还可以支持更加复杂的语法, 例如

1
tfdbg> eval "np.matmul((`output/Identity:0` / `Softmax:0`).T, `Softmax:0`)"

单步跟踪

使用

1
invoke_stepper
命令进入单步模式:

tfdbg-stepper

接下来使用

1
s
命令就可以运行一个step(注意,这里step和之前step的概念不同) 使用
1
s -t <num>
可以运行
1
num
个step. 使用
1
exit
运行余下的step并退出单步模式。

filter(类似条件”断点”)

默认情况下打印的tensor有点多,如果希望按照自己设定的条件来打印相关tensor, 可以使用

1
filter
. 例如,设置如下filter:

1
2
3
4
def my_filter_callable(datum, tensor):
    return 'Softmax' in datum.tensor_name
sess = tf_debug.LocalCLIDebugWrapperSession(sess, ui_type=FLAGS.ui_type)
sess.add_tensor_filter('my_filter', my_filter_callable)

则只有名称包含

1
Softmax
的tensor会被打印:

1
run -f my_filter

tfdbg-filter

再比如,想要运行到包含

1
nan
或者
1
inf
(一般情况下意味着训练有问题)的tensor可以使用:

1
tfdbg> run -f has_inf_or_nan

1
has_inf_or_nan
是一个默认被注册的
1
filter
.