Skip to content

Commit b803b27

Browse files
committed
Re-introduce documentation warning for custom augmentations
1 parent a6d07e1 commit b803b27

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

luxonis_ml/data/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -917,6 +917,14 @@ The augmentations are specified as a list of dictionaries, where each dictionary
917917

918918
By default, we support most augmentations from the `albumentations` library. You can find the full list of augmentations and their parameters in the [Albumentations](https://albumentations.ai/docs/api_reference/augmentations/)documentation.
919919

920+
> **Note:** The standard Albumentations flip transforms (`HorizontalFlip`, `VerticalFlip`, `Transpose`)
921+
> will flip images and keypoints but **do not** swap symmetric keypoints\
922+
> (e.g., left/right joints in human poses). For tasks with symmetric keypoint structures, use our custom augmentations:
923+
>
924+
> - `HorizontalSymetricKeypointsFlip`
925+
> - `VerticalSymetricKeypointsFlip`
926+
> - `TransposeSymmetricKeypoints`
927+
920928
On top of that, we provide a handful of custom batch augmentations:
921929

922930
- `Mosaic4` - Mosaic augmentation with 4 images. Combines crops of 4 images into a single image in a mosaic pattern.

luxonis_ml/data/augmentations/albumentations_engine.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ def _check_augmentation_warnings(
249249
if "keypoints" in available_target_types and augmentation_name in [
250250
"HorizontalFlip",
251251
"VerticalFlip",
252-
"Transpose"
252+
"Transpose",
253253
]:
254254
logger.warning(
255255
f"Using '{augmentation_name}' with keypoints."

0 commit comments

Comments
 (0)