Unverified Commit 4b4b8bf6 authored by moto's avatar moto Committed by GitHub
Browse files

[Doc] Group filtering in functinal.rst (#1005)

parent f04b3628
......@@ -8,145 +8,166 @@ torchaudio.functional
Functions to perform common audio operations.
:hidden:`spectrogram`
~~~~~~~~~~~~~~~~~~~~~
:hidden:`Filtering`
~~~~~~~~~~~~~~~~~~~
.. autofunction:: spectrogram
:hidden:`amplitude_to_DB`
~~~~~~~~~~~~~~~~~~~~~~~~~
allpass_biquad
--------------
.. autofunction:: amplitude_to_DB
.. autofunction:: allpass_biquad
:hidden:`create_fb_matrix`
~~~~~~~~~~~~~~~~~~~~~~~~~~
band_biquad
-----------
.. autofunction:: create_fb_matrix
.. autofunction:: band_biquad
:hidden:`create_dct`
~~~~~~~~~~~~~~~~~~~~
bandpass_biquad
---------------
.. autofunction:: create_dct
.. autofunction:: bandpass_biquad
:hidden:`mu_law_encoding`
~~~~~~~~~~~~~~~~~~~~~~~~~
bandreject_biquad
-----------------
.. autofunction:: mu_law_encoding
.. autofunction:: bandreject_biquad
:hidden:`mu_law_decoding`
~~~~~~~~~~~~~~~~~~~~~~~~~
bass_biquad
-----------
.. autofunction:: mu_law_decoding
.. autofunction:: bass_biquad
:hidden:`complex_norm`
~~~~~~~~~~~~~~~~~~~~~~
biquad
------
.. autofunction:: complex_norm
.. autofunction:: biquad
:hidden:`angle`
~~~~~~~~~~~~~~~
contrast
--------
.. autofunction:: angle
.. autofunction:: contrast
:hidden:`magphase`
~~~~~~~~~~~~~~~~~~
dcshift
-------
.. autofunction:: magphase
.. autofunction:: dcshift
:hidden:`phase_vocoder`
~~~~~~~~~~~~~~~~~~~~~~~
deemph_biquad
-------------
.. autofunction:: phase_vocoder
.. autofunction:: deemph_biquad
:hidden:`lfilter`
~~~~~~~~~~~~~~~~~
.. autofunction:: lfilter
dither
------
:hidden:`biquad`
~~~~~~~~~~~~~~~~
.. autofunction:: dither
.. autofunction:: biquad
equalizer_biquad
----------------
:hidden:`lowpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: equalizer_biquad
.. autofunction:: lowpass_biquad
flanger
-------
:hidden:`highpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: flanger
gain
----
.. autofunction:: gain
highpass_biquad
---------------
.. autofunction:: highpass_biquad
:hidden:`allpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~
lfilter
-------
.. autofunction:: allpass_biquad
.. autofunction:: lfilter
:hidden:`equalizer_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~
lowpass_biquad
--------------
.. autofunction:: equalizer_biquad
.. autofunction:: lowpass_biquad
:hidden:`bandpass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
overdrive
---------
.. autofunction:: bandpass_biquad
.. autofunction:: overdrive
:hidden:`bandreject_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
phaser
------
.. autofunction:: bandreject_biquad
.. autofunction:: phaser
:hidden:`band_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
riaa_biquad
-----------
.. autofunction:: band_biquad
.. autofunction:: riaa_biquad
:hidden:`treble_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
treble_biquad
-------------
.. autofunction:: treble_biquad
:hidden:`bass_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: bass_biquad
vad
---
:hidden:`deemph_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: vad
.. autofunction:: deemph_biquad
:hidden:`spectrogram`
~~~~~~~~~~~~~~~~~~~~~
:hidden:`riaa_biquad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: spectrogram
.. autofunction:: riaa_biquad
:hidden:`amplitude_to_DB`
~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`contrast`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: amplitude_to_DB
.. autofunction:: contrast
:hidden:`create_fb_matrix`
~~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`dcshift`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: create_fb_matrix
.. autofunction:: dcshift
:hidden:`create_dct`
~~~~~~~~~~~~~~~~~~~~
:hidden:`overdrive`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: create_dct
.. autofunction:: overdrive
:hidden:`mu_law_encoding`
~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`phaser`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: mu_law_encoding
.. autofunction:: phaser
:hidden:`mu_law_decoding`
~~~~~~~~~~~~~~~~~~~~~~~~~
:hidden:`flanger`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: mu_law_decoding
.. autofunction:: flanger
:hidden:`complex_norm`
~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: complex_norm
:hidden:`angle`
~~~~~~~~~~~~~~~
.. autofunction:: angle
:hidden:`magphase`
~~~~~~~~~~~~~~~~~~
.. autofunction:: magphase
:hidden:`phase_vocoder`
~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: phase_vocoder
:hidden:`mask_along_axis`
~~~~~~~~~~~~~~~~~~~~~~~~~
......@@ -172,8 +193,3 @@ Functions to perform common audio operations.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: sliding_window_cmn
:hidden:`vad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: vad
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