Add example for MuLawDecoding (#1684)

90c0edc5 · S Harish · GitHub · 2aad9289 · 90c0edc5
Unverified Commit 90c0edc5 authored Aug 06, 2021 by S Harish Committed by GitHub Aug 06, 2021
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 0 deletions

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

No files found.
--- a/torchaudio/transforms.py
+++ b/torchaudio/transforms.py
@@ -699,6 +699,11 @@ class MuLawDecoding(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.MuLawDecoding(quantization_channels=512)
+        >>> mulawtrans = transform(waveform)
    """
    __constants__ = ['quantization_channels']