Example code for Spectrogram in documentation #1566

harishsdev · 2021-06-10T17:22:27Z

harishsdev · 2021-06-10T17:23:14Z

PR for : #1564

mthrok

Thanks for the con tribulation but your base branch is old more than one month. Please rebase it on master.

mthrok · 2021-06-10T19:51:17Z

torchaudio/transforms.py

@@ -60,6 +60,20 @@ class Spectrogram(torch.nn.Module):
            dimension for real and imaginary parts. (see ``torch.view_as_real``).
            When ``power`` is provided, the value must be False, as the resulting
            Tensor represents real-valued power.
+
+         Example:-


Indentation is off.

hyphen and colon are unnecessary.

Please follow an existing example;

audio/torchaudio/functional/functional.py

Lines 821 to 824 in aec0e8c

Example

>>> specgram = torch.randn(1, 40, 1000)

>>> delta = compute_deltas(specgram)

>>> delta2 = compute_deltas(delta)

mthrok · 2021-06-10T19:56:04Z

torchaudio/transforms.py

+         Sample rate of waveform: 8000
+         >>> specgram = torchaudio.transforms.Spectrogram()(waveform)
+         >>> print("Shape of spectrogram: {}".format(specgram.size()))
+         Shape of spectrogram: torch.Size([2, 201, 1342])


This example spends 6 lines for loading audio tensor and 3 lines for the Transform. Instead please make an example around the transform.

Make the resulting transform instance an intermediate named variable.
Also please use some constructor arguments for showcasing it.

harishsdev · 2021-06-11T09:52:12Z

@mthrok Thanks for inputs

I have forked the repository and created Spectrogram branch with following commands rebased,please give me some inputs if i am wrong

git remote add upstream https://github.com/pytorch/audio.git
git fetch upstream

git checkout master

git rebase upstream/master

git push -f origin master

harishsdev · 2021-06-12T03:11:22Z

How to run flake in torchaudio for checking pep8 style coding, please suggest

mthrok

Hi @harishsdev

You can simple do flake8 torchaudio for flake8.

mthrok · 2021-06-16T19:25:50Z

torchaudio/transforms.py

+                    >>> specgram = torch.randn(1, 40, 1000)
+                    >>> specgram = torchaudio.transforms.Spectrogram()(specgram)
+                    >>> specgram.shape
+                    torch.Size([1, 40, 201, 6])


This indentation is too much, there should be only 4 spaces instead of 8.

Please assign the transform into intermediate variable.

Please provide some arguments to Spectrogram constructor.

The input to Spectrogram should be called waveform.

mthrok · 2021-07-02T18:23:23Z

@harishsdev

Please build the doc by yourself or check the artifact of build_docs job.
The indentation is off.

https://239906-90321822-gh.circle-artifacts.com/0/docs/transforms.html#spectrogram

Also please, do assign the transform object to an intermediate variable to showcase the instantiation of Transform and application of the transform separately. Please do not write them in one line.

mthrok

Please fix the indentation. Build the doc and see that the rendering is correct.
Please assign the transform into intermediate variable.

nateanl · 2021-08-03T15:54:37Z

torchaudio/transforms.py

+    Example
+
+        >>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True)
+        >>> transformed_spectrogram = torchaudio.transforms.Spectrogram(n_fft = 800)(waveform)


Hi @harishsdev. Could you assign the transform parameter and move the forward method to a separate line? You can see #1644 as an example.

transform = torchaudio.transforms.Spectrogram(n_fft = 512) spectrogram = transform(waveform)

harishsdev · 2021-08-03T16:58:35Z

Sure I will update it

…

On Tue, Aug 3, 2021, 21:25 nateanl ***@***.***> wrote: ***@***.**** requested changes on this pull request. ------------------------------ In torchaudio/transforms.py <#1566 (comment)>: > @@ -67,6 +67,12 @@ class Spectrogram(torch.nn.Module): This argument is only effective when ``power=None``. It is ignored for cases where ``power`` is a number as in those cases, the returned tensor is power spectrogram, which is a real-valued tensor. + + Example + + >>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True) + >>> transformed_spectrogram = torchaudio.transforms.Spectrogram(n_fft = 800)(waveform) Hi @harishsdev <https://github.com/harishsdev>. Could you assign the transform parameter and move the forward method to a separate line? You can see #1644 <#1644> as an example. transform = torchaudio.transforms.Spectrogram(n_fft = 512) spectrogram = transform(waveform) — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1566 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ALCDHPVBCAT63CGEZ3DK6QTT3AGOHANCNFSM46O6HLLQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> .

