Skip to main content

Image classifier with zero-shot learning.

Project description

Zeroshot (Python)

Image classification for the masses

Installation

Install via pip: pip install zeroshot

For GPU support, pip install zeroshot[torch]

N.B. In theory ONNX supports GPU, but the restrictions on CUDA version are iffy at best, and so for easiest results just use PyTorch. If you're brave, instead pip install onnxruntime-gpu.

Usage

First, go to app.usezeroshot.com and create a classifier. Check out the video on the landing page for an example.

Then, in Python (image should be an RGB numpy array with channels last):

import zeroshot

# Create the classifier and preprocessing function.
classifier = zeroshot.Classifier("model-uuid-goes-here")
preprocess_fn = zeroshot.create_preprocess_fn()

# Run the model!
prediction = classifier.predict(preprocess_fn(image))
print(f"The image is class {prediction}")

You can also download the classifier and save it somewhere locally so you don't need to hit the server each time. Hit "download model" in the web-app and save the json file somewhere. You can then instead do:

classifier = zeroshot.Classifier("/home/user/path/to/model.json")

Additional Tips

  • To use a GPU, install the torch backend with pip install zeroshot[torch]
  • If you are hitting issues with torch trying to run on CPU, try disabling XFormers by setting XFORMERS_DISABLED=1 in your ENV varaibles.

Read the docs

See the docs folder for some details on how things work under the hood.

Get help

If you need help or just want to chat, join the Moonshine Labs Slack server and come hang out in the #zeroshot channel.

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

zeroshot-0.1.11.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

zeroshot-0.1.11-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file zeroshot-0.1.11.tar.gz.

File metadata

  • Download URL: zeroshot-0.1.11.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.9.10 Linux/6.2.0-37-generic

File hashes

Hashes for zeroshot-0.1.11.tar.gz
Algorithm Hash digest
SHA256 7e012ac58ccb1979560f294846d86c475d05f9bfe660e948e15294296b37522b
MD5 5283ea518438216de7f9c8529f62d323
BLAKE2b-256 d3534ca17cfe405bce9e9d33b657c7d886d3c05cd942265e145af61026bb10f6

See more details on using hashes here.

File details

Details for the file zeroshot-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: zeroshot-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.9.10 Linux/6.2.0-37-generic

File hashes

Hashes for zeroshot-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 208452598d4426b64f78f1c9c3d4caf0b314bc10a55657c38384c3f77d946b9f
MD5 3a1a8b8263405406f188d65f916e9e90
BLAKE2b-256 01b8118650fa88ce84de4897229bce0026600657d497807fe4b066ea4727c1ef

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