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

Commit c6a7aba

Browse files
szhamarcoabreu
authored andcommitted
add doc for gluon contrib (#9873)
1 parent fbbc080 commit c6a7aba

File tree

2 files changed

+63
-13
lines changed

2 files changed

+63
-13
lines changed

docs/api/python/gluon/contrib.md

Lines changed: 61 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,60 @@ In the rest of this document, we list routines provided by the `gluon.contrib` p
2424

2525
## Contrib
2626

27+
### Neural network
28+
29+
```eval_rst
30+
.. currentmodule:: mxnet.gluon.contrib.nn
31+
32+
.. autosummary::
33+
:nosignatures:
34+
35+
Concurrent
36+
HybridConcurrent
37+
Identity
38+
```
39+
40+
### Recurrent neural network
41+
42+
```eval_rst
43+
.. currentmodule:: mxnet.gluon.contrib.rnn
44+
45+
.. autosummary::
46+
:nosignatures:
47+
48+
VariationalDropoutCell
49+
Conv1DRNNCell
50+
Conv2DRNNCell
51+
Conv3DRNNCell
52+
Conv1DLSTMCell
53+
Conv2DLSTMCell
54+
Conv3DLSTMCell
55+
Conv1DGRUCell
56+
Conv2DGRUCell
57+
Conv3DGRUCell
58+
```
59+
60+
### Data
61+
2762
```eval_rst
28-
.. currentmodule:: mxnet.gluon.contrib
63+
.. currentmodule:: mxnet.gluon.contrib.data
2964
3065
.. autosummary::
3166
:nosignatures:
3267
33-
rnn.VariationalDropoutCell
34-
rnn.Conv1DRNNCell
35-
rnn.Conv2DRNNCell
36-
rnn.Conv3DRNNCell
37-
rnn.Conv1DLSTMCell
38-
rnn.Conv2DLSTMCell
39-
rnn.Conv3DLSTMCell
40-
rnn.Conv1DGRUCell
41-
rnn.Conv2DGRUCell
42-
rnn.Conv3DGRUCell
68+
IntervalSampler
69+
```
70+
71+
#### Text dataset
72+
73+
```eval_rst
74+
.. currentmodule:: mxnet.gluon.contrib.data.text
75+
76+
.. autosummary::
77+
:nosignatures:
78+
79+
WikiText2
80+
WikiText103
4381
```
4482

4583
## API Reference
@@ -52,10 +90,22 @@ In the rest of this document, we list routines provided by the `gluon.contrib` p
5290
:members:
5391
:imported-members:
5492
93+
.. automodule:: mxnet.gluon.contrib.nn
94+
:members:
95+
:imported-members:
96+
5597
.. automodule:: mxnet.gluon.contrib.rnn
5698
:members:
5799
:imported-members:
58100
101+
.. automodule:: mxnet.gluon.contrib.data
102+
:members:
103+
:imported-members:
104+
105+
.. automodule:: mxnet.gluon.contrib.data.text
106+
:members:
107+
:imported-members:
108+
59109
```
60110

61111
<script>auto_index("api-reference");</script>

python/mxnet/gluon/contrib/data/text.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class WikiText2(_WikiText):
108108
109109
Parameters
110110
----------
111-
root : str, default '~/.mxnet/datasets/cifar10'
111+
root : str, default '~/.mxnet/datasets/wikitext-2'
112112
Path to temp folder for storing data.
113113
segment : str, default 'train'
114114
Dataset segment. Options are 'train', 'validation', 'test'.
@@ -146,7 +146,7 @@ class WikiText103(_WikiText):
146146
147147
Parameters
148148
----------
149-
root : str, default '~/.mxnet/datasets/cifar10'
149+
root : str, default '~/.mxnet/datasets/wikitext-103'
150150
Path to temp folder for storing data.
151151
segment : str, default 'train'
152152
Dataset segment. Options are 'train', 'validation', 'test'.

0 commit comments

Comments
 (0)