Skip to main content

MetaCLIP base model for use with Autodistill.

Project description

Autodistill MetaCLIP Module

This repository contains the code supporting the MetaCLIP base model for use with Autodistill.

MetaCLIP, developed by Meta AI Research, is a computer vision model trained using pairs of images and text. The model was described in the Demystifying CLIP Data paper. You can use MetaCLIP with autodistill for image classification.

Read the full Autodistill documentation.

Read the MetaCLIP Autodistill documentation.

Installation

To use MetaCLIP with autodistill, you need to install the following dependency:

pip3 install autodistill-metaclip

Quickstart

get predictions

from autodistill_metaclip import MetaCLIP

# define an ontology to map class names to our MetaCLIP prompt
# the ontology dictionary has the format {caption: class}
# where caption is the prompt sent to the base model, and class is the label that will
# be saved for that caption in the generated annotations
# then, load the model
base_model = MetaCLIP(
    ontology=CaptionOntology(
        {
            "person": "person",
            "a forklift": "forklift"
        }
    )
)

results = base_model.predict("./image.png")
print(results)

calculate and compare embeddings

from autodistill_metaclip import MetaCLIP

base_model = MetaCLIP(None)

text = base_model.embed_text("coffee")
image = base_model.embed_image("coffeeshop.jpg")

print(base_model.compare(text, image))

License

This project was licensed under a Creative Commons Attribution-NonCommercial 4.0 International.

🏆 Contributing

We love your input! Please see the core Autodistill contributing guide to get started. Thank you 🙏 to all our contributors!

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

autodistill-metaclip-0.1.3.tar.gz (9.7 kB view hashes)

Uploaded Source

Built Distribution

autodistill_metaclip-0.1.3-py3-none-any.whl (10.1 kB view hashes)

Uploaded Python 3

Supported by

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