albumentations README

The project's README from github.com/albumentations-team/albumentations. As one markdown file: README.md.

Albumentations

PyPI version CI PyPI Downloads Conda Downloads

📣 Stay updated! Subscribe to our newsletter for the latest releases, tutorials, and tips directly from the Albumentations team.

License: MIT Gurubase

Docs | Discord | Twitter | LinkedIn

⚠️ Important Notice: Albumentations is No Longer Maintained

This repository is no longer actively maintained. The last update was in June 2025, and no further bug fixes, features, or compatibility updates will be provided.

🚀 Introducing AlbumentationsX - The Future of Albumentations

All development has moved to AlbumentationsX, the next-generation successor to Albumentations.

Note: AlbumentationsX uses dual licensing (AGPL-3.0 / Commercial). The AGPL license has strict copyleft requirements - see details below.

Your Options Moving Forward

1. Continue Using Albumentations (MIT License)

Best for: Projects that work fine with the current version and don't need updates

2. Upgrade to AlbumentationsX (Dual Licensed)

Best for: Projects that need ongoing support, updates, and new features

⚠️ AGPL License Warning: The AGPL-3.0 license is NOT compatible with permissive licenses like MIT, Apache 2.0, or BSD. If your project uses any of these licenses, you CANNOT use the AGPL version of AlbumentationsX - you'll need a commercial license.

Migration is Simple

# Uninstall original
pip uninstall albumentations

# Install AlbumentationsX
pip install albumentationsx

That's it! Your existing code continues to work without any changes:

import albumentations as A  # Same import!

transform = A.Compose([
    A.RandomCrop(width=256, height=256),
    A.HorizontalFlip(p=0.5),
    A.RandomBrightnessContrast(p=0.2),
])

Learn More

Original Albumentations README

GitAds Sponsored

Sponsored by GitAds

Albumentations is a Python library for image augmentation. Image augmentation is used in deep learning and computer vision tasks to increase the quality of trained models. The purpose of image augmentation is to create new training samples from the existing data.

Here is an example of how you can apply some pixel-level augmentations from Albumentations to create new images from the original one: parrot

Why Albumentations

Table of contents

Authors

Current Maintainer

Vladimir I. Iglovikov | Kaggle Grandmaster

Emeritus Core Team Members

Mikhail Druzhinin | Kaggle Expert

Alex Parinov | Kaggle Master

Alexander Buslaev | Kaggle Master

Eugene Khvedchenya | Kaggle Grandmaster

Installation

Albumentations requires Python 3.9 or higher. To install the latest version from PyPI:

pip install -U albumentations

Other installation options are described in the documentation.

Documentation

The full documentation is available at https://albumentations.ai/docs/.

A simple example

import albumentations as A
import cv2

# Declare an augmentation pipeline
transform = A.Compose([
    A.RandomCrop(width=256, height=256),
    A.HorizontalFlip(p=0.5),
    A.RandomBrightnessContrast(p=0.2),
])

# Read an image with OpenCV and convert it to the RGB colorspace
image = cv2.imread("image.jpg")
image = cv2.cvtColor(image, cv2.COLOR_BGR2RGB)

# Augment an image
transformed = transform(image=image)
transformed_image = transformed["image"]

Getting started

I am new to image augmentation

Please start with the introduction articles about why image augmentation is important and how it helps to build better models.

I want to use Albumentations for the specific task such as classification or segmentation

If you want to use Albumentations for a specific task such as classification, segmentation, or object detection, refer to the set of articles that has an in-depth description of this task. We also have a list of examples on applying Albumentations for different use cases.

I want to explore augmentations and see Albumentations in action

Check the online demo of the library. With it, you can apply augmentations to different images and see the result. Also, we have a list of all available augmentations and their targets.

Who is using Albumentations

See also

List of augmentations

Pixel-level transforms

Pixel-level transforms will change just an input image and will leave any additional targets such as masks, bounding boxes, and keypoints unchanged. For volumetric data (volumes and 3D masks), these transforms are applied independently to each slice along the Z-axis (depth dimension), maintaining consistency across the volume. The list of pixel-level transforms:

Spatial-level transforms

Spatial-level transforms will simultaneously change both an input image as well as additional targets such as masks, bounding boxes, and keypoints. For volumetric data (volumes and 3D masks), these transforms are applied independently to each slice along the Z-axis (depth dimension), maintaining consistency across the volume. The following table shows which additional targets are supported by each transform:

