# custom

Python API: `luxonis_ml.data.augmentations.custom`

Built-in custom Albumentations transforms.

The
[TRANSFORMATIONS](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom.md)
registry contains Luxonis transforms that can be used by
[AlbumentationsEngine](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/albumentations_engine.md)
through augmentation configuration records. Registered transforms are referenced by class name in the `name` field, the same way
as standard Albumentations transforms.

Built-in custom transforms include:

 * [LetterboxResize](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/letterbox_resize.md)
   for aspect-ratio preserving resize and padding.
 * [MixUp](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/mixup.md)
   for blending pairs of images and compatible labels.
 * [Mosaic4](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/mosaic.md)
   for composing a 2×2 image mosaic.
 * Symmetric keypoint flips and transposition helpers for keypoint tasks.

User-defined transforms can be registered with `TRANSFORMATIONS.register` and then used by name in loader augmentation
configuration.

```python
TRANSFORMATIONS.register(module=CustomTransform)

augmentation_config = [
    {
        "name": "CustomTransform",
        "params": {"p": 1.0},
    },
]
```

## Child Pages

 * [letterbox_resize](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/letterbox_resize.md)
 * [mixup](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/mixup.md)
 * [mosaic](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/mosaic.md)
 * [symmetric_keypoints_flip](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/augmentations/custom/symmetric_keypoints_flip.md)

## Attributes

### TRANSFORMATIONS