Large re-amp on the torchaudio/docs

README.md

@@ -11,7 +11,9 @@ torchaudio: an audio library for PyTorch
     - [Kaldi (ark/scp)](http://pytorch.org/audio/kaldi_io.html)
 - [Dataloaders for common audio datasets (VCTK, YesNo)](http://pytorch.org/audio/datasets.html)
 - Common audio transforms
-  - [Scale, PadTrim, DownmixMono, LC2CL, BLC2CBL, MuLawEncoding, MuLawExpanding](http://pytorch.org/audio/transforms.html)
+    - [Spectrogram, SpectrogramToDB, MelScale, MelSpectrogram, MFCC, MuLawEncoding, MuLawDecoding, Resample](http://pytorch.org/audio/transforms.html)
+- Compliance interfaces: Run code using PyTorch that align with other libraries
+    - [Kaldi: fbank, spectrogram, resample_waveform](https://pytorch.org/audio/compliance.kaldi.html)
 
 Dependencies
 ------------

docs/source/compliance.kaldi.rst

@@ -24,3 +24,8 @@ Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: spectrogram
+
+:hidden:`resample_waveform`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: resample_waveform

docs/source/functional.rst

@@ -8,63 +8,57 @@ torchaudio.functional
 
 Functions to perform common audio operations.
 
-:hidden:`scale`
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: scale
-
-
-:hidden:`pad_trim`
+:hidden:`istft`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: pad_trim
+.. autofunction:: istft
 
-:hidden:`downmix_mono`
+:hidden:`spectrogram`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: downmix_mono
+.. autofunction:: spectrogram
 
-:hidden:`LC2CL`
+:hidden:`amplitude_to_DB`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: LC2CL
+.. autofunction:: amplitude_to_DB
 
-:hidden:`istft`
+:hidden:`create_fb_matrix`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: istft
+.. autofunction:: create_fb_matrix
 
-:hidden:`spectrogram`
+:hidden:`create_dct`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: spectrogram
+.. autofunction:: create_dct
 
-:hidden:`create_fb_matrix`
+:hidden:`mu_law_encoding`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: create_fb_matrix
+.. autofunction:: mu_law_encoding
 
-:hidden:`spectrogram_to_DB`
+:hidden:`mu_law_decoding`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: spectrogram_to_DB
+.. autofunction:: mu_law_decoding
 
-:hidden:`create_dct`
+:hidden:`complex_norm`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: create_dct
+.. autofunction:: complex_norm
 
-:hidden:`BLC2CBL`
+:hidden:`angle`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: BLC2CBL
+.. autofunction:: angle
 
-:hidden:`mu_law_encoding`
+:hidden:`magphase`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: mu_law_encoding
+.. autofunction:: magphase
 
-:hidden:`mu_law_expanding`
+:hidden:`phase_vocoder`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autofunction:: mu_law_expanding
+.. autofunction:: phase_vocoder

docs/source/kaldi_io.rst

@@ -7,7 +7,7 @@ torchaudio.kaldi_io
 .. currentmodule:: torchaudio.kaldi_io
 
 To use this module, the dependency kaldi_io_ needs to be installed.
-This is a light wrapper around ``kaldi_io`` that returns :class:`torch.Tensors`.
+This is a light wrapper around ``kaldi_io`` that returns :class:`torch.Tensor`.
 
 .. _kaldi_io: https://github.com/vesis84/kaldi-io-for-python
 

docs/source/legacy.rst

@@ -1,7 +1,19 @@
+.. role:: hidden
+    :class: hidden-section
+
 torchaudio.legacy
 ======================
 
+.. currentmodule:: torchaudio.legacy
+
 Legacy loading and save functions.
 
-.. automodule:: torchaudio.legacy
-   :members:
+:hidden:`load`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: load
+
+:hidden:`save`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: save

docs/source/sox_effects.rst

@@ -1,12 +1,21 @@
+.. role:: hidden
+    :class: hidden-section
+
 torchaudio.sox_effects
 ======================
 
 Create SoX effects chain for preprocessing audio.
 
 .. currentmodule:: torchaudio.sox_effects
 
+:hidden:`SoxEffect`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. autoclass:: SoxEffect
   :members:
 
+:hidden:`SoxEffectsChain`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. autoclass:: SoxEffectsChain
   :members: append_effect_to_chain, sox_build_flow_effects, clear_chain, set_input_file

docs/source/transforms.rst

@@ -1,24 +1,66 @@
+.. role:: hidden
+    :class: hidden-section
+
 torchaudio.transforms
 ======================
 
 .. currentmodule:: torchaudio.transforms
 
-Transforms are common audio transforms. They can be chained together using :class:`Compose`
+Transforms are common audio transforms. They can be chained together using :class:`torch.nn.Sequential`
+
+
+:hidden:`Spectrogram`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: Spectrogram
+
+  .. automethod:: torchaudio._docs.Spectrogram.forward
+
+:hidden:`AmplitudeToDB`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: AmplitudeToDB
+
+  .. automethod:: torchaudio._docs.AmplitudeToDB.forward
+
+:hidden:`MelScale`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autoclass:: Compose
+.. autoclass:: MelScale
 
-.. autoclass:: Scale
+  .. automethod:: torchaudio._docs.MelScale.forward
 
-.. autoclass:: PadTrim
+:hidden:`MelSpectrogram`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autoclass:: DownmixMono
+.. autoclass:: MelSpectrogram
 
-.. autoclass:: LC2CL
+  .. automethod:: torchaudio._docs.MelSpectrogram.forward
 
-.. autoclass:: MEL
+:hidden:`MFCC`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. autoclass:: BLC2CBL
+.. autoclass:: MFCC
+
+  .. automethod:: torchaudio._docs.MFCC.forward
+
+:hidden:`MuLawEncoding`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: MuLawEncoding
 
-.. autoclass:: MuLawExpanding
+  .. automethod:: torchaudio._docs.MuLawEncoding.forward
+
+:hidden:`MuLawDecoding`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: MuLawDecoding
+
+  .. automethod:: torchaudio._docs.MuLawDecoding.forward
+
+:hidden:`Resample`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autoclass:: Resample
+
+  .. automethod:: torchaudio._docs.Resample.forward