• Stars
    star
    21,231
  • Rank 1,094 (Top 0.03 %)
  • Language
    Jupyter Notebook
  • License
    MIT License
  • Created over 3 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

CLIP (Contrastive Language-Image Pretraining), Predict the most relevant text snippet given an image

CLIP

[Blog] [Paper] [Model Card] [Colab]

CLIP (Contrastive Language-Image Pre-Training) is a neural network trained on a variety of (image, text) pairs. It can be instructed in natural language to predict the most relevant text snippet, given an image, without directly optimizing for the task, similarly to the zero-shot capabilities of GPT-2 and 3. We found CLIP matches the performance of the original ResNet50 on ImageNet “zero-shot” without using any of the original 1.28M labeled examples, overcoming several major challenges in computer vision.

Approach

CLIP

Usage

First, install PyTorch 1.7.1 (or later) and torchvision, as well as small additional dependencies, and then install this repo as a Python package. On a CUDA GPU machine, the following will do the trick:

$ conda install --yes -c pytorch pytorch=1.7.1 torchvision cudatoolkit=11.0
$ pip install ftfy regex tqdm
$ pip install git+https://github.com/openai/CLIP.git

Replace cudatoolkit=11.0 above with the appropriate CUDA version on your machine or cpuonly when installing on a machine without a GPU.

import torch
import clip
from PIL import Image

device = "cuda" if torch.cuda.is_available() else "cpu"
model, preprocess = clip.load("ViT-B/32", device=device)

image = preprocess(Image.open("CLIP.png")).unsqueeze(0).to(device)
text = clip.tokenize(["a diagram", "a dog", "a cat"]).to(device)

with torch.no_grad():
    image_features = model.encode_image(image)
    text_features = model.encode_text(text)
    
    logits_per_image, logits_per_text = model(image, text)
    probs = logits_per_image.softmax(dim=-1).cpu().numpy()

print("Label probs:", probs)  # prints: [[0.9927937  0.00421068 0.00299572]]

API

The CLIP module clip provides the following methods:

clip.available_models()

Returns the names of the available CLIP models.

clip.load(name, device=..., jit=False)

Returns the model and the TorchVision transform needed by the model, specified by the model name returned by clip.available_models(). It will download the model as necessary. The name argument can also be a path to a local checkpoint.

The device to run the model can be optionally specified, and the default is to use the first CUDA device if there is any, otherwise the CPU. When jit is False, a non-JIT version of the model will be loaded.

clip.tokenize(text: Union[str, List[str]], context_length=77)

Returns a LongTensor containing tokenized sequences of given text input(s). This can be used as the input to the model


The model returned by clip.load() supports the following methods:

model.encode_image(image: Tensor)

Given a batch of images, returns the image features encoded by the vision portion of the CLIP model.

model.encode_text(text: Tensor)

Given a batch of text tokens, returns the text features encoded by the language portion of the CLIP model.

model(image: Tensor, text: Tensor)

Given a batch of images and a batch of text tokens, returns two Tensors, containing the logit scores corresponding to each image and text input. The values are cosine similarities between the corresponding image and text features, times 100.

More Examples

Zero-Shot Prediction

The code below performs zero-shot prediction using CLIP, as shown in Appendix B in the paper. This example takes an image from the CIFAR-100 dataset, and predicts the most likely labels among the 100 textual labels from the dataset.

import os
import clip
import torch
from torchvision.datasets import CIFAR100

# Load the model
device = "cuda" if torch.cuda.is_available() else "cpu"
model, preprocess = clip.load('ViT-B/32', device)

# Download the dataset
cifar100 = CIFAR100(root=os.path.expanduser("~/.cache"), download=True, train=False)

# Prepare the inputs
image, class_id = cifar100[3637]
image_input = preprocess(image).unsqueeze(0).to(device)
text_inputs = torch.cat([clip.tokenize(f"a photo of a {c}") for c in cifar100.classes]).to(device)

# Calculate features
with torch.no_grad():
    image_features = model.encode_image(image_input)
    text_features = model.encode_text(text_inputs)

# Pick the top 5 most similar labels for the image
image_features /= image_features.norm(dim=-1, keepdim=True)
text_features /= text_features.norm(dim=-1, keepdim=True)
similarity = (100.0 * image_features @ text_features.T).softmax(dim=-1)
values, indices = similarity[0].topk(5)

