From e0f37cacad6fad1710fb50897930cdefd122e79f Mon Sep 17 00:00:00 2001 From: radioactive11 Date: Wed, 28 Jul 2021 13:55:58 +0530 Subject: [PATCH 1/4] added example for Resampler --- torchaudio/transforms.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/torchaudio/transforms.py b/torchaudio/transforms.py index 6d56dd5efb..2d185a367c 100644 --- a/torchaudio/transforms.py +++ b/torchaudio/transforms.py @@ -643,6 +643,11 @@ class Resample(torch.nn.Module): cached as ``torch.float64``. If you use resample with lower precision, then instead of providing this providing this argument, please use ``Resample.to(dtype)``, so that the kernel generation is still carried out on ``torch.float64``. + + Example + >>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True) + >>> resampler = transforms.Resample(sample_rate, sample_rate/10) + >>> waveform = resampler(waveform) """ def __init__( From 60482fda1c36d33b951b785b64745a8afa77abbb Mon Sep 17 00:00:00 2001 From: radioactive11 Date: Wed, 28 Jul 2021 17:13:26 +0530 Subject: [PATCH 2/4] Resample example resolved --- torchaudio/transforms.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/torchaudio/transforms.py b/torchaudio/transforms.py index 2d185a367c..cbea191215 100644 --- a/torchaudio/transforms.py +++ b/torchaudio/transforms.py @@ -645,9 +645,9 @@ class Resample(torch.nn.Module): carried out on ``torch.float64``. Example - >>> waveform, sample_rate = torchaudio.load('test.wav', normalization=True) - >>> resampler = transforms.Resample(sample_rate, sample_rate/10) - >>> waveform = resampler(waveform) + >>> waveform, sample_rate = torchaudio.load('test.wav', normalize=True) + >>> transform = transforms.Resample(sample_rate, sample_rate/10) + >>> waveform = transform(waveform) """ def __init__( From 44695b8759d4ec2bf14b0120ebcaf603b105ba39 Mon Sep 17 00:00:00 2001 From: radioactive11 Date: Thu, 29 Jul 2021 12:36:11 +0530 Subject: [PATCH 3/4] added example for ComplexNorm --- torchaudio/transforms.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/torchaudio/transforms.py b/torchaudio/transforms.py index cbea191215..762740dcf6 100644 --- a/torchaudio/transforms.py +++ b/torchaudio/transforms.py @@ -698,6 +698,11 @@ class ComplexNorm(torch.nn.Module): Args: power (float, optional): Power of the norm. (Default: to ``1.0``) + + Example + >>> complex_tensor = ... # Tensor shape of (…, complex=2) + >>> transform = transforms.ComplexNorm(power=2) + >>> complex_tensor = transform(complex_tensor) """ __constants__ = ['power'] From b9f96e4007fb858aa3ef5aa2f573a0536eb44fa2 Mon Sep 17 00:00:00 2001 From: Arijit Roy Date: Tue, 3 Aug 2021 17:09:14 +0530 Subject: [PATCH 4/4] Updated according to suggestion Co-authored-by: nateanl --- torchaudio/transforms.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/torchaudio/transforms.py b/torchaudio/transforms.py index 54e8884fa4..c96c65d9ba 100644 --- a/torchaudio/transforms.py +++ b/torchaudio/transforms.py @@ -784,7 +784,7 @@ class ComplexNorm(torch.nn.Module): Example >>> complex_tensor = ... # Tensor shape of (…, complex=2) >>> transform = transforms.ComplexNorm(power=2) - >>> complex_tensor = transform(complex_tensor) + >>> complex_norm = transform(complex_tensor) """ __constants__ = ['power']