update docs

pytorch · Aug 18, 2021 · 0a91ebc · 0a91ebc
1 parent c0b23dc
commit 0a91ebc
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 29 deletions.
diff --git a/docs/source/functional.rst b/docs/source/functional.rst
@@ -256,6 +256,14 @@ vad
 
 .. autofunction:: spectral_centroid
 
+:hidden:`Loss`
+~~~~~~~~~~~~~~
+
+rnnt_loss
+---------
+
+.. autofunction:: rnnt_loss
+
 References
 ~~~~~~~~~~
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -39,7 +39,6 @@ The :mod:`torchaudio` package consists of I/O, popular datasets and common audio
    compliance.kaldi
    kaldi_io
    utils
-   rnnt_loss
    tacotron2
 
 

diff --git a/docs/source/rnnt_loss.rst b/docs/source/rnnt_loss.rst
diff --git a/docs/source/transforms.rst b/docs/source/transforms.rst
@@ -171,6 +171,12 @@ Transforms are common audio transforms. They can be chained together using :clas
 
   .. automethod:: forward
 
+:hidden:`RNNTLoss`
+~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: RNNTLoss
+
+  .. automethod:: forward
 
 References
 ~~~~~~~~~~

diff --git a/torchaudio/functional/functional.py b/torchaudio/functional/functional.py
@@ -1762,6 +1762,7 @@ def rnnt_loss(
     The RNN Transducer loss extends the CTC loss by defining a distribution over output
     sequences of all lengths, and by jointly modelling both input-output and output-output
     dependencies.
+    
     Args:
         logits (Tensor): Tensor of dimension (batch, max seq length, max target length + 1, class)
             containing output from joiner

diff --git a/torchaudio/transforms.py b/torchaudio/transforms.py
@@ -1437,6 +1437,7 @@ class RNNTLoss(torch.nn.Module):
     The RNN Transducer loss extends the CTC loss by defining a distribution over output
     sequences of all lengths, and by jointly modelling both input-output and output-output
     dependencies.
+    
     Args:
         blank (int, optional): blank label (Default: ``-1``)
         clamp (float, optional): clamp for gradients (Default: ``-1``)