Metadata-Version: 2.3
Name: tensorboard-book
Version: 0.7.0
Summary: Bookkeeping for folders of TensorBoard runs: index, tag, group, compare and browse artifacts.
Author: Esteban Gomez
Author-email: Esteban Gomez <esteban.gomezmellado@aalto.fi>
License: MIT
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Dist: numpy>=1.24
Requires-Dist: plotly>=6.0
Requires-Dist: polars>=1.20
Requires-Dist: pyyaml>=6.0
Requires-Dist: streamlit>=1.50
Requires-Dist: tensorboard>=2.12
Requires-Python: >=3.10
Project-URL: Source, https://github.com/eagomez2/tensorboard-book
Project-URL: Documentation, https://github.com/eagomez2/tensorboard-book/tree/main/docs
Description-Content-Type: text/markdown

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg">
    <img src="assets/logo.svg" width="96" alt="tensorboard-book logo">
  </picture>
</p>

<h1 align="center"><code>tensorboard-book</code></h1>

<p align="center">
  <a href="pyproject.toml"><img src="https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-2F6BD8" alt="Python 3.10 to 3.13"></a>
  <a href="pyproject.toml"><img src="https://img.shields.io/badge/version-0.7.0-0F5F5A" alt="version 0.7.0"></a>
  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-0F5F5A" alt="MIT license"></a>
  <a href="https://eagomez2.github.io/tensorboard-book/"><img src="https://img.shields.io/badge/docs-online-0F5F5A" alt="documentation"></a>
  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
</p>

A web application for organizing and comparing the runs in a TensorBoard
log folder. `tensorboard-book` indexes every run, reports the best value of
each metric, and stores tags, notes and groups alongside the runs. It can
compare runs at their best step, overlay curves, show when runs were active,
browse run files, and open any selection of runs in TensorBoard.

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="docs/images/experiments-dark.webp">
  <img src="docs/images/experiments-light.webp" alt="The Experiments view">
</picture>

## Install

Requires Python 3.10 or newer.

```bash
git clone https://github.com/eagomez2/tensorboard-book
cd tensorboard-book
uv tool install .      # or: pip install .
```

## Usage

Start the app on the folder that you pass to `tensorboard --logdir`:

```bash
tensorboard-book /path/to/runs
```

To try it on example data, run `tensorboard-book demo tbook-demo` and then
`tensorboard-book tbook-demo`. The
[quick start](https://eagomez2.github.io/tensorboard-book/quickstart/)
walks through the demo.

## Documentation

The documentation is available at
**[eagomez2.github.io/tensorboard-book](https://eagomez2.github.io/tensorboard-book/)**.
It covers installation, passwords and deployment, each view of the app, the
filter syntax and all commands. Its source is in [`docs/`](docs/index.md).

## License

For further details about the license of this tool, please see
[LICENSE](LICENSE), using MIT license.

## Disclaimer

`tensorboard-book` is an independent project. It is not affiliated with or
endorsed by Google or the TensorFlow team.

## Author

Esteban Gomez ([esteban.gomezmellado@aalto.fi](mailto:esteban.gomezmellado@aalto.fi))
