Transforming and augmenting images

Transforms are common image transformations available in the torchvision.transforms module. They can be chained together using Compose. Most transform classes have a function equivalent: functional transforms give fine-grained control over the transformations. This is useful if you have to build a more complex transformation pipeline (e.g. in the case of segmentation tasks).

Most transformations accept both PIL images and tensor images, although some transformations are PIL-only and some are tensor-only. The Conversion Transforms may be used to convert to and from PIL images.

The transformations that accept tensor images also accept batches of tensor images. A Tensor Image is a tensor with (C, H, W) shape, where C is a number of channels, H and W are image height and width. A batch of Tensor Images is a tensor of (B, C, H, W) shape, where B is a number of images in the batch.

The expected range of the values of a tensor image is implicitly defined by the tensor dtype. Tensor images with a float dtype are expected to have values in [0, 1). Tensor images with an integer dtype are expected to have values in [0, MAX_DTYPE] where MAX_DTYPE is the largest value that can be represented in that dtype.

Randomized transformations will apply the same transformation to all the images of a given batch, but they will produce different transformations across calls. For reproducible transformations across calls, you may use functional transforms.

The following examples illustrate the use of the available transforms:

• Illustration of transforms

  

• Tensor transforms and JIT

  

Warning

Since v0.8.0 all random transformations are using torch default random generator to sample random parameters. It is a backward compatibility breaking change and user should set the random state as following:

# Previous versions
# import random
# random.seed(12)

# Now
import torch
torch.manual_seed(17)

Please, keep in mind that the same seed for torch random generator and Python random generator will not produce the same results.

Scriptable transforms

In order to script the transformations, please use torch.nn.Sequential instead of Compose.

transforms = torch.nn.Sequential(
    transforms.CenterCrop(10),
    transforms.Normalize((0.485, 0.456, 0.406), (0.229, 0.224, 0.225)),
)
scripted_transforms = torch.jit.script(transforms)

Make sure to use only scriptable transformations, i.e. that work with torch.Tensor and does not require lambda functions or PIL.Image.

For any custom transformations to be used with torch.jit.script, they should be derived from torch.nn.Module.

Compositions of transforms

Compose(transforms)

Composes several transforms together.

Transforms on PIL Image and torch.*Tensor

CenterCrop(size)	Crops the given image at the center.
ColorJitter([brightness, contrast, …])	Randomly change the brightness, contrast, saturation and hue of an image.
FiveCrop(size)	Crop the given image into four corners and the central crop.
Grayscale([num_output_channels])	Convert image to grayscale.
Pad(padding[, fill, padding_mode])	Pad the given image on all sides with the given “pad” value.
RandomAffine(degrees[, translate, scale, …])	Random affine transformation of the image keeping center invariant.
RandomApply(transforms[, p])	Apply randomly a list of transformations with a given probability.
RandomCrop(size[, padding, pad_if_needed, …])	Crop the given image at a random location.
RandomGrayscale([p])	Randomly convert image to grayscale with a probability of p (default 0.1).
RandomHorizontalFlip([p])	Horizontally flip the given image randomly with a given probability.
RandomPerspective([distortion_scale, p, …])	Performs a random perspective transformation of the given image with a given probability.
RandomResizedCrop(size[, scale, ratio, …])	Crop a random portion of image and resize it to a given size.
RandomRotation(degrees[, interpolation, …])	Rotate the image by angle.
RandomVerticalFlip([p])	Vertically flip the given image randomly with a given probability.
Resize(size[, interpolation, max_size, …])	Resize the input image to the given size.
TenCrop(size[, vertical_flip])	Crop the given image into four corners and the central crop plus the flipped version of these (horizontal flipping is used by default).
GaussianBlur(kernel_size[, sigma])	Blurs image with randomly chosen Gaussian blur.
RandomInvert([p])	Inverts the colors of the given image randomly with a given probability.
RandomPosterize(bits[, p])	Posterize the image randomly with a given probability by reducing the number of bits for each color channel.
RandomSolarize(threshold[, p])	Solarize the image randomly with a given probability by inverting all pixel values above a threshold.
RandomAdjustSharpness(sharpness_factor[, p])	Adjust the sharpness of the image randomly with a given probability.
RandomAutocontrast([p])	Autocontrast the pixels of the given image randomly with a given probability.
RandomEqualize([p])	Equalize the histogram of the given image randomly with a given probability.

Transforms on PIL Image only

RandomChoice(transforms[, p])	Apply single transformation randomly picked from a list.
RandomOrder(transforms)	Apply a list of transformations in a random order.

Transforms on torch.*Tensor only

LinearTransformation(transformation_matrix, …)	Transform a tensor image with a square transformation matrix and a mean_vector computed offline.
Normalize(mean, std[, inplace])	Normalize a tensor image with mean and standard deviation.
RandomErasing([p, scale, ratio, value, inplace])	Randomly selects a rectangle region in an torch Tensor image and erases its pixels.
ConvertImageDtype(dtype)	Convert a tensor image to the given dtype and scale the values accordingly This function does not support PIL Image.

Conversion Transforms

ToPILImage([mode])	Convert a tensor or an ndarray to PIL Image.
ToTensor()	Convert a PIL Image or numpy.ndarray to tensor.
PILToTensor()	Convert a PIL Image to a tensor of the same type.

