models.rst 2.86 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
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
Emformer
~~~~~~~~

.. autoclass:: Emformer

  .. automethod:: forward

  .. automethod:: infer

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
^^^^^^^^^^

94
.. container:: py attribute
95

96
97
  .. autodata::  Hypothesis
    :no-value:
discort's avatar
discort committed
98

99
100
101
102
103
104
105
106
107
Tacotron2
~~~~~~~~~

.. autoclass:: Tacotron2

  .. automethod:: forward

  .. automethod:: infer

moto's avatar
moto committed
108
109
Wav2Letter
~~~~~~~~~~
Tomás Osório's avatar
Tomás Osório committed
110
111
112
113

.. autoclass:: Wav2Letter

  .. automethod:: forward
jimchen90's avatar
jimchen90 committed
114
115


moto's avatar
moto committed
116
117
Wav2Vec2.0 / HuBERT
~~~~~~~~~~~~~~~~~~~
moto's avatar
moto committed
118

moto's avatar
moto committed
119
120
121
Model
-----

moto's avatar
moto committed
122
Wav2Vec2Model
moto's avatar
moto committed
123
^^^^^^^^^^^^^
moto's avatar
moto committed
124
125
126
127
128
129
130

.. autoclass:: Wav2Vec2Model

  .. automethod:: extract_features

  .. automethod:: forward

131
132
133
134
135
136
137
HuBERTPretrainModel
^^^^^^^^^^^^^^^^^^^

.. autoclass:: HuBERTPretrainModel

  .. automethod:: forward

moto's avatar
moto committed
138
139
140
Factory Functions
-----------------

141
142
143
144
145
146
wav2vec2_model
^^^^^^^^^^^^^^

.. autofunction:: wav2vec2_model


moto's avatar
moto committed
147
wav2vec2_base
moto's avatar
moto committed
148
^^^^^^^^^^^^^
moto's avatar
moto committed
149

moto's avatar
moto committed
150
151
.. autofunction:: wav2vec2_base

moto's avatar
moto committed
152
wav2vec2_large
moto's avatar
moto committed
153
^^^^^^^^^^^^^^
moto's avatar
moto committed
154

moto's avatar
moto committed
155
156
.. autofunction:: wav2vec2_large

moto's avatar
moto committed
157
wav2vec2_large_lv60k
moto's avatar
moto committed
158
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
159

moto's avatar
moto committed
160
161
.. autofunction:: wav2vec2_large_lv60k

moto's avatar
moto committed
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
hubert_base
^^^^^^^^^^^

.. autofunction:: hubert_base

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

.. autofunction:: hubert_large

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

.. autofunction:: hubert_xlarge

177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
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

197
198
199
Utility Functions
-----------------

200
201
.. currentmodule:: torchaudio.models.wav2vec2.utils

moto's avatar
moto committed
202
import_huggingface_model
moto's avatar
moto committed
203
^^^^^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
204

205
206
.. autofunction:: import_huggingface_model

moto's avatar
moto committed
207
import_fairseq_model
moto's avatar
moto committed
208
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
209

moto's avatar
moto committed
210
211
.. autofunction:: import_fairseq_model

212
.. currentmodule:: torchaudio.models
moto's avatar
moto committed
213

moto's avatar
moto committed
214
215
WaveRNN
~~~~~~~
jimchen90's avatar
jimchen90 committed
216
217
218
219

.. autoclass:: WaveRNN

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

221
222
  .. automethod:: infer

moto's avatar
moto committed
223
224
225
226
References
~~~~~~~~~~

.. footbibliography::