Instructions to use HuggingFaceM4/idefics-9b-instruct with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use HuggingFaceM4/idefics-9b-instruct with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="HuggingFaceM4/idefics-9b-instruct")

# Load model directly
from transformers import AutoProcessor, AutoModelForImageTextToText

processor = AutoProcessor.from_pretrained("HuggingFaceM4/idefics-9b-instruct")
model = AutoModelForImageTextToText.from_pretrained("HuggingFaceM4/idefics-9b-instruct")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use HuggingFaceM4/idefics-9b-instruct with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "HuggingFaceM4/idefics-9b-instruct"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "HuggingFaceM4/idefics-9b-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/HuggingFaceM4/idefics-9b-instruct

SGLang

How to use HuggingFaceM4/idefics-9b-instruct with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "HuggingFaceM4/idefics-9b-instruct" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "HuggingFaceM4/idefics-9b-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "HuggingFaceM4/idefics-9b-instruct" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "HuggingFaceM4/idefics-9b-instruct",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use HuggingFaceM4/idefics-9b-instruct with Docker Model Runner:
```
docker model run hf.co/HuggingFaceM4/idefics-9b-instruct
```

VictorSanh commited on Jul 31, 2023

Commit

4b3cca8

1 Parent(s): b99c897

add the new instruct model

Browse files

Files changed (5) hide show

added_tokens.json +1 -0
pytorch_model-00001-of-00002.bin +2 -2
pytorch_model-00002-of-00002.bin +2 -2
pytorch_model.bin.index.json +1 -1
special_tokens_map.json +7 -0

added_tokens.json CHANGED Viewed

@@ -1,4 +1,5 @@
 {
   "<fake_token_around_image>": 32000,
   "<image>": 32001
 }

 {
+  "<end_of_utterance>": 32002,
   "<fake_token_around_image>": 32000,
   "<image>": 32001
 }

pytorch_model-00001-of-00002.bin CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:aa56e10990afb6b882003571f094c95e37fae5471c4d8a318c7368644261ecb5
-size 9971911147

 version https://git-lfs.github.com/spec/v1
+oid sha256:ca3ed0da9957263e4f02b99828156f20f0ccb4d1fb59c2c0658188b51dbaf3a6
+size 9971919339

pytorch_model-00002-of-00002.bin CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:4de33759f4bbb32b1c56bd7d891ab0966380e55d6a830afc87cc136a8e60513b
-size 7887831155

 version https://git-lfs.github.com/spec/v1
+oid sha256:43ae92a7323df858911062a06d73f7cb55701cefd5621de8f26979f3a6497494
+size 7887839347

pytorch_model.bin.index.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "metadata": {
-    "total_size": 17859371560
   },
   "weight_map": {
     "lm_head.additional_fc.weight": "pytorch_model-00002-of-00002.bin",

 {
   "metadata": {
+    "total_size": 17859387944
   },
   "weight_map": {
     "lm_head.additional_fc.weight": "pytorch_model-00002-of-00002.bin",

special_tokens_map.json CHANGED Viewed

@@ -13,6 +13,13 @@
       "normalized": true,
       "rstrip": false,
       "single_word": false
     }
   ],
   "bos_token": {

       "normalized": true,
       "rstrip": false,
       "single_word": false
+    },
+    {
+      "content": "<end_of_utterance>",
+      "lstrip": false,
+      "normalized": true,
+      "rstrip": false,
+      "single_word": false
     }
   ],
   "bos_token": {