Skip to main content

AltCLIP model for use with Autodistill.

Project description

Autodistill AltCLIP Module

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

AltCLIP is a multi-modal vision model. With AltCLIP, you can compare the similarity between text and images, or the similarlity between two images. AltCLIP was trained on multi-lingual text-image pairs, which means it can be used for zero-shot classification with text prompts in different languages. Read the AltCLIP paper for more information.

The Autodistill AltCLIP module enables you to use AltCLIP for zero-shot classification.

Read the full Autodistill documentation.

Read the CLIP Autodistill documentation.

Installation

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

pip3 install autodistill-altclip

Quickstart

from autodistill_altclip import AltCLIP
from autodistill.detection import CaptionOntology

# define an ontology to map class names to our AltCLIP 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 results
# then, load the model
base_model = AltCLIP(
    ontology=CaptionOntology(
        {
            "person": "person",
            "a forklift": "forklift"
        }
    )
)

results = base_model.predict("construction.jpg")

print(results)

License

The AltCLIP model is licensed under an Apache 2.0 license. See the model README for more information.

🏆 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-altclip-0.1.2.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

autodistill_altclip-0.1.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file autodistill-altclip-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for autodistill-altclip-0.1.2.tar.gz
Algorithm Hash digest
SHA256 54fbe9cddcc6a1d389914fc5842b9c4f2e66460039ce88fa71a98be87a8fa10c
MD5 5c37f7a057c7bd1be5f1fce88ed2c2fc
BLAKE2b-256 00663f2cdd5eea67e84aded299465ad7f912726fd76d12b920f33f179c927746

See more details on using hashes here.

File details

Details for the file autodistill_altclip-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for autodistill_altclip-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cdbacea010768b5ba6367c5d8b8f39f7d025ed60f1ec431e1d87c125a31f0fdd
MD5 bc30eacf397c9a68918f34f8a2037819
BLAKE2b-256 7fe04d3f29826919f06d7cb1d7ce172ef50718d7cab677b90bca0685eb025a4f

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