Installation Guide

Dependencies

ChainerUI is developed under Python 2.7+, 3.5+, 3.6+. For other requirements, see requirements.txt.

requirements.txt
enum34>=1.1.6; python_version < '3.4'
msgpack>=0.5.6
Flask>=1.0.2
sqlalchemy>=1.1.18
alembic>=1.0.0
chainer>=3.0.0
gevent>=1.2.2
structlog>=18.2.0

ChainerUI uses sqlite3 module which is included in the standard Python library. If Python is built from source, sqlite3 must be installed before building Python.

  • On Ubuntu, libsqlite3-dev must be installed before building Python ($ apt-get install libsqlite3-dev).
  • On Windows, install Visual C++ Build Tools with the Default Install setting before building Python.

Install ChainerUI

Install ChainerUI via PyPI

To install ChainerUI, use pip:

$ pip install chainerui

Install ChainerUI from source

To install ChaineruI from source, build from a cloned Git repository. Frontend module requires npm 6.2.0+:

$ git clone https://github.com/chainer/chainerui.git
$ cd chainerui/frontend
$ npm install && npm run build && cd ..
$ pip install -e .

Quick start

Initialize ChainerUI database:

$ chainerui db create
$ chainerui db upgrade

Clone examples of train log and create a project:

$ git clone https://github.com/chainer/chainerui.git
$ cd chainerui

$ # create your first project
$ chainerui project create -d examples -n example-project

Run ChainerUI server:

$ chainerui server

Open http://localhost:5000/ and select “example-project”, then show a chart of training logs.

For more detailed usage, see Getting started.

Docker start

Get Docker container from DockerHub and start ChainerUI server. The container has installed ChainerUI module, setup a DB and a command to start the server:

$ git clone https://github.com/chainer/chainerui.git
$ cd chainerui

$ # replace tag to the latest version number
$ docker pull chainer/chainerui:v0.4.0
$ docker run -d -p 5000:5000 -v $PWD:/projects --name chainerui chainer/chainerui:v0.4.0
$ # then ChainerUI server is running
$ # create project via HTTP
$ curl http://localhost:5000/api/v1/projects -X POST -H "Content-Type: application/json" -d '{"project":{"name":"example-project","path_name":"/projects/examples"}}'

Open http://localhost:5000/ and select “example-project”, then show a chart of training logs.

Form more detailed usage, see Use Docker.

Browser compatibility

ChainerUI is supported by the latest stable version of the following browsers.

  • Firefox
  • Chrome