You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/09/10 23:54:05 UTC

[GitHub] indhub closed pull request #12455: Add Python API docs for test_utils and visualization

indhub closed pull request #12455: Add Python API docs for test_utils and visualization
URL: https://github.com/apache/incubator-mxnet/pull/12455
 
 
   

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/docs/api/python/index.md b/docs/api/python/index.md
index 15d1045a93e..8f60bcd0f13 100644
--- a/docs/api/python/index.md
+++ b/docs/api/python/index.md
@@ -177,4 +177,14 @@ Code examples are placed throughout the API documentation and these can be run a
    :maxdepth: 1
 
    symbol_in_pictures/symbol_in_pictures.md
-```
\ No newline at end of file
+```
+
+## Tools
+
+```eval_rst
+.. toctree::
+    :maxdepth: 1
+
+    tools/test_utils.md
+    tools/visualization.md
+```
diff --git a/docs/api/python/tools/test_utils.md b/docs/api/python/tools/test_utils.md
new file mode 100644
index 00000000000..e29d9b99a84
--- /dev/null
+++ b/docs/api/python/tools/test_utils.md
@@ -0,0 +1,27 @@
+# Test Utilities
+
+This module has a variety of tools that help using and testing MXNet.
+
+```eval_rst
+    .. currentmodule:: mxnet.test_utils
+```
+
+```eval_rst
+.. autosummary::
+    :nosignatures:
+
+    mxnet.test_utils
+```
+
+## API Reference
+
+<script type="text/javascript" src='../../../_static/js/auto_module_index.js'></script>
+
+```eval_rst
+
+.. automodule:: mxnet.test_utils
+    :members:
+
+```
+
+<script>auto_index("api-reference");</script>
diff --git a/docs/api/python/tools/visualization.md b/docs/api/python/tools/visualization.md
new file mode 100644
index 00000000000..6faa24980dd
--- /dev/null
+++ b/docs/api/python/tools/visualization.md
@@ -0,0 +1,27 @@
+# Visualization
+
+This module contains visualization features.
+
+```eval_rst
+    .. currentmodule:: mxnet.visualization
+```
+
+```eval_rst
+.. autosummary::
+    :nosignatures:
+
+    mxnet.visualization
+```
+
+## API Reference
+
+<script type="text/javascript" src='../../../_static/js/auto_module_index.js'></script>
+
+```eval_rst
+
+.. automodule:: mxnet.visualization
+    :members:
+
+```
+
+<script>auto_index("api-reference");</script>


 

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