Start Tensorboard in Jupyter Notebook
Clone or download
lspvic Release 0.1.8
* Support tensorflow 1.11, thanks @ferrarodav .
Latest commit bb33ce6 Oct 20, 2018

README.rst

Jupyter-Tensorboard: Start Tensorboard in Jupyter Notebook

build-status pypi-status pypi-pyversions tf-versions docker-stars

Tensorboard Integration for Jupyter Notebook.

A jupyter server extension for better collaboration between jupyter notebook and tensorboard (a visualization tool for tensorflow), providing graphical user interface for tensorboard start, manage and stop in jupyter interface. It provides:

  • No need to type tensorboard and the long log path in command line.
  • No need extra port for serve tensorboard. This is helpful for remote jupyter servers.
  • Multiple tensorboard instance managing simultaneously.

Installation

  1. Be sure that tensorflow(-gpu)>=1.3.0 has been installed. If not, you should install or upgrade your tensorflow>=1.3.0 first, and tensorboard is a dependency of tensorflow so that it is automatically installed. This package does not have a tensorflow dependency because there are several distributions of tensorflow, for example, tensorflow and tensorflow-gpu. Any way, you must be sure you have tensorflow(-gpu) installed before install this package.

  2. Install the pip package. The python version must be the same as Jupyter: if you start jupyter notebook in python3, pip3 may be used to install the package

    pip(3) install jupyter-tensorboard

    NOTE:

    The python version is important, you must be sure that your jupyter, jupyter_tensorboard, tensorflow have the same python version. If your tensorflow python and jupyter python versions are different, e.g., use tensorflow in py2 but jupyter starts in py3, both versions of tensorflow(py2 and py3) should be installed, and jupyter_tensorboard should install to py3, in accordance with jupyter.

  3. Restart the jupyter notebook server.

Use jupyter-tensorboard in docker containers

Docker image for Jupyter Notebook Scientific Python Stack + Tensorflow + Tensorboard is available, just with the command:

docker pull lspvic/tensorboard-notebook
docker run -it --rm -p 8888:8888 lspvic/tensorboard-notebook

Jupyter notebook with tensorboard integrated is now available in http://localhost:8888 , details are in docker/README.md.

Usage

Once jupyter_tensorboard is installed and enabled, and your notebook server has been restarted, you should be able to find the interfaces to manage tensorboard instances.

  • In notebook tree view, select a directory, a tensorboard button will be presented. Click the button, a new browser tab will be opened to show the tensorboard interface with the proposed directory as logdir.

https://github.com/lspvic/jupyter_tensorboard/raw/master/docs/_static/tensorboard_button.png

  • In notebook tree view, click the tensorboard menu in new and a new tensorboard instance is started with current directory as logdir.

https://github.com/lspvic/jupyter_tensorboard/raw/master/docs/_static/tensorboard_menu.png

  • In notebook running tab, a list of tensorboard instances are showed. Managing operations such as browsing, navigating, shutdown can be found here.

https://github.com/lspvic/jupyter_tensorboard/raw/master/docs/_static/tensorboard_list.png

  • The tensorboard instance interface is in http://jupyter-host/tensorboard/<name>/ with the instance names increasing from 1.

https://github.com/lspvic/jupyter_tensorboard/raw/master/docs/_static/tensorboard_url.png

Uninstall

To purge the installation of the extension, there are a few steps to execute:

jupyter tensorboard disable --user
pip uninstall jupyter-tensorboard

or if you have uninstall the pip package, but the extension seems to be not purged, you can execute:

jupyter serverextension disable jupyter_tensorboard --user
jupyter nbextension disable jupyter_tensorboard/tree --user
jupyter nbextension uninstall jupyter_tensorboard --user

The commands accept the same flags as the jupyter serverextension command provided by notebook versions, including --system to enable(or disable) in system-wide config, or --sys-prefix to enable(or disable) in config files inside python's sys.prefix, such as for a virtual environment.

Troubleshooting

If you encounter problems with this server extension, you can:

  • Check that jupyter-tensorboard, tensorflow and tensorboard are all installed via pip list|grep tensor, you should see at least three lines, jupyter-tensorboard, tensorflow and tensorflow-tensorboard (or tensorboard ). And also, check that tensorflow version is >=1.3.
  • Check that jupyter notebook is installed in the same python version via pip list|grep notebook, you shold see notebook package.
  • If you have installed the package but no buttons of tensorboard in jupyter appear, you need to run jupyter tensorboard enable --user. The step should be performed in the installation process, however, in some cases it seems that the command is not executed.
  • Checking for error messages in the browser's Javascript console (e.g. CTRL+SHIFT+J in Chrome).
  • Check the issue page for this repository. If you can't find one that fits your problem, please create a new one!

Thanks

Thanks all the contributors and others for making significant contributions (report bugs, fix bugs, make enhancements, etc).