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

Libraries

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

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

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

# Load model directly
from transformers import AutoProcessor, AutoModelForImageTextToText

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

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

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

Install from pip and serve model

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

Use Docker

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

SGLang

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

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

Leyo commited on Jul 12, 2023

Commit

6edaaa6

1 Parent(s): 51b1776

winoground fix

Browse files

Files changed (1) hide show

README.md +1 -1

README.md CHANGED Viewed

@@ -171,7 +171,7 @@ We perform checkpoint selection based on validation sets of TODO, and select the
 TODO: beautiful plots of shots scaling laws.
-| 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_score (image_score/text_score)) |
 |:-----------|--------:|---------------------:|---------------------:|-----------------------:|----------------------:|-------------------:|---------------:|-----------------:|-----------------:|------------------------:|-----------------:|-------------------------:|-----------------------:|--------------------------:|----------------------------------------------------:|
 | IDEFICS 80B |       0 |                 60   |                 45.2 |                   30.9 |                  36   |               56.8 |           91.8 |             65   |             53.7 |                    74.3 |             48.8 |                     60.6 |                   68.9 |                      60.5 |                                                   8 (18.8/22.5)|
 |            |       4 |                 63.4 |                 52.3 |                   34.7 |                  45.8 |               77.9 |          109.3 |            101.1 |             68.9 |                    -   |             48.6 |                     58.7 |                   66.3 |                      63.9 |                                                  - |

 TODO: beautiful plots of shots scaling laws.
+| 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)) |
 |:-----------|--------:|---------------------:|---------------------:|-----------------------:|----------------------:|-------------------:|---------------:|-----------------:|-----------------:|------------------------:|-----------------:|-------------------------:|-----------------------:|--------------------------:|----------------------------------------------------:|
 | IDEFICS 80B |       0 |                 60   |                 45.2 |                   30.9 |                  36   |               56.8 |           91.8 |             65   |             53.7 |                    74.3 |             48.8 |                     60.6 |                   68.9 |                      60.5 |                                                   8 (18.8/22.5)|
 |            |       4 |                 63.4 |                 52.3 |                   34.7 |                  45.8 |               77.9 |          109.3 |            101.1 |             68.9 |                    -   |             48.6 |                     58.7 |                   66.3 |                      63.9 |                                                  - |