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

Libraries

How to use microsoft/kosmos-2.5 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")

# pip install -U transformers accelerate
# Load model directly
from transformers import AutoImageProcessor, AutoModelForMultimodalLM

processor = AutoImageProcessor.from_pretrained("microsoft/kosmos-2.5")
model = AutoModelForMultimodalLM.from_pretrained("microsoft/kosmos-2.5", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

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

Use Docker

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

SGLang

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

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

estyle commited on May 13, 2024

Commit

8ceeda6

verified ·

1 Parent(s): c1681f1

Update README.md

Browse files

Files changed (1) hide show

README.md +5 -0

README.md CHANGED Viewed

@@ -13,6 +13,11 @@ Kosmos-2.5 is a multimodal literate model for machine reading of text-intensive
 [Kosmos-2.5: A Multimodal Literate Model](https://arxiv.org/abs/2309.11419)
 ## Citation
 If you find Kosmos-2.5 useful in your research, please cite the following paper:

 [Kosmos-2.5: A Multimodal Literate Model](https://arxiv.org/abs/2309.11419)
+## NOTE:
+- This is a research project and is limited for **research purposes only**.
+- Since this is a generative model, there is a risk of **hallucination** during the generation process, and it **CAN NOT** guarantee the accuracy of all OCR/Markdown results in the images.
 ## Citation
 If you find Kosmos-2.5 useful in your research, please cite the following paper: