Add example for MuLawEncoding (#1586)

48b23c11 · S Harish · GitHub · 2cece69e · 48b23c11
Unverified Commit 48b23c11 authored Aug 04, 2021 by S Harish Committed by GitHub Aug 04, 2021
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

torchaudio/transforms.py torchaudio/transforms.py +6 -0

No files found.
--- a/torchaudio/transforms.py
+++ b/torchaudio/transforms.py
@@ -654,6 +654,12 @@ class MuLawEncoding(torch.nn.Module):
    Args:
        quantization_channels (int, optional): Number of channels. (Default: ``256``)
+    Example
+       >>> waveform, sample_rate = torchaudio.load('test.wav', normalize=True)
+       >>> transform = torchaudio.transforms.MuLawEncoding(quantization_channels=512)
+       >>> mulawtrans = transform(waveform)
    """
    __constants__ = ['quantization_channels']