marcoabreu closed pull request #9873: add doc for gluon contrib
URL: https://github.com/apache/incubator-mxnet/pull/9873
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/gluon/contrib.md b/docs/api/python/gluon/contrib.md
index 86f0331a5e7..bc3089fa878 100644
--- a/docs/api/python/gluon/contrib.md
+++ b/docs/api/python/gluon/contrib.md
@@ -24,22 +24,60 @@ In the rest of this document, we list routines provided by
the `gluon.contrib` p
## Contrib
+### Neural network
+
+```eval_rst
+.. currentmodule:: mxnet.gluon.contrib.nn
+
+.. autosummary::
+ :nosignatures:
+
+ Concurrent
+ HybridConcurrent
+ Identity
+```
+
+### Recurrent neural network
+
+```eval_rst
+.. currentmodule:: mxnet.gluon.contrib.rnn
+
+.. autosummary::
+ :nosignatures:
+
+ VariationalDropoutCell
+ Conv1DRNNCell
+ Conv2DRNNCell
+ Conv3DRNNCell
+ Conv1DLSTMCell
+ Conv2DLSTMCell
+ Conv3DLSTMCell
+ Conv1DGRUCell
+ Conv2DGRUCell
+ Conv3DGRUCell
+```
+
+### Data
+
```eval_rst
-.. currentmodule:: mxnet.gluon.contrib
+.. currentmodule:: mxnet.gluon.contrib.data
.. autosummary::
:nosignatures:
- rnn.VariationalDropoutCell
- rnn.Conv1DRNNCell
- rnn.Conv2DRNNCell
- rnn.Conv3DRNNCell
- rnn.Conv1DLSTMCell
- rnn.Conv2DLSTMCell
- rnn.Conv3DLSTMCell
- rnn.Conv1DGRUCell
- rnn.Conv2DGRUCell
- rnn.Conv3DGRUCell
+ IntervalSampler
+```
+
+#### Text dataset
+
+```eval_rst
+.. currentmodule:: mxnet.gluon.contrib.data.text
+
+.. autosummary::
+ :nosignatures:
+
+ WikiText2
+ WikiText103
```
## API Reference
@@ -52,10 +90,22 @@ In the rest of this document, we list routines provided by
the `gluon.contrib` p
:members:
:imported-members:
+.. automodule:: mxnet.gluon.contrib.nn
+ :members:
+ :imported-members:
+
.. automodule:: mxnet.gluon.contrib.rnn
:members:
:imported-members:
+.. automodule:: mxnet.gluon.contrib.data
+ :members:
+ :imported-members:
+
+.. automodule:: mxnet.gluon.contrib.data.text
+ :members:
+ :imported-members:
+
```
<script>auto_index("api-reference");</script>
diff --git a/python/mxnet/gluon/contrib/data/text.py
b/python/mxnet/gluon/contrib/data/text.py
index 82f780942a0..93c42bb6ff7 100644
--- a/python/mxnet/gluon/contrib/data/text.py
+++ b/python/mxnet/gluon/contrib/data/text.py
@@ -108,7 +108,7 @@ class WikiText2(_WikiText):
Parameters
----------
- root : str, default '~/.mxnet/datasets/cifar10'
+ root : str, default '~/.mxnet/datasets/wikitext-2'
Path to temp folder for storing data.
segment : str, default 'train'
Dataset segment. Options are 'train', 'validation', 'test'.
@@ -146,7 +146,7 @@ class WikiText103(_WikiText):
Parameters
----------
- root : str, default '~/.mxnet/datasets/cifar10'
+ root : str, default '~/.mxnet/datasets/wikitext-103'
Path to temp folder for storing data.
segment : str, default 'train'
Dataset segment. Options are 'train', 'validation', 'test'.
----------------------------------------------------------------
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:
us...@infra.apache.org
With regards,
Apache Git Services