Generic Transforms

Lambda(lambd)

Apply a user-defined lambda as a transform.

Automatic Augmentation Transforms

AutoAugment is a common Data Augmentation technique that can improve the accuracy of Image Classification models. Though the data augmentation policies are directly linked to their trained dataset, empirical studies show that ImageNet policies provide significant improvements when applied to other datasets. In TorchVision we implemented 3 policies learned on the following datasets: ImageNet, CIFAR10 and SVHN. The new transform can be used standalone or mixed-and-matched with existing transforms:

AutoAugmentPolicy(value)	AutoAugment policies learned on different datasets.
AutoAugment(policy, interpolation, fill)	AutoAugment data augmentation method based on “AutoAugment: Learning Augmentation Strategies from Data”.
RandAugment(num_ops, magnitude, …)	RandAugment data augmentation method based on “RandAugment: Practical automated data augmentation with a reduced search space”.
TrivialAugmentWide(num_magnitude_bins, …)	Dataset-independent data-augmentation with TrivialAugment Wide, as described in “TrivialAugment: Tuning-free Yet State-of-the-Art Data Augmentation”.

Functional Transforms

Functional transforms give you fine-grained control of the transformation pipeline. As opposed to the transformations above, functional transforms don’t contain a random number generator for their parameters. That means you have to specify/generate all parameters, but the functional transform will give you reproducible results across calls.

Example: you can apply a functional transform with the same parameters to multiple images like this:

import torchvision.transforms.functional as TF
import random

def my_segmentation_transforms(image, segmentation):
    if random.random() > 0.5:
        angle = random.randint(-30, 30)
        image = TF.rotate(image, angle)
        segmentation = TF.rotate(segmentation, angle)
    # more transforms ...
    return image, segmentation

Example: you can use a functional transform to build transform classes with custom behavior:

import torchvision.transforms.functional as TF
import random

class MyRotationTransform:
    """Rotate by one of the given angles."""

    def __init__(self, angles):
        self.angles = angles

    def __call__(self, x):
        angle = random.choice(self.angles)
        return TF.rotate(x, angle)

rotation_transform = MyRotationTransform(angles=[-30, -15, 0, 15, 30])

adjust_brightness(img, brightness_factor)	Adjust brightness of an image.
adjust_contrast(img, contrast_factor)	Adjust contrast of an image.
adjust_gamma(img, gamma[, gain])	Perform gamma correction on an image.
adjust_hue(img, hue_factor)	Adjust hue of an image.
adjust_saturation(img, saturation_factor)	Adjust color saturation of an image.
adjust_sharpness(img, sharpness_factor)	Adjust the sharpness of an image.
affine(img, angle, translate, scale, shear)	Apply affine transformation on the image keeping image center invariant.
autocontrast(img)	Maximize contrast of an image by remapping its pixels per channel so that the lowest becomes black and the lightest becomes white.
center_crop(img, output_size)	Crops the given image at the center.
convert_image_dtype(image[, dtype])	Convert a tensor image to the given dtype and scale the values accordingly This function does not support PIL Image.
crop(img, top, left, height, width)	Crop the given image at specified location and output size.
equalize(img)	Equalize the histogram of an image by applying a non-linear mapping to the input in order to create a uniform distribution of grayscale values in the output.
erase(img, i, j, h, w, v[, inplace])	Erase the input Tensor Image with given value.
five_crop(img, size)	Crop the given image into four corners and the central crop.
gaussian_blur(img, kernel_size[, sigma])	Performs Gaussian blurring on the image by given kernel.
get_image_num_channels(img)	Returns the number of channels of an image.
get_image_size(img)	Returns the size of an image as [width, height].
hflip(img)	Horizontally flip the given image.
invert(img)	Invert the colors of an RGB/grayscale image.
normalize(tensor, mean, std[, inplace])	Normalize a float tensor image with mean and standard deviation.
pad(img, padding[, fill, padding_mode])	Pad the given image on all sides with the given “pad” value.
perspective(img, startpoints, endpoints[, …])	Perform perspective transform of the given image.
pil_to_tensor(pic)	Convert a PIL Image to a tensor of the same type.
posterize(img, bits)	Posterize an image by reducing the number of bits for each color channel.
resize(img, size[, interpolation, max_size, …])	Resize the input image to the given size.
resized_crop(img, top, left, height, width, size)	Crop the given image and resize it to desired size.
rgb_to_grayscale(img[, num_output_channels])	Convert RGB image to grayscale version of image.
rotate(img, angle[, interpolation, expand, …])	Rotate the image by angle.
solarize(img, threshold)	Solarize an RGB/grayscale image by inverting all pixel values above a threshold.
ten_crop(img, size[, vertical_flip])	Generate ten cropped images from the given image.
to_grayscale(img[, num_output_channels])	Convert PIL image of any mode (RGB, HSV, LAB, etc) to grayscale version of image.
to_pil_image(pic[, mode])	Convert a tensor or an ndarray to PIL Image.
to_tensor(pic)	Convert a PIL Image or numpy.ndarray to tensor.
vflip(img)	Vertically flip the given image.