Instructions to use Yuanze/Olympus with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use Yuanze/Olympus with Transformers:

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

pipe = pipeline("image-text-to-text", model="Yuanze/Olympus")
messages = [
    {
        "role": "user",
        "content": [
            {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"},
            {"type": "text", "text": "What animal is on the candy?"}
        ]
    },
]
pipe(text=messages)

# Load model directly
from transformers import AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained("Yuanze/Olympus", dtype="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use Yuanze/Olympus with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "Yuanze/Olympus"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Yuanze/Olympus",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker

docker model run hf.co/Yuanze/Olympus

SGLang

How to use Yuanze/Olympus 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 "Yuanze/Olympus" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Yuanze/Olympus",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

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 "Yuanze/Olympus" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Yuanze/Olympus",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Docker Model Runner
How to use Yuanze/Olympus with Docker Model Runner:
```
docker model run hf.co/Yuanze/Olympus
```

nielsr HF Staff commited on Apr 3, 2025

Commit

f30d469

verified ·

1 Parent(s): 7827d02

Improve model card: Add Github link, and update pipeline tag

Browse files

This PR adds:

- A Github link, so people can find your code.
- A `pipeline_tag`, ensuring people can find your model at https://huggingface.co/models?pipeline_tag=image-text-to-text.

Files changed (1) hide show

README.md +8 -5

README.md CHANGED Viewed

@@ -1,13 +1,13 @@
 ---
-license: apache-2.0
 datasets:
 - liuhaotian/LLaVA-Instruct-150K
 language:
 - en
-base_model:
-- zhumj34/Mipha-3B
-pipeline_tag: image-text-to-text
 library_name: transformers
 tags:
 - transformers
 - llm
@@ -15,9 +15,10 @@ tags:
 - conversational
 - olympus
 - llava
-- text-generation
 - vision-language
 ---
 <p align="center">
   <img src="https://github.com/yuanze-lin/Olympus/blob/main/asset/olympus.png?raw=true" alt="icon" width="150" height="150" style="vertical-align:middle; margin-right:5px;" />
 </p>
@@ -162,6 +163,8 @@ bash scripts/mipha/eval/vqav2.sh
   <img src="https://github.com/yuanze-lin/Olympus/blob/main/asset/application.png?raw=true" alt="Capacity" width="1000" height="100"/>
 </p>
 ## Citation
 If you find Olympus useful for your research and applications, please cite using this BibTeX:

 ---
+base_model:
+- zhumj34/Mipha-3B
 datasets:
 - liuhaotian/LLaVA-Instruct-150K
 language:
 - en
 library_name: transformers
+license: apache-2.0
+pipeline_tag: image-text-to-text
 tags:
 - transformers
 - llm
 - conversational
 - olympus
 - llava
+- image-text-to-text
 - vision-language
 ---
 <p align="center">
   <img src="https://github.com/yuanze-lin/Olympus/blob/main/asset/olympus.png?raw=true" alt="icon" width="150" height="150" style="vertical-align:middle; margin-right:5px;" />
 </p>
   <img src="https://github.com/yuanze-lin/Olympus/blob/main/asset/application.png?raw=true" alt="Capacity" width="1000" height="100"/>
 </p>
+You can find the code repository at: https://github.com/yuanze-lin/Olympus
 ## Citation
 If you find Olympus useful for your research and applications, please cite using this BibTeX: