Package: targetran
MotivationData augmentationis a technique commonly used for training machine learning models in the
computer vision field, where one can increase the amount of image data by
creating transformed copies of the original images.In the object detection sub-field, the transformation has to be done also
to the target rectangular bounding-boxes. However, such functionality is not
readily available in frameworks such as TensorFlow and PyTorch.While there are other powerful augmentation tools available, many of those
do not work well with theTPUwhen accessing fromGoogle ColaborKaggle Notebooks,
which are popular options nowadays for a lot of people who do not have their
own hardware resources.Here comes Targetran to fill the gap.What is Targetran?A light-weight data augmentation library to assist object detection or
image classification model training.Has simple Python API to transform both the images and the target rectangular
bounding-boxes.Use dataset-idiomatic approach for TensorFlow and PyTorch.Can be used with the TPU for acceleration (TensorFlow Dataset only).(Figure produced by the example codehere.)Table of contentsInstallationUsageNotationsData formatDesign principlesTensorFlow DatasetPyTorch DatasetImage classificationExamplesAPIInstallationTested for Python 3.8, 3.9, and 3.10.The best way to install Targetran with its dependencies is from PyPI:python3-mpipinstall--upgradetargetranAlternatively, to obtain the latest version from this repository:gitclonehttps://github.com/bhky/targetran.gitcdtargetran
python3-mpipinstall.UsageNotationsNDFloatArray: NumPy float array type, which is an alias tonp.typing.NDArray[np.float_].
The values are converted tonp.float32internally.tf.Tensor: General TensorFlow Tensor type. The values are converted totf.float32internally.Data formatFor object detection model training, which is the primary usage here, the following data are needed.image_seq(Sequence ofNDFloatArrayortf.Tensorof shape(height, width, num_channels)):images in channel-last format;image sizes can be different.bboxes_seq(Sequence ofNDFloatArrayortf.Tensorof shape(num_bboxes_per_image, 4)):eachbboxesarray/tensor provides the bounding-boxes associated with an image;each single bounding-box is given as[top_left_x, top_left_y, bbox_width, bbox_height];empty array/tensor means no bounding-boxes (and labels) for that image.labels_seq(Sequence ofNDFloatArrayortf.Tensorof shape(num_bboxes_per_image,)):eachlabelsarray/tensor provides the bounding-box labels associated with an image;empty array/tensor means no labels (and bounding-boxes) for that image.Some dummy data are created below for illustration. Please note the required format.importnumpyasnp# Each image could have different sizes, but they must follow the channel-last format,# i.e., (height, width, num_channels).image_seq=[np.random.rand(480,512,3)for_inrange(3)]# The bounding-boxes (bboxes) are given as a sequence of NumPy arrays (or TF tensors).# Each array represents the bboxes for one corresponding image.## Each bbox is given as [top_left_x, top_left_y, bbox_width, bbox_height].## In case an image has no bboxes, an empty array should be provided.bboxes_seq=[np.array([# Image with 2 bboxes.[214,223,10,11],[345,230,21,9],]),np.array([]),# Empty array for image with no bboxes.np.array([# Image with 3 bboxes.[104,151,22,10],[99,132,20,15],[340,220,31,12],]),]# Labels for the bboxes are also given as a sequence of NumPy arrays (or TF tensors).# The number of bboxes and labels should match. An empty array indicates no bboxes/labels.labels_seq=[np.array([0,1]),# 2 labels.np.array([]),# No labels.np.array([2,3,0]),# 3 labels.]# During operation, all the data values will be converted to float32.Design principlesBounding-boxes will always be rectangular with sides parallel to the image frame.After transformation, each resulting bounding-box is determined by the smallest
rectangle (with sides parallel to the image frame) enclosing the original transformed bounding-box.After transformation, resulting bounding-boxes with their centroids outside the
image frame will be removed, together with the corresponding labels.TensorFlow Datasetimporttensorflowastffromtargetran.tfimport(seqs_to_tf_dataset,TFCombineAffine,TFRandomFlipLeftRight,TFRandomFlipUpDown,TFRandomRotate,TFRandomShear,TFRandomTranslate,TFRandomCrop,TFResize,)# Convert the above data sequences into a TensorFlow Dataset.# Users can have their own way to create the Dataset, as long as for each iteration# it returns a tuple of tensors for a single sample: (image, bboxes, labels).ds=seqs_to_tf_dataset(image_seq,bboxes_seq,labels_seq)# The affine transformations can be combined into one operation for better performance.# Note that cropping and resizing are not affine and cannot be combined.# Option (1):affine_transform=TFCombineAffine([TFRandomRotate(probability=0.8),# Probability to include each affine transformation stepTFRandomShear(probability=0.6),# can be specified, otherwise the default value is used.TFRandomTranslate(),# Thus, the number of selected steps could vary.TFRandomFlipLeftRight(),TFRandomFlipUpDown()],probability=1.0# Probability to apply this single combined transformation.)# Option (2):# Alternatively, one can decide the exact number of randomly selected transformations,# e.g., use only any two of them. This could be a better option because too many# transformation steps may deform the images too much.affine_transform=TFCombineAffine([TFRandomRotate(),# Individual `probability` has no effect in this approach.TFRandomShear(),TFRandomTranslate(),TFRandomFlipLeftRight(),TFRandomFlipUpDown()],num_selected_transforms=2,# Only two steps from the list will be selected.selected_probabilities=[0.5,0.0,0.3,0.2,0.0],# Must sum up to 1.0, if given.keep_order=True,# If True, the selected steps must be performed in the given order.probability=1.0# Probability to apply this single combined transformation.)# Please refer to the API manual for more parameter options.# Apply transformations.auto_tune=tf.data.AUTOTUNEds=ds\.map(TFRandomCrop(probability=0.5),num_parallel_calls=auto_tune)\.map(affine_transform,num_parallel_calls=auto_tune)\.map(TFResize((256,256)),num_parallel_calls=auto_tune)# In the Dataset `map` call, the parameter `num_parallel_calls` can be set to,# e.g., tf.data.AUTOTUNE, for better performance. See docs for TensorFlow Dataset.# Batching:# Since the array/tensor shape of each sample could be different, conventional# way of batching may not work. Users will have to consider their own use cases.# One possibly useful way is the padded-batch.ds=ds.padded_batch(batch_size=2,padding_values=-1.0)PyTorch DatasetfromtypingimportOptional,Sequence,Tupleimportnumpy.typingfromtorch.utils.dataimportDatasetfromtargetran.npimport(CombineAffine,RandomFlipLeftRight,RandomFlipUpDown,RandomRotate,RandomShear,RandomTranslate,RandomCrop,Resize,)fromtargetran.utilsimportComposeNDFloatArray=numpy.typing.NDArray[numpy.float_]classPTDataset(Dataset):"""A very simple PyTorch Dataset.As per common practice, transforms are done on NumPy arrays."""def__init__(self,image_seq:Sequence[NDFloatArray],bboxes_seq:Sequence[NDFloatArray],labels_seq:Sequence[NDFloatArray],transforms:Optional[Compose])->None:self.image_seq=image_seqself.bboxes_seq=bboxes_seqself.labels_seq=labels_seqself.transforms=transformsdef__len__(self)->int:returnlen(self.image_seq)def__getitem__(self,idx:int)->Tuple[NDFloatArray,NDFloatArray,NDFloatArray]:ifself.transforms:returnself.transforms(self.image_seq[idx],self.bboxes_seq[idx],self.labels_seq[idx])return(self.image_seq[idx],self.bboxes_seq[idx],self.labels_seq[idx])# The affine transformations can be combined into one operation for better performance.# Note that cropping and resizing are not affine and cannot be combined.# Option (1):affine_transform=CombineAffine([RandomRotate(probability=0.8),# Probability to include each affine transformation stepRandomShear(probability=0.6),# can be specified, otherwise the default value is used.RandomTranslate(),# Thus, the number of selected steps could vary.RandomFlipLeftRight(),RandomFlipUpDown()],probability=1.0# Probability to apply this single combined transformation.)# Option (2):# Alternatively, one can decide the exact number of randomly selected transformations,# e.g., use only any two of them. This could be a better option because too many# transformation steps may deform the images too much.affine_transform=CombineAffine([RandomRotate(),# Individual `probability` has no effect in this approach.RandomShear(),RandomTranslate(),RandomFlipLeftRight(),RandomFlipUpDown()],num_selected_transforms=2,# Only two steps from the list will be selected.selected_probabilities=[0.5,0.0,0.3,0.2,0.0],# Must sum up to 1.0, if given.keep_order=True,# If True, the selected steps must be performed in the given order.probability=1.0# Probability to apply this single combined transformation.)# Please refer to the API manual for more parameter options.# The `Compose` here is similar to that from the torchvision package, except# that here it also supports callables with multiple inputs and outputs needed# for objection detection tasks, i.e., (image, bboxes, labels).transforms=Compose([RandomCrop(probability=0.5),affine_transform,Resize((256,256)),])# Convert the above data sequences into a PyTorch Dataset.# Users can have their own way to create the Dataset, as long as for each iteration# it returns a tuple of arrays for a single sample: (image, bboxes, labels).ds=PTDataset(image_seq,bboxes_seq,labels_seq,transforms=transforms)# Batching:# In PyTorch, it is common to use a Dataset with a DataLoader, which provides# batching functionality. However, since the array/tensor shape of each sample# could be different, the default batching may not work. Targetran provides# a `collate_fn` that helps producing batches of (image_seq, bboxes_seq, labels_seq).fromtorch.utils.dataimportDataLoaderfromtargetran.utilsimportcollate_fndata_loader=DataLoader(ds,batch_size=2,collate_fn=collate_fn)Image classificationWhile the tools here are primarily designed for object detection tasks, they can
also be used for image classification in which only the images are to be transformed,
e.g., given a dataset that returns(image, label)samples, or even onlyimagesamples.
Theimage_onlyfunction can be used to convert a transformation class for this purpose.If the dataset returns a tuple(image, ...)in each iteration, only theimagewill be transformed, other parameters that followed such as(..., label, weight)will be returned untouched.If the dataset returnsimageonly (not a tuple), then only the transformedimagewill be returned.fromtargetran.utilsimportimage_only# TensorFlow.ds=ds\.map(image_only(TFRandomCrop()))\.map(image_only(affine_transform))\.map(image_only(TFResize((256,256))))\.batch(32)# Conventional batching can be used for classification setup.# PyTorch.transforms=Compose([image_only(RandomCrop()),image_only(affine_transform),image_only(Resize((256,256))),])ds=PTDataset(...,transforms=transforms)data_loader=DataLoader(ds,batch_size=32)ExamplesCode examples in this repositoryConstruct a TensorFlow Dataset with Targetran
and object detection data(Kaggle Notebook)Image classification with TensorFlow and Targetran on TPU(Kaggle Notebook)APISeeherefor API details.