Transform Image Mask BBoxes Keypoints Volume Mask3D
Affine ✓ ✓ ✓ ✓ ✓ ✓
AtLeastOneBBoxRandomCrop ✓ ✓ ✓ ✓ ✓ ✓
BBoxSafeRandomCrop ✓ ✓ ✓ ✓ ✓ ✓
CenterCrop ✓ ✓ ✓ ✓ ✓ ✓
CoarseDropout ✓ ✓ ✓ ✓ ✓ ✓
ConstrainedCoarseDropout ✓ ✓ ✓ ✓ ✓ ✓
Crop ✓ ✓ ✓ ✓ ✓ ✓
CropAndPad ✓ ✓ ✓ ✓ ✓ ✓
CropNonEmptyMaskIfExists ✓ ✓ ✓ ✓ ✓ ✓
D4 ✓ ✓ ✓ ✓ ✓ ✓
ElasticTransform ✓ ✓

albumentations (albumentations-team/albumentations)

Searching Database…

15.3K ·GitHub
Albumentations
archived
Что это?Albumentations — это быстрая и гибкая библиотека Python для аугментации изображений, которая используется при обучении моделей компьютерного зрения. Она предлагает большой набор преобразований на уровне пикселей и на уровне пространства для изображений, масок, ограничивающих рамок, ключевых точек и даже трёхмерных объёмов.
Это библиотека или самостоятельное приложение?Это библиотека Python, которую вы импортируете в свой конвейер обучения, а не самостоятельное приложение.
Как добавить её в проект?Установите её через pip, затем импортируйте и составьте набор преобразований, которые нужно применить к вашим изображениям, маскам, ограничивающим рамкам или ключевым точкам.
Нужны ли мне PyTorch или TensorFlow, чтобы это использовать?Сама библиотека не привязана к конкретному фреймворку (преобразования написаны на чистом Python и основаны на NumPy); она работает с любыми данными изображений, независимо от того, используете ли вы для обучения PyTorch, TensorFlow или другой фреймворк.
Проект всё ещё поддерживается?Нет. Репозиторий больше не поддерживается активно с июня 2025 года, и никаких дальнейших исправлений ошибок, новых функций или обновлений совместимости не будет.
Кому нужен оригинальный Albumentations, а кому — его преемник?Используйте оригинальный Albumentations, только если ваш проект уже нормально работает с текущей версией и не требует исправлений или новых функций; в остальных случаях в README рекомендуется перейти на AlbumentationsX для дальнейшей поддержки.
К каким типам данных, кроме обычных изображений, можно применять преобразования?Преобразования поддерживают изображения, маски сегментации, ограничивающие рамки, ключевые точки и объёмные трёхмерные данные (объёмы и трёхмерные маски); для трёхмерных данных они применяются последовательно ко всем срезам по глубине.
Сколько видов аугментации предлагается?Есть десятки преобразований на уровне пикселей (например, Blur, CLAHE, GaussNoise, RandomRain) и десятки пространственных преобразований (например, Affine, CoarseDropout, CropAndPad, ElasticTransform), которые могут одновременно влиять на изображения, маски, ограничивающие рамки и ключевые точки.
Как перейти на AlbumentationsX, если мне нужна активная поддержка?Переход задуман как прямая замена: достаточно выполнить pip install albumentationsx, и ваш существующий код Albumentations продолжит работать без изменений.
Могу ли я бесплатно использовать AlbumentationsX в коммерческом проекте с лицензией MIT?Нет — вариант по лицензии AGPL-3.0 бесплатен только для проектов с лицензией AGPL и несовместим с лицензиями без ограничений, такими как MIT, Apache или BSD, поэтому коммерческим проектам или проектам с такими лицензиями нужна платная коммерческая лицензия.
What are similar projects?imgaug, labelImg, X-AnyLabeling, VisionHOPE, Detectron, detectron2, deep-learning-for-image-processing, kornia
Which topics is it in?bounding-boxes, augmentation, detection, image-segmentation, segmentation, image-classification, object-detection, image-processing, deprecated, computer-vision, pytorch, deep-learning
Creator
albumentations-team
Size
102.7 MB
Stars
15.3K
Updated
CommitJun 25Release2.0.8May 27
Age
8y
Commits · 90 Days