Fix invalid TimeStretch example in transforms doc#4196
Open
adityasingh2400 wants to merge 1 commit into
Open
Conversation
docs/source/transforms.rst showed TimeStretch(stretch_factor, fixed_rate=True), but the class signature has no positional stretch_factor and fixed_rate takes a float, not a bool. Replace with a runnable example using the actual signature. Fixes pytorch#3438
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/audio/4196
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/source/transforms.rstshowed theTimeStretchtransform being constructed as:This is incorrect for two reasons:
TimeStretch.__init__has no positionalstretch_factorparameter. Its signature isTimeStretch(hop_length=None, n_freq=201, fixed_rate=None), sostretch_factorwould silently bind tohop_length.fixed_rateis typed asOptional[float](the rate to stretch by), not a boolean.This PR replaces the example with a runnable form that matches the actual signature, using
n_freqderived the same way as theMelScalecall directly below it (n_fft // 2 + 1), and passing the existingstretch_factorargument asfixed_rate:Fixes #3438.
Test plan
TimeStretchsignature insrc/torchaudio/transforms/_transforms.py:__init__(self, hop_length=None, n_freq=201, fixed_rate=None).