Instructions to use Zyphra/ZAYA1-VL-8B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use Zyphra/ZAYA1-VL-8B with Transformers:

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

pipe = pipeline("image-text-to-text", model="Zyphra/ZAYA1-VL-8B")
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 AutoModelForSeq2SeqLM
model = AutoModelForSeq2SeqLM.from_pretrained("Zyphra/ZAYA1-VL-8B", dtype="auto")

Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use Zyphra/ZAYA1-VL-8B with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "Zyphra/ZAYA1-VL-8B"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "Zyphra/ZAYA1-VL-8B",
		"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/Zyphra/ZAYA1-VL-8B

SGLang

How to use Zyphra/ZAYA1-VL-8B 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 "Zyphra/ZAYA1-VL-8B" \
    --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": "Zyphra/ZAYA1-VL-8B",
		"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 "Zyphra/ZAYA1-VL-8B" \
        --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": "Zyphra/ZAYA1-VL-8B",
		"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 Zyphra/ZAYA1-VL-8B with Docker Model Runner:
```
docker model run hf.co/Zyphra/ZAYA1-VL-8B
```

hassansh commited on 17 days ago

Commit

daa240d

verified ·

1 Parent(s): e9b74a6

Update README.md

Browse files

Files changed (1) hide show

README.md +5 -0

README.md CHANGED Viewed

@@ -53,6 +53,7 @@ TODO
 To use ZAYA1, install `zaya` branch from our fork of `transformers` library, which is based on the v4.57.1 of `transformers`:
 ```bash
 pip install "transformers @ git+https://github.com/Zyphra/transformers.git@zaya"
 ```
 The command above relies on requirements for `transformers v4.57.1` being installed in your environment. If you're installing in a fresh Python environment, you might want to specify a specific extra, like `[dev-torch]`, to install all the dependencies:
@@ -68,11 +69,15 @@ TODO
 ```python
 from transformers import Zaya1VLForConditionalGeneration, Zaya1VLProcessor
 import torch
 device = "cuda"
 processor = Zaya1VLProcessor.from_pretrained("Zyphra/ZAYA1-VL", temporal_patch_size=1)
 model = Zaya1VLForConditionalGeneration.from_pretrained("Zyphra/ZAYA1-VL", device_map=device, torch_dtype=torch.bfloat16, attn_implementation="flash_attention_2")
 question = "What do you see in the image? Give us some detail."
 add_special_tokens = True
 num_img_tokens = 8000

 To use ZAYA1, install `zaya` branch from our fork of `transformers` library, which is based on the v4.57.1 of `transformers`:
 ```bash
 pip install "transformers @ git+https://github.com/Zyphra/transformers.git@zaya"
+pip install qwen-vl-utils==0.0.2
 ```
 The command above relies on requirements for `transformers v4.57.1` being installed in your environment. If you're installing in a fresh Python environment, you might want to specify a specific extra, like `[dev-torch]`, to install all the dependencies:
 ```python
 from transformers import Zaya1VLForConditionalGeneration, Zaya1VLProcessor
 import torch
+from PIL import Image
+from qwen_vl_utils import process_vision_info
 device = "cuda"
 processor = Zaya1VLProcessor.from_pretrained("Zyphra/ZAYA1-VL", temporal_patch_size=1)
 model = Zaya1VLForConditionalGeneration.from_pretrained("Zyphra/ZAYA1-VL", device_map=device, torch_dtype=torch.bfloat16, attn_implementation="flash_attention_2")
+image = Image.open("image1.jpg")
 question = "What do you see in the image? Give us some detail."
 add_special_tokens = True
 num_img_tokens = 8000