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 ...@@ -201,13 +201,12 @@ treble_biquad
.. autofunction:: treble_biquad .. autofunction:: treble_biquad
vad
---
:hidden:`Feature Extractions` :hidden:`Feature Extractions`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`vad`
-------------
.. autofunction:: vad .. autofunction:: vad
:hidden:`spectrogram` :hidden:`spectrogram`
...@@ -231,7 +230,7 @@ vad ...@@ -231,7 +230,7 @@ vad
.. autofunction:: phase_vocoder .. autofunction:: phase_vocoder
:hidden:`pitch_shift` :hidden:`pitch_shift`
----------------------- ---------------------
.. autofunction:: pitch_shift .. autofunction:: pitch_shift
......
...@@ -8,171 +8,181 @@ torchaudio.transforms ...@@ -8,171 +8,181 @@ torchaudio.transforms
Transforms are common audio transforms. They can be chained together using :class:`torch.nn.Sequential` 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 .. automethod:: forward
:hidden:`InverseSpectrogram` :hidden:`MelScale`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ------------------
.. autoclass:: InverseSpectrogram .. autoclass:: MelScale
.. automethod:: forward .. automethod:: forward
:hidden:`GriffinLim` :hidden:`InverseMelScale`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -------------------------
.. autoclass:: GriffinLim .. autoclass:: InverseMelScale
.. automethod:: forward .. automethod:: forward
:hidden:`AmplitudeToDB` :hidden:`MuLawEncoding`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -----------------------
.. autoclass:: AmplitudeToDB .. autoclass:: MuLawEncoding
.. automethod:: forward .. automethod:: forward
:hidden:`MelScale` :hidden:`MuLawDecoding`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -----------------------
.. autoclass:: MelScale .. autoclass:: MuLawDecoding
.. automethod:: forward .. automethod:: forward
:hidden:`InverseMelScale` :hidden:`Resample`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ------------------
.. autoclass:: InverseMelScale .. autoclass:: Resample
.. automethod:: forward .. automethod:: forward
:hidden:`FrequencyMasking`
--------------------------
:hidden:`MelSpectrogram` .. autoclass:: FrequencyMasking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: MelSpectrogram
.. automethod:: forward .. automethod:: forward
:hidden:`MFCC` :hidden:`TimeMasking`
~~~~~~~~~~~~~~ ---------------------
.. autoclass:: MFCC .. autoclass:: TimeMasking
.. automethod:: forward .. automethod:: forward
:hidden:`LFCC` :hidden:`TimeStretch`
~~~~~~~~~~~~~~ ---------------------
.. autoclass:: LFCC .. autoclass:: TimeStretch
.. automethod:: forward .. automethod:: forward
:hidden:`MuLawEncoding` :hidden:`Fade`
~~~~~~~~~~~~~~~~~~~~~~~ --------------
.. autoclass:: MuLawEncoding .. autoclass:: Fade
.. automethod:: forward .. automethod:: forward
:hidden:`MuLawDecoding` :hidden:`Vol`
~~~~~~~~~~~~~~~~~~~~~~~ -------------
.. autoclass:: MuLawDecoding .. autoclass:: Vol
.. automethod:: forward .. automethod:: forward
:hidden:`Resample` :hidden:`Complex Utility`
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: Resample :hidden:`ComplexNorm`
---------------------
.. autoclass:: ComplexNorm
.. automethod:: forward .. automethod:: forward
:hidden:`ComplexNorm` :hidden:`Feature Extractions`
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: ComplexNorm :hidden:`Spectrogram`
---------------------
.. autoclass:: Spectrogram
.. automethod:: forward .. automethod:: forward
:hidden:`ComputeDeltas` :hidden:`InverseSpectrogram`
~~~~~~~~~~~~~~~~~~~~~~~ ----------------------------
.. autoclass:: ComputeDeltas .. autoclass:: InverseSpectrogram
.. automethod:: forward .. automethod:: forward
:hidden:`TimeStretch` :hidden:`MelSpectrogram`
~~~~~~~~~~~~~~~~~~~~~ ------------------------
.. autoclass:: TimeStretch .. autoclass:: MelSpectrogram
.. automethod:: forward .. automethod:: forward
:hidden:`PitchShift` :hidden:`GriffinLim`
~~~~~~~~~~~~~~~~~~~~ --------------------
.. autoclass:: PitchShift .. autoclass:: GriffinLim
.. automethod:: forward .. automethod:: forward
:hidden:`Fade` :hidden:`MFCC`
~~~~~~~~~~~~~~ --------------
.. autoclass:: Fade .. autoclass:: MFCC
.. automethod:: forward .. automethod:: forward
:hidden:`FrequencyMasking` :hidden:`LFCC`
~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------
.. autoclass:: FrequencyMasking .. autoclass:: LFCC
.. automethod:: forward .. automethod:: forward
:hidden:`TimeMasking` :hidden:`ComputeDeltas`
~~~~~~~~~~~~~~~~~~~~~ -----------------------
.. autoclass:: TimeMasking .. autoclass:: ComputeDeltas
.. automethod:: forward .. automethod:: forward
:hidden:`Vol` :hidden:`PitchShift`
~~~~~~~~~~~~~ --------------------
.. autoclass:: Vol .. autoclass:: PitchShift
.. automethod:: forward .. automethod:: forward
:hidden:`SlidingWindowCmn` :hidden:`SlidingWindowCmn`
~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------------------
.. autoclass:: SlidingWindowCmn .. autoclass:: SlidingWindowCmn
.. automethod:: forward .. automethod:: forward
:hidden:`SpectralCentroid` :hidden:`SpectralCentroid`
~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------------------
.. autoclass:: SpectralCentroid .. autoclass:: SpectralCentroid
.. automethod:: forward .. automethod:: forward
:hidden:`Vad` :hidden:`Vad`
~~~~~~~~~~~~~ -------------
.. autoclass:: Vad .. autoclass:: Vad
.. automethod:: forward .. automethod:: forward
:hidden:`Loss`
~~~~~~~~~~~~~~
:hidden:`RNNTLoss` :hidden:`RNNTLoss`
~~~~~~~~~~~~~~~~~~ ------------------
.. autoclass:: 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