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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file autodistill-metaclip-0.1.3.tar.gz.

File metadata

  • Download URL: autodistill-metaclip-0.1.3.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for autodistill-metaclip-0.1.3.tar.gz
Algorithm Hash digest
SHA256 3826aa55404601047a5dda0f51aac787e4e77b9d2aff4156a237ced65b100d38
MD5 7f41b37853e18d6c29ece27dcdbcd26b
BLAKE2b-256 5612c9c4f7323713c101b028a411af5c300ef0912840acfe33af9529cf82867e

See more details on using hashes here.

File details

Details for the file autodistill_metaclip-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for autodistill_metaclip-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7ce6fa139e3a8a236b59a1dfd6713faf4584c9dfd334c8544fbf6cf59f5ca2e7
MD5 954c00365b0d201df4953980d944848e
BLAKE2b-256 1a826547a18c55e628e85b83c219230cede1b6a1150c22f529acf9042d4e4948

See more details on using hashes here.

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