Skip to content

Cross-library augmentation toolbox supporting 300 operators over 8 libraries + AI transforms

License

Notifications You must be signed in to change notification settings

adobe-research/beacon-aug

Repository files navigation

Beacon-aug

  • A cross-library image augmentation module for deep learning training

Check our website for user instructions

Collaborative projects in Adobe Research

Contributors

  • Module building: Rebecca Li, Yannick Hold-Geoffroy, Geoffrey Oxholm
  • Customized functions and advanced properties contributing: Richard Zhang, Maksym Andriushchenko, Krishna Kumar Singh, Zhifei Zhang

Why Beacon-aug

Install

How to install

pip install git+https://github.com/adobe-research/beacon-aug

How to develop

git clone https://github.com/adobe-research/beacon-aug.git

conda create -y -n aug python=3.7
conda activate aug

python setup.py develop   # for developer 

import beacon_aug will now directly link to the package in the cloned directory, easing development.

How to use

import beacon_aug as BA
aug = BA.HorizontalFlip(p=1,  library="albumentations")
image_auged = aug(image=image)["image"]

Check tutorials for more examples:

Operator Overview

Basic Operators

Customized Operators

  • check this instructions to add customized functions
  • Contributors:
    • TextFlow: Zhifei Zhang @zzhang
    • HidePatch: Krishna kumar Singh @krishsin
BA.{CustomizedOperator}(library="custom")

Standard Operators:

Beacon_aug support all the operators in all standard libraries

BA.{StandardOperator}(library={library})
  • Check this list for the operators supporting one library
  • Check the chart for the operators supporting multiple libraries

Advanced Operators

  • Check here for user instruction

Trouble Shooting

  • Check here
  • If you have troubles not solved, try the prune version by simply reinstall beacon-aug replacing requirements.txt with requirements_prune.txt in a new virtual environment

Citation

@misc{beacon-aug2021,
  author = {Li, Xiaoyang Rebecca
            and Hold-Geoffroy, Yannick
            and Oxholm Geoffrey
            and Singh, Krishna Kumar
            and Zhang, Zhifei Zhang
            and Zhang, Richard
            and Andriushchenko, Maksym
            and others},
  title = {Beacon-aug: A cross-library image augmentation toolbox.},
  howpublished = {\url{https://github.com/adobe-research/beacon-aug}},
  year = {2021},
  note = {Online; accessed Jan-11-2022}
}