models.rst 2.08 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
13
.. currentmodule:: torchaudio.models

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


moto's avatar
moto committed
14
15
ConvTasNet
~~~~~~~~~~
moto's avatar
moto committed
16
17
18
19
20
21

.. autoclass:: ConvTasNet

  .. automethod:: forward


moto's avatar
moto committed
22
23
DeepSpeech
~~~~~~~~~~
discort's avatar
discort committed
24
25
26
27
28
29

.. autoclass:: DeepSpeech

  .. automethod:: forward


30
31
32
33
34
35
36
37
38
Tacotron2
~~~~~~~~~

.. autoclass:: Tacotron2

  .. automethod:: forward

  .. automethod:: infer

moto's avatar
moto committed
39
40
Wav2Letter
~~~~~~~~~~
Tomás Osório's avatar
Tomás Osório committed
41
42
43
44

.. autoclass:: Wav2Letter

  .. automethod:: forward
jimchen90's avatar
jimchen90 committed
45
46


moto's avatar
moto committed
47
48
Wav2Vec2.0 / HuBERT
~~~~~~~~~~~~~~~~~~~
moto's avatar
moto committed
49

moto's avatar
moto committed
50
51
52
Model
-----

moto's avatar
moto committed
53
Wav2Vec2Model
moto's avatar
moto committed
54
^^^^^^^^^^^^^
moto's avatar
moto committed
55
56
57
58
59
60
61

.. autoclass:: Wav2Vec2Model

  .. automethod:: extract_features

  .. automethod:: forward

62
63
64
65
66
67
68
HuBERTPretrainModel
^^^^^^^^^^^^^^^^^^^

.. autoclass:: HuBERTPretrainModel

  .. automethod:: forward

moto's avatar
moto committed
69
70
71
Factory Functions
-----------------

72
73
74
75
76
77
wav2vec2_model
^^^^^^^^^^^^^^

.. autofunction:: wav2vec2_model


moto's avatar
moto committed
78
wav2vec2_base
moto's avatar
moto committed
79
^^^^^^^^^^^^^
moto's avatar
moto committed
80

moto's avatar
moto committed
81
82
.. autofunction:: wav2vec2_base

moto's avatar
moto committed
83
wav2vec2_large
moto's avatar
moto committed
84
^^^^^^^^^^^^^^
moto's avatar
moto committed
85

moto's avatar
moto committed
86
87
.. autofunction:: wav2vec2_large

moto's avatar
moto committed
88
wav2vec2_large_lv60k
moto's avatar
moto committed
89
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
90

moto's avatar
moto committed
91
92
.. autofunction:: wav2vec2_large_lv60k

moto's avatar
moto committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
hubert_base
^^^^^^^^^^^

.. autofunction:: hubert_base

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

.. autofunction:: hubert_large

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

.. autofunction:: hubert_xlarge

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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

128
129
130
Utility Functions
-----------------

131
132
.. currentmodule:: torchaudio.models.wav2vec2.utils

moto's avatar
moto committed
133
import_huggingface_model
moto's avatar
moto committed
134
^^^^^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
135

136
137
.. autofunction:: import_huggingface_model

moto's avatar
moto committed
138
import_fairseq_model
moto's avatar
moto committed
139
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
140

moto's avatar
moto committed
141
142
.. autofunction:: import_fairseq_model

143
.. currentmodule:: torchaudio.models
moto's avatar
moto committed
144

moto's avatar
moto committed
145
146
WaveRNN
~~~~~~~
jimchen90's avatar
jimchen90 committed
147
148
149
150

.. autoclass:: WaveRNN

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

152
153
  .. automethod:: infer

moto's avatar
moto committed
154
155
156
157
References
~~~~~~~~~~

.. footbibliography::