sinapsis-albumentations 0.1.0

Templates to perform image transformations using the albumentations library.

Sinapsis Albumentations

Templates for applying image transformations using Albumentations.

🐍 Installation • 🚀 Features • 📚 Usage example • 📙 Documentation • 🔍 License

The Sinapsis albumentations module provides an extensive collection of templates powered by the Albumentations library. These templates allow users to apply a wide range of augmentations, from simple operations like flipping and resizing to more advanced transformations such as elastic distortions and geometric warping.

🐍 Installation

Install using your package manager of choice. We encourage the use of uv

Example with uv:

  uv pip install sinapsis-albumentations --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-albumentations --extra-index-url https://pypi.sinapsis.tech

🚀 Features

Templates Supported

[!TIP] Use CLI command sinapsis info --all-template-names to show a list with all the available templates installed with the sinapsis-albumentations package.

🌍 General Attributes

[!NOTE] All templates share the following attributes:

• apply_to_annotations (bool, optional): Determines whether transformations should also be applied to annotations like bounding boxes, keypoints, and masks. Defaults to False.
• bbox_params (dict[str, Any], optional): Configuration for transforming bounding boxes, following Albumentations' BboxParams format. Defaults to None.
• keypoints_params (dict[str, Any], optional): Defines keypoint transformation settings using Albumentations' KeypointParams. Defaults to None.
• additional_targets (dict[str, Any], optional): Specifies extra annotation types (e.g., segmentation masks) to be transformed alongside the image. Defaults to {"mask": "mask"}.

Additional transformation-specific attributes can be dynamically assigned through the class initialization dictionary (*_init attributes). These attributes correspond directly to the arguments used in Albumentations.

[!TIP] Use CLI command sinapsis info --example-template-config TEMPLATE_NAME to produce an example Agent config for the Template specified in TEMPLATE_NAME.

For example, for RotateWrapper use sinapsis info --example-template-config RotateWrapper to produce the following example config:

agent:
  name: my_test_agent
templates:
- template_name: InputTemplate
  class_name: InputTemplate
- template_name: RotateWrapper
  class_name: RotateWrapper
  template_input: InputTemplate
  attributes:
    apply_to_annotations: false
    bbox_params: null
    keypoints_params: null
    additional_targets:
      mask: mask
    rotate_init:
      limit: [-45, 45]
      interpolation: 1
      border_mode: 4
      value: [0, 0, 0]
      mask_value: null
      rotate_method: "largest_box"
      crop_border: false
      fill_value: 0
      mask_fill_value: 0
      deterministic: true
      p: 1.0

📚 Usage example

The following example demonstrates how to use Sinapsis Albumentations to apply multiple image augmentations. This setup loads a dataset of images, applies horizontal flipping and elastic transformation, and saves the results. Below is the full YAML configuration, followed by a breakdown of each component.

Example configuration

agent:
  name: transforms_agent
  description: "Agent to apply an horizontal-flip and an elastic-transformation to a set of images loaded from a directory."

templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}

- template_name: FolderImageDatasetCV2
  class_name: FolderImageDatasetCV2
  template_input: InputTemplate
  attributes:
    data_dir: my_dataset

- template_name: HorizontalFlip
  class_name: HorizontalFlipWrapper
  template_input: FolderImageDatasetCV2
  attributes:
    horizontalflip_init:
      p: 1.0

- template_name: ElasticTransform
  class_name: ElasticTransformWrapper
  template_input: HorizontalFlip
  attributes:
    elastictransform_init:
      mask_value: 150
      p: 1.0
      alpha: 100
      sigma: 50

- template_name: ImageSaver
  class_name: ImageSaver
  template_input: ElasticTransform
  attributes:
    save_dir: results
    extension: jpg

This configuration defines an agent and a sequence of templates to apply image transformations.

[!NOTE] Attributes specified under the *_init keys (e.g., elastictransform_init, horizontalflip_init) correspond directly to the Albumentations transformation parameters. Ensure that values are assigned correctly according to the official Albumentations documentation, as they affect the behavior and performance of each transformation.

[!IMPORTANT] The FolderImageDataserCV2 and ImageSaver correspond to sinapsis-data-readers and sinapsis-data-writers. If you want to use the example, please make sure you install the packages.

To run the config, use the CLI:

sinapsis run name_of_config.yml

📙 Documentation

Documentation for this and other sinapsis packages is available on the sinapsis website

Tutorials for different projects within sinapsis are available at sinapsis tutorials page

🔍 License

This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.

For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.