# Print the result
print("\nTop predictions:\n")
for value, index in zip(values, indices):
    print(f"{cifar100.classes[index]:>16s}: {100 * value.item():.2f}%")

The output will look like the following (the exact numbers may be slightly different depending on the compute device):

Top predictions:

           snake: 65.31%
          turtle: 12.29%
    sweet_pepper: 3.83%
          lizard: 1.88%
       crocodile: 1.75%

Note that this example uses the encode_image() and encode_text() methods that return the encoded features of given inputs.

Linear-probe evaluation

The example below uses scikit-learn to perform logistic regression on image features.

import os
import clip
import torch

import numpy as np
from sklearn.linear_model import LogisticRegression
from torch.utils.data import DataLoader
from torchvision.datasets import CIFAR100
from tqdm import tqdm

# Load the model
device = "cuda" if torch.cuda.is_available() else "cpu"
model, preprocess = clip.load('ViT-B/32', device)

# Load the dataset
root = os.path.expanduser("~/.cache")
train = CIFAR100(root, download=True, train=True, transform=preprocess)
test = CIFAR100(root, download=True, train=False, transform=preprocess)


def get_features(dataset):
    all_features = []
    all_labels = []
    
    with torch.no_grad():
        for images, labels in tqdm(DataLoader(dataset, batch_size=100)):
            features = model.encode_image(images.to(device))

            all_features.append(features)
            all_labels.append(labels)

    return torch.cat(all_features).cpu().numpy(), torch.cat(all_labels).cpu().numpy()

# Calculate the image features
train_features, train_labels = get_features(train)
test_features, test_labels = get_features(test)

# Perform logistic regression
classifier = LogisticRegression(random_state=0, C=0.316, max_iter=1000, verbose=1)
classifier.fit(train_features, train_labels)

# Evaluate using the logistic regression classifier
predictions = classifier.predict(test_features)
accuracy = np.mean((test_labels == predictions).astype(float)) * 100.
print(f"Accuracy = {accuracy:.3f}")

Note that the C value should be determined via a hyperparameter sweep using a validation split.

See Also

More Repositories

1

whisper

Robust Speech Recognition via Large-Scale Weak Supervision
Python
57,624
star
2

openai-cookbook

Examples and guides for using the OpenAI API
MDX
55,428
star
3

gym

A toolkit for developing and comparing reinforcement learning algorithms.
Python
33,715
star
4

gpt-2

Code for the paper "Language Models are Unsupervised Multitask Learners"
Python
20,844
star
5

chatgpt-retrieval-plugin

The ChatGPT Retrieval Plugin lets you easily find personal or work documents by asking questions in natural language.
Python
20,818
star
6

openai-python

The official Python library for the OpenAI API
Python
19,939
star
7

gpt-3

GPT-3: Language Models are Few-Shot Learners
15,573
star
8

baselines

OpenAI Baselines: high-quality implementations of reinforcement learning algorithms
Python
15,252
star
9

evals

Evals is a framework for evaluating LLMs and LLM systems, and an open-source registry of benchmarks.
Python
13,483
star
10

triton

Development repository for the Triton language and compiler
C++
11,038
star
11

DALL-E

PyTorch package for the discrete VAE used for DALL·E.
Python
10,672
star
12

shap-e

Generate 3D objects conditioned on text or images
Python
10,285
star
13

spinningup

An educational resource to help anyone learn deep reinforcement learning.
Python
8,587
star
14

tiktoken

tiktoken is a fast BPE tokeniser for use with OpenAI's models.
Python
8,533
star
15

universe

Universe: a software platform for measuring and training an AI's general intelligence across the world's supply of games, websites and other applications.
Python
7,385
star
16

jukebox

Code for the paper "Jukebox: A Generative Model for Music"
Python
7,326
star
17

openai-node

The official Node.js / Typescript library for the OpenAI API
TypeScript
6,824
star
18

point-e

Point cloud diffusion for 3D model synthesis
Python
5,777
star
19

consistency_models

Official repo for consistency models.
Python
5,725
star
20

guided-diffusion

Python
5,000
star
21

plugins-quickstart

Get a ChatGPT plugin up and running in under 5 minutes!
Python
4,133
star
22

transformer-debugger

Python
3,607
star
23

