updates to the card

README.md

@@ -15,58 +15,22 @@ datasets:
 
 TODO: logo?
 
-# Model Card for m4-80b
-
-<!-- Provide a quick summary of what the model is/does. [Optional] -->
-IDEFICS (**I**mage-aware **D**ecoder **E**nhanced à la **F**lamingo with **I**nterleaved **C**ross-attention**S**) is an open-access reproduction of Flamingo, a closed-source visual language model developed by Deepmind. The multimodal model accepts arbitrary sequences of image and text inputs and produces text outputs and is built solely on public available data and models.
-IDEFICS (TODO) is on par with the original model on various image + text benchmarks, including visual question answering (open-ended and multiple choice), image captioning, and image classification when evaluated with in-context few-shot learning.
-
-The model comes into two variants: a large [80 billion parameters version](https://huggingface.co/HuggingFaceM4/m4-80b) and a [9 billion parameters version](https://huggingface.co/HuggingFaceM4/m4-9b).
-We also fine-tune these base models on a mixture of SFT datasets (TODO: find a more understandable characterization), which boosts the downstream performance while making the models more usable in conversational settings: (TODO: 80B-sfted) and (TODO: 9B sfted).
-
-
-#  Table of Contents
-
-- [Model Card for m4-80b](#model-card-for--model_id-)
-- [Table of Contents](#table-of-contents)
-- [Model Details](#model-details)
-  - [Model Description](#model-description)
-- [Uses](#uses)
-  - [Direct Use](#direct-use)
-  - [Downstream Use [Optional]](#downstream-use-optional)
-  - [Out-of-Scope Use](#out-of-scope-use)
-- [Bias, Risks, and Limitations](#bias-risks-and-limitations)
-  - [Recommendations](#recommendations)
-- [Training Details](#training-details)
-  - [Training Data](#training-data)
-  - [Training Procedure](#training-procedure)
-    - [Preprocessing](#preprocessing)
-    - [Speeds, Sizes, Times](#speeds-sizes-times)
-- [Evaluation](#evaluation)
-  - [Testing Data, Factors & Metrics](#testing-data-factors--metrics)
-    - [Testing Data](#testing-data)
-    - [Factors](#factors)
-    - [Metrics](#metrics)
-  - [Results](#results)
-- [Model Examination](#model-examination)
-- [Environmental Impact](#environmental-impact)
-- [Technical Specifications [optional]](#technical-specifications-optional)
-  - [Model Architecture and Objective](#model-architecture-and-objective)
-  - [Compute Infrastructure](#compute-infrastructure)
-    - [Hardware](#hardware)
-    - [Software](#software)
-- [Citation](#citation)
-- [Glossary [optional]](#glossary-optional)
-- [More Information [optional]](#more-information-optional)
-- [Model Card Authors [optional]](#model-card-authors-optional)
-- [Model Card Contact](#model-card-contact)
-- [How to Get Started with the Model](#how-to-get-started-with-the-model)
+# IDEFICS
 
+IDEFICS (**I**mage-aware **D**ecoder **E**nhanced à la **F**lamingo with **I**nterleaved **C**ross-attention**S**) is an open-access reproduction of [Flamingo](https://huggingface.co/papers/2204.14198), a closed-source visual language model developed by Deepmind. Like GPT-4, the multimodal model accepts arbitrary sequences of image and text inputs and produces text outputs. IDEFICS is built solely on public available data and models.
+
+The model can answer questions about images, describe visual contents, create stories grounded on multiple images, or simply behave as a pure language model without visual inputs.
+
+IDEFICS is on par with the original model on various image-text benchmarks, including visual question answering (open-ended and multiple choice), image captioning, and image classification when evaluated with in-context few-shot learning. It comes into two variants: a large [80 billion parameters](https://huggingface.co/HuggingFaceM4/idefics-80b) version and a [9 billion parameters](https://huggingface.co/HuggingFaceM4/idefics-9b) version.
+
+We also fine-tune these base models on a mixture of supervised and instruction fine-tuning datasets, which boosts the downstream performance while making the models more usable in conversational settings: [idefics-80b-instruct](https://huggingface.co/HuggingFaceM4/idefics-80b-instruct) and [idefics-9b-instruct](https://huggingface.co/HuggingFaceM4/idefics-9b-instruct). As they reach higher performance, we recommend using these instructed versions first.
+
+Read more about some of the technical challenges encountered during training IDEFICS [here](https://github.com/huggingface/m4-logs/blob/master/memos/README.md).
 
 # Model Details
 
 - **Developed by:** Hugging Face
-- **Model type:** Multi-modal model (text+image)
+- **Model type:** Multi-modal model (image+text)
 - **Language(s) (NLP):** en
 - **License:** other
 - **Parent Model:** [laion/CLIP-ViT-H-14-laion2B-s32B-b79K](https://huggingface.co/laion/CLIP-ViT-H-14-laion2B-s32B-b79K) and [huggyllama/llama-65b](https://huggingface.co/huggyllama/llama-65b)
@@ -77,41 +41,61 @@ We also fine-tune these base models on a mixture of SFT datasets (TODO: find a m
     - Original Paper: [Flamingo: a Visual Language Model for Few-Shot Learning](https://huggingface.co/papers/2204.14198)
 
 IDEFICS is a large multimodal English model that takes sequences of interleaved images and texts as inputs and generates text outputs.
-The model shows strong in-context few-shot learning capabilities (and on par with the closed-source model), and is a robust starting point to fine-tune multimodal models on custom data.
+The model shows strong in-context few-shot learning capabilities and is on par with the closed-source model. This makes IDEFICS a robust starting point to fine-tune multimodal models on custom data.
 
 IDEFICS is built on top of two unimodal open-access pre-trained models to connect the two modalities. Newly initialized parameters in the form of Transformer blocks bridge the gap between the vision encoder and the language model. The model is trained on a mixture of image/text pairs and unstrucutred multimodal web documents.
 
+IDEFICS-instruct is the model obtained by further training IDEFICS on Supervised Fine-Tuning and Instruction Fine-Tuning datasets. This improves downstream performance significantly (making [idefics-9b-instruct](https://huggingface.co/HuggingFaceM4/idefics-9b-instruct) a very strong model at its 9 billion scale), while making the model more suitable to converse with.
 
 # Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-
 The model can be used to perform inference on multimodal (image + text) tasks in which the input is composed of a text query/instruction along with one or multiple images. This model does not support image generation.
 
-It is possible to fine-tune the base model on custom data for a specific use-case. We note that the instruction-fine-tuned models are significantly better at following instructions and thus should be prefered when using the models out-of-the-box.
+It is possible to fine-tune the base model on custom data for a specific use-case. We note that the instruction-fine-tuned models are significantly better at following instructions from users and thus should be prefered when using the models out-of-the-box.
 
-The following screenshot is an example of interaction with the model:
+The following screenshot is an example of interaction with the instructed model:
 
-TODO: screenshot
+<img src="./assets/guarding_baguettes.png"  width="35%">
 
 
 # How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-<details>
-<summary> Click to expand </summary>
+```python
+import torch
+from transformers import IdeficsForVisionText2Text, AutoProcessor
+
+device = "cuda" if torch.cuda.is_available() else "cpu"
+
+checkpoint = "HuggingFaceM4/idefics-9b"
+model = IdeficsForVisionText2Text.from_pretrained(checkpoint, torch_dtype=torch.bfloat16).to(device)
+processor = AutoProcessor.from_pretrained(checkpoint)
 
-More information needed
+# We feed to the model an arbitrary sequence of text strings and images. Images can be either URLs or PIL Images.
+prompts = [
+    [
+        "https://upload.wikimedia.org/wikipedia/commons/8/86/Id%C3%A9fix.JPG",
+        "In this picture from Asterix and Obelix, we can see"
+    ],
+]
 
-</details>
+# --batched mode
+inputs = processor(prompts, return_tensors="pt").to(device)
+# --single sample mode
+# inputs = processor(prompts[0], return_tensors="pt").to(device)
 
+generated_ids = model.generate(**inputs, max_length=100)
+generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)
+for i, t in enumerate(generated_text):
+    print(f"{i}:\n{t}\n")
+```
 
 To quickly test your software without waiting for the huge model to download/load you can use `HuggingFaceM4/tiny-random-idefics` - it hasn't been trained and has random weights but it is very useful for quick testing.
 
 # Training Details
 
-We closel follow the training procedure layed out in [Flamingo](https://huggingface.co/papers/2204.14198). We combine two open-source pre-trained models ([laion/CLIP-ViT-H-14-laion2B-s32B-b79K](https://huggingface.co/laion/CLIP-ViT-H-14-laion2B-s32B-b79K) and [huggyllama/llama-65b](https://huggingface.co/huggyllama/llama-65b)) by initializing new Transformer blocks. The pre-trained backbones are frozen while we train the newly initialized parameters.
+We closely follow the training procedure layed out in [Flamingo](https://huggingface.co/papers/2204.14198). We combine two open-source pre-trained models ([laion/CLIP-ViT-H-14-laion2B-s32B-b79K](https://huggingface.co/laion/CLIP-ViT-H-14-laion2B-s32B-b79K) and [huggyllama/llama-65b](https://huggingface.co/huggyllama/llama-65b)) by initializing new Transformer blocks. The pre-trained backbones are frozen while we train the newly initialized parameters.
 
 The model is trained on the following data mixture of openly accessible English data:
 
@@ -119,14 +103,14 @@ The model is trained on the following data mixture of openly accessible English
 |-------------|-----------------------------------------|---------------------------|---------------------------|--------|-----------------------------------------|
 | [OBELICS](https://huggingface.co/datasets/HuggingFaceM4/OBELICS)     | Unstructured Multimodal Web Documents    | 114.9B                      | 353M                      | 1      | 73.85%                                  |
 | [Wikipedia](https://huggingface.co/datasets/wikipedia)   | Unstructured Multimodal Web Documents    | 3.192B                     | 39M                     | 3      | 6.15%                                  |
-| [LAION](https://huggingface.co/datasets/laion/laion2B-en)       | Image-Text Pairs                         | 29.9B                      | 1.120B                      | 1      | 17.18%   
+| [LAION](https://huggingface.co/datasets/laion/laion2B-en)       | Image-Text Pairs                         | 29.9B                      | 1.120B                      | 1      | 17.18%
 | [PMD](https://huggingface.co/datasets/facebook/pmd)         | Image-Text Pairs                         | 1.6B                      | 70M                      | 3      | 2.82%                                   |                                |
 
-**OBELICS** is an open, massive and curated collection of interleaved image-text web documents, containing 141M documents, 115B text tokens and 353M images. An interactive visualization of the dataset content is available [here](TODO). (https://atlas.nomic.ai/map/259c207e-a228-445b-af77-281c84f8bd52/1211f37e-6c31-4dab-80ba-fdb02dfc1a51 -> this is an early, non-final version)
+**OBELICS** is an open, massive and curated collection of interleaved image-text web documents, containing 141M documents, 115B text tokens and 353M images. An interactive visualization of the dataset content is available [here](https://atlas.nomic.ai/map/f2fba2aa-3647-4f49-a0f3-9347daeee499/ee4a84bd-f125-4bcc-a683-1b4e231cb10f).
 
-**Wkipedia** is the multimodal equivalent of the encyclopedia. We used the English dump of Wikipedia created on February 20th, 2023.
+**Wkipedia**. We used the English dump of Wikipedia created on February 20th, 2023.
 
-**LAION** is a collection of image-text pairs collected from web pages from Common Crawl and texts are obtained using the alternative texts of each image. We deduplicated it (following [this paper](https://arxiv.org/abs/2303.12733)), slightly filtered it, and removed the opted-out images.
+**LAION** is a collection of image-text pairs collected from web pages from Common Crawl and texts are obtained using the alternative texts of each image. We deduplicated it (following [Webster et al., 2023](https://arxiv.org/abs/2303.12733)), filtered it, and removed the opted-out images using the [Spawning API](https://api.spawning.ai/spawning-api).
 
 **PMD** is a collection of publicly-available image-text pair datasets. The dataset contains pairs from Conceptual Captions, Conceptual Captions 12M, WIT, Localized Narratives, RedCaps, COCO, SBU Captions, Visual Genome and a subset of YFCC100M dataset. Due to a server failure at the time of the pre-processing, we did not include SBU captions.
 
@@ -164,15 +148,15 @@ We use the following hyper and training parameters:
 
 # Evaluation
 
-<!-- This section describes the evaluation protocols and provides the results. -->
-We closely follow the evaluation protocol of Flamingo and evaluate IDEFICS on a suite of downstream image + text benchmarks ranging from visual question answering to image captioning.
+We follow the evaluation protocol of Flamingo and evaluate IDEFICS on a suite of downstream image-text benchmarks ranging from visual question answering to image captioning.
 
 We compare our model to the original Flamingo along with [OpenFlamingo](openflamingo/OpenFlamingo-9B-vitl-mpt7b), another open-source reproduction.
 
-We perform checkpoint selection based on validation sets of TODO, and select the checkpoint at step 65'000 for IDEFICS-9B and at step 37'500 for IDEFICS. The models are evaluated with in-context few-shot learning where the priming instances are selected from a support set to be similar (i.e. close in a vector space) to the queried instance. We do not use any form of ensembling.
+We perform checkpoint selection based on validation sets of VQAv2, TextVQA, OKVQA, VizWiz, Visual Dialogue, Coco, Flickr30k, and HatefulMemes. We select the checkpoint at step 65'000 for IDEFICS-9B and at step 37'500 for IDEFICS. The models are evaluated with in-context few-shot learning where the priming instances are selected at random from a support set. We do not use any form of ensembling.
 
-TODO: beautiful plots of shots scaling laws.
+<img src="./assets/Figure_Evals_IDEFIX.png"  width="55%">
 
+TODO: update this table
 | Model      |   Shots |   VQAv2 (OE VQA acc) |   OKVQA (OE VQA acc) |   TextVQA (OE VQA acc) |   VizWiz (OE VQA acc) |   TextCaps (CIDEr) |   Coco (CIDEr) |   NoCaps (CIDEr) |   Flickr (CIDEr) |   ImageNet1k (accuracy) |   VisDial (NDCG) |   HatefulMemes (ROC AUC) |   ScienceQA (accuracy) |   RenderedSST2 (accuracy) |   Winoground (group (text/image)) |
 |:-----------|--------:|---------------------:|---------------------:|-----------------------:|----------------------:|-------------------:|---------------:|-----------------:|-----------------:|------------------------:|-----------------:|-------------------------:|-----------------------:|--------------------------:|----------------------------------:|
 | IDEFIX 80B |       0 |                 60.0 |                 45.2 |                   30.9 |                  36.0 |               56.8 |           91.8 |             65.0 |             53.7 |                    74.3 |             48.8 |                     60.6 |                   68.9 |                      60.5 |                               8.0 (18.8/22.5)|
@@ -187,14 +171,20 @@ TODO: beautiful plots of shots scaling laws.
 |            |      16 |                 57.2 |                 49.0 |                   28.1 |                  45.0 |               68.0 |           99.6 |             87.2 |             65.0 |                    - |             - |                     52.5 |                   - |                      66.0 |                              - |
 |            |      32 |                 57.9 |                 50.4 |                   28.2 |                  45.9 |               69.7 |          101.5 |             88.6 |             66.0 |                    - |             - |                     53.1 |                   - |                      63.4 |                              - |
 
+We also report results where the priming samples are selected to be similar (i.e. close in a vector space) to the queried instance.
+
+TODO: table with rices shots
+
 # Technical Specifications
 
+- **Hardware Type:** 64 nodes of 8x 80GB A100 gpus, EFA network
+- **Hours used:** ~672 node hours
+- **Cloud Provider:** AWS Sagemaker
+
 ## Hardware
 
 The training was performed on an AWS SageMaker cluster with 64 nodes of 8x80GB A100 GPUs (512 GPUs total). The cluster uses the current EFA network which provides about 340GBps throughput.
 
-As the network is quite slow for the needs of DeepSpeed ZeRO-3 we were only able to clock ~90 TFLOPs.
-
 ## Software
 
 The training software is built on top of HuggingFace Transformers + Accelerate, and DeepSpeed ZeRO-3 for training, and [WebDataset](https://github.com/webdataset/webdataset) for data loading.
@@ -202,8 +192,6 @@ The training software is built on top of HuggingFace Transformers + Accelerate,
 
 # Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
 Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)).
 As a derivative of such a language model, IDEFICS can produce texts that include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
 Moreover, IDEFICS can produce factually incorrect texts, and should not be relied on to produce factually accurate information.
@@ -214,35 +202,28 @@ TODO: give 4/5 representative examples
 To measure IDEFICS's ability to recognize socilogical (TODO: find a better adjective) attributes, we evaluate the model on FairFace...
 TODO: include FairFace numbers
 
+# License
 
-# Environmental Impact
-
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-
-- **Hardware Type:** 64 nodes of 8x 80GB A100 gpus, EFA network
-- **Hours used:** ~672 node hours
-- **Cloud Provider:** AWS Sagemaker
-- **Carbon Emitted:** unknown
+The model is built on top of of two pre-trained models: [laion/CLIP-ViT-H-14-laion2B-s32B-b79K](https://huggingface.co/laion/CLIP-ViT-H-14-laion2B-s32B-b79K) and [huggyllama/llama-65b](https://huggingface.co/huggyllama/llama-65b). The first was released under an MIT license, while the second was released under a specific noncommercial license focused on research purposes. As such, users should comply with that license by applying directly to [Meta's form](https://docs.google.com/forms/d/e/1FAIpQLSfqNECQnMkycAp2jP4Z9TFX0cGR4uf7b_fBxjY_OjhJILlKGA/viewform).
 
+We release the additional weights we trained under an MIT license.
 
 # Citation
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-
 **BibTeX:**
 
-More information needed
-
-**APA:**
-
-More information needed
-
-
-# Model Card Authors [optional]
-
-<!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
+```bibtex
+@misc{laurençon2023obelisc,
+      title={OBELISC: An Open Web-Scale Filtered Dataset of Interleaved Image-Text Documents},
+      author={Hugo Laurençon and Lucile Saulnier and Léo Tronchon and Stas Bekman and Amanpreet Singh and Anton Lozhkov and Thomas Wang and Siddharth Karamcheti and Alexander M. Rush and Douwe Kiela and Matthieu Cord and Victor Sanh},
+      year={2023},
+      eprint={2306.16527},
+      archivePrefix={arXiv},
+      primaryClass={cs.IR}
+}
+```
+
+# Model Card Authors
 
 V, i, c, t, o, r, ,,  , S, t, a, s, ,,  , X, X, X