nateanl

Same as #1586. We can merge it after addressing the nits.

nateanl · 2021-08-04T05:09:29Z

torchaudio/transforms.py

+
+    Example
+
+        >>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True)


Suggested change

>>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True)

>>> waveform, sample_rate = torchaudio.load('test.wav', normalize=True)

nateanl · 2021-08-04T05:09:48Z

torchaudio/transforms.py

+    Example
+
+        >>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True)
+        >>> transform = torchaudio.transforms.Spectrogram(n_fft = 800)


Suggested change

>>> transform = torchaudio.transforms.Spectrogram(n_fft = 800)

>>> transform = torchaudio.transforms.Spectrogram(n_fft=800)

nateanl · 2021-08-04T05:12:13Z

torchaudio/transforms.py

@@ -67,6 +67,13 @@ class Spectrogram(torch.nn.Module):
            This argument is only effective when ``power=None``. It is ignored for
            cases where ``power`` is a number as in those cases, the returned tensor is
            power spectrogram, which is a real-valued tensor.
+
+    Example
+


Same for this one. Let's delete the line break.

Suggested change

* Update build.sh Picks up 1.9 build from test. * Update build.sh * Update lite interpreter tutorial to beta (pytorch#1549) * Update lite interpreter tutorial to beta * Update lite interpreter to beta * update model export script * address comment and update documentation * add custome build in first paragraph * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Update prototype_source/lite_interpreter.rst Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * replace file name * update ios part Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> * Revert "Update lite interpreter tutorial to beta (pytorch#1549)" (pytorch#1569) This reverts commit a702ca0fafe9d4a1ee0c1e4331de66245ceb3103. * Update build.sh * Update build.sh * updated pipeline tutorial (pytorch#1562) * reduce (pytorch#1546) * Update seq2seq_translation_tutorial.py (pytorch#1532) Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> * added CPU optimization guide part into tuning_guide (pytorch#1512) * added CPU optimization guide part into tuning_guide * changed non-python command to python comments in CPU specific optimization section * Update tuning_guide.py Changed comment of bash commands to double quote. * Update tuning_guide.py Co-authored-by: Brian Johnson <brianjo@fb.com> * Typo fix (pytorch#1538) Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> * Typo fix in text sentiment tutorial (pytorch#1543) Trivial typo fix in docs * Update dcgan_faces_tutorial.py (pytorch#1550) Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> * updated pipeline tutorial Co-authored-by: define_liuyi <793753866@qq.com> Co-authored-by: dhayeah <57786651+dhayeah@users.noreply.github.com> Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> Co-authored-by: Jing Xu <jing.xu@intel.com> Co-authored-by: Brian Johnson <brianjo@fb.com> Co-authored-by: Andrew C. Freeman <andrew.freeman@cawb.com> Co-authored-by: Davide Fiocco <davidefiocco@users.noreply.github.com> Co-authored-by: universuen <52519513+universuen@users.noreply.github.com> * Update audio manipulation tutorial (pytorch#1566) * add resampling tutorial * update benchmarking and sectioning * remove np import * Update torchaudio tutorial * update resample dtype initialization Co-authored-by: moto <855818+mthrok@users.noreply.github.com> * updated text sentiment tutorial (pytorch#1563) * updated transformer tutorial (pytorch#1565) * Update numeric_suite_tutorial.py s/Logger=/logger_cls=/ * Update profiler recipe doc (1.9) (pytorch#1528) Summary: Update the profiler recipe to use the new API and features Test Plan: make html-noplot Co-authored-by: Brian Johnson <brianjo@fb.com> * Update build.sh Co-authored-by: cccclai <chenlai@fb.com> Co-authored-by: Raziel <129535+raziel@users.noreply.github.com> Co-authored-by: parmeet <parmeetbhatia@fb.com> Co-authored-by: define_liuyi <793753866@qq.com> Co-authored-by: dhayeah <57786651+dhayeah@users.noreply.github.com> Co-authored-by: Holly Sweeney <77758406+holly1238@users.noreply.github.com> Co-authored-by: Jing Xu <jing.xu@intel.com> Co-authored-by: Andrew C. Freeman <andrew.freeman@cawb.com> Co-authored-by: Davide Fiocco <davidefiocco@users.noreply.github.com> Co-authored-by: universuen <52519513+universuen@users.noreply.github.com> Co-authored-by: Caroline Chen <carolinechen@fb.com> Co-authored-by: moto <855818+mthrok@users.noreply.github.com> Co-authored-by: Nikita Shulga <nshulga@fb.com> Co-authored-by: ilia-cher <30845429+ilia-cher@users.noreply.github.com>

Example code for Spectrogram in documentation

78738d1

facebook-github-bot added the CLA Signed label Jun 10, 2021

harishsdev mentioned this pull request Jun 10, 2021

Add example codes for documentation #1564

Closed

19 tasks

mthrok requested changes Jun 10, 2021

View reviewed changes

Spectrogram example resolved

e077d4b

Merge branch 'master' into Spectrogram

cd63147

harishsdev requested a review from mthrok June 12, 2021 03:10

mthrok requested changes Jun 16, 2021

View reviewed changes

harishsdev added 3 commits June 18, 2021 09:07

Example Code for Spectrogram API

86a7f81

modified Spectrogram

d84f287

modified for space

f3872ae

harishsdev requested a review from mthrok June 21, 2021 10:07

mthrok requested changes Jul 2, 2021

View reviewed changes

modified Spectrogram

8c49ed4

mthrok assigned mthrok and nateanl Aug 3, 2021

nateanl requested changes Aug 3, 2021

View reviewed changes

harishsdev added 2 commits August 4, 2021 09:33

Spectrogram

fe4a05b

spectrogram

ebcd94a

harishsdev requested a review from nateanl August 4, 2021 04:36

nateanl approved these changes Aug 4, 2021

View reviewed changes

Spectrogram

44df364

harishsdev requested a review from nateanl August 4, 2021 05:23

nateanl merged commit 1d6b15e into pytorch:main Aug 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Example code for Spectrogram in documentation #1566

Example code for Spectrogram in documentation #1566

harishsdev commented Jun 10, 2021

harishsdev commented Jun 10, 2021

mthrok left a comment

mthrok Jun 10, 2021

mthrok Jun 10, 2021

harishsdev commented Jun 11, 2021

harishsdev commented Jun 12, 2021

mthrok left a comment

mthrok Jun 16, 2021

mthrok commented Jul 2, 2021

mthrok left a comment

nateanl Aug 3, 2021

harishsdev commented Aug 3, 2021 via email

nateanl left a comment

nateanl Aug 4, 2021

nateanl Aug 4, 2021

nateanl Aug 4, 2021

	Example
	>>> specgram = torch.randn(1, 40, 1000)
	>>> delta = compute_deltas(specgram)
	>>> delta2 = compute_deltas(delta)


		Example

		>>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True)

	>>> transform = torchaudio.transforms.Spectrogram(n_fft = 800)
	>>> transform = torchaudio.transforms.Spectrogram(n_fft=800)

Example code for Spectrogram in documentation #1566

Example code for Spectrogram in documentation #1566

Conversation

harishsdev commented Jun 10, 2021

harishsdev commented Jun 10, 2021

mthrok left a comment

Choose a reason for hiding this comment

mthrok Jun 10, 2021

Choose a reason for hiding this comment

mthrok Jun 10, 2021

Choose a reason for hiding this comment

harishsdev commented Jun 11, 2021

harishsdev commented Jun 12, 2021

mthrok left a comment

Choose a reason for hiding this comment

mthrok Jun 16, 2021

Choose a reason for hiding this comment

mthrok commented Jul 2, 2021

mthrok left a comment

Choose a reason for hiding this comment

nateanl Aug 3, 2021

Choose a reason for hiding this comment

harishsdev commented Aug 3, 2021 via email

nateanl left a comment

Choose a reason for hiding this comment

nateanl Aug 4, 2021

Choose a reason for hiding this comment

nateanl Aug 4, 2021

Choose a reason for hiding this comment

nateanl Aug 4, 2021

Choose a reason for hiding this comment