A language-agnostic interface to TensorBoard
Clone or download
albanD Merge pull request #34 from albanD/sanitise_q
sanitises special characters in experiment name and key name
Latest commit 3e39fa7 Jul 12, 2017
Permalink
Failed to load latest commit information.
client fix for python 3 Jul 12, 2017
doc multiple features: Jan 25, 2017
server Only work with the exact same timestamp Feb 26, 2017
.gitignore Initial commit Dec 10, 2016
.travis.yml Fix cont build (#33) Jul 12, 2017
CONTRIBUTING.md Fix cont build (#33) Jul 12, 2017
LICENSE Initial commit Dec 10, 2016
README.md Update Tensorboard link Jul 11, 2017

README.md

Crayon Build Status PyPI

Crayon is a framework that gives you access to the visualisation power of TensorBoard with any language. Currently it provides a Python and a Lua interface, however you can easily implement a wrapper around the provided RESTful API.


This system is composed of two parts:

  • A server running on a given machine that will be used to display tensorboard and store all the data.
  • A client embedded inside your code that will send the datas to the server.

Note that the server and the client do not have to be on the same machine.

Install

Server machine

The machine that will host the server needs to have docker installed. The server is completely packaged inside a docker container. To get it, run:

$ docker pull alband/crayon

Client machine

The client machine only need to install the client for the required language. Detailed instructions can be read by nagivating to their respective directories.

TL;DR:

  • Lua / Torch - $ luarocks install crayon
  • Python 2 - $ pip install pycrayon
  • Python 3 - $ pip3 install pycrayon

Usage

Server machine

To start the server, run the following:

$ docker run -d -p 8888:8888 -p 8889:8889 --name crayon alband/crayon

Tensorboard is now accessible on a browser at server_machine_address:8888. The client should send the data at server_machine_address:8889.

Client

See the documentation for the required language: