Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Cadene/vqa.pytorch
Visual Question Answering in Pytorch
https://github.com/Cadene/vqa.pytorch
clevr coco deep-learning pytorch resnet skipthoughts torch vgenome vqa
Last synced: about 2 months ago
JSON representation
Visual Question Answering in Pytorch
- Host: GitHub
- URL: https://github.com/Cadene/vqa.pytorch
- Owner: Cadene
- Created: 2017-05-17T19:41:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-11T23:54:10.000Z (almost 5 years ago)
- Last Synced: 2024-04-20T11:32:51.478Z (5 months ago)
- Topics: clevr, coco, deep-learning, pytorch, resnet, skipthoughts, torch, vgenome, vqa
- Language: Python
- Size: 1.73 MB
- Stars: 699
- Watchers: 34
- Forks: 178
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-pytorch - Visual Question Answering in Pytorch
- awesome-pytorch - Visual Question Answering in Pytorch
README
# Visual Question Answering in pytorch
**/!\ New version of pytorch for VQA available here:** https://github.com/Cadene/block.bootstrap.pytorch
This repo was made by [Remi Cadene](http://remicadene.com) (LIP6) and [Hedi Ben-Younes](https://twitter.com/labegne) (LIP6-Heuritech), two PhD Students working on VQA at [UPMC-LIP6](http://lip6.fr) and their professors [Matthieu Cord](http://webia.lip6.fr/~cord) (LIP6) and [Nicolas Thome](http://webia.lip6.fr/~thomen) (LIP6-CNAM). We developed this code in the frame of a research paper called [MUTAN: Multimodal Tucker Fusion for VQA](https://arxiv.org/abs/1705.06676) which is (as far as we know) the current state-of-the-art on the [VQA 1.0 dataset](http://visualqa.org).
The goal of this repo is two folds:
- to make it easier to reproduce our results,
- to provide an efficient and modular code base to the community for further research on other VQA datasets.
If you have any questions about our code or model, don't hesitate to contact us or to submit any issues. Pull request are welcome!
#### News:
- 16th january 2018: a pretrained vqa2 model and web demo
- 18th july 2017: VQA2, VisualGenome, FBResnet152 (for pytorch) added [v2.0 commit msg](https://github.com/Cadene/vqa.pytorch/commit/42391fd4a39c31e539eb6cb73ecd370bac0f010a)
- 16th july 2017: paper accepted at ICCV2017
- 30th may 2017: poster accepted at CVPR2017 (VQA Workshop)
#### Summary:
* [Introduction](#introduction)
* [What is the task about?](#what-is-the-task-about)
* [Quick insight about our method](#quick-insight-about-our-method)
* [Installation](#installation)
* [Requirements](#requirements)
* [Submodules](#submodules)
* [Data](#data)
* [Reproducing results on VQA 1.0](#reproducing-results-on-vqa-10)
* [Features](#features)
* [Pretrained models](#pretrained-models)
* [Reproducing results on VQA 2.0](#reproducing-results-on-vqa-20)
* [Features](#features-20)
* [Pretrained models](#pretrained-models-20)
* [Documentation](#documentation)
* [Architecture](#architecture)
* [Options](#options)
* [Datasets](#datasets)
* [Models](#models)
* [Quick examples](#quick-examples)
* [Extract features from COCO](#extract-features-from-coco)
* [Extract features from VisualGenome](#extract-features-from-visualgenome)
* [Train models on VQA 1.0](#train-models-on-vqa-10)
* [Train models on VQA 2.0](#train-models-on-vqa-20)
* [Train models on VQA + VisualGenome](#train-models-on-vqa-10-or-20--visualgenome)
* [Monitor training](#monitor-training)
* [Restart training](#restart-training)
* [Evaluate models on VQA](#evaluate-models-on-vqa)
* [Web demo](#web-demo)
* [Citation](#citation)
* [Acknowledgment](#acknowledgment)
## Introduction
### What is the task about?
The task is about training models in a end-to-end fashion on a multimodal dataset made of triplets:
- an **image** with no other information than the raw pixels,
- a **question** about visual content(s) on the associated image,
- a short **answer** to the question (one or a few words).
As you can see in the illustration bellow, two different triplets (but same image) of the VQA dataset are represented. The models need to learn rich multimodal representations to be able to give the right answers.
The VQA task is still on active research. However, when it will be solved, it could be very useful to improve human-to-machine interfaces (especially for the blinds).
### Quick insight about our method
The VQA community developped an approach based on four learnable components:
- a question model which can be a LSTM, GRU, or pretrained Skipthoughts,
- an image model which can be a pretrained VGG16 or ResNet-152,
- a fusion scheme which can be an element-wise sum, concatenation, [MCB](https://arxiv.org/abs/1606.01847), [MLB](https://arxiv.org/abs/1610.04325), or [Mutan](https://arxiv.org/abs/1705.06676),
- optionally, an attention scheme which may have several "glimpses".
One of our claim is that the multimodal fusion between the image and the question representations is a critical component. Thus, our proposed model uses a Tucker Decomposition of the correlation Tensor to model richer multimodal interactions in order to provide proper answers. Our best model is based on :
- a pretrained Skipthoughts for the question model,
- features from a pretrained Resnet-152 (with images of size 3x448x448) for the image model,
- our proposed Mutan (based on a Tucker Decomposition) for the fusion scheme,
- an attention scheme with two "glimpses".
## Installation
### Requirements
First install python 3 (we don't provide support for python 2). We advise you to install python 3 and pytorch with Anaconda:
- [python with anaconda](https://www.continuum.io/downloads)
- [pytorch with CUDA](http://pytorch.org)
```
conda create --name vqa python=3
source activate vqa
conda install pytorch torchvision cuda80 -c soumith
```
Then clone the repo (with the `--recursive` flag for submodules) and install the complementary requirements:
```
cd $HOME
git clone --recursive https://github.com/Cadene/vqa.pytorch.git
cd vqa.pytorch
pip install -r requirements.txt
```
### Submodules
Our code has two external dependencies:
- [VQA](https://github.com/Cadene/VQA) is used to evaluate results files on the valset with the OpendEnded accuracy,
- [skip-thoughts.torch](https://github.com/Cadene/skip-thoughts.torch) is used to import pretrained GRUs and embeddings,
- [pretrained-models.pytorch](https://github.com/Cadene/pretrained-models.pytorch) is used to load pretrained convnets.
### Data
Data will be automaticaly downloaded and preprocessed when needed. Links to data are stored in `vqa/datasets/vqa.py`, `vqa/datasets/coco.py` and `vqa/datasets/vgenome.py`.
## Reproducing results on VQA 1.0
### Features
As we first developped on Lua/Torch7, we used the features of [ResNet-152 pretrained with Torch7](https://github.com/facebook/fb.resnet.torch). We ported the pretrained resnet152 trained with Torch7 in pytorch in the v2.0 release. We will provide all the extracted features soon. Meanwhile, you can download the coco features as following:
```
mkdir -p data/coco/extract/arch,fbresnet152torch
cd data/coco/extract/arch,fbresnet152torch
wget https://data.lip6.fr/coco/trainset.hdf5
wget https://data.lip6.fr/coco/trainset.txt
wget https://data.lip6.fr/coco/valset.hdf5
wget https://data.lip6.fr/coco/valset.txt
wget https://data.lip6.fr/coco/testset.hdf5
wget https://data.lip6.fr/coco/testset.txt
```
/!\ There are currently 3 versions of ResNet152:
- fbresnet152torch which is the torch7 model,
- fbresnet152 which is the porting of the torch7 in pytorch,
- [resnet152](https://github.com/pytorch/vision/blob/master/torchvision/models/resnet.py) which is the pretrained model from torchvision (we've got lower results with it).
### Pretrained VQA models
We currently provide three models trained with our old Torch7 code and ported to Pytorch:
- MutanNoAtt trained on the VQA 1.0 trainset,
- MLBAtt trained on the VQA 1.0 trainvalset and VisualGenome,
- MutanAtt trained on the VQA 1.0 trainvalset and VisualGenome.
```
mkdir -p logs/vqa
cd logs/vqa
wget http://webia.lip6.fr/~cadene/Downloads/vqa.pytorch/logs/vqa/mutan_noatt_train.zip
wget http://webia.lip6.fr/~cadene/Downloads/vqa.pytorch/logs/vqa/mlb_att_trainval.zip
wget http://webia.lip6.fr/~cadene/Downloads/vqa.pytorch/logs/vqa/mutan_att_trainval.zip
```
Even if we provide results files associated to our pretrained models, you can evaluate them once again on the valset, testset and testdevset using a single command:
```
python train.py -e --path_opt options/vqa/mutan_noatt_train.yaml --resume ckpt
python train.py -e --path_opt options/vqa/mlb_noatt_trainval.yaml --resume ckpt
python train.py -e --path_opt options/vqa/mutan_att_trainval.yaml --resume ckpt
```
To obtain test and testdev results on VQA 1.0, you will need to zip your result json file (name it as `results.zip`) and to submit it on the [evaluation server](https://competitions.codalab.org/competitions/6961).
## Reproducing results on VQA 2.0
### Features 2.0
You must download the coco dataset (and visual genome if needed) and then extract the features with a convolutional neural network.
### Pretrained VQA models 2.0
We currently provide three models trained with our current pytorch code on VQA 2.0
- MutanAtt trained on the trainset with the fbresnet152 features,
- MutanAtt trained on thetrainvalset with the fbresnet152 features.
```
cd $VQAPYTORCH
mkdir -p logs/vqa2
cd logs/vqa2
wget http://data.lip6.fr/cadene/vqa.pytorch/vqa2/mutan_att_train.zip
wget http://data.lip6.fr/cadene/vqa.pytorch/vqa2/mutan_att_trainval.zip
```
## Documentation
### Architecture
```
.
├── options # default options dir containing yaml files
├── logs # experiments dir containing directories of logs (one by experiment)
├── data # datasets directories
| ├── coco # images and features
| ├── vqa # raw, interim and processed data
| ├── vgenome # raw, interim, processed data + images and features
| └── ...
├── vqa # vqa package dir
| ├── datasets # datasets classes & functions dir (vqa, coco, vgenome, images, features, etc.)
| ├── external # submodules dir (VQA, skip-thoughts.torch, pretrained-models.pytorch)
| ├── lib # misc classes & func dir (engine, logger, dataloader, etc.)
| └── models # models classes & func dir (att, fusion, notatt, seq2vec, convnets)
|
├── train.py # train & eval models
├── eval_res.py # eval results files with OpenEnded metric
├── extract.py # extract features from coco with CNNs
└── visu.py # visualize logs and monitor training
```
### Options
There are three kind of options:
- options from the yaml options files stored in the `options` directory which are used as default (path to directory, logs, model, features, etc.)
- options from the ArgumentParser in the `train.py` file which are set to None and can overwrite default options (learning rate, batch size, etc.)
- options from the ArgumentParser in the `train.py` file which are set to default values (print frequency, number of threads, resume model, evaluate model, etc.)
You can easly add new options in your custom yaml file if needed. Also, if you want to grid search a parameter, you can add an ArgumentParser option and modify the dictionnary in `train.py:L80`.
### Datasets
We currently provide four datasets:
- [COCOImages](http://mscoco.org/) currently used to extract features, it comes with three datasets: trainset, valset and testset
- [VisualGenomeImages]() currently used to extract features, it comes with one split: trainset
- [VQA 1.0](http://www.visualqa.org/vqa_v1_download.html) comes with four datasets: trainset, valset, testset (including test-std and test-dev) and "trainvalset" (concatenation of trainset and valset)
- [VQA 2.0](http://www.visualqa.org) same but twice bigger (however same images than VQA 1.0)
We plan to add:
- [CLEVR](http://cs.stanford.edu/people/jcjohns/clevr/)
### Models
We currently provide four models:
- MLBNoAtt: a strong baseline (BayesianGRU + Element-wise product)
- [MLBAtt](https://arxiv.org/abs/1610.04325): the previous state-of-the-art which adds an attention strategy
- MutanNoAtt: our proof of concept (BayesianGRU + Mutan Fusion)
- MutanAtt: the current state-of-the-art
We plan to add several other strategies in the futur.
## Quick examples
### Extract features from COCO
The needed images will be automaticaly downloaded to `dir_data` and the features will be extracted with a resnet152 by default.
There are three options for `mode` :
- `att`: features will be of size 2048x14x14,
- `noatt`: features will be of size 2048,
- `both`: default option.
Beware, you will need some space on your SSD:
- 32GB for the images,
- 125GB for the train features,
- 123GB for the test features,
- 61GB for the val features.
```
python extract.py -h
python extract.py --dir_data data/coco --data_split train
python extract.py --dir_data data/coco --data_split val
python extract.py --dir_data data/coco --data_split test
```
Note: By default our code will share computations over all available GPUs. If you want to select only one or a few, use the following prefix:
```
CUDA_VISIBLE_DEVICES=0 python extract.py
CUDA_VISIBLE_DEVICES=1,2 python extract.py
```
### Extract features from VisualGenome
Same here, but only train is available:
```
python extract.py --dataset vgenome --dir_data data/vgenome --data_split train
```
### Train models on VQA 1.0
Display help message, selected options and run default. The needed data will be automaticaly downloaded and processed using the options in `options/vqa/default.yaml`.
```
python train.py -h
python train.py --help_opt
python train.py
```
Run a MutanNoAtt model with default options.
```
python train.py --path_opt options/vqa/mutan_noatt_train.yaml --dir_logs logs/vqa/mutan_noatt_train
```
Run a MutanAtt model on the trainset and evaluate on the valset after each epoch.
```
python train.py --vqa_trainsplit train --path_opt options/vqa/mutan_att_trainval.yaml
```
Run a MutanAtt model on the trainset and valset (by default) and run throw the testset after each epoch (produce a results file that you can submit to the evaluation server).
```
python train.py --vqa_trainsplit trainval --path_opt options/vqa/mutan_att_trainval.yaml
```
### Train models on VQA 2.0
See options of [vqa2/mutan_att_trainval](https://github.com/Cadene/vqa.pytorch/blob/master/options/vqa2/mutan_att_trainval.yaml):
```
python train.py --path_opt options/vqa2/mutan_att_trainval.yaml
```
### Train models on VQA (1.0 or 2.0) + VisualGenome
See options of [vqa2/mutan_att_trainval_vg](https://github.com/Cadene/vqa.pytorch/blob/master/options/vqa2/mutan_att_trainval_vg.yaml):
```
python train.py --path_opt options/vqa2/mutan_att_trainval_vg.yaml
```
### Monitor training
Create a visualization of an experiment using `plotly` to monitor the training, just like the picture bellow (**click the image to access the html/js file**):
Note that you have to wait until the first open ended accuracy has finished processing and then the html file will be created and will pop out on your default browser. The html will be refreshed every 60 seconds. However, you will currently need to press F5 on your browser to see the change.
```
python visu.py --dir_logs logs/vqa/mutan_noatt
```
Create a visualization of multiple experiments to compare them or monitor them like the picture bellow (**click the image to access the html/js file**):
```
python visu.py --dir_logs logs/vqa/mutan_noatt,logs/vqa/mutan_att
```
### Restart training
Restart the model from the last checkpoint.
```
python train.py --path_opt options/vqa/mutan_noatt.yaml --dir_logs logs/vqa/mutan_noatt --resume ckpt
```
Restart the model from the best checkpoint.
```
python train.py --path_opt options/vqa/mutan_noatt.yaml --dir_logs logs/vqa/mutan_noatt --resume best
```
### Evaluate models on VQA
Evaluate the model from the best checkpoint. If your model has been trained on the training set only (`vqa_trainsplit=train`), the model will be evaluate on the valset and will run throw the testset. If it was trained on the trainset + valset (`vqa_trainsplit=trainval`), it will not be evaluate on the valset.
```
python train.py --vqa_trainsplit train --path_opt options/vqa/mutan_att.yaml --dir_logs logs/vqa/mutan_att --resume best -e
```
### Web demo
You must set your local ip address and port in `demo_server.py` line 169 and your global ip address and port in `demo_web/js/custom.js` line 51.
The port associated to the global ip address must redirect to your local ip address.
Launch your API:
```
CUDA_VISIBLE_DEVICES=0 python demo_server.py
```
Open `demo_web/index.html` on your browser to access the API with a human interface.
## Citation
Please cite the arXiv paper if you use Mutan in your work:
```
@article{benyounescadene2017mutan,
author = {Hedi Ben-Younes and
R{\'{e}}mi Cad{\`{e}}ne and
Nicolas Thome and
Matthieu Cord},
title = {MUTAN: Multimodal Tucker Fusion for Visual Question Answering},
journal = {ICCV},
year = {2017},
url = {http://arxiv.org/abs/1705.06676}
}
```
## Acknowledgment
Special thanks to the authors of [MLB](https://arxiv.org/abs/1610.04325) for providing some [Torch7 code](https://github.com/jnhwkim/MulLowBiVQA), [MCB](https://arxiv.org/abs/1606.01847) for providing some [Caffe code](https://github.com/akirafukui/vqa-mcb), and our professors and friends from LIP6 for the perfect working atmosphere.