CLI tool for image caption using BLIP & BLIP2
Project description
ZZ-Image-Caption
Image captioner CLI using BLIP and BLIP2 models
Installation
Requirements:
- Python 3.10 or higher
Install using pip:
pip install zz-image-caption
Install pytorch
You may need to install pytorch separately depending on your system to use CUDA (default to use CPU if not available).
Usage
Basic usage:
Print caption for an image to the console
caption image.jpg
Advanced usage:
Rename images in a directory with their captions
caption images/ -o filename
Write metadata for images in a directory with their captions
caption images/ -o metadata
Print caption for an image to the console using the BLIP2 model
caption image.jpg --blip2
Command Line Interface Options
The following table lists all the command-line arguments available with descriptions and additional details:
Argument | Type | Choices | Default | Description |
---|---|---|---|---|
-v , --version |
flag | Display the version of the tool. | ||
input |
string | Path to the input image file or directory. | ||
-o , --output |
string | text, json, metadata, filename | Specify the output type. | |
-a , --append |
string | Append string to caption output. | ||
-t , --token |
integer | 32 | Max token length for captioning. | |
-b , --batch |
integer | 1 | Batch size for captioning. | |
-p , --prompt |
string | Prompt for captioning. | ||
--temp , --temperature |
float | 1.0 | Temperature for captioning. | |
--seed |
integer | Seed for reproducibility. | ||
--large |
flag | Use the large model for captioning. | ||
--cpu |
flag | Use CPU instead of GPU (not recommended). | ||
--blip2 |
flag | Use Blip2 model for captioning. | ||
--verbose |
flag | Print verbose output. | ||
--debug |
flag | Print debug output. |
Help:
caption --help
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file zz-img-caption-0.0.3.tar.gz
.
File metadata
- Download URL: zz-img-caption-0.0.3.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
1b624642758fa555feab16cd9ddda51e1474491c65fe3a25ed26e58d90a74afe
|
|
MD5 |
c2b1c5b49340a39e302fab8505424316
|
|
BLAKE2b-256 |
0bbe35134e3ab65e8ac84f7580ea55ac4d01ddd52cbeab9b6f0083df8b68f6cf
|
File details
Details for the file zz_img_caption-0.0.3-py3-none-any.whl
.
File metadata
- Download URL: zz_img_caption-0.0.3-py3-none-any.whl
- Upload date:
- Size: 7.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.11
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
04ea82f1019f69602491534d00397af2248bb6fd53beb5fa818903bc40ddeff5
|
|
MD5 |
33dd58bc42d0db5a137a856eac98c8a3
|
|
BLAKE2b-256 |
d91c90e16fde97d08210bbca53c6422bb9704bfe7884fbca76de52fba9adccea
|