Skip to content
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.

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

Improve resampling documentation #1519

Merged
merged 1 commit into from
May 20, 2021

Conversation

carolineechen
Copy link
Contributor

@carolineechen carolineechen commented May 20, 2021

Improve resampling documentation

cc #1487

@@ -770,6 +770,8 @@ def resample_waveform(waveform: Tensor,
but less efficient. We suggest around 4 to 10 for normal use. (Default: ``6``)
rolloff (float, optional): The roll-off frequency of the filter, as a fraction of the Nyquist.
Lower values reduce anti-aliasing, but also reduce some of the highest frequencies. (Default: ``0.99``)
resampling_method (str, optional): The resampling method to use.
Options: [``sinc_interpolation``, ``kaiser_window``] (Default: ``'sinc_interpolation'``)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mthrok any thoughts on whether or not we should also add beta as a parameter to kaldi's resample waveform? this would make it more consistent with the trasnforms/functional form, but not "kaldi-compliant". resampling_method was added for easier testing which was done in compliance_kaldi_test -- if we remove beta, do we also want to remove resampling_method once we migrate the tests to functional?

@mthrok
Copy link
Collaborator

mthrok commented May 20, 2021

Let's add the possibility to remove resample_waveform from compliance.kaldi module in #1487 then discuss how we can proceed.

@carolineechen carolineechen merged commit 22fe802 into pytorch:master May 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants