Merge pull request #314 from disktnk/fix/web-api-doc

Add web client API documentation
chainer · Aug 5, 2019 · a4ce011 · a4ce011
2 parents b651d65 + 9f229ae
commit a4ce011
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git 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
@@ -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
 ---------