Add docstring to Identity and mention it in readme

asteroid-team · Jun 29, 2022 · 8f84099 · 8f84099
1 parent 2351b48
commit 8f84099
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -131,6 +131,13 @@ _Added in v0.8.0_
 
 Apply high-pass filtering to the input audio.
 
+## Identity
+
+_Added in v0.11.0_
+
+This transform returns the input unchanged. It can be used for simplifying the code
+in cases where data augmentation should be disabled.
+
 ## LowPassFilter
 
 _Added in v0.8.0_

diff --git a/torch_audiomentations/augmentations/identity.py b/torch_audiomentations/augmentations/identity.py
@@ -6,6 +6,10 @@
 
 
 class Identity(BaseWaveformTransform):
+    """
+    This transform returns the input unchanged. It can be used for simplifying the code
+    in cases where data augmentation should be disabled.
+    """
 
     supported_modes = {"per_batch", "per_example", "per_channel"}
     supports_multichannel = True