ChainerUI

ChainerUI is a visualization and management tool for Chainer.

Installation

To install ChainerUI, use pip.

$ pip install chainerui

To install ChainerUI from source.

$ git clone https://github.com/chainer/chainerui.git
$ cd chainerui/frontend
$ npm install && npm run build && cd ..
$ python setup.py install

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.

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".

For more detailed usage, see getting started

Browser compatibility

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

Firefox
Chrome

License

MIT License

Contribution

Any contribution to ChainerUI is welcome!

Python codes follow the Chainer contribution guide.

Run tests

Install "pytest" package and run test

$ CHAINERUI_ENV=test pytest

Build client side JS

$ cd frontend
$ npm install
$ npm run build:watch

Bartzi/chainerui