Skip to content

Add documentation for RNN transducer #1171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 11, 2021
Merged

Add documentation for RNN transducer #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ The :mod:`torchaudio` package consists of I/O, popular datasets and common audio
compliance.kaldi
kaldi_io
utils
transducer


.. toctree::
Expand Down
23 changes: 23 additions & 0 deletions docs/source/transducer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. role:: hidden
:class: hidden-section

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a good idea to note that prototype is nightly-only feature at the top of all the pages for prototype. So that there is a less chance of receiving the report like this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've labelled the issue as prototype and linked to the "source of truth" definition of prototype, which says "not part of release". Do you mean to say that you feel this may not be clear enough?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we cannot be too careful here.

I suggest add .. note:: or .. warning:: and tell users to use nightly build in a more straightforward manner.

Reading the classification, I feel like it is not even included in nightly build, which is another binary distribution.

Prototype: These features are typically not available as part of binary distributions like PyPI or Conda, except sometimes behind run-time flags, and are at an early stage for feedback and testing.

torchaudio.prototype.transducer
===============================

.. currentmodule:: torchaudio.prototype.transducer

.. note::

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 also needs to be imported explicitly using: :code:`from torchaudio.prototype.transducer import rnnt_loss, RNNTLoss`.

rnnt_loss
---------

.. autofunction:: rnnt_loss

:hidden:`RNNTLoss`
~~~~~~~~~~~~~~~~~~

.. autoclass:: RNNTLoss

.. automethod:: forward