Skip to main content

A library for comparing text and images using 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

# First, install CLIP:
pip install git+https://github.com/openai/CLIP.git

# Then install abril:
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, "./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.9.tar.gz (4.4 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.9-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: abril-0.1.9.tar.gz
  • Upload date:
  • Size: 4.4 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.9.tar.gz
Algorithm Hash digest
SHA256 db968148c5c81fd899a8dc701375ec58c0dfb60246b365b2f84f6b7641c0a522
MD5 14bc45ba33118a59911e6b4de2e48c47
BLAKE2b-256 74ceaddaec25a2381442b422aba02f954bb149d979f9a431c4ea0570f5671660

See more details on using hashes here.

File details

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

File metadata

  • Download URL: abril-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 5.0 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 7f16eb1d8495c225248993ba04e74b80178e4f77d1ebdf4158b16bd84014856a
MD5 37ab5579233502b3725494ca8061f7e0
BLAKE2b-256 37e0fb5dffa5b2fe9f0a9dd34f080e68490a7dad7fe6d288ba7f96584e3c067e

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