[GitHub] indhub closed pull request #13291: Visualization doc fix. Added notes for shortform

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

indhub closed pull request #13291: Visualization doc fix. Added notes for shortform
URL: https://github.com/apache/incubator-mxnet/pull/13291
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/python/mxnet/visualization.py b/python/mxnet/visualization.py
index 9297edee810..1ebdcb54f4c 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:


 

----------------------------------------------------------------
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