Unverified Commit ecfaac11 authored by Caroline Chen's avatar Caroline Chen Committed by GitHub
Browse files

Add sections to transforms docs (#1720)

parent 496b381a
......@@ -201,13 +201,12 @@ treble_biquad
.. autofunction:: treble_biquad
vad
---
:hidden:`Feature Extractions`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`vad`
-------------
.. autofunction:: vad
:hidden:`spectrogram`
......@@ -231,7 +230,7 @@ vad
.. autofunction:: phase_vocoder
:hidden:`pitch_shift`
-----------------------
---------------------
.. autofunction:: pitch_shift
......
......@@ -8,171 +8,181 @@ torchaudio.transforms
Transforms are common audio transforms. They can be chained together using :class:`torch.nn.Sequential`
:hidden:`Utility`
~~~~~~~~~~~~~~~~~~
:hidden:`Spectrogram`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`AmplitudeToDB`
-----------------------
.. autoclass:: Spectrogram
.. autoclass:: AmplitudeToDB
.. automethod:: forward
:hidden:`InverseSpectrogram`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`MelScale`
------------------
.. autoclass:: InverseSpectrogram
.. autoclass:: MelScale
.. automethod:: forward
:hidden:`GriffinLim`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`InverseMelScale`
-------------------------
.. autoclass:: GriffinLim
.. autoclass:: InverseMelScale
.. automethod:: forward
:hidden:`AmplitudeToDB`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`MuLawEncoding`
-----------------------
.. autoclass:: AmplitudeToDB
.. autoclass:: MuLawEncoding
.. automethod:: forward
:hidden:`MelScale`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`MuLawDecoding`
-----------------------
.. autoclass:: MelScale
.. autoclass:: MuLawDecoding
.. automethod:: forward
:hidden:`InverseMelScale`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`Resample`
------------------
.. autoclass:: InverseMelScale
.. autoclass:: Resample
.. automethod:: forward
:hidden:`FrequencyMasking`
--------------------------
:hidden:`MelSpectrogram`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: MelSpectrogram
.. autoclass:: FrequencyMasking
.. automethod:: forward
:hidden:`MFCC`
~~~~~~~~~~~~~~
:hidden:`TimeMasking`
---------------------
.. autoclass:: MFCC
.. autoclass:: TimeMasking
.. automethod:: forward
:hidden:`LFCC`
~~~~~~~~~~~~~~
:hidden:`TimeStretch`
---------------------
.. autoclass:: LFCC
.. autoclass:: TimeStretch
.. automethod:: forward
:hidden:`MuLawEncoding`
~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`Fade`
--------------
.. autoclass:: MuLawEncoding
.. autoclass:: Fade
.. automethod:: forward
:hidden:`MuLawDecoding`
~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`Vol`
-------------
.. autoclass:: MuLawDecoding
.. autoclass:: Vol
.. automethod:: forward
:hidden:`Resample`
~~~~~~~~~~~~~~~~~~
:hidden:`Complex Utility`
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: Resample
:hidden:`ComplexNorm`
---------------------
.. autoclass:: ComplexNorm
.. automethod:: forward
:hidden:`ComplexNorm`
~~~~~~~~~~~~~~~~~~~~~
:hidden:`Feature Extractions`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: ComplexNorm
:hidden:`Spectrogram`
---------------------
.. autoclass:: Spectrogram
.. automethod:: forward
:hidden:`ComputeDeltas`
~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`InverseSpectrogram`
----------------------------
.. autoclass:: ComputeDeltas
.. autoclass:: InverseSpectrogram
.. automethod:: forward
:hidden:`TimeStretch`
~~~~~~~~~~~~~~~~~~~~~
:hidden:`MelSpectrogram`
------------------------
.. autoclass:: TimeStretch
.. autoclass:: MelSpectrogram
.. automethod:: forward
:hidden:`PitchShift`
~~~~~~~~~~~~~~~~~~~~
:hidden:`GriffinLim`
--------------------
.. autoclass:: PitchShift
.. autoclass:: GriffinLim
.. automethod:: forward
:hidden:`Fade`
~~~~~~~~~~~~~~
:hidden:`MFCC`
--------------
.. autoclass:: Fade
.. autoclass:: MFCC
.. automethod:: forward
:hidden:`FrequencyMasking`
~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`LFCC`
--------------
.. autoclass:: FrequencyMasking
.. autoclass:: LFCC
.. automethod:: forward
:hidden:`TimeMasking`
~~~~~~~~~~~~~~~~~~~~~
:hidden:`ComputeDeltas`
-----------------------
.. autoclass:: TimeMasking
.. autoclass:: ComputeDeltas
.. automethod:: forward
:hidden:`Vol`
~~~~~~~~~~~~~
:hidden:`PitchShift`
--------------------
.. autoclass:: Vol
.. autoclass:: PitchShift
.. automethod:: forward
:hidden:`SlidingWindowCmn`
~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
.. autoclass:: SlidingWindowCmn
.. automethod:: forward
:hidden:`SpectralCentroid`
~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------
.. autoclass:: SpectralCentroid
.. automethod:: forward
:hidden:`Vad`
~~~~~~~~~~~~~
-------------
.. autoclass:: Vad
.. automethod:: forward
:hidden:`Loss`
~~~~~~~~~~~~~~
:hidden:`RNNTLoss`
~~~~~~~~~~~~~~~~~~
------------------
.. autoclass:: RNNTLoss
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment