Skip to content

Commit

Permalink
A README for the preprocessing layers (keras-team#1979)
Browse files Browse the repository at this point in the history
* init

* nits

* review comments

* nits
  • Loading branch information
ariG23498 authored Jul 27, 2023
1 parent e9e368a commit b4f6cd6
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
54 changes: 54 additions & 0 deletions keras_cv/layers/preprocessing/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Preprocessing Layers

KerasCV offers many preprocessing and data augmentation layers which support classification, object detection, and segmentation masks. When you use KerasCV augmentation layers to augment your training data, class labels, bounding boxes, and mask labels automatically get augmented alongside the image augmentations!

The provided table gives an overview of the different augmentation layers available and the data formats they support.

| Layer Name | Vectorized | Segmentation Masks | BBoxes | Class Labels |
| :-- | :--: | :--: | :--: | :--: |
| AugMix |||||
| AutoContrast |||||
| ChannelShuffle |||||
| CutMix |||||
| Equalization |||||
| FourierMix |||||
| Grayscale |||||
| GridMask |||||
| JitteredResize |||||
| MixUp |||||
| Mosaic |||||
| Posterization |||||
| RandAugment |||||
| RandomApply <sup>+</sup> | - | - | - | - |
| RandomAspectRatio |||||
| RandomBrightness |||||
| RandomChannelShift |||||
| RandomChoice <sup>+</sup> | - | - | - | - |
| RandomColorDegeneration |||||
| RandomColorJitter |||||
| RandomContrast |||||
| RandomCropAndResize |||||
| RandomCrop |||||
| RandomCutout |||||
| RandomFlip |||||
| RandomGaussianBlur |||||
| RandomHue |||||
| RandomJpegQuality |||||
| RandomRotation |||||
| RandomSaturation |||||
| RandomSharpness |||||
| RandomShear |||||
| RandomTranslation |||||
| RandomZoom |||||
| RepeatedAugmentation <sup>+</sup> | - | - | - | - |
| Rescaling |||||
| Resizing |||||
| Solarization |||||

<sup>+</sup> Meta Layers, the data types will depend on the Sub Layers.

# Base Layers

- BaseImageAugmentationLayer
- VectorizedBaseImageAugmentationLayer
- RandomAugmentationPipeline
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class BaseImageAugmentationLayer(base_class):
The `call()` method supports two formats of inputs:
1. A single image tensor with shape (height, width, channels) or
(batch_size, height, width, channels)
1. A dict of tensors with any of the following keys (note that `"images"`
2. A dict of tensors with any of the following keys (note that `"images"`
must be present):
* `"images"` - Image Tensor with shape (height, width, channels) or
(batch_size, height, width, channels)
Expand Down

0 comments on commit b4f6cd6

Please sign in to comment.