models.rst 4.6 KB
Newer Older
Tomás Osório's avatar
Tomás Osório committed
1
2
3
4
.. role:: hidden
    :class: hidden-section

torchaudio.models
moto's avatar
moto committed
5
=================
Tomás Osório's avatar
Tomás Osório committed
6
7
8
9
10
11

.. currentmodule:: torchaudio.models

The models subpackage contains definitions of models for addressing common audio tasks.


moto's avatar
moto committed
12
13
ConvTasNet
~~~~~~~~~~
moto's avatar
moto committed
14
15
16
17
18
19

.. autoclass:: ConvTasNet

  .. automethod:: forward


moto's avatar
moto committed
20
21
DeepSpeech
~~~~~~~~~~
discort's avatar
discort committed
22
23
24
25
26
27

.. autoclass:: DeepSpeech

  .. automethod:: forward


28
29
30
Tacotron2
~~~~~~~~~

moto's avatar
moto committed
31
32
33
34
35
36
Model
-----

Tacotoron2
^^^^^^^^^^

37
38
39
40
41
42
43
44
45
46
.. autoclass:: Tacotron2

  .. automethod:: forward

  .. automethod:: infer

Factory Functions
-----------------

tacotron2
moto's avatar
moto committed
47
^^^^^^^^^
48
49
50
51

.. autofunction:: tacotron2


moto's avatar
moto committed
52
53
Wav2Letter
~~~~~~~~~~
Tomás Osório's avatar
Tomás Osório committed
54
55
56
57

.. autoclass:: Wav2Letter

  .. automethod:: forward
jimchen90's avatar
jimchen90 committed
58
59


moto's avatar
moto committed
60
61
Wav2Vec2.0 / HuBERT
~~~~~~~~~~~~~~~~~~~
moto's avatar
moto committed
62

moto's avatar
moto committed
63
64
65
Model
-----

moto's avatar
moto committed
66
Wav2Vec2Model
moto's avatar
moto committed
67
^^^^^^^^^^^^^
moto's avatar
moto committed
68
69
70
71
72
73
74
75
76
77

.. autoclass:: Wav2Vec2Model

  .. automethod:: extract_features

  .. automethod:: forward

Factory Functions
-----------------

78
79
80
81
82
83
wav2vec2_model
^^^^^^^^^^^^^^

.. autofunction:: wav2vec2_model


moto's avatar
moto committed
84
wav2vec2_base
moto's avatar
moto committed
85
^^^^^^^^^^^^^
moto's avatar
moto committed
86

moto's avatar
moto committed
87
88
.. autofunction:: wav2vec2_base

moto's avatar
moto committed
89
wav2vec2_large
moto's avatar
moto committed
90
^^^^^^^^^^^^^^
moto's avatar
moto committed
91

moto's avatar
moto committed
92
93
.. autofunction:: wav2vec2_large

moto's avatar
moto committed
94
wav2vec2_large_lv60k
moto's avatar
moto committed
95
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
96

moto's avatar
moto committed
97
98
.. autofunction:: wav2vec2_large_lv60k

99
wav2vec2_ft_base
100
101
^^^^^^^^^^^^^^^^^

102
.. autofunction:: wav2vec2_ft_base
103

104
wav2vec2_ft_large
105
106
^^^^^^^^^^^^^^^^^^

107
.. autofunction:: wav2vec2_ft_large
108

109
wav2vec2_ft_large_lv60k
110
111
^^^^^^^^^^^^^^^^^^^^^^^^

112
.. autofunction:: wav2vec2_ft_large_lv60k
113

moto's avatar
moto committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
hubert_base
^^^^^^^^^^^

.. autofunction:: hubert_base

hubert_large
^^^^^^^^^^^^

.. autofunction:: hubert_large

hubert_xlarge
^^^^^^^^^^^^^

.. autofunction:: hubert_xlarge

129
hubert_ft_large
moto's avatar
moto committed
130
131
^^^^^^^^^^^^^^^^

132
.. autofunction:: hubert_ft_large
moto's avatar
moto committed
133

134
hubert_ft_xlarge
moto's avatar
moto committed
135
136
^^^^^^^^^^^^^^^^^

137
.. autofunction:: hubert_ft_xlarge
moto's avatar
moto committed
138

139
140
141
142
143
144
145
146
147
Pre-trained Models
------------------

.. autoclass:: Wav2Vec2PretrainedModelBundle

   .. automethod:: get_model

   .. autoproperty:: labels

148
149
150
151
152
153

WAV2VEC2_BASE
^^^^^^^^^^^^^

.. container:: py attribute

154
155
156
   .. autodata:: WAV2VEC2_BASE
      :no-value:

