diff --git a/chainerui/client/client.py b/chainerui/client/client.py index 944f98a2..7eccf380 100644 --- a/chainerui/client/client.py +++ b/chainerui/client/client.py @@ -299,7 +299,13 @@ def log_reporter(): with new one. The callback function is expected to use with ``postprocess`` - option of Chainer ``LogReport`` extension. + option of Chainer ``LogReport`` extension:: + + >>> chainerui.init() + >>> + >>> trainer = chainer.training.Trainer(...) + >>> trainer.extend( + >>> extensions.LogReport(postprocess=chainerui.log_reporter())) Returns: func: function. diff --git a/docs/source/reference/module.rst b/docs/source/reference/module.rst index c46616a5..dab65200 100644 --- a/docs/source/reference/module.rst +++ b/docs/source/reference/module.rst @@ -43,6 +43,18 @@ Asset summaries .. automethod:: chainerui.summary._Reporter.text +.. _module_web_client: + +Web client +---------- + +.. _module_web_client_log: + +.. autofunction:: chainerui.init +.. autofunction:: chainerui.log_reporter +.. autofunction:: chainerui.log + + Utilities ---------