tensorboard_logger

.. image:: https://img.shields.io/pypi/v/tensorboard_logger.svg :target: https://pypi.python.org/pypi/tensorboard_logger

.. image:: https://img.shields.io/travis/TeamHG-Memex/tensorboard_logger.svg :target: https://travis-ci.org/TeamHG-Memex/tensorboard_logger

注意：建议改用 https://pytorch.org/docs/stable/tensorboard.html_，它具有相同的功能， 并且是 PyTorch 的一部分。

无需 TensorFlow 即可记录 TensorBoard 事件

TensorBoard <https://www.tensorflow.org/how_tos/summaries_and_tensorboard/>_ 是一个可视化工具（并非本项目，而是 TensorFlow <https://www.tensorflow.org>_ 框架的一部分）， 它可以方便地查看训练进度、比较不同运行的结果，并且还提供了许多其他实用功能。

.. image:: tensorboard_example.png

tensorboard_logger 库允许在不使用 TensorFlow 的情况下编写 TensorBoard 事件：

from tensorboard_logger import configure, log_value

configure("runs/run-1234")

for step in range(1000):
    v1, v2 = do_stuff()
    log_value('v1', v1, step)
    log_value('v2', v2, step)

注意：如果你的项目已经在使用 TensorFlow，那么你可能并不需要这个库。

安装

TensorFlow 仅用于查看已记录的事件；请参阅 官方文档 <https://www.tensorflow.org/get_started/os_setup.html#download-and-setup>_ 中的安装指南（你可能只需要 CPU 版本）。

可以通过 pip 安装 tensorboard_logger：

pip install tensorboard_logger

用法

你可以使用默认的日志记录器，通过 tensorboard_logger.configure 和 tensorboard_logger.log_value 函数进行操作， 或者直接使用 tensorboard_logger.Logger 类。

该库可以将某些变量的数值以 TensorBoard 格式记录下来，这样你就可以使用 TensorBoard 来可视化这些变量的变化情况， 并比较不同运行之间的同一变量。日志文件会被写入指定的目录中，因此每个运行都需要一个独立的目录 （你也可以在同一目录中存放其他日志或输出文件）。如果你想比较来自不同运行的日志，这些目录应该位于同一个父目录下 （父目录下还可以有其他文件或目录，TensorBoard 会自动识别哪些目录包含日志）。

除了变量名和对应的值之外，另一个重要的参数是 step：它必须是一个整数，表示某种递增的步骤——可以是训练过程中的步数， 也可以是其他类型的计数。在 TensorBoard 中，数据会按照 step 进行排序，不过你也可以选择按时间或相对 step 排序。

一个简单的使用示例：

from tensorboard_logger import configure, log_value

configure("runs/run-1234", flush_secs=5)

for step in range(1000):
    v1, v2 = do_stuff()
    log_value('v1', v1, step)
    log_value('v2', v2, step)

你可以立即启动 TensorBoard：

tensorboard --logdir runs

然后访问 http://localhost:6006 查看指标（请注意，默认情况下它会绑定到 0.0.0.0）。 页面会在切换到浏览器标签时自动刷新，右上角还有一个手动刷新按钮。

运行时开销较大，每次记录一个值大约需要 0.1 到 0.2 毫秒（即每秒约 5,000 到 10,000 次操作）。

API

tensorboard_logger.configure(logdir, flush_secs=2)

配置日志记录：日志文件将被写入 logdir 目录，并且每隔 flush_secs 秒刷新一次。 注意： 目前每次写入事件后都会立即刷新文件。

tensorboard_logger.log_value(name, value, step=None)

为给定的 name 记录新的 value，并在指定的 step 上记录。value 应该是实数（会被转换为浮点数）， name 应该是字符串（会被转换为有效的 TensorFlow 摘要名称）。step 应该是非负整数，用于可视化目的： 你可以在同一个 step 上记录多个不同的变量，但不应在同一 step 上记录同一变量的不同值（这一点不会被检查）。 你也可以完全省略 step 参数。

tensorboard_logger.unconfigure()

简单地取消日志记录配置，将全局变量 _default_logger 设置为 None。

tensorboard_logger.Logger

用于在指定目录中写入日志的类。 如果上述两个函数中使用的默认日志记录器无法满足你的需求（例如你需要同时向多个目录写入日志， 或者你不希望使用全局变量），则可以使用此方法。 构造函数的签名与 tensorboard_logger.configure 相同，它也提供了一个与 tensorboard_logger.log_value 签名相同的 log_value 方法。

开发

编译 Python protobuf 文件：

protoc --python_out . tensorboard_logger/tf_protobuf/summary.proto
protoc --python_out . tensorboard_logger/tf_protobuf/event.proto

许可证

MIT 许可证_

.. _MIT 许可证: LICENSE

---

.. image:: https://hyperiongray.s3.amazonaws.com/define-hg.svg :target: https://www.hyperiongray.com/?pk_campaign=github&pk_kwd=tensorboard_logger :alt: define hyperiongray

tensorboard_logger 快速上手指南

tensorboard_logger 是一个轻量级 Python 库，允许你在不安装 TensorFlow 的情况下记录 TensorBoard 格式的事件日志。它非常适合仅需可视化训练进度、对比不同运行结果的非 TensorFlow 项目（如纯 PyTorch 或其他自定义训练循环）。

注意：如果你已经在使用 PyTorch，建议优先使用官方内置的 torch.utils.tensorboard，功能更完善且无需额外依赖。

---

环境准备

• 系统要求：支持 Python 的操作系统（Linux, macOS, Windows）。

• 前置依赖：

  • 记录日志时：无需安装 TensorFlow，仅需安装本库。
  • 查看日志时：必须安装 TensorFlow（用于启动 TensorBoard 服务）。通常只需安装 CPU 版本即可。

  安装 TensorFlow (CPU 版) 参考命令：

  pip install tensorflow-cpu
  # 或者国内镜像加速
  pip install tensorflow-cpu -i https://pypi.tuna.tsinghua.edu.cn/simple
  

---

安装步骤

使用 pip 直接安装 tensorboard_logger：

pip install tensorboard_logger

推荐使用国内镜像源以加快下载速度：

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

---

基本使用

1. 记录数据

在你的训练代码中，配置日志目录并记录数值。每个运行（run）建议使用独立的子目录以便在 TensorBoard 中对比。

from tensorboard_logger import configure, log_value

# 配置日志输出目录，flush_secs 控制刷新频率（秒）
configure("runs/run-1234", flush_secs=5)

for step in range(1000):
    v1, v2 = do_stuff()  # 替换为你的实际计算逻辑
    
    # 记录变量值：名称、数值、步数
    log_value('v1', v1, step)
    log_value('v2', v2, step)

2. 查看可视化结果

记录开始后（或完成后），在终端运行以下命令启动 TensorBoard 服务。注意 --logdir 应指向包含各个运行子目录的父目录。

tensorboard --logdir runs

启动成功后，浏览器访问： http://localhost:6006

即可看到 v1 和 v2 随步数变化的曲线图。

性能提示

单次记录操作的开销约为 0.1 - 0.2 毫秒，适合高频记录场景（每秒约可处理 5,000 - 10,000 次操作）。