Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Add Python API docs for test_utils and visualization #12455

Merged
merged 5 commits into from
Sep 10, 2018
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/api/python/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,3 +177,13 @@ Code examples are placed throughout the API documentation and these can be run a

symbol_in_pictures/symbol_in_pictures.md
```

## Tools

```eval_rst
.. toctree::
:maxdepth: 1

tools/test_utils.md
tools/visualization.md
```
27 changes: 27 additions & 0 deletions docs/api/python/tools/test_utils.md
Original file line number Diff line number Diff line change
@@ -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>
27 changes: 27 additions & 0 deletions docs/api/python/tools/visualization.md
Original file line number Diff line number Diff line change
@@ -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>