Repository files navigation

Crayon is a framework that gives you access to the visualisation powerofTensorBoard withany language. Currently it provides a Python and a Lua interface, howeveryou can easily implement a wrapper around theprovidedRESTful API.

This system is composed of two parts:

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

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

The machine that will host the server needs tohavedocker installed. The server is completelypackaged inside a docker container. To get it, run:

$ docker pull alband/crayon

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

TL;DR:

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

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 atserver_machine_address:8888. Theclient should send the data atserver_machine_address:8889.

See the documentation for the required language:

• Lua
• Python