retro

Retro Games in Gym
C
3,289
star
24

glide-text2im

GLIDE: a diffusion-based text-conditional image synthesis model
Python
3,277
star
25

glow

Code for reproducing results in "Glow: Generative Flow with Invertible 1x1 Convolutions"
Python
3,016
star
26

mujoco-py

MuJoCo is a physics engine for detailed, efficient rigid body simulations with contacts. mujoco-py allows using MuJoCo from Python 3.
Cython
2,586
star
27

openai-quickstart-node

Node.js example app from the OpenAI API quickstart tutorial
JavaScript
2,501
star
28

weak-to-strong

Python
2,341
star
29

improved-gan

Code for the paper "Improved Techniques for Training GANs"
Python
2,218
star
30

improved-diffusion

Release for Improved Denoising Diffusion Probabilistic Models
Python
2,102
star
31

roboschool

DEPRECATED: Open-source software for robot simulation, integrated with OpenAI Gym.
Python
2,064
star
32

image-gpt

Python
1,990
star
33

consistencydecoder

Consistency Distilled Diff VAE
Python
1,933
star
34

finetune-transformer-lm

Code and model for the paper "Improving Language Understanding by Generative Pre-Training"
Python
1,929
star
35

multiagent-particle-envs

Code for a multi-agent particle environment used in the paper "Multi-Agent Actor-Critic for Mixed Cooperative-Competitive Environments"
Python
1,871
star
36

gpt-2-output-dataset

Dataset of GPT-2 outputs for research in detection, biases, and more
Python
1,865
star
37

pixel-cnn

Code for the paper "PixelCNN++: A PixelCNN Implementation with Discretized Logistic Mixture Likelihood and Other Modifications"
Python
1,856
star
38

human-eval

Code for the paper "Evaluating Large Language Models Trained on Code"
Python
1,755
star
39

requests-for-research

A living collection of deep learning problems
HTML
1,625
star
40

openai-quickstart-python

Python example app from the OpenAI API quickstart tutorial
1,608
star
41

gpt-discord-bot

Example Discord bot written in Python that uses the completions API to have conversations with the `text-davinci-003` model, and the moderations API to filter the messages.
Python
1,569
star
42

multi-agent-emergence-environments

Environment generation code for the paper "Emergent Tool Use From Multi-Agent Autocurricula"
Python
1,557
star
43

evolution-strategies-starter

Code for the paper "Evolution Strategies as a Scalable Alternative to Reinforcement Learning"
Python
1,504
star
44

generating-reviews-discovering-sentiment

Code for "Learning to Generate Reviews and Discovering Sentiment"
Python
1,491
star
45

neural-mmo

Code for the paper "Neural MMO: A Massively Multiagent Game Environment for Training and Evaluating Intelligent Agents"
Python
1,463
star
46

sparse_attention

Examples of using sparse attention, as in "Generating Long Sequences with Sparse Transformers"
Python
1,347
star
47

maddpg

Code for the MADDPG algorithm from the paper "Multi-Agent Actor-Critic for Mixed Cooperative-Competitive Environments"
Python
1,284
star
48

prm800k

800,000 step-level correctness labels on LLM solutions to MATH problems
Python
1,239
star
49

Video-Pre-Training

Video PreTraining (VPT): Learning to Act by Watching Unlabeled Online Videos
Python
1,205
star
50

following-instructions-human-feedback

1,129
star
51

universe-starter-agent

A starter agent that can solve a number of universe environments.
Python
1,086
star
52

lm-human-preferences

Code for the paper Fine-Tuning Language Models from Human Preferences
Python
1,067
star
53

dalle-2-preview

1,049
star
54

InfoGAN

Code for reproducing key results in the paper "InfoGAN: Interpretable Representation Learning by Information Maximizing Generative Adversarial Nets"
Python
1,029
star
55

procgen

Procgen Benchmark: Procedurally-Generated Game-Like Gym-Environments
C++
972
star
56

supervised-reptile

Code for the paper "On First-Order Meta-Learning Algorithms"
JavaScript
955
star
57

blocksparse

Efficient GPU kernels for block-sparse matrix multiplication and convolution
Cuda
941
star
58

openai-openapi

OpenAPI specification for the OpenAI API
917
star
59

automated-interpretability

Python
875
star
60

