Skip to content

Add deprecation warnings to functions for complex #1445

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 13, 2021
Merged

Add deprecation warnings to functions for complex #1445

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e6642b3
Add deprecation warnings to functions for complex
mthrok Apr 9, 2021
37a94af
Remove the
mthrok Apr 12, 2021
ffdccfb
Fix import
mthrok Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 33 additions & 4 deletions torchaudio/functional/functional.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,14 @@ def spectrogram(
``n_fft // 2 + 1`` and ``n_fft`` is the number of
Fourier bins, and time is the number of window hops (n_frame).
"""
if power is None and not return_complex:
warnings.warn(
"The use of pseudo complex type in spectrogram is now deprecated."
"Please migrate to native complex type by providing `return_complex=True`. "
"Please refer to https://github.com/pytorch/audio/issues/1337 "
"for more details about torchaudio's plan to migrate to native complex type."
)

if power is not None and return_complex:
raise ValueError(
'When `power` is provided, the return value is real-valued. '
Expand Down Expand Up @@ -525,6 +533,12 @@ def mu_law_decoding(
return x


@_mod_utils.deprecated(
"Please convert the input Tensor to complex type with `torch.view_as_complex` then "
"use `torch.abs`. "
"Please refer to https://github.com/pytorch/audio/issues/1337 "
"for more details about torchaudio's plan to migrate to native complex type."
)
def complex_norm(
complex_tensor: Tensor,
power: float = 1.0
Expand All @@ -544,6 +558,12 @@ def complex_norm(
return complex_tensor.pow(2.).sum(-1).pow(0.5 * power)


@_mod_utils.deprecated(
"Please convert the input Tensor to complex type with `torch.view_as_complex` then "
"use `torch.angle`. "
"Please refer to https://github.com/pytorch/audio/issues/1337 "
"for more details about torchaudio's plan to migrate to native complex type."
)
def angle(
complex_tensor: Tensor
) -> Tensor:
Expand Down Expand Up @@ -621,10 +641,19 @@ def phase_vocoder(
if rate == 1.0:
return complex_specgrams

if not complex_specgrams.is_complex() and complex_specgrams.size(-1) != 2:
raise ValueError(
"complex_specgrams must be either native complex tensors or "
"real valued tensors with shape (..., 2)")
if not complex_specgrams.is_complex():
warnings.warn(
"The use of pseudo complex type in `torchaudio.functional.phase_vocoder` and "
"`torchaudio.transforms.TimeStretch` is now deprecated."
"Please migrate to native complex type by converting the input tensor with "
"`torch.view_as_complex`. "
"Please refer to https://github.com/pytorch/audio/issues/1337 "
"for more details about torchaudio's plan to migrate to native complex type."
)
if complex_specgrams.size(-1) != 2:
raise ValueError(
"complex_specgrams must be either native complex tensors or "
"real valued tensors with shape (..., 2)")

is_complex = complex_specgrams.is_complex()

Expand Down