|
1 | 1 | # Image Tagging GUI
|
| 2 | + |
| 3 | +Cross-platform desktop application for quickly tagging images, aimed towards |
| 4 | +creators of image datasets for generative AI. |
| 5 | +Written in Python using PySide6. |
| 6 | + |
| 7 | +## Features |
| 8 | + |
| 9 | +- Keyboard-friendly interface for fast tagging |
| 10 | +- Tag autocomplete based on your most used tags |
| 11 | +- Integrated token counter |
| 12 | +- Searchable list of all used tags |
| 13 | +- Filter images by tag |
| 14 | +- Rename or delete all instances of a tag |
| 15 | +- Automatic dark mode based on system settings |
| 16 | + |
| 17 | +## Installation |
| 18 | + |
| 19 | +The easiest way to use the application is to download the latest release from |
| 20 | +the [releases page](https://www.github.com/jhc13/image-tagging-gui/releases). |
| 21 | +The executable file can be run directly without any additional dependencies. |
| 22 | + |
| 23 | +Alternatively, you can install manually by cloning this repository and |
| 24 | +installing the dependencies in `requirements.txt`. |
| 25 | +Run `image-tagging-gui/run_gui.py` to start the program. |
| 26 | +Python 3.11 is recommended, but Python 3.10 should also work. |
| 27 | + |
| 28 | +## Usage |
| 29 | + |
| 30 | +Load the directory containing your images by clicking the `Load Directory` |
| 31 | +button in the center of the window (or `File` -> `Load Directory`). |
| 32 | +Tags are loaded from `.txt` files in the directory with the same names as the |
| 33 | +images. |
| 34 | +Any changes you make to the tags are also automatically saved to these `.txt` |
| 35 | +files. |
| 36 | + |
| 37 | +You can change the settings in `File` -> `Settings`. |
| 38 | +Panes can be resized, undocked, and moved around. |
| 39 | + |
| 40 | +## Controls |
| 41 | + |
| 42 | +### Images pane |
| 43 | + |
| 44 | +- Previous / next image: `Up` / `Down` arrow keys |
| 45 | +- First / last image: `Home` / `End` |
| 46 | + |
| 47 | +### Image Tags pane |
| 48 | + |
| 49 | +- Add a tag: Type the tag into the `Add Tag` box and press `Enter` |
| 50 | +- Add the first tag suggested by autocomplete: Press `Ctrl`+`Enter` |
| 51 | +- Delete a tag: Select the tag and press `Delete` |
| 52 | +- Rename a tag: Double-click the tag, or select the tag and press `F2` |
| 53 | +- Reorder tags: Drag and drop the tags |
| 54 | +- Select multiple tags: Hold `Ctrl` or `Shift` while selecting the tags |
| 55 | + |
| 56 | +### All Tags pane |
| 57 | + |
| 58 | +- Show all images containing a tag: Select the tag |
| 59 | +- Go back to showing all images: Click the `Clear Image Filter` button |
| 60 | +- Delete all instances of a tag: Select the tag and press `Delete` |
| 61 | +- Rename all instances of a tag: Double-click the tag, or select the tag and |
| 62 | + press `F2` |
0 commit comments