[incubator-mxnet] branch master updated: Visualization doc fix. Added notes for shortform (#13291)

[in...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

indhub pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new 5af975e  Visualization doc fix. Added notes for shortform (#13291)
5af975e is described below

commit 5af975e8b1d5f368f5c9a039ec6d2184c583eb99
Author: vdantu <36...@users.noreply.github.com>
AuthorDate: Fri Nov 16 13:35:10 2018 -0800

    Visualization doc fix. Added notes for shortform (#13291)
---
 python/mxnet/visualization.py | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/python/mxnet/visualization.py b/python/mxnet/visualization.py
index 9297ede..1ebdcb5 100644
--- a/python/mxnet/visualization.py
+++ b/python/mxnet/visualization.py
@@ -57,9 +57,22 @@ def print_summary(symbol, shape=None, line_length=120, positions=[.44, .64, .74,
         Rotal length of printed lines
     positions: list
         Relative or absolute positions of log elements in each line.
+
     Returns
     ------
     None
+
+    Notes
+    -----
+    If ``mxnet`` is imported, the visualization module can be used in its short-form.
+    For example, if we ``import mxnet`` as follows::
+
+        import mxnet
+
+    this method in visualization module can be used in its short-form as::
+
+        mxnet.viz.print_summary(...)
+
     """
     if not isinstance(symbol, Symbol):
         raise TypeError("symbol must be Symbol")
@@ -238,6 +251,18 @@ def plot_network(symbol, title="plot", save_format='pdf', shape=None, node_attrs
     >>> digraph = mx.viz.plot_network(net, shape={'data':(100,200)},
     ... node_attrs={"fixedsize":"false"})
     >>> digraph.view()
+
+    Notes
+    -----
+    If ``mxnet`` is imported, the visualization module can be used in its short-form.
+    For example, if we ``import mxnet`` as follows::
+
+        import mxnet
+
+    this method in visualization module can be used in its short-form as::
+
+        mxnet.viz.plot_network(...)
+
     """
     # todo add shape support
     try: