Skip to content
This repository has been archived by the owner on Feb 6, 2023. It is now read-only.

Add web client API documentation #314

Merged
merged 4 commits into from
Aug 5, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion chainerui/client/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 12 additions & 0 deletions docs/source/reference/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------

Expand Down