Skip to content

Commit b492ec5

Browse files
committed
add doc for rnnt loss.
1 parent 1bb1115 commit b492ec5

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ The :mod:`torchaudio` package consists of I/O, popular datasets and common audio
3939
compliance.kaldi
4040
kaldi_io
4141
utils
42+
transducer
4243

4344

4445
.. toctree::

docs/source/transducer.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. role:: hidden
2+
:class: hidden-section
3+
4+
torchaudio.prototype.transducer
5+
===============================
6+
7+
.. currentmodule:: torchaudio.prototype.transducer
8+
9+
.. note::
10+
11+
The RNN transducer loss is a prototype feature, see `here <https://pytorch.org/audio>`_ to learn more about the nomenclature. It is only available within the nightlies, and needs to be imported explicitly using: :code:`from torchaudio.prototype.transducer import rnnt_loss, RNNTLoss`.
12+
13+
rnnt_loss
14+
---------
15+
16+
.. autofunction:: rnnt_loss
17+
18+
:hidden:`RNNTLoss`
19+
~~~~~~~~~~~~~~~~~~
20+
21+
.. autoclass:: RNNTLoss
22+
23+
.. automethod:: forward

0 commit comments

Comments
 (0)