[GitHub] fhieber commented on a change in pull request #10139: [REQUEST FOR REVIEW] [MXNET-109] Logging APIs for Visualizing MXNet Data in TensorBoard

[GitBox <gi...@apache.org>]

fhieber commented on a change in pull request #10139: [REQUEST FOR REVIEW] [MXNET-109] Logging APIs for Visualizing MXNet Data in TensorBoard
URL: https://github.com/apache/incubator-mxnet/pull/10139#discussion_r175684515
 
 

 ##########
 File path: docs/api/python/contrib/summary.md
 ##########
 @@ -0,0 +1,258 @@
+# Logging MXNet Data for Visualization in TensorBoard
+
+## Overview
+
+The module `mxnet.contrib.summary` enables MXNet users to visualize data in
+[TensorBoard](https://www.tensorflow.org/programmers_guide/summaries_and_tensorboard). 
+Please note that this module only provides the APIs for data logging. For visualization,
+users still need to install TensorBoard.
+
+### How to install TensorBoard
+To launch TensorBoard for visualization, make sure you have the
+[official release of TensorBoard](https://pypi.python.org/pypi/tensorboard) installed.
+You can type `pip install tensorboard` on you machine to install TensorBoard.
 
 Review comment:
   Small comment: the official Tensorboard package requires Tensorflow, but does not declare this dependency in the pypi package (https://pypi.python.org/pypi/tensorboard). So you might need to add a 'pip install tensorflow' here.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services