Augmentify is a CLI data augmentation tool used to assist in YOLO model training.
- Install Python from 'https://www.python.org/downloads/' (I recommend version 3.11.8)
- Open a shell session
- cd into your preferred directory to install the program
- Once in the preferred directory, run: 'git clone https://github.com/AlexTseng01/augmentify.git'
- Create a virtual environment: 'python -m venv venv'
- Enter the virtual environment: './venv/Scripts/Activate.ps1'
- Install the dependencies: 'pip install albumentations opencv-python'
Before using Augmentify, make sure you are in the Augmentify directory and that the virtual environment is activated. Then you can run the program.
Once you have Augmentify installed and your virtual environment activated in the terminal, you can configure the program in several ways.
Augmentify requires two mandatory parameters to run; the target folder path that you want to augment, and some action(s) to perform on the entire target folder.
The target folder can be any folder with your dataset as long as Augmentify has permission to access it.
The action(s) can be any of these functions listed:
- h_flip
- v_flip
- rotate
- scale
- shift
- brightness
- contrast
- saturation
- grayscale
- invert
- add_empty_labels
Optional Parameters
| Parameter | Type | Description | Example |
|---------------------|-----------|----------------------------------------------------|-----------------------|
| --save\_path | string | Directory where output images will be saved. | "path/to/folder" |
| --include\_path | boolean | Include the original directory path in metadata. | True |
| --rot\_deg | float | Rotation (in degrees) to apply. | -10.5 |
| --bright\_mult | float | Brightness multiplier. | 2.0 |
| --contrast\_mult | float | Contrast multiplier. | 1.1 |
Examples of configurations:
1. Vertical flip + horizontal flip + brightness + save path + subdirectory
python augmentify_cli.py "C:\path\to\target" v_flip h_flip brightness --save_path "C:\path\to\saveFolder" --bright_mult 2.0 --include_sub True
2. Horizontal flip only
python augmentify_cli.py "C:\path\to\target" h_flip
3. Add empty labels
python augmentify_cli.py "C:\path\to\target" add_empty_labels