Package: otter-ai
Project Credits|Otter Paper|OtterHD Paper|MIMIC-IT Paper|Otter TeamspaceCorresponding Checkpoints:Otter-AI/OtterHD-8Bluodian/OTTER-Image-MPT7Bluodian/OTTER-Video-LLaMA7B-DenseCaptionMore at Our Research Group->Otters Embrace AIFor who in the mainland China:|Disclaimer:The code may not be perfectly polished and refactored, butall opensourced codes are tested and runnableas we also use the code to support our research. If you have any questions, please feel free to open an issue. We are eagerly looking forward to suggestions and PRs to improve the code quality.🦾 Update[2023-11]: Supporting GPT4V's Evaluation on 8 Benchmarks; Anouncing OtterHD-8B, improved from Fuyu-8B. CheckoutOtterHDfor details.🦦 AddedOtterHD, a multimodal fine-tuned fromFuyu-8Bto facilitate fine-grained interpretations of high-resolution visual inputwithout a explicit vision encoder module. All image patches are linear transformed and processed together with text tokens. This is a very innovative and elegant exploration. We are fascinated and paved in this way, we opensourced the finetune script for Fuyu-8B and improve training throughput by 4-5 times faster withFlash-Attention-2. Try our finetune script atOtterHD.🔍 AddedMagnifierBench, an evaluation benchmark tailored to assess whether the model can identify the tiny objects' information (1% image size) and spatial relationships.Improved pipeline forPretrain|SFT|RLHFwith (part of) current leading LMMs.Models:Otter|OpenFlamingo|Idefics|FuyuTraining Datasets Interface: (Pretrain)MMC4 | LAION2B | CC3M | CC12M,(SFT)MIMIC-IT | M3IT | LLAVAR | LRV | SVIT...We tested above datasets for both pretraining and instruction tuning with OpenFlamingo and Otter. We also tested the datasets with Idefics and Fuyu for instruction tuning. We will opensource the training scripts gradually.Benchmark Interface: MagnifierBench/MMBench/MM-VET/MathVista/POPE/MME/SicenceQA/SeedBench. Run them can be in one-click, please seeBenchmarkfor details.datasets:-name:magnifierbenchsplit:testprompt:Answer with the option's letter from the given choices directly.api_key:[Your API Key]# GPT4 or GPT3.5 to evaluate the answers and ground truth.debug:true# put debug=true will save the model response in log file.-name:mmesplit:testdebug:true-name:mmbenchsplit:testdebug:truemodels:-name:gpt4vapi_key:[Your API Key]# to call GPT4V model.Code refactorizationfororganizing multiple groups of datasets with integrated yaml file, see details atmanaging datasets in MIMIC-IT format. For example,IMAGE_TEXT:# Group name should be in [IMAGE_TEXT, TEXT_ONLY, IMAGE_TEXT_IN_CONTEXT]LADD:# Dataset name can be assigned at any name you wantmimicit_path:azure_storage/json/LA/LADD_instructions.json# Path of the instruction json fileimages_path:azure_storage/Parquets/LA.parquet# Path of the image parquet filenum_samples:-1# Number of samples you want to use, -1 means use all samples, if not set, default is -1.M3IT_CAPTIONING:mimicit_path:azure_storage/json/M3IT/captioning/coco/coco_instructions.jsonimages_path:azure_storage/Parquets/coco.parquetnum_samples:20000This is a major change and would result previous code not runnable, please check the details.[2023-08]Added Support for using Azure, Anthropic, Palm, Cohere models for Self-Instruct with Syphus pipeline, for information on usage modifythis linewith your selected model and set your API keys in the environment. For more information seeLiteLLM[2023-07]: Anouncing MIMIC-IT dataset for multiple interleaved image-text/video instruction tuning.🤗 CheckoutMIMIC-ITon Huggingface datasets.🥚 UpdateEggssection for downloading MIMIC-IT dataset.🥃 Contact usif you wish to develop Otter for your scenarios(for satellite images or funny videos?). We aim to support and assist with Otter's diverse use cases. OpenFlamingo and Otter are strong models with theFlamingo's excellently designed architecture that accepts multiple images/videos or other modality inputs. Let's build more interesting models together.[2023-06]🧨Download MIMIC-IT Dataset. For more details on navigating the dataset, please refer toMIMIC-IT Dataset README.🏎️Run Otter Locally. You can run our model locally with at least 16G GPU mem for tasks like image/video tagging and captioning and identifying harmful content. We fix a bug related to video inference whereframe tensorswere mistakenly unsqueezed to a wrongvision_x.Make sure to adjust thesys.path.append("../..")correctly to accessotter.modeling_otterin order to launch the model.🤗 Check ourpaperintroducing MIMIC-IT in details. Meet MIMIC-IT, the first multimodal in-context instruction tuning dataset with 2.8M instructions! From general scene understanding to spotting subtle differences and enhancing egocentric view comprehension for AR headsets, our MIMIC-IT dataset has it all.🦦 Why In-Context Instruction Tuning?Large Language Models (LLMs) have demonstrated exceptional universal aptitude as few/zero-shot learners for numerous tasks, owing to their pre-training on extensive text data. Among these LLMs, GPT-3 stands out as a prominent model with significant capabilities. Additionally, variants of GPT-3, namely InstructGPT and ChatGPT, have proven effective in interpreting natural language instructions to perform complex real-world tasks, thanks to instruction tuning.Motivated by the upstream interleaved format pretraining of the Flamingo model, we present 🦦 Otter, a multi-modal model based on OpenFlamingo (the open-sourced version of DeepMind's Flamingo). We train our Otter in an in-context instruction tuning way on our proposedMI-ModalIn-ContextInstructionTuning (MIMIC-IT) dataset. Otter showcases improved instruction-following and in-context learning ability in both images and videos.🗄 MIMIC-IT Dataset DetailsMIMIC-IT enables the application of egocentric visual assistant model that can serve that can answer your questions likeHey, Do you think I left my keys on the table?. Harness the power of MIMIC-IT to unlock the full potential of your AI-driven visual assistant and elevate your interactive vision-language tasks to new heights.We also introduceSyphus, an automated pipeline for generating high-quality instruction-response pairs in multiple languages. Building upon the framework proposed by LLaVA, we utilize ChatGPT to generate instruction-response pairs based on visual content. To ensure the quality of the generated instruction-response pairs, our pipeline incorporates system messages, visual annotations, and in-context examples as prompts for ChatGPT.For more details, please check theMIMIC-IT dataset.🤖 Otter Model DetailsOtter is designed to support multi-modal in-context instruction tuning based on the OpenFlamingo model, which involves conditioning the language model on the corresponding media, such as an image that corresponds to a caption or an instruction-response pair.We train Otter on MIMIC-IT dataset with approximately 2.8 million in-context instruction-response pairs, which are structured into a cohesive template to facilitate various tasks. Otter supports videos inputs (frames are arranged as original Flamingo's implementation) and multiple images inputs as in-context examples, which isthe first multi-modal instruction tuned model.The following template encompasses images, user instructions, and model-generated responses, utilizing theUserandGPTrole labels to enable seamless user-assistant interactions.prompt=f"<image>User:{instruction}GPT:<answer>{response}<endofchunk>"Training the Otter model on the MIMIC-IT dataset allows it to acquire different capacities, as demonstrated by the LA and SD tasks. Trained on the LA task, the model exhibits exceptional scene comprehension, reasoning abilities, and multi-round conversation capabilities.# multi-round of conversationprompt=f"<image>User:{first_instruction}GPT:<answer>{first_response}<endofchunk>User:{second_instruction}GPT:<answer>"Regarding the concept of organizing visual-language in-context examples, we demonstrate here the acquired ability of the Otter model to follow inter-contextual instructions after training on the LA-T2T task. The organized input data format is as follows:# Multiple in-context example with similar instructionsprompt=f"<image>User:{ict_first_instruction}GPT: <answer>{ict_first_response}
<image>User:{ict_second_instruction}GPT: <answer>{ict_second_response}
<image>User:{query_instruction}GPT: <answer>"For more details, please refer to ourpaper's appendix for other tasks.🗂️ EnvironmentsCompare cuda version returned by nvidia-smi and nvcc --version. They need to match. Or at least, the version get by nvcc --version should be <= the version get by nvidia-smi.Install the pytorch that matches your cuda version. (e.g. cuda 11.7 torch 2.0.0). We have successfully run this code on cuda 11.1 torch 1.10.1 and cuda 11.7 torch 2.0.0. You can refer to PyTorch's documentation,LatestorPrevious.You may install viaconda env create -f environment.yml. Especially to make sure thetransformers>=4.28.0,accelerate>=0.18.0.After configuring environment, you can use the 🦩 Flamingo model / 🦦 Otter model as a 🤗 Hugging Face model with only a few lines! One-click and then model configs/weights are downloaded automatically. Please refer toHuggingface Otter/Flamingofor details.☄️ TrainingOtter is trained based on OpenFlamingo. You may need to use converted weights atluodian/OTTER-9B-INITorluodian/OTTER-MPT7B-Init. They are respectively converted fromOpenFlamingo-LLaMA7B-v1andOpenFlamingo-MPT7B-v2, we added a<answer>token for Otter's downstream instruction tuning.You may also use any trained Otter weights to start with your training on top of ours, see them atOtter Weights. You can refer toMIMIC-ITfor preparing image/instruction/train json files.exportPYTHONPATH=.RUN_NAME="Otter_MPT7B"GPU=8WORKERS=$((${GPU}*2))echo"Using${GPU}GPUs and${WORKERS}workers"echo"Running${RUN_NAME}"acceleratelaunch--config_file=./pipeline/accelerate_configs/accelerate_config_zero3.yaml\--num_processes=${GPU}\pipeline/train/instruction_following.py\--pretrained_model_name_or_path=luodian/OTTER-MPT7B-Init\--model_name=otter\--instruction_format=simple\--training_data_yaml=./shared_scripts/Demo_Data.yaml\--batch_size=8\--num_epochs=3\--report_to_wandb\--wandb_entity=ntu-slab\--external_save_dir=./checkpoints\--run_name=${RUN_NAME}\--wandb_project=Otter_MPTV\--workers=${WORKERS}\--lr_scheduler=cosine\--learning_rate=2e-5\--warmup_steps_ratio=0.01\--save_hf_model\--max_seq_len=1024\📑 CitationIf you found this repository useful, please consider citing:@article{li2023otter,
  title={Otter: A Multi-Modal Model with In-Context Instruction Tuning},
  author={Li, Bo and Zhang, Yuanhan and Chen, Liangyu and Wang, Jinghao and Yang, Jingkang and Liu, Ziwei},
  journal={arXiv preprint arXiv:2305.03726},
  year={2023}
}

@article{li2023mimicit,
    title={MIMIC-IT: Multi-Modal In-Context Instruction Tuning},
    author={Bo Li and Yuanhan Zhang and Liangyu Chen and Jinghao Wang and Fanyi Pu and Jingkang Yang and Chunyuan Li and Ziwei Liu},
    year={2023},
    eprint={2306.05425},
    archivePrefix={arXiv},
    primaryClass={cs.CV}
}👨‍🏫 AcknowledgementsWe thankJack Hesselfor the advise and support, as well as theOpenFlamingoteam for their great contribution to the open source community.Huge accolades toFlamingoandOpenFlamingoteam for the work on this great architecture.📝 Related ProjectsLLaVA: Visual Instruction TuningInstruction Tuning with GPT4