Skip to content

[0.7.1] Update documentation #1067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 7, 2020
Merged

[0.7.1] Update documentation #1067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@
#
# The short X.Y version.
# TODO: change to [:2] at v1.0
version = '0.7.0'
version = '0.7.1'
# The full version, including alpha/beta/rc tags.
# TODO: verify this works as expected
release = '0.7.0'
release = '0.7.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/datasets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ torchaudio.datasets
====================

All datasets are subclasses of :class:`torch.utils.data.Dataset`
i.e, they have ``__getitem__`` and ``__len__`` methods implemented.
and have ``__getitem__`` and ``__len__`` methods implemented.
Hence, they can all be passed to a :class:`torch.utils.data.DataLoader`
which can load multiple samples parallelly using ``torch.multiprocessing`` workers.
For example: ::
Expand Down
200 changes: 113 additions & 87 deletions docs/source/functional.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,145 +8,176 @@ torchaudio.functional

Functions to perform common audio operations.

:hidden:`spectrogram`
~~~~~~~~~~~~~~~~~~~~~
:hidden:`Filtering`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the functionals aren't moved in 0.7 but this subsection isn't visible, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is visible. hidden here is a command to tell doxygen which class it should use to render this section.
Filtering subsection is for the improved user experience and has nothing to do with where the location these functions are defined.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, this seems reasonable

~~~~~~~~~~~~~~~~~~~

.. 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:`griffinlim`
~~~~~~~~~~~~~~~~~~~~~~~~~

:hidden:`contrast`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: griffinlim

.. autofunction:: contrast
:hidden:`amplitude_to_DB`
~~~~~~~~~~~~~~~~~~~~~~~~~

:hidden:`dcshift`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: amplitude_to_DB

.. autofunction:: dcshift
:hidden:`DB_to_amplitude`
~~~~~~~~~~~~~~~~~~~~~~~~~

:hidden:`overdrive`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: DB_to_amplitude

.. autofunction:: overdrive
:hidden:`create_fb_matrix`
~~~~~~~~~~~~~~~~~~~~~~~~~~

:hidden:`phaser`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: create_fb_matrix

.. autofunction:: phaser
:hidden:`create_dct`
~~~~~~~~~~~~~~~~~~~~

:hidden:`flanger`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: create_dct

.. autofunction:: flanger
:hidden:`mu_law_encoding`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: mu_law_encoding

:hidden:`mu_law_decoding`
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: mu_law_decoding

:hidden:`complex_norm`
~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: complex_norm

:hidden:`angle`
~~~~~~~~~~~~~~~

.. autofunction:: angle

:hidden:`magphase`
~~~~~~~~~~~~~~~~~~

.. autofunction:: magphase

:hidden:`phase_vocoder`
~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: phase_vocoder

:hidden:`mask_along_axis`
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -172,8 +203,3 @@ Functions to perform common audio operations.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: sliding_window_cmn

:hidden:`vad`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: vad