157
158
159
160
161
162
WAV2VEC2_ASR_BASE_10M
^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

   .. autodata:: torchaudio.models.WAV2VEC2_ASR_BASE_10M
163
164
      :no-value:

165
166
167
168
169
WAV2VEC2_ASR_BASE_100H
^^^^^^^^^^^^^^^^^^^^^^
      
.. container:: py attribute

170
171
172
   .. autodata:: WAV2VEC2_ASR_BASE_100H
      :no-value:

173
174
175
176
177
WAV2VEC2_ASR_BASE_960H
^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

178
179
180
   .. autodata:: WAV2VEC2_ASR_BASE_960H
      :no-value:

181
182
183
184
185
WAV2VEC2_LARGE
^^^^^^^^^^^^^^

.. container:: py attribute

186
187
188
   .. autodata:: WAV2VEC2_LARGE
      :no-value:

189
190
191
192
193
WAV2VEC2_ASR_LARGE_10M
^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

194
195
196
   .. autodata:: WAV2VEC2_ASR_LARGE_10M
      :no-value:

197
198
199
200
201
WAV2VEC2_ASR_LARGE_100H
^^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

202
203
204
   .. autodata:: WAV2VEC2_ASR_LARGE_100H
      :no-value:

205
206
207
208
209
WAV2VEC2_ASR_LARGE_960H
^^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

210
211
212
   .. autodata:: WAV2VEC2_ASR_LARGE_960H
      :no-value:

213
214
215
216
217
WAV2VEC2_LARGE_LV60K
^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

218
219
220
   .. autodata:: WAV2VEC2_LARGE_LV60K
      :no-value:

221
222
223
224
225
WAV2VEC2_ASR_LARGE_LV60K_10M
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

226
227
228
   .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_10M
      :no-value:

229
230
231
232
233
WAV2VEC2_ASR_LARGE_LV60K_100H
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

234
235
236
   .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_100H
      :no-value:

237
238
239
240
241
WAV2VEC2_ASR_LARGE_LV60K_960H
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: py attribute

242
243
244
   .. autodata:: WAV2VEC2_ASR_LARGE_LV60K_960H
      :no-value:

245
246
247
248
249
WAV2VEC2_XLSR53
^^^^^^^^^^^^^^^

.. container:: py attribute

250
251
252
   .. autodata:: WAV2VEC2_XLSR53
      :no-value:

253
254
255
256
257
HUBERT_BASE
^^^^^^^^^^^

.. container:: py attribute

258
259
260
   .. autodata:: HUBERT_BASE
      :no-value:

261
262
263
264
265
HUBERT_LARGE
^^^^^^^^^^^^

.. container:: py attribute

266
267
268
   .. autodata:: HUBERT_LARGE
      :no-value:

269
270
271
272
273
HUBERT_XLARGE
^^^^^^^^^^^^^

.. container:: py attribute

274
275
276
   .. autodata:: HUBERT_XLARGE
      :no-value:

277
278
279
280
281
HUBERT_ASR_LARGE
^^^^^^^^^^^^^^^^

.. container:: py attribute

282
283
   .. autodata:: HUBERT_ASR_LARGE
      :no-value:
284

285
286
287
288
289
HUBERT_ASR_XLARGE
^^^^^^^^^^^^^^^^^

.. container:: py attribute

290
291
292
   .. autodata:: HUBERT_ASR_XLARGE
      :no-value:

293
294
295
Utility Functions
-----------------

296
297
.. currentmodule:: torchaudio.models.wav2vec2.utils

moto's avatar
moto committed
298
import_huggingface_model
moto's avatar
moto committed
299
^^^^^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
300

301
302
.. autofunction:: import_huggingface_model

moto's avatar
moto committed
303
import_fairseq_model
moto's avatar
moto committed
304
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
305

moto's avatar
moto committed
306
307
.. autofunction:: import_fairseq_model

308
.. currentmodule:: torchaudio.models
moto's avatar
moto committed
309

moto's avatar
moto committed
310
311
WaveRNN
~~~~~~~
jimchen90's avatar
jimchen90 committed
312

moto's avatar
moto committed
313
314
315
316
317
318
Model
-----

WaveRNN
^^^^^^^

jimchen90's avatar
jimchen90 committed
319
320
321
.. autoclass:: WaveRNN

  .. automethod:: forward
moto's avatar
moto committed
322

323
324
  .. automethod:: infer

325
326
327
328
Factory Functions
-----------------

wavernn
moto's avatar
moto committed
329
^^^^^^^
330
331
332

.. autofunction:: wavernn

moto's avatar
moto committed
333
334
335
336
References
~~~~~~~~~~

.. footbibliography::