grade-school-math

Python
859
star
61

kubernetes-ec2-autoscaler

A batch-optimized scaling manager for Kubernetes
Python
849
star
62

random-network-distillation

Code for the paper "Exploration by Random Network Distillation"
Python
847
star
63

summarize-from-feedback

Code for "Learning to summarize from human feedback"
Python
833
star
64

large-scale-curiosity

Code for the paper "Large-Scale Study of Curiosity-Driven Learning"
Python
798
star
65

multiagent-competition

Code for the paper "Emergent Complexity via Multi-agent Competition"
Python
761
star
66

imitation

Code for the paper "Generative Adversarial Imitation Learning"
Python
643
star
67

deeptype

Code for the paper "DeepType: Multilingual Entity Linking by Neural Type System Evolution"
Python
633
star
68

mlsh

Code for the paper "Meta-Learning Shared Hierarchies"
Python
588
star
69

iaf

Code for reproducing key results in the paper "Improving Variational Inference with Inverse Autoregressive Flow"
Python
499
star
70

mujoco-worldgen

Automatic object XML generation for Mujoco
Python
475
star
71

safety-gym

Tools for accelerating safe exploration research.
Python
421
star
72

vdvae

Repository for the paper "Very Deep VAEs Generalize Autoregressive Models and Can Outperform Them on Images"
Python
407
star
73

coinrun

Code for the paper "Quantifying Transfer in Reinforcement Learning"
C++
381
star
74

robogym

Robotics Gym Environments
Python
370
star
75

weightnorm

Example code for Weight Normalization, from "Weight Normalization: A Simple Reparameterization to Accelerate Training of Deep Neural Networks"
Python
357
star
76

atari-py

A packaged and slightly-modified version of https://github.com/bbitmaster/ale_python_interface
C++
354
star
77

openai-gemm

Open single and half precision gemm implementations
C
335
star
78

vime

Code for the paper "Curiosity-driven Exploration in Deep Reinforcement Learning via Bayesian Neural Networks"
Python
331
star
79

safety-starter-agents

Basic constrained RL agents used in experiments for the "Benchmarking Safe Exploration in Deep Reinforcement Learning" paper.
Python
312
star
80

ebm_code_release

Code for Implicit Generation and Generalization with Energy Based Models
Python
311
star
81

CLIP-featurevis

code for reproducing some of the diagrams in the paper "Multimodal Neurons in Artificial Neural Networks"
Python
294
star
82

gym-http-api

API to access OpenAI Gym from other languages via HTTP
Python
291
star
83

gym-soccer

Python
289
star
84

robosumo

Code for the paper "Continuous Adaptation via Meta-Learning in Nonstationary and Competitive Environments"
Python
283
star
85

EPG

Code for the paper "Evolved Policy Gradients"
Python
240
star
86

phasic-policy-gradient

Code for the paper "Phasic Policy Gradient"
Python
240
star
87

orrb

Code for the paper "OpenAI Remote Rendering Backend"
C#
235
star
88

miniF2F

Formal to Formal Mathematics Benchmark
Objective-C++
202
star
89

web-crawl-q-and-a-example

Learn how to crawl your website and build a Q/A bot with the OpenAI API
Jupyter Notebook
199
star
90

atari-reset

Code for the blog post "Learning Montezuma’s Revenge from a Single Demonstration"
Python
183
star
91

spinningup-workshop

For educational materials related to the spinning up workshops.
TeX
181
star
92

train-procgen

Code for the paper "Leveraging Procedural Generation to Benchmark Reinforcement Learning"
Python
167
star
93

human-eval-infilling

Code for the paper "Efficient Training of Language Models to Fill in the Middle"
Python
142
star
94

dallify-discord-bot

Example code for using OpenAI’s NodeJS SDK with discord.js SDK to create a Discord Bot that uses Slash Commands.
TypeScript
139
star
95

gym3

Vectorized interface for reinforcement learning environments
Python
136
star
96

lean-gym

Lean
134
star
97

retro-baselines

Publicly releasable baselines for the Retro contest
Python
128
star
98

neural-gpu

Code for the Neural GPU model originally described in "Neural GPUs Learn Algorithms"
Python
120
star
99

baselines-results

Jupyter Notebook
117
star
100

go-vncdriver

Fast VNC driver
Go
116
star