Add example codes for documentation

[harishsdev]

📚 Documentation

I have observed that Example codes are missing from Documentation for the below mentioned Classes from torchaudio, Can I Raise PR for it

Group A

• Spectrogram PR:Example code for Spectrogram in documentation #1566
• GriffinLim PR:Example code for GriffinLim Audio transform #1671
• AmplitudeToDB
• MelScale
• InverseMelScale
• MFCC
• MuLawEncoding PR:Example for Mu law encoding  #1586
• MuLawDecoding PR:Example code for MuLawDecoding Transform #1684
• SpectralCentroid

Group B

• Resample PR:added example for Resampler #1644
• ComplexNorm PR:Added example for ComplexNorm #1658
• ComputeDeltas
• TimeStretch
• Fade

Group C

• FrequencyMasking
• TimeMasking
• Vol
• SlidingWindowCmn
• Vad

[mthrok]

Hi @harishsdev

Yes, this will be a great addition. Feel free to add PRs. However, please split PRs for each class, (make one PR per class) so that it is easier to review.

Also, some of them are covered in tutorial, so please have a look it as well.
https://pytorch.org/tutorials/beginner/audio_preprocessing_tutorial.html#feature-extractions

[mthrok]

I will make this issue open for contribution.

[harishsdev]

I am working on Group A

[harishsdev]

@mthrok please help to review

[vivekkumar7089]

After following the instructions given in contributing.md for development and installation, when I am trying to build docs locally I am getting this error after running make html

Running Sphinx v2.4.4
checking for /home/vivek_kumar/OpenSource/audio/docs/source/refs.bib in bibtex cache... not found
parsing bibtex file /home/vivek_kumar/OpenSource/audio/docs/source/refs.bib... parsed 10 entries
loading intersphinx inventory from https://docs.python.org/objects.inv...
loading intersphinx inventory from https://docs.scipy.org/doc/numpy/objects.inv...
loading intersphinx inventory from https://pytorch.org/docs/stable/objects.inv...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
intersphinx inventory has moved: https://docs.scipy.org/doc/numpy/objects.inv -> https://numpy.org/doc/stable/objects.inv
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 12 source files that are out of date
updating environment: [new config] 12 added, 0 changed, 0 removed
reading sources... [  8%] backend
reading sources... [ 16%] compliance.kaldi
reading sources... [ 25%] datasets
reading sources... [ 33%] functional
reading sources... [ 41%] index
reading sources... [ 50%] kaldi_io
reading sources... [ 58%] models
reading sources... [ 66%] rnnt_loss
reading sources... [ 75%] sox_effects
reading sources... [ 83%] torchaudio
reading sources... [ 91%] transforms
reading sources... [100%] utils

Warning, treated as error:
autodoc: failed to import class 'backend.common.AudioMetaData' from module 'torchaudio'; the following exception was raised:
No module named 'torchaudio'
Makefile:27: recipe for target 'html' failed
make: *** [html] Error 2

@mthrok please help me out to overcome this error!

[radioactive11]

Can I start working on Group B?

[nateanl]

Hi @radioactive11! Sure, feel free to create a PR for each class in Group B.

[radioactive11]

@nateanl Thank you for letting me work on this issue. I am new to the repo. Should I add an example like this one?