Skip to main content

Text-image comparison using OpenAI CLIP

Project description

Abril - Text-Image Comparison using CLIP

Abril is a Python library that makes it easy to compare text and images using OpenAI's CLIP model. It provides a simple interface for calculating similarity scores between text descriptions and images.

Installation

pip install abril

Usage

from abril import ClipComparer
from PIL import Image

# Initialize the comparer
comparer = ClipComparer()

# Compare a single text with an image
score = comparer.compare_text_with_image(
    "a photo of a dog",
    "path/to/image.jpg"
)
print(f"Similarity score: {score}")

# Find the best matching text for an image
texts = [
    "a photo of a dog",
    "a photo of a cat",
    "a photo of a car"
]
best_text, score = comparer.find_best_match(texts, "path/to/image.jpg")
print(f"Best match: {best_text} (score: {score})")

Features

  • Easy-to-use interface for text-image comparison
  • Support for both single and multiple text comparisons
  • Uses CLIP's ViT-B/32 model by default (can be changed)
  • Automatically uses GPU if available for faster processing
  • Handles both file paths and PIL Images flexibly
  • Normalizes features for better comparison
  • Returns scores between 0 and 1 for easy interpretation
  • Built on OpenAI's CLIP model
  • GPU acceleration when available

Requirements

  • Python ≥ 3.7
  • PyTorch ≥ 1.7.1
  • Other dependencies are handled automatically during installation

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abril-0.1.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

abril-0.1.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file abril-0.1.1.tar.gz.

File metadata

  • Download URL: abril-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.13

File hashes

Hashes for abril-0.1.1.tar.gz
Algorithm Hash digest
SHA256 6e29b52b52a8e8b1f91cbd8f5d4ceef6734672d26170a4f96b27b13d516c9ae8
MD5 4845dddd94b48fbd5eb516e0eff49dd7
BLAKE2b-256 282814df2036e6d9d77057421dab5e867aec046dad5723968cd32833946a1079

See more details on using hashes here.

File details

Details for the file abril-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: abril-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.13

File hashes

Hashes for abril-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9bda077840ca1105708a2d3721daf6c7b125ae4fca02f502a633c3967c4fa3ec
MD5 477aa1f985cb3e15976e1103a042c99a
BLAKE2b-256 e27ed126e29a6ad3f76f2663db135663920f1107059c83522e6b1b871debaafc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page