Update README.md

README.md

@@ -1,3 +1,168 @@
----
-license: apache-2.0
----
+---
+language:
+- en
+- fr
+- de
+- es
+- it
+- pt
+- ru
+- zh
+- ja
+license: apache-2.0
+library_name: vllm
+extra_gated_description: If you want to learn more about how we process your personal
+  data, please read our <a href="https://mistral.ai/terms/">Privacy Policy</a>.
+---
+
+# Model Card for Pixtral-12B-Base-2409
+
+The Pixtral-12B-Base-2409 is a Multimodal Model of 12B parameters plus a 400M parameter vision encoder.
+
+For more details about this model please refer to our release [blog post](https://mistral.ai/news/pixtral-12b/).
+
+Feel free to try it [here](https://chat.mistral.ai/chat)
+
+## Key features
+- Natively multimodal, trained with interleaved image and text data
+- 12B parameter Multimodal Decoder + 400M parameter Vision Encoder
+- Supports variable image sizes
+- Leading performance in its weight class on multimodal tasks
+- Maintains state-of-the-art performance on text-only benchmarks
+- Sequence length: 128k
+- License: Apache 2.0
+
+## Benchmarks
+
+TODO
+
+### Multimodal Benchmarks
+
+TODO
+
+### Instruction Following
+
+TODO
+
+### Text Benchmarks
+
+TODO
+
+### Comparison with Closed Source and Larger Models
+
+TODO
+
+## Usage Examples
+
+### vLLM (recommended)
+
+We recommend using Pixtral with the [vLLM library](https://github.com/vllm-project/vllm)
+to implement production-ready inference pipelines with Pixtral.
+
+**_Installation_**
+
+Make sure you install `vLLM >= v1.6.2`:
+
+```
+pip install --upgrade vllm
+```
+
+Also make sure you have `mistral_common >= 1.4.4` installed:
+
+```
+pip install --upgrade mistral_common
+```
+
+You can also make use of a ready-to-go [docker image](https://hub.docker.com/layers/vllm/vllm-openai/latest/images/sha256-de9032a92ffea7b5c007dad80b38fd44aac11eddc31c435f8e52f3b7404bbf39?context=explore).
+
+**_Example_**
+
+```py
+from vllm import LLM
+from vllm.sampling_params import SamplingParams
+
+model_name = "mistralai/Pixtral-12B-Base-2409"
+
+sampling_params = SamplingParams(max_tokens=8192)
+
+llm = LLM(model=model_name, tokenizer_mode="mistral")
+
+prompt = "Describe this image in one sentence."
+image_url = "https://picsum.photos/id/237/200/300"
+
+messages = [
+    {
+        "role": "user",
+        "content": [{"type": "text", "text": prompt}, {"type": "image_url", "image_url": {"url": image_url}}]
+    },
+]
+
+outputs = llm.chat(messages, sampling_params=sampling_params)
+
+print(outputs[0].outputs[0].text)
+```
+
+### Mistral-inference
+
+We recommend using [mistral-inference](https://github.com/mistralai/mistral-inference) to quickly try out / "vibe-check" Pixtral.
+
+
+**_Install_**
+
+Make sure to have `mistral_inference >= 1.4.1` installed.
+
+```
+pip install mistral_inference --upgrade
+```
+
+**_Download_**
+
+```py
+from huggingface_hub import snapshot_download
+from pathlib import Path
+
+mistral_models_path = Path.home().joinpath('mistral_models', 'Pixtral')
+mistral_models_path.mkdir(parents=True, exist_ok=True)
+
+snapshot_download(repo_id="mistralai/Pixtral-12B-Base-2409", allow_patterns=["params.json", "consolidated.safetensors", "tekken.json"], local_dir=mistral_models_path)
+```
+
+**_Python_**
+
+You can also run the model in a Python shell as follows.
+
+```py
+from mistral_inference.transformer import Transformer
+from mistral_inference.generate import generate
+
+from mistral_common.tokens.tokenizers.mistral import MistralTokenizer
+from mistral_common.protocol.instruct.messages import UserMessage, TextChunk, ImageURLChunk
+from mistral_common.protocol.instruct.request import CompletionRequest
+
+tokenizer = MistralTokenizer.from_file(f"{mistral_models_path}/tekken.json")
+model = Transformer.from_folder(mistral_models_path)
+
+url = "https://huggingface.co/datasets/patrickvonplaten/random_img/resolve/main/yosemite.png"
+prompt = "The above image presents a"
+
+completion_request = CompletionRequest(prompt=[UserMessage(content=[ImageURLChunk(image_url=url), TextChunk(text=prompt)])])
+
+encoded = tokenizer.encode_chat_completion(completion_request)
+
+images = encoded.images
+tokens = encoded.tokens
+
+out_tokens, _ = generate([tokens], model, images=[images], max_tokens=256, temperature=0.35, eos_id=tokenizer.instruct_tokenizer.tokenizer.eos_id)
+result = tokenizer.decode(out_tokens[0])
+
+print(result)
+```
+
+## Limitations
+
+The Pixtral model does not have any moderation mechanisms. We're looking forward to engaging with the community on ways to
+make the model finely respect guardrails, allowing for deployment in environments requiring moderated outputs.
+
+## The Mistral AI Team
+
+Albert Jiang, Alexandre Sablayrolles, Alexis Tacnet, Alok Kothari, Antoine Roux, Arthur Mensch, Audrey Herblin-Stoop, Augustin Garreau, Austin Birky, Bam4d, Baptiste Bout, Baudouin de Monicault, Blanche Savary, Carole Rambaud, Caroline Feldman, Devendra Singh Chaplot, Diego de las Casas, Diogo Costa, Eleonore Arcelin, Emma Bou Hanna, Etienne Metzger, Gaspard Blanchet, Gianna Lengyel, Guillaume Bour, Guillaume Lample, Harizo Rajaona, Henri Roussez, Hichem Sattouf, Ian Mack, Jean-Malo Delignon, Jessica Chudnovsky, Justus Murke, Kartik Khandelwal, Lawrence Stewart, Louis Martin, Louis Ternon, Lucile Saulnier, Lélio Renard Lavaud, Margaret Jennings, Marie Pellat, Marie Torelli, Marie-Anne Lachaux, Marjorie Janiewicz, Mickaël Seznec, Nicolas Schuhl, Niklas Muhs, Olivier de Garrigues, Patrick von Platen, Paul Jacob, Pauline Buche, Pavan Kumar Reddy, Perry Savas, Pierre Stock, Romain Sauvestre, Sagar Vaze, Sandeep Subramanian, Saurabh Garg, Sophia Yang, Szymon Antoniak, Teven Le Scao, Thibault Schueller, Thibaut Lavril, Thomas Wang, Théophile Gervet, Timothée Lacroix, Valera Nemychnikova, Wendy Shang, William El Sayed, William Marshall