This downloads the tool, installs what it needs in its own isolated
environment, and adds a captions command you can run from anywhere. When it
finishes, open a new terminal (or run source ~/.bashrc).
Then just type:
captions
Manual install
If you'd rather set it up by hand:
Download this folder and open a terminal in it.
Install the requirements:
pip install -r requirements.txt
Run it:
python caption.py
Use it
Just run it:
python caption.py
It will ask you for a folder of images, show the settings, and caption them.
Sit back, a progress bar shows how far it's gotten.
Want to skip the questions?
If you already know what you want, you can do it in one line:
python caption.py --path "/path/to/your/images"
Useful extras:
Option
What it does
--path "FOLDER"
Caption this folder right away (no prompt).
--force
Re-caption images that already have a .txt file.
--model florence2-base
Pick a different model (see below).
--max-new-tokens 512
Allow longer captions.
Choosing a model
When you run it, you can pick which AI model writes the captions. Bigger = more
detailed, but uses more VRAM.
Model
Size
Best for
florence2-large (default)
~1.5 GB
Slightly less accurate. Needs a normal GPU.
florence2-base
~0.45 GB
2 GB GPUs, or when you want it fast.
If your card only has 2 GB of VRAM, choose florence2-base.
Prefix and suffix (optional)
If you're captioning images to train your own image model, you may want a
trigger word on every caption (for example, your subject's name). Set a
prefix and the tool adds it to the front of every caption automatically.
A suffix does the same at the end.
Leave them empty if you just want plain descriptions.
Settings
Settings are stored in caption_config.json next to the script. You can edit
that file directly, or change things from the tool's menu. The defaults:
Skip images that already have a caption (so re-running is safe).
At least ~15 words per caption (it re-captions anything shorter).
256 token cap on caption length.
Questions
Does it need to be online? Only the very first time, to download the
model. After that, everything runs offline.
Where do my images go? Nowhere. They're processed locally and the caption
is saved next to each image.
