clip-cam 0.1.5

A package for visualizing the prompt-image feature matching in ViT-based CLIP models, highlighting the alignment between image features and textual prompts.

clip_cam

clip_cam is a Python package for visualizing the image-prompt feature matching in ViT-based CLIP models, highlighting the alignment between image features and textual prompts. It allows you to visualize how CLIP interprets the relationship between an image and a text description, providing insights into its attention patterns.

🚀 Features

• Generate Grad-CAM-style heatmaps for image-text matching.
• Support for Vision Transformer (ViT) architectures.
• Easy integration with existing CLIP implementations.
• Custom checkpoint support for fine-tuned models.

📦 Installation

You can install clip_cam via pip:

pip install clip_cam

🔥 Usage

Run the following command to generate a visualization:

python clip_cam.py --model_name "ViT-B/16" --image_path "path/to/image.jpg" --text "your text prompt"

Arguments:

• --image_path: Path to the input image.
• --text: Text input/prompt.
• --model_name: CLIP model name (default: ViT-B/16).
• --checkpoint: (Optional) Path to a fine-tuned CLIP model checkpoint.

Example:

python clip_cam.py --model_name "ViT-B/16" --image_path "cat.jpg" --text "a cute kitten" 

🛠️ How It Works

1. Model Loading: Uses the specified CLIP model with optional fine-tuned checkpoint.
2. Feature Extraction:
   • Extracts dense visual features from the image.
   • Encodes the text prompt and normalizes the embeddings.
3. Matching & Visualization:
   • Computes image-text matching scores.
   • Resizes the matching map using bilinear interpolation.
   • Visualizes the results generating a heatmap of image-text matching.

🔥 Example Visualization

Example visualization showing attention heatmap over the image for the provided text prompt.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.