Image-Text-to-Text
Transformers
Safetensors
Japanese
English
llama
text-generation
vision-language-model
vlm
llava
llava-onevision
japanese
siglip
llm-jp
finance
financial-qa
document-understanding
multimodal
reasoning
sft
dpo
lora
conversational
text-generation-inference
Instructions to use Yana/compass-vlm with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use Yana/compass-vlm with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("image-text-to-text", model="Yana/compass-vlm") 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 AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("Yana/compass-vlm") model = AutoModelForCausalLM.from_pretrained("Yana/compass-vlm") 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?"} ] }, ] inputs = tokenizer.apply_chat_template( messages, add_generation_prompt=True, tokenize=True, return_dict=True, return_tensors="pt", ).to(model.device) outputs = model.generate(**inputs, max_new_tokens=40) print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:])) - Notebooks
- Google Colab
- Kaggle
- Local Apps
- vLLM
How to use Yana/compass-vlm with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "Yana/compass-vlm" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "Yana/compass-vlm", "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/Yana/compass-vlm
- SGLang
How to use Yana/compass-vlm 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 "Yana/compass-vlm" \ --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": "Yana/compass-vlm", "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 "Yana/compass-vlm" \ --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": "Yana/compass-vlm", "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 Yana/compass-vlm with Docker Model Runner:
docker model run hf.co/Yana/compass-vlm
File size: 765 Bytes
47a171f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | {
"backend": "tokenizers",
"bos_token": "<|bos|>",
"clean_up_tokenization_spaces": false,
"cls_token": "<|cls|>",
"eod_token": "<|eod|>",
"eos_token": "<|eos|>",
"extra_ids": 0,
"extra_special_tokens": [
"<image>",
"</image>"
],
"is_local": true,
"mask_token": "<|mask|>",
"max_length": null,
"model_max_length": 1000000000000000019884624838656,
"model_specific_special_tokens": {
"eod_token": "<|eod|>"
},
"pad_to_multiple_of": null,
"pad_token": "<|pad|>",
"pad_token_type_id": 0,
"padding_side": "right",
"sep_token": "<|sep|>",
"sp_model_kwargs": {},
"stride": 0,
"tokenizer_class": "TokenizersBackend",
"truncation_side": "right",
"truncation_strategy": "longest_first",
"unk_token": "<|unk|>"
}
|