Keras 2 API文档 / 回调API / TensorBoard

TensorBoard

[源代码]

TensorBoard

tf_keras.callbacks.TensorBoard(
    log_dir="logs",
    histogram_freq=0,
    write_graph=True,
    write_images=False,
    write_steps_per_second=False,
    update_freq="epoch",
    profile_batch=0,
    embeddings_freq=0,
    embeddings_metadata=None,
    **kwargs
)

启用 TensorBoard 可视化。

TensorBoard 是 TensorFlow 提供的一个可视化工具。

此回调记录 TensorBoard 的事件,包括:

  • 指标摘要图
  • 训练图可视化
  • 权重直方图
  • 采样分析

当在 Model.evaluate 或常规验证 (on_test_end) 中使用时,除了 epoch 摘要外,还会有一个摘要记录评估指标与 Model.optimizer.iterations 的关系。指标名称将以 evaluation 作为前缀,而 Model.optimizer.iterations 是 TensorBoard 中可视化的步数。

如果您已使用 pip 安装 TensorFlow,则应该能够从命令行启动 TensorBoard:

tensorboard --logdir=path_to_your_logs

您可以在 这里 找到更多关于 TensorBoard 的信息。

参数

  • log_dir:用于保存日志文件的目录路径,TensorBoard 将解析这些日志文件。例如,log_dir = os.path.join(working_dir, 'logs') 此目录不应被任何其他回调重复使用。
  • histogram_freq:计算模型层权重直方图的频率(以 epoch 为单位)。如果设置为 0,则不计算直方图。必须指定验证数据(或分割)才能进行直方图可视化。
  • write_graph:是否在 TensorBoard 中可视化计算图。当 write_graph 设置为 True 时,日志文件可能会变得非常大。
  • write_images:是否将模型权重写入 TensorBoard 以进行图像可视化。
  • write_steps_per_second:是否将每秒训练步数记录到 TensorBoard。这支持 epoch 和 batch 频率的日志记录。
  • update_freq'batch''epoch' 或整数。使用 'epoch' 时,在每个 epoch 后将损失和指标写入 TensorBoard。如果使用整数,例如 1000,则所有指标和损失(包括 Model.compile 添加的自定义指标和损失)将每 1000 个 batch 写入 TensorBoard。'batch'1 的同义词,意味着它们将在每个 batch 写入。但请注意,过于频繁地写入 TensorBoard 可能会减慢训练速度,尤其是在与 tf.distribute.Strategy 结合使用时,因为它会产生额外的同步开销。不支持与 ParameterServerStrategy 一起使用。也可以通过 train_step 重写来获得 batch 级别的摘要写入。有关更多详细信息,请参阅 TensorBoard Scalars 教程 # noqa: E501。
  • profile_batch:对 batch 进行分析以采样计算特性。profile_batch 必须是非负整数或整数元组。一对正整数表示要分析的 batch 范围。默认情况下,分析是禁用的。
  • embeddings_freq:可视化 embedding 层(以 epoch 为单位)的频率。如果设置为 0,则不进行 embedding 可视化。
  • embeddings_metadata:一个字典,将 embedding 层名称映射到要保存 embedding 层元数据的文件的文件名。如果所有 embedding 层都使用相同的元数据文件,则可以传递单个文件名。

示例

基本用法

tensorboard_callback = tf.keras.callbacks.TensorBoard(log_dir="./logs")
model.fit(x_train, y_train, epochs=2, callbacks=[tensorboard_callback])
# Then run the tensorboard command to view the visualizations.

在 subclassed Model 中自定义 batch 级摘要

class MyModel(tf.keras.Model):

  def build(self, _):
    self.dense = tf.keras.layers.Dense(10)

  def call(self, x):
    outputs = self.dense(x)
    tf.summary.histogram('outputs', outputs)
    return outputs

model = MyModel()
model.compile('sgd', 'mse')

# Make sure to set `update_freq=N` to log a batch-level summary every N
# batches.  In addition to any [`tf.summary`](https://tensorflowcn.cn/api_docs/python/tf/summary) contained in `Model.call`,
# metrics added in `Model.compile` will be logged every N batches.
tb_callback = tf.keras.callbacks.TensorBoard('./logs', update_freq=1)
model.fit(x_train, y_train, callbacks=[tb_callback])

在 Functional API Model 中自定义 batch 级摘要

def my_summary(x):
  tf.summary.histogram('x', x)
  return x

inputs = tf.keras.Input(10)
x = tf.keras.layers.Dense(10)(inputs)
outputs = tf.keras.layers.Lambda(my_summary)(x)
model = tf.keras.Model(inputs, outputs)
model.compile('sgd', 'mse')

# Make sure to set `update_freq=N` to log a batch-level summary every N
# batches. In addition to any [`tf.summary`](https://tensorflowcn.cn/api_docs/python/tf/summary) contained in `Model.call`,
# metrics added in `Model.compile` will be logged every N batches.
tb_callback = tf.keras.callbacks.TensorBoard('./logs', update_freq=1)
model.fit(x_train, y_train, callbacks=[tb_callback])

性能分析

# Profile a single batch, e.g. the 5th batch.
tensorboard_callback = tf.keras.callbacks.TensorBoard(
    log_dir='./logs', profile_batch=5)
model.fit(x_train, y_train, epochs=2, callbacks=[tensorboard_callback])

# Profile a range of batches, e.g. from 10 to 20.
tensorboard_callback = tf.keras.callbacks.TensorBoard(
    log_dir='./logs', profile_batch=(10,20))
model.fit(x_train, y_train, epochs=2, callbacks=[tensorboard_callback])