Add example for ComplexNorm (#1658)

1b919530 · Arijit Roy · GitHub · 2e58f18a · 1b919530
Unverified Commit 1b919530 authored Aug 03, 2021 by Arijit Roy Committed by GitHub Aug 03, 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
@@ -780,6 +780,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_norm = transform(complex_tensor)
    """
    __constants__ = ['power']