TensorFlow 代码调试实用指南

我在 TensorFlow Korea Group 第一次 meetup 上的演讲！

2016年6月18日，首尔谷歌韩国办公室

• 幻灯片：https://wookayin.github.io/tensorflow-talk-debugging
• 代码：https://github.com/wookayin/tensorflow-talk-debugging/tree/master/codes
• 视频（韩语）：https://www.youtube.com/watch?v=01nDEZe0BfU

更新记录

• 2016年6月18日（v1）：演讲初版。
• 2016年12月9日（v2）：添加了对官方调试器的简要介绍，供读者参考。
• 2016年2月17日（v3）：更新示例以兼容 TensorFlow 1.0，并增加了更多关于 tfdbg 的内容。

tensorflow-talk-debugging 快速上手指南

本指南基于 tensorflow-talk-debugging 项目整理，旨在帮助开发者掌握 TensorFlow 代码的调试技巧，包括官方调试器 tfdbg 的使用。

环境准备

• 操作系统：Linux、macOS 或 Windows（需配置 Python 环境）
• Python 版本：建议 Python 3.5+（兼容 TensorFlow 1.0 及以上版本）
• 前置依赖：
  • TensorFlow 1.0 或更高版本
  • Git（用于克隆示例代码）

国内加速建议：安装 TensorFlow 时推荐使用清华镜像源，以提升下载速度。

安装步骤

1. 克隆示例代码仓库

   git clone https://github.com/wookayin/tensorflow-talk-debugging.git
   cd tensorflow-talk-debugging/codes
   

2. 安装 TensorFlow（如未安装） 使用 pip 并指定国内镜像源：

   pip install tensorflow -i https://pypi.tuna.tsinghua.edu.cn/simple
   

   注：本项目示例主要基于 TensorFlow 1.x 编写。若使用 TensorFlow 2.x，需注意 API 兼容性差异或启用兼容模式。

基本使用

本项目核心在于通过示例代码学习调试方法。以下是最简单的使用流程：

1. 查看示例代码 进入 codes 目录，你将看到多个演示不同调试场景的脚本（如 debug_example.py 等）。

2. 运行带调试器的脚本 使用 tfdbg 启动调试会话。在命令行中运行示例代码时，添加 --debug 标志（具体取决于脚本实现），或直接修改代码引入调试器：

   from tensorflow.python import debug as tf_debug
   
   # 创建会话时包裹调试器
   sess = tf.Session()
   sess = tf_debug.LocalCLIDebugWrapperSession(sess)
   # 或者添加 tensor 过滤规则
   # sess.add_tensor_filter("has_inf_or_nan", tf_debug.has_inf_or_nan)
   

3. 执行调试命令 运行脚本后，终端将进入 tfdbg 的交互式命令行界面。常用命令包括：

   • lt：列出当前可用的张量（tensors）
   • pt <tensor_name>：打印特定张量的值
   • run：继续运行到下一个断点或结束

   示例交互：

   tfdbg> lt
   tfdbg> pt hidden_layer/Relu:0
   tfdbg> run
   

4. 参考幻灯片与视频

   • 详细原理请参考项目幻灯片：https://wookayin.github.io/tensorflow-talk-debugging
   • 视频教程（韩语，含操作演示）：https://www.youtube.com/watch?v=01nDEZe0BfU