models.rst 3.18 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

moto's avatar
moto committed
7
8
.. py:module:: torchaudio.models

Tomás Osório's avatar
Tomás Osório committed
9
10
11
12
.. currentmodule:: torchaudio.models

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

13
14
15
16
17
18
Conformer
~~~~~~~~~

.. autoclass:: Conformer

  .. automethod:: forward
Tomás Osório's avatar
Tomás Osório committed
19

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

.. autoclass:: ConvTasNet

  .. automethod:: forward


moto's avatar
moto committed
28
29
DeepSpeech
~~~~~~~~~~
discort's avatar
discort committed
30
31
32
33
34

.. autoclass:: DeepSpeech

  .. automethod:: forward

35
36
37
38
39
40
41
42
43
Emformer
~~~~~~~~

.. autoclass:: Emformer

  .. automethod:: forward

  .. automethod:: infer

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
Hybrid Demucs
~~~~~~~~~~~~~

Model
-----

HDemucs
^^^^^^^

.. autoclass:: HDemucs

  .. automethod:: forward

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

hdemucs_low
^^^^^^^^^^^

.. autofunction:: hdemucs_low

hdemucs_medium
^^^^^^^^^^^^^^

.. autofunction:: hdemucs_medium

hdemucs_high
^^^^^^^^^^^^

.. autofunction:: hdemucs_high

75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
RNN-T
~~~~~

Model
-----

RNNT
^^^^

.. autoclass:: RNNT

  .. automethod:: forward

  .. automethod:: transcribe_streaming

  .. automethod:: transcribe

  .. automethod:: predict

  .. automethod:: join

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

emformer_rnnt_model
^^^^^^^^^^^^^^^^^^^

.. autofunction:: emformer_rnnt_model

emformer_rnnt_base
^^^^^^^^^^^^^^^^^^

.. autofunction:: emformer_rnnt_base


Decoder
-------

RNNTBeamSearch
^^^^^^^^^^^^^^

.. autoclass:: RNNTBeamSearch

  .. automethod:: forward

  .. automethod:: infer

Hypothesis
^^^^^^^^^^

125
.. container:: py attribute
126

127
128
  .. autodata::  Hypothesis
    :no-value:
discort's avatar
discort committed
129

130
131
132
133
134
135
136
137
138
Tacotron2
~~~~~~~~~

.. autoclass:: Tacotron2

  .. automethod:: forward

  .. automethod:: infer

moto's avatar
moto committed
139
140
Wav2Letter
~~~~~~~~~~
Tomás Osório's avatar
Tomás Osório committed
141
142
143
144

.. autoclass:: Wav2Letter

  .. automethod:: forward
jimchen90's avatar
jimchen90 committed
145
146


moto's avatar
moto committed
147
148
Wav2Vec2.0 / HuBERT
~~~~~~~~~~~~~~~~~~~
moto's avatar
moto committed
149

moto's avatar
moto committed
150
151
152
Model
-----

moto's avatar
moto committed
153
Wav2Vec2Model
moto's avatar
moto committed
154
^^^^^^^^^^^^^
moto's avatar
moto committed
155
156
157
158
159
160
161

.. autoclass:: Wav2Vec2Model

  .. automethod:: extract_features

  .. automethod:: forward

162
163
164
165
166
167
168
HuBERTPretrainModel
^^^^^^^^^^^^^^^^^^^

.. autoclass:: HuBERTPretrainModel

  .. automethod:: forward

moto's avatar
moto committed
169
170
171
Factory Functions
-----------------

172
173
174
175
176
177
wav2vec2_model
^^^^^^^^^^^^^^

.. autofunction:: wav2vec2_model


moto's avatar
moto committed
178
wav2vec2_base
moto's avatar
moto committed
179
^^^^^^^^^^^^^
moto's avatar
moto committed
180

moto's avatar
moto committed
181
182
.. autofunction:: wav2vec2_base

moto's avatar
moto committed
183
wav2vec2_large
moto's avatar
moto committed
184
^^^^^^^^^^^^^^
moto's avatar
moto committed
185

moto's avatar
moto committed
186
187
.. autofunction:: wav2vec2_large

moto's avatar
moto committed
188
wav2vec2_large_lv60k
moto's avatar
moto committed
189
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
190

moto's avatar
moto committed
191
192
.. autofunction:: wav2vec2_large_lv60k

moto's avatar
moto committed
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
hubert_base
^^^^^^^^^^^

.. autofunction:: hubert_base

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

.. autofunction:: hubert_large

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

.. autofunction:: hubert_xlarge

208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
hubert_pretrain_model
^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: hubert_pretrain_model

hubert_pretrain_base
^^^^^^^^^^^^^^^^^^^^

.. autofunction:: hubert_pretrain_base

hubert_pretrain_large
^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: hubert_pretrain_large

hubert_pretrain_xlarge
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: hubert_pretrain_xlarge

228
229
230
Utility Functions
-----------------

231
232
.. currentmodule:: torchaudio.models.wav2vec2.utils

moto's avatar
moto committed
233
import_huggingface_model
moto's avatar
moto committed
234
^^^^^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
235

236
237
.. autofunction:: import_huggingface_model

moto's avatar
moto committed
238
import_fairseq_model
moto's avatar
moto committed
239
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
240

moto's avatar
moto committed
241
242
.. autofunction:: import_fairseq_model

243
.. currentmodule:: torchaudio.models
moto's avatar
moto committed
244

moto's avatar
moto committed
245
246
WaveRNN
~~~~~~~
jimchen90's avatar
jimchen90 committed
247
248
249
250

.. autoclass:: WaveRNN

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

252
253
  .. automethod:: infer

moto's avatar
moto committed
254
255
256
257
References
~~~~~~~~~~

.. footbibliography::