Skip to main content

Mantis: Interleaved Multi-Image Instruction Tuning (TMLR 2024)

This repository contain the code for our TMLR24 paper Mantis (https://arxiv.org/abs/2405.01483).

Mantis


🤔 The recent years have witnessed a great array of large multimodal models (LMMs) to effectively solve single-image vision language tasks. However, their abilities to solve multi-image visual language tasks is yet to be improved.

😦 The existing multi-image LMMs (e.g. OpenFlamingo, Emu, Idefics, etc) mostly gain their multi-image ability through pre-training on hundreds of millions of noisy interleaved image-text data from web, which is neither efficient nor effective.

🔥 Therefore, we present Mantis, an LLaMA-3 based LMM with interleaved text and image as inputs, train on Mantis-Instruct under academic-level resources (i.e. 36 hours on 16xA100-40G).

🚀 Mantis achieves state-of-the-art performance on 5 multi-image benchmarks (NLVR2, Q-Bench, BLINK, MVBench, Mantis-Eval), and maintaining a strong single-image performance on par with CogVLM and Emu2.

🔥News

Installation

conda create -n mantis python=3.10
conda activate mantis
pip install -e .
# install flash-attention
pip install flash-attn --no-build-isolation

Inference

You can run inference with the following command:

cd examples
python run_mantis.py

Training

Install the requirements with the following command:

pip install -e .[train,eval]
cd mantis/train

Our training scripts follows the coding format and model structure of Hugging face. Different from LLaVA Github repo, you can directly load our models from Hugging Face model hub.

Training examples with different data formats

(These example data are all pre-prepared in the data/examples/ folder, so you can check the format of the data and the debug the training script directly. set CUDA_VISIBLE_DEVICES to the GPU you want to use.)

  • training with text-image interleaved data (see example data)
cd mantis/train
bash scripts/train_example_chat.sh # Q-lora, 1 GPU required
  • training with video-text interleaved data (see example data)
cd mantis/train
bash scripts/train_example_video.sh # Q-lora, 1 GPU required
cd mantis/train
bash scripts/train_example_classification.sh # full-finetune, might need 8 GPUs or more

Training examples with different models

We support training of Mantis based on the Fuyu architecture and the LLaVA architecture. You can train the model with the following command:

Training Mantis based on LLaMA3 with CLIP/SigLIP encoder:

  • Pretrain Mantis-LLaMA3 Multimodal projector on pretrain data (Stage 1):
bash scripts/pretrain_mllava.sh
  • Fine-tune the pretrained Mantis-LLaMA3 on Mantis-Instruct (Stage 2):
bash scripts/train_mllava.sh

Training Mantis based on Fuyu-8B:

  • Fine-tune Fuyu-8B on Mantis-Instruct to get Mantis-Fuyu:
bash scripts/train_fuyu.sh

Note:

  • Our training scripts contain auto inference bash commands to infer the number of GPUs and the number of GPU nodes use for the training. So you only need to modify the data config path and the base models.
  • The training data will be automatically downloaded from hugging face when you run the training scripts.

See mantis/train/README.md for more details.

Check all the training scripts in mantist/train/scripts

Evaluation

To reproduce our evaluation results, please check mantis/benchmark/README.md

Data

Downloading

you can easily preparing Mantis-Insturct's downloading with the following command (The downloading and extracting might take about an hour):

python data/download_mantis_instruct.py --max_workers 8

Model Zoo

Mantis Models

We provide the following models in the 🤗 Hugging Face model hub:

Run models

  • Run Mantis-8B-Idefics2:
cd examples && python run_mantis_idefics2.py
  • Mantis-8B-siglip-llama3:
cd examples && python run_mantis.py
  • Mantis-8B-Fuyu:
cd examples && python run_mantis_fuyu.py

Chat CLI

We provide a simple chat CLI for Mantis models. You can run the following command to chat with Mantis-8B-siglip-llama3:

python examples/chat_mantis.py

Intermediate Checkpoints

The following intermediate checkpoints after pre-training the multi-modal projectors are also available for experiments reproducibility (Please note the follwing checkpoints still needs further fine-tuning on Mantis-Instruct to be intelligent. They are not working models.):

Acknowledgement

  • Thanks LLaVA and LLaVA-hf team for providing the LLaVA codebase, and hugging face compatibility!
  • Thanks Haoning Wu for providing codes of MVBench evaluation!

Star History

Star History Chart

Citation

@article{Jiang2024MANTISIM,
  title={MANTIS: Interleaved Multi-Image Instruction Tuning},
  author={Dongfu Jiang and Xuan He and Huaye Zeng and Cong Wei and Max W.F. Ku and Qian Liu and Wenhu Chen},
  journal={Transactions on Machine Learning Research},
  year={2024},
  volume={2024},
  url={https://openreview.net/forum?id=skLtdUVaJa}
}

Metadata

Release files for mantis-vl 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mantis-vl 0.0.5
File Size Uploaded
mantis_vl-0.0.5.tar.gz 295.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mantis-vl 0.0.5
File Interpreter ABI Platform
mantis_vl-0.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 671.3 kB

Release files / mantis_vl-0.0.5.tar.gz

Download URL mantis_vl-0.0.5.tar.gz
Size 295.3 kB
Tags Source
SHA-256 checksum
How to use checksums
abfb6ae3bae7e2dd33c8e4aaaf7a68c5b40a881efed6d9e317390339acfbfe18
BLAKE2b-256 checksum
How to use checksums
cbe037eee6b9fef58877f3d51876d976fa04fb2d143cf143ce782f7b4cba07f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Release files / mantis_vl-0.0.5-py3-none-any.whl

Download URL mantis_vl-0.0.5-py3-none-any.whl
Size 376.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0f3976db11d77b13cd334f935766e3da29e31550ba1ee59406b348331ac4c49b
BLAKE2b-256 checksum
How to use checksums
813e9bbc1b0041effafd965e6fa5af686162fa9492b3b5cebba91a44f50785b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.0 CPython/3.9.19

Release history Release notifications | RSS feed

This release

0.0.5 This release

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page