docs update

stefanklut · Dec 13, 2023 · 5c66b6f · 5c66b6f
1 parent 60b056a
commit 5c66b6f
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/datasets/augmentations.py b/datasets/augmentations.py
@@ -914,11 +914,16 @@ def build_augmentation(cfg: CfgNode, mode: str = "train") -> list[T.Augmentation
     Function to generate all the augmentations used in the inference and training process
 
     Args:
-        cfg (CfgNode): config node
+        cfg (CfgNode): The configuration node containing the parameters for the augmentations.
         mode (str): flag if the augmentation are used for inference or training
+            - Possible values are "train", "val", or "test".
 
     Returns:
         list[T.Augmentation | T.Transform]: list of augmentations to apply to an image
+
+    Raises:
+        NotImplementedError: If the mode is not one of "train", "val", or "test".
+        NotImplementedError: If the resize mode specified in the configuration is not recognized.
     """
     augmentation: list[T.Augmentation | T.Transform] = []