README.md

TensorBoard Logger

Standalone C++ API to log data in TensorBoard format, without any code dependency on TensorFlow or TensorBoard.

Only support scalar, histogram, image, audio text and projector at the moment.

Using the library

Protobuf is the only dependency and assumed to be available via cmake's find_package.

To build and install TensorBoard Logger with cmake:

> BUILD_DIR=build
> mkdir -p $BUILD_DIR && cmake -B $BUILD_DIR . && cmake --build $BUILD_DIR -j
> cmake --install $BUILD_DIR

Alternatively to build a shared library set BUILD_SHARED_LIBS=ON:

> BUILD_DIR=build
> mkdir -p $BUILD_DIR && cmake -B $BUILD_DIR -DBUILD_SHARED_LIBS=ON . && cmake --build $BUILD_DIR -j
> cmake --install $BUILD_DIR

Then use find_package(tensorboard_logger REQUIRED) in your project.

Alternatively use via cmake FetchContent:

FetchContent_Declare(
    tensorboard_logger
    GIT_REPOSITORY      https://github.com/RustingSword/tensorboard_logger.git
    GIT_TAG             master
)
FetchContent_MakeAvailable(tensorboard_logger)

Make sure to add tensorboard_logger to target_link_libraries of your projects target.

To run the test:

> BUILD_DIR=build
> mkdir -p $BUILD_DIR && cmake -DBUILD_TEST=ON -B $BUILD_DIR . && cmake --build $BUILD_DIR -j
> mkdir -p demo && ./$BUILD_DIR/tensorboard_logger_test
> tensorboard --logdir demo  # try adding --load_fast=false if you don't see projector tab

Screenshots

Acknowledgement

• Inspired by dmlc tensorboard project.

• CRC code from The SNIPPETS Portable C/C++ Source Code Collection, via http://stackoverflow.com/a/303020, with some modifications.

• Audio sample from File Examples.