doc: improve docstring formatting

pyannote · Jan 7, 2022 · e16b900 · e16b900
1 parent 71b78d1
commit e16b900
Showing 1 changed file with 6 additions and 7 deletions.
diff --git a/pyannote/audio/augmentation/spec_augment.py b/pyannote/audio/augmentation/spec_augment.py
@@ -32,13 +32,12 @@
 
 
 class SpecAugment(Callback):
-    """
-    Callback for spectrogram augmentation. Two-step process :
-
-    1) Apply frequency mask(s)
-    2) Apply time mask(s)
-    (3) Time warping) : Not implemented yet. Shown as leading to a small improvement
-    in the reference.
+    """Spectrogram augmentation. 
+    
+    This is a callback that applies the following transformations to each batch:
+        1. Apply frequency masks
+        2. Apply time masks
+        3. Time warping (TODO)
 
     Parameters
     ----------