diff --git a/docs/source/conf.py b/docs/source/conf.py index 9a7b31b47a..b91994c3d0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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. diff --git a/docs/source/datasets.rst b/docs/source/datasets.rst index 2ceb93a440..2fbb2c7929 100644 --- a/docs/source/datasets.rst +++ b/docs/source/datasets.rst @@ -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: :: diff --git a/docs/source/functional.rst b/docs/source/functional.rst index 89e992bb89..ebed60de6b 100644 --- a/docs/source/functional.rst +++ b/docs/source/functional.rst @@ -8,145 +8,176 @@ 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:`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` ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -172,8 +203,3 @@ Functions to perform common audio operations. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autofunction:: sliding_window_cmn - -:hidden:`vad` -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. autofunction:: vad