Instructions to use microsoft/kosmos-2.5-chat with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use microsoft/kosmos-2.5-chat with Transformers:

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

pipe = pipeline("image-text-to-text", model="microsoft/kosmos-2.5-chat")

# Load model directly
from transformers import AutoImageProcessor, AutoModelForImageTextToText

processor = AutoImageProcessor.from_pretrained("microsoft/kosmos-2.5-chat")
model = AutoModelForImageTextToText.from_pretrained("microsoft/kosmos-2.5-chat")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use microsoft/kosmos-2.5-chat with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/microsoft/kosmos-2.5-chat

SGLang

How to use microsoft/kosmos-2.5-chat 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 "microsoft/kosmos-2.5-chat" \
    --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": "microsoft/kosmos-2.5-chat",
		"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 "microsoft/kosmos-2.5-chat" \
        --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": "microsoft/kosmos-2.5-chat",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use microsoft/kosmos-2.5-chat with Docker Model Runner:
```
docker model run hf.co/microsoft/kosmos-2.5-chat
```

ydshieh commited on Aug 21, 2025

Commit

245a0c8

1 Parent(s): 685ba67

update after integration

Browse files

Files changed (1) hide show

chat.py +2 -1

chat.py CHANGED Viewed

@@ -15,7 +15,8 @@ model = Kosmos2_5ForConditionalGeneration.from_pretrained(repo,
 processor = AutoProcessor.from_pretrained(repo)
 # sample image
-url = "https://huggingface.co/microsoft/kosmos-2.5/blob/main/receipt_00008.png"
 image = Image.open(requests.get(url, stream=True).raw)
 question = "What is the sub total of the receipt?"

 processor = AutoProcessor.from_pretrained(repo)
 # sample image
+url = "https://huggingface.co/microsoft/kosmos-2.5/resolve/main/receipt_00008.png"
 image = Image.open(requests.get(url, stream=True).raw)
 question = "What is the sub total of the receipt?"