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

Libraries

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

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

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

# Load model directly
from transformers import AutoProcessor, AutoModelForImageTextToText

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

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

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

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "HuggingFaceM4/idefics-9b"
# 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",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

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

SGLang

How to use HuggingFaceM4/idefics-9b 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" \
    --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",
		"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" \
        --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",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

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

ybelkada commited on Jul 25, 2023

Commit

f5f247a

1 Parent(s): 6abda9e

Update config.json

Browse files

Should make this checkpoint compatible with https://github.com/huggingface/transformers/pull/25092

Files changed (1) hide show

config.json +2 -0

config.json CHANGED Viewed

@@ -43,6 +43,8 @@
   "vision_image_size": 224,
   "vision_intermediate_size": 5120,
   "vision_patch_size": 14,
   "vision_model_name": "laion/CLIP-ViT-H-14-laion2B-s32B-b79K",
   "vision_model_params": "{\"id2label\":{}, \"label2id\":{}}",
   "vocab_size": 32000

   "vision_image_size": 224,
   "vision_intermediate_size": 5120,
   "vision_patch_size": 14,
+  "vision_num_attention_heads": 16,
+  "vision_num_hidden_layers": 32,
   "vision_model_name": "laion/CLIP-ViT-H-14-laion2B-s32B-b79K",
   "vision_model_params": "{\"id2label\":{}, \"label2id\":{}}",
   "vocab_size": 32000