Skip to main content

BioCLIP model for use with Autodistill

Project description

Autodistill BioCLIP Module

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

BioCLIP is a CLIP model trained on the TreeOfLife-10M dataset, created by the researchers who made BioCLIP. The dataset on which BioCLIP was trained included more than 450,000 classes.

You can use BioCLIP to auto-label natural organisms (i.e. animals, plants) in images for use in training a classification model. You can combine this model with a grounded detection model to identify the exact region in which a given class is present in an image. Learn more about combining models with Autodistill.

Read the full Autodistill documentation.

Read the BioCLIP Autodistill documentation.

Installation

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

pip3 install autodistill-bioclip

Quickstart

from autodistill_bioclip import BioCLIP

# define an ontology to map class names to our BioCLIP 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
classes = ["arabica", "robusta"]

base_model = BioCLIP(
    ontology=CaptionOntology(
        {
            item: item for item in classes
        }
    )
)

results = base_model.predict("../arabica.jpeg")

top = results.get_top_k(1)
top_class = classes[top[0][0]]

print(f"Predicted class: {top_class}")

License

This project is licensed under an MIT license.

The underlying BioCLIP model is also licensed under an MIT license.

🏆 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-bioclip-0.1.0.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autodistill_bioclip-0.1.0-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file autodistill-bioclip-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for autodistill-bioclip-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c87f28bd6a758be599dbb0108ed92ac84a3ee81cb95f23f69e9408d10a1135ac
MD5 be02e1554caf038ffe74ee3341de412f
BLAKE2b-256 dda28cbb914dd506cec9ec4661dcd221950bdd51fdad5f890324c43273b9d614

See more details on using hashes here.

File details

Details for the file autodistill_bioclip-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for autodistill_bioclip-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 96ffacde93916bd22f4fd09af97ba30c438b92281dca56be26f0e9739c0f8298
MD5 a8e524f9c76cb2284354fbd932d8539a
BLAKE2b-256 cb9fd4c2306e93e5c8f4beda2c323f6530794caf48bdd5b5a14a7c333b3a3ac9

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