Helper class for Tensorboard (can be used directly in Jupyter notebooks)

example.py

## Example Usage with Keras

# ...

try:
  tensorboard.start()

  model.fit(
    # ...
    callbacks = [
      tensorboard.get_tensorflow_callback()
    ]
  )
  
  tensorboard.stop()

except KeyboardInterrupt:
  tensorboard.stop()
  sys.stderr.write("Interrupted.\n")

except:
  tensorboard.stop()
  raise

# ...

Tensorboard.md

Tensorboard Helper

Usage

1. Add tensorboard.py to your project.
   • Add the file to your project and import it.
   • Or, if using Jupyter Notebook, paste it into a code cell.
2. Initialize the class as follows:

# Clear any logs from previous runs
!rm -rf ./logs/

# Set the log directory for Tensorboard.
log_dir = path.join("logs", datetime.datetime.now().strftime("%m%d%Y-%H%M%S"))

# If this is the main invocation (default for a Jupyter Notebook), then start
# TensorBoard and write the PID into a file so it can be controlled.
if __name__ == '__main__':
    tensorboard = Tensorboard(log_dir=log_dir)

3. Ensure sure you call tensorboard.start() before running model.fit.
4. Add tensorboard.get_tensorflow_callback() to the callbacks array when you run model.fit.
5. Ensure you call tensorboard.stop() to clean up after you call model.fit.

Refer to example.py for a demonstration.

License

(You may consider this public domain.)

MIT License

Copyright (c) 2022 Sam Jakob Mearns

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

tensorboard.py

class Tensorboard:
    def __init__(self, log_dir: str):
        """Initializes a Tensorboard process."""

        self.log_dir: str = log_dir
        """The directory containing Tensorboard's logs."""

        self.process: subprocess.Popen
        """The sub-process that Tensorboard runs in."""
    
    def get_tensorflow_callback(self, histogram_freq: int = 1) -> keras.callbacks.TensorBoard:
        """
        Instantiates and returns a Keras Tensorflow callback for the created
        Tensorboard instance.
        """
        return keras.callbacks.TensorBoard(
            log_dir=log_dir,
            histogram_freq=histogram_freq,
            write_graph=True,
            write_images=True,
            update_freq='batch',
            write_steps_per_second=True
        )

    def start(self) -> None:
        """
        Starts the Tensorboard process in the background, redirecting standard
        input to the current application/notebook.
        """
        if __name__ == '__main__':
            self.process = subprocess.Popen(
                ['tensorboard --logdir ' + log_dir], shell=True)
            
            print("Waiting for Tensorboard...")
            sleep(3)
            webbrowser.open('http://127.0.0.1:6006/')
        else:
            raise RuntimeError("Process creation aborted. This is not __main__.")

    
    def stop(self, force: bool = False) -> None:
        """Shuts down the Tensorboard process."""
        if force:
            print("Forcibly stopping Tensorboard...")
            self.process.kill()
            self.process.wait()
            print("Done.")
        else:
            print("Stopping Tensorboard...")
            self.process.terminate()
            self.process.wait()
            print("Done.")