Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 1.67 KB

README.md

File metadata and controls

60 lines (41 loc) · 1.67 KB
Raw

chaineripy

example screenshot

Utilities to integrate Chainer with IPython. Currently it consists two trainer extensions: chaineripy.extensions.PrintReport and chaineripy.extensions.ProgressBar.

INSTALL

pip install chaineripy

You need to enable the widgets extension.

USAGE

Those extensions provide the same API as Chainer's builtin counterparts, so all you need to do is replace

from chainer.training.extensions import PrintReport, ProgressBar

by

from chaineripy.extensions import PrintReport, ProgressBar

when you run Chainer on a IPython notebook.

The example notebook demonstrates the usage.

PrintReport and ProgressBar classes also export the following functions and properties.

PringReport.update(self, log)
@property
PringReport.widget(self)

ProgressBar.update(self, iteration, epoch_detail)
@property
ProgressBar.widget(self)

For detailed usages, please see the source codes. Using these functionalities, you can show the widgets provided even if you don't use Trainer or Updater.

CONTRIBUTION

Contributions are very welcome, including but not limited to: new widgets or features, bug fixes, documents improvements, and aesthetic improvements.

Adding codes that work on both of plain terminal and other IPython consoles are much welcomed, but I WON'T support dynamic detection of the type of current console. If you couldn't write console neutral code, please create modules for each console supporting the same API, and let users choose the appropriate module.