• Stars
    star
    686
  • Rank 65,892 (Top 2 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 1 year ago
  • Updated 3 months ago

Reviews

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

Repository Details

Official code for VisProg (CVPR 2023 Best Paper!)

Visual Programming: Compositional visual reasoning without training (CVPR 2023)

By Tanmay Gupta and Aniruddha Kembhavi

[ Project Page | Arxiv Paper | Blog ]

teaser

This repository contains the official code for VisProg - a neuro-symbolic system that solves complex and compositional visual tasks given natural language instructions. VisProg uses the in-context learning ability of GPT3 to generate python programs which are then executed to get both the solution and a comprehensive and interpretable rationale. Each line of the generated program may invoke one of several off-the-shelf computer vision models, image processing routines, or python functions to produce intermediate outputs that may be consumed by subsequent parts of the program.

This code base has been designed to be:

βœ… easy to use (a simple ipynb per task)
βœ… easy to extend with new functionality by adding new modules to VisProg
βœ… easy to extend to new tasks by adding in-context examples for these tasks
βœ… minimal and modular to make it easy to dig into and build upon

Install Dependencies

conda env create -f environment.yaml
conda activate visprog

Running the notebooks

Having setup and activated the conda environment, you should be all set to run the notebooks in the notebooks/ folder. If you use an editor like VSCode, openning the .ipynbs within VSCode might be the easiest way to get started.

You will find a notebook for each of the following tasks, but they are quite similar in structure:

Simply, enter your OpenAI API key in the cell that currently reads <Enter your key here> and run the notebook. The notebooks are designed to be self-contained and should run end-to-end without any additional setup.

The basic structure of the notebooks is as follows:

  • Setup paths
  • Set OPENAI_API_KEY environment variable to use GPT3
  • Import ProgramGenerator and ProgramInterpreter classes
  • Import PROMPT (a text string containing in-context examples) or create_prompt (a function that creates the prompt on the fly)
  • Create the ProgramGenerator and ProgramInterpreter objects
  • Load the image or images to perform inference on
  • Specify the natural language question / statement / instruction
  • Generate program from the specified instruction using ProgramGenerator
  • Interpret and execute program using ProgramInterpreter
  • Visualize the returned result and visual rationale (execution trace)

Example Output

We have tried to make it easy to visualize each step of the execution trace.

For instance, when running the gqa notebook for the instruction How many people or animals are in the image? on assets/camel1.png, you should see the following outputs:

Program

BOX0=LOC(image=IMAGE,object='people')
BOX1=LOC(image=IMAGE,object='animals')
ANSWER0=COUNT(box=BOX0)
ANSWER1=COUNT(box=BOX1)
ANSWER2=EVAL(expr="{ANSWER0} + {ANSWER1}")
FINAL_RESULT=RESULT(var=ANSWER2)

Visual Rationale

assets/rationale.png

What if VisProg doesn't solve your task?

It is possible that the instruction you provide is not solved correctly by VisProg. This can happen for a few reasons:

  1. The instruction is very different from in-context examples that VisProg has seen before. In this case, even though the current set of modules may be adequate for solving the task, VisProg failed because of incorrect program generation. In this case, see if you can write a program using VisProg's modules that solves the task. If you can, then you may add this program to the in-context examples and re-run the notebook to handle similar instructions.
  2. The problem is not solvable with the current set of modules in VisProg. If this is the case, you can add new modules to VisProg to solve this task. See the next section for details.

Adding new functionality and ability to solve new tasks

  • Add new modules for enabling these functionalities to engine/step_interpreters.py. Don't forget to register these modules in register_step_interpreters function in the same file. Here's the step interpreter for the COUNT module. All modules have a similar structure with a parse, html, and execute function. The parse function parses the program string to extract the arguments and output variable. The html function generates the html representation for the execution trace. The execute function executes the module and returns the output and the html (if inspect=True) for the execution trace.

    class CountInterpreter():
        step_name = 'COUNT'
    
        def __init__(self):
            print(f'Registering {self.step_name} step')
    
        def parse(self,prog_step):
            parse_result = parse_step(prog_step.prog_str)
            step_name = parse_result['step_name']
            box_var = parse_result['args']['box']
            output_var = parse_result['output_var']
            assert(step_name==self.step_name)
            return box_var,output_var
    
        def html(self,box_img,output_var,count):
            step_name = html_step_name(self.step_name)
            output_var = html_var_name(output_var)
            box_arg = html_arg_name('bbox')
            box_img = html_embed_image(box_img)
            output = html_output(count)
            return f"""<div>{output_var}={step_name}({box_arg}={box_img})={output}</div>"""
    
        def execute(self,prog_step,inspect=False):
            box_var,output_var = self.parse(prog_step)
            boxes = prog_step.state[box_var]
            count = len(boxes)
            prog_step.state[output_var] = count
            if inspect:
                box_img = prog_step.state[box_var+'_IMAGE']
                html_str = self.html(box_img, output_var, count)
                return count, html_str
    
            return count
  • Add your in-context examples to a new file prompts/your_task_or_dataset_name.py. Note that instead of using in-context examples to generate programs, you may experiment with different ways of prompting such as providing function signatures and docstrings without needing to change the code at all!

  • You can now play with examples from this dataset using a notebook similar to those in the notebooks/ folder or create a python script to run inference on a large number of examples.

Here's what VisProg can do today

assets/teaser1.png

A summary of currently available modules

assets/modules.png

*Note that we have replaced ViLT for VQA with a more performant model called BLIP which was recently made available on Huggingface. This shows how easy it is to swap out or upgrade modules in VisProg.

Changes since the version used in the CVPR paper

  • GPT3 upgraded to text-davinci-003 from text-davinci-002
  • VQA module upgraded from ViLT to the more performant BLIP
  • Changed the implementation of CLASSIFY and SELECT modules that use CLIP to use cosine similarity instead of dot product (which is the default score provided by Huggingface's CLIP model)

Citation

If you find this code useful in your research, please consider citing:

@article{Gupta2022VisProg,
  title={Visual Programming: Compositional visual reasoning without training},
  author={Tanmay Gupta and Aniruddha Kembhavi},
  journal={ArXiv},
  year={2022},
  volume={abs/2211.11559}
}

More Repositories

1

allennlp

An open-source NLP research library, built on PyTorch.
Python
11,751
star
2

OLMo

Modeling, training, eval, and inference code for OLMo
Python
4,535
star
3

RL4LMs

A modular RL library to fine-tune language models to human preferences
Python
2,101
star
4

longformer

Longformer: The Long-Document Transformer
Python
2,022
star
5

bilm-tf

Tensorflow implementation of contextualized word representations from bi-directional language models
Python
1,621
star
6

scispacy

A full spaCy pipeline and models for scientific/biomedical documents.
Python
1,618
star
7

bi-att-flow

Bi-directional Attention Flow (BiDAF) network is a multi-stage hierarchical process that represents context at different levels of granularity and uses a bi-directional attention flow mechanism to achieve a query-aware context representation without early summarization.
Python
1,533
star
8

scibert

A BERT model for scientific text.
Python
1,495
star
9

open-instruct

Python
1,185
star
10

ai2thor

An open-source platform for Visual AI.
C#
1,160
star
11

dolma

Data and tools for generating and inspecting OLMo pre-training data.
Python
961
star
12

XNOR-Net

ImageNet classification using binary Convolutional Neural Networks
Lua
839
star
13

s2orc

S2ORC: The Semantic Scholar Open Research Corpus: https://www.aclweb.org/anthology/2020.acl-main.447/
Python
817
star
14

mmc4

MultimodalC4 is a multimodal extension of c4 that interleaves millions of images with text.
Python
793
star
15

scitldr

Python
734
star
16

objaverse-xl

πŸͺ Objaverse-XL is a Universe of 10M+ 3D Objects. Contains API Scripts for Downloading and Processing!
Python
701
star
17

papermage

library supporting NLP and CV research on scientific papers
Python
692
star
18

natural-instructions

Expanding natural instructions
Python
690
star
19

science-parse

Science Parse parses scientific papers (in PDF form) and returns them in structured form.
Java
611
star
20

pdffigures2

Given a scholarly PDF, extract figures, tables, captions, and section titles.
Scala
593
star
21

writing-code-for-nlp-research-emnlp2018

A companion repository for the "Writing code for NLP Research" Tutorial at EMNLP 2018
Python
558
star
22

tango

Organize your experiments into discrete steps that can be cached and reused throughout the lifetime of your research project.
Python
528
star
23

allennlp-models

Officially supported AllenNLP models
Python
521
star
24

specter

SPECTER: Document-level Representation Learning using Citation-informed Transformers
Python
506
star
25

dont-stop-pretraining

Code associated with the Don't Stop Pretraining ACL 2020 paper
Python
488
star
26

unified-io-2

Python
471
star
27

macaw

Multi-angle c(q)uestion answering
Python
451
star
28

lumos

Code and data for "Lumos: Learning Agents with Unified Data, Modular Design, and Open-Source LLMs"
Python
433
star
29

document-qa

Python
420
star
30

scholarphi

An interactive PDF reader.
Python
418
star
31

deep_qa

A deep NLP library, based on Keras / tf, focused on question answering (but useful for other NLP too)
Python
404
star
32

acl2018-semantic-parsing-tutorial

Materials from the ACL 2018 tutorial on neural semantic parsing
402
star
33

unifiedqa

UnifiedQA: Crossing Format Boundaries With a Single QA System
Python
384
star
34

pawls

Software that makes labeling PDFs easy.
Python
380
star
35

OLMoE

OLMoE: Open Mixture-of-Experts Language Models
Jupyter Notebook
374
star
36

kb

KnowBert -- Knowledge Enhanced Contextual Word Representations
Python
359
star
37

PeerRead

Data and code for Kang et al., NAACL 2018's paper titled "A Dataset of Peer Reviews (PeerRead): Collection, Insights and NLP Applications"
Python
354
star
38

reward-bench

RewardBench: the first evaluation tool for reward models.
Python
346
star
39

naacl2021-longdoc-tutorial

Python
342
star
40

openie-standalone

Quality information extraction at web scale. Edit
Scala
327
star
41

Holodeck

CVPR 2024: Language Guided Generation of 3D Embodied AI Environments.
Python
319
star
42

python-package-template

A template repo for Python packages
Python
318
star
43

allenact

An open source framework for research in Embodied-AI from AI2.
Python
316
star
44

ir_datasets

Provides a common interface to many IR ranking datasets.
Python
314
star
45

s2orc-doc2json

Parsers for scientific papers (PDF2JSON, TEX2JSON, JATS2JSON)
Python
302
star
46

acl2022-zerofewshot-tutorial

291
star
47

OLMo-Eval

Evaluation suite for LLMs
Python
280
star
48

procthor

🏘️ Scaling Embodied AI by Procedurally Generating Interactive 3D Houses
Python
257
star
49

fm-cheatsheet

Website for hosting the Open Foundation Models Cheat Sheet.
JavaScript
255
star
50

FineGrainedRLHF

Python
243
star
51

beaker-cli

A collaborative platform for rapid and reproducible research.
Go
230
star
52

comet-atomic-2020

Python
228
star
53

spv2

Science-parse version 2
Python
225
star
54

scifact

Data and models for the SciFact verification task.
Python
217
star
55

objaverse-rendering

πŸ“· Scripts for rendering Objaverse
Python
206
star
56

ScienceWorld

ScienceWorld is a text-based virtual environment centered around accomplishing tasks from the standardized elementary science curriculum.
Scala
197
star
57

unified-io-inference

Jupyter Notebook
196
star
58

allennlp-demo

Code for the AllenNLP demo.
TypeScript
191
star
59

citeomatic

A citation recommendation system that allows users to find relevant citations for their paper drafts. The tool is backed by Semantic Scholar's OpenCorpus dataset.
Jupyter Notebook
189
star
60

cartography

Dataset Cartography: Mapping and Diagnosing Datasets with Training Dynamics
Jupyter Notebook
188
star
61

savn

Learning to Learn how to Learn: Self-Adaptive Visual Navigation using Meta-Learning (https://arxiv.org/abs/1812.00971)
Python
175
star
62

vampire

Variational Methods for Pretraining in Resource-limited Environments
Python
173
star
63

vila

Incorporating VIsual LAyout Structures for Scientific Text Classification
Python
172
star
64

s2-folks

Public space for the user community of Semantic Scholar APIs to share scripts, report issues, and make suggestions.
171
star
65

hidden-networks

Python
164
star
66

cord19

Get started with CORD-19
161
star
67

mmda

multimodal document analysis
Jupyter Notebook
158
star
68

PRIMER

The official code for PRIMERA: Pyramid-based Masked Sentence Pre-training for Multi-document Summarization
Python
150
star
69

catwalk

This project studies the performance and robustness of language models and task-adaptation methods.
Python
141
star
70

dnw

Discovering Neural Wirings (https://arxiv.org/abs/1906.00586)
Python
139
star
71

deepfigures-open

Companion code to the paper "Extracting Scientific Figures with Distantly Supervised Neural Networks" πŸ€–
Python
133
star
72

tpu_pretrain

LM Pretraining with PyTorch/TPU
Python
132
star
73

allentune

Hyperparameter Search for AllenNLP
Python
128
star
74

SciREX

Data/Code Repository for https://api.semanticscholar.org/CorpusID:218470122
Python
128
star
75

scidocs

Dataset accompanying the SPECTER model
Python
127
star
76

lm-explorer

interactive explorer for language models
Python
127
star
77

pdffigures

Command line tool to extract figures, tables, and captions from scholarly documents in PDF form.
C++
125
star
78

OpenBookQA

Code for experiments on OpenBookQA from the EMNLP 2018 paper "Can a Suit of Armor Conduct Electricity? A New Dataset for Open Book Question Answering"
Python
121
star
79

peS2o

Pretraining Efficiently on S2ORC!
120
star
80

gooaq

Question-answers, collected from Google
Python
116
star
81

allennlp-as-a-library-example

A simple example for how to build your own model using AllenNLP as a dependency.
Python
113
star
82

embodied-clip

Official codebase for EmbCLIP
Python
111
star
83

multimodalqa

Python
109
star
84

alexafsm

With alexafsm, developers can model dialog agents with first-class concepts such as states, attributes, transition, and actions. alexafsm also provides visualization and other tools to help understand, test, debug, and maintain complex FSM conversations.
Python
108
star
85

allennlp-semparse

A framework for building semantic parsers (including neural module networks) with AllenNLP, built by the authors of AllenNLP
Python
107
star
86

scicite

Repository for NAACL 2019 paper on Citation Intent prediction
Python
106
star
87

ai2thor-rearrangement

πŸ”€ Visual Room Rearrangement
Python
104
star
88

commonsense-kg-completion

Python
102
star
89

medicat

Dataset of medical images, captions, subfigure-subcaption annotations, and inline textual references
Python
102
star
90

real-toxicity-prompts

Jupyter Notebook
101
star
91

s2search

The Semantic Scholar Search Reranker
Python
99
star
92

aristo-mini

Aristo mini is a light-weight question answering system that can quickly evaluate Aristo science questions with an evaluation web server and the provided baseline solvers.
Python
96
star
93

gpv-1

A task-agnostic vision-language architecture as a step towards General Purpose Vision
Jupyter Notebook
92
star
94

flex

Few-shot NLP benchmark for unified, rigorous eval
Python
91
star
95

elastic

Python
91
star
96

manipulathor

ManipulaTHOR, a framework that facilitates visual manipulation of objects using a robotic arm
Jupyter Notebook
88
star
97

spoc-robot-training

SPOC: Imitating Shortest Paths in Simulation Enables Effective Navigation and Manipulation in the Real World
Python
85
star
98

S2AND

Semantic Scholar's Author Disambiguation Algorithm & Evaluation Suite
Python
85
star
99

propara

ProPara (Process Paragraph Comprehension) dataset and models
Python
82
star
100

ARC-Solvers

ARC Question Solvers
Python
82
star