models.rst 1.65 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
62
63
64

.. autoclass:: Wav2Vec2Model

  .. automethod:: extract_features

  .. automethod:: forward

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

65
66
67
68
69
70
wav2vec2_model
^^^^^^^^^^^^^^

.. autofunction:: wav2vec2_model


moto's avatar
moto committed
71
wav2vec2_base
moto's avatar
moto committed
72
^^^^^^^^^^^^^
moto's avatar
moto committed
73

moto's avatar
moto committed
74
75
.. autofunction:: wav2vec2_base

moto's avatar
moto committed
76
wav2vec2_large
moto's avatar
moto committed
77
^^^^^^^^^^^^^^
moto's avatar
moto committed
78

moto's avatar
moto committed
79
80
.. autofunction:: wav2vec2_large

moto's avatar
moto committed
81
wav2vec2_large_lv60k
moto's avatar
moto committed
82
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
83

moto's avatar
moto committed
84
85
.. autofunction:: wav2vec2_large_lv60k

moto's avatar
moto committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
hubert_base
^^^^^^^^^^^

.. autofunction:: hubert_base

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

.. autofunction:: hubert_large

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

.. autofunction:: hubert_xlarge

101
102
103
Utility Functions
-----------------

104
105
.. currentmodule:: torchaudio.models.wav2vec2.utils

moto's avatar
moto committed
106
import_huggingface_model
moto's avatar
moto committed
107
^^^^^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
108

109
110
.. autofunction:: import_huggingface_model

moto's avatar
moto committed
111
import_fairseq_model
moto's avatar
moto committed
112
^^^^^^^^^^^^^^^^^^^^
moto's avatar
moto committed
113

moto's avatar
moto committed
114
115
.. autofunction:: import_fairseq_model

116
.. currentmodule:: torchaudio.models
moto's avatar
moto committed
117

moto's avatar
moto committed
118
119
WaveRNN
~~~~~~~
jimchen90's avatar
jimchen90 committed
120
121
122
123

.. autoclass:: WaveRNN

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

125
126
  .. automethod:: infer

moto's avatar
moto committed
127
128
129
130
References
~~~~~~~~~~

.. footbibliography::