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

Libraries

How to use HuggingFaceM4/idefics2-8b-base with Transformers:

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

pipe = pipeline("image-text-to-text", model="HuggingFaceM4/idefics2-8b-base")

# Load model directly
from transformers import AutoProcessor, AutoModelForImageTextToText

processor = AutoProcessor.from_pretrained("HuggingFaceM4/idefics2-8b-base")
model = AutoModelForImageTextToText.from_pretrained("HuggingFaceM4/idefics2-8b-base")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use HuggingFaceM4/idefics2-8b-base with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/HuggingFaceM4/idefics2-8b-base

SGLang

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

Docker Model Runner
How to use HuggingFaceM4/idefics2-8b-base with Docker Model Runner:
```
docker model run hf.co/HuggingFaceM4/idefics2-8b-base
```

VictorSanh commited on Apr 13, 2024

Commit

54c6ef4

verified ·

1 Parent(s): 1ed46b5

Update README.md

Browse files

Files changed (1) hide show

README.md +2 -10

README.md CHANGED Viewed

@@ -143,10 +143,6 @@ model = AutoModelForVision2Seq.from_pretrained(
     "HuggingFaceM4/idefics2-8b-base",
 ).to(DEVICE)
-BAD_WORDS_IDS = processor.tokenizer(["<image>", "<fake_token_around_image>"], add_special_tokens=False).input_ids
-EOS_WORDS_IDS = [processor.tokenizer.eos_token_id]
 # Create inputs
 prompts = [
   "<image>In this image, we can see the city of New York, and more specifically the Statue of Liberty.<image>In this image,",
@@ -158,7 +154,7 @@ inputs = {k: v.to(DEVICE) for k, v in inputs.items()}
 # Generate
-generated_ids = model.generate(**inputs, bad_words_ids=BAD_WORDS_IDS, eos_token_id=EOS_WORDS_IDS, max_new_tokens=500)
 generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)
 print(generated_texts)
@@ -176,10 +172,6 @@ model = AutoModelForVision2Seq.from_pretrained(
     "HuggingFaceM4/idefics2-8b",
 ).to(DEVICE)
-BAD_WORDS_IDS = processor.tokenizer(["<image>", "<fake_token_around_image>"], add_special_tokens=False).input_ids
-EOS_WORDS_IDS = processor.tokenizer("<end_of_utterance>", add_special_tokens=False).input_ids + [processor.tokenizer.eos_token_id]
 # Create inputs
 messages = [
     {
@@ -209,7 +201,7 @@ inputs = {k: v.to(DEVICE) for k, v in inputs.items()}
 # Generate
-generated_ids = model.generate(**inputs, bad_words_ids=BAD_WORDS_IDS, eos_token_id=EOS_WORDS_IDS, max_new_tokens=500)
 generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)
 print(generated_texts)

     "HuggingFaceM4/idefics2-8b-base",
 ).to(DEVICE)
 # Create inputs
 prompts = [
   "<image>In this image, we can see the city of New York, and more specifically the Statue of Liberty.<image>In this image,",
 # Generate
+generated_ids = model.generate(**inputs, max_new_tokens=500)
 generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)
 print(generated_texts)
     "HuggingFaceM4/idefics2-8b",
 ).to(DEVICE)
 # Create inputs
 messages = [
     {
 # Generate
+generated_ids = model.generate(**inputs, max_new_tokens=500)
 generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)
 print(generated_texts)