Keras 3 API 文档 / 回调 API / TensorBoard

TensorBoard

[源代码]

TensorBoard

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,
)

为 TensorBoard 启用可视化功能。

TensorBoard 是 TensorFlow 附带的可视化工具。使用此回调需要安装 TensorFlow。

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

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

当在 model.evaluate() 或常规验证中使用时,除了周期(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:计算模型各层权重直方图的频率(以周期为单位)。如果设置为 0,则不会计算直方图。必须指定验证数据(或分割)才能进行直方图可视化。
  • write_graph:(目前不支持)是否在 TensorBoard 中可视化计算图。请注意,当 write_graph 设置为 True 时,日志文件可能会变得非常大。
  • write_images:是否将模型权重写入以在 TensorBoard 中可视化为图像。
  • write_steps_per_second:是否将每秒的训练步数记录到 TensorBoard 中。这支持按周期和批次频率记录。
  • update_freq"batch""epoch" 或整数。使用 "epoch" 时,在每个周期后将损失和指标写入 TensorBoard。如果使用整数(例如 1000),则每 1000 个批次将所有指标和损失(包括通过 Model.compile 添加的自定义指标)记录到 TensorBoard。"batch" 是 1 的同义词,表示每个批次都将写入。但请注意,过于频繁地写入 TensorBoard 可能会减慢您的训练速度,尤其是在使用分布式策略时,因为它会产生额外的同步开销。通过覆盖 train_step 方法也可以实现批次级别的摘要写入。更多详细信息请参阅 TensorBoard 标量教程
  • profile_batch:对批次进行性能分析以采样计算特性。profile_batch 必须是一个非负整数或一个整数元组。一对正整数表示要进行性能分析的批次范围。默认情况下,性能分析是禁用的。
  • embeddings_freq:可视化嵌入层的频率(以周期为单位)。如果设置为 0,则不会可视化嵌入。
  • embeddings_metadata:一个字典,将嵌入层名称映射到用于保存该嵌入层元数据的文件名。如果所有嵌入层都使用相同的元数据文件,可以传递一个单独的文件名。

示例

tensorboard_callback = 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.

在子类化模型中自定义批次级摘要

class MyModel(keras.Model):

    def build(self, _):
        self.dense = 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 = keras.callbacks.TensorBoard('./logs', update_freq=1)
model.fit(x_train, y_train, callbacks=[tb_callback])

在函数式 API 模型中自定义批次级摘要

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

inputs = keras.Input(10)
x = keras.layers.Dense(10)(inputs)
outputs = keras.layers.Lambda(my_summary)(x)
model = 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 = 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 = 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 = keras.callbacks.TensorBoard(
    log_dir='./logs', profile_batch=(10,20))
model.fit(x_train, y_train, epochs=2, callbacks=[tensorboard_callback])