Instructions to use vanta-research/scout-4b with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use vanta-research/scout-4b with Transformers:

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

pipe = pipeline("text-generation", model="vanta-research/scout-4b")
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)

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

processor = AutoProcessor.from_pretrained("vanta-research/scout-4b")
model = AutoModelForMultimodalLM.from_pretrained("vanta-research/scout-4b", device_map="auto")
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 = processor.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=256)
print(processor.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use vanta-research/scout-4b with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf vanta-research/scout-4b:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf vanta-research/scout-4b:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf vanta-research/scout-4b:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf vanta-research/scout-4b:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf vanta-research/scout-4b:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf vanta-research/scout-4b:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf vanta-research/scout-4b:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf vanta-research/scout-4b:Q4_K_M

Use Docker

docker model run hf.co/vanta-research/scout-4b:Q4_K_M

Llama new
LM Studio
Jan

vLLM

How to use vanta-research/scout-4b with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "vanta-research/scout-4b"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "vanta-research/scout-4b",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/vanta-research/scout-4b:Q4_K_M

SGLang

How to use vanta-research/scout-4b 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 "vanta-research/scout-4b" \
    --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": "vanta-research/scout-4b",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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 "vanta-research/scout-4b" \
        --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": "vanta-research/scout-4b",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use vanta-research/scout-4b with Ollama:
```
ollama run hf.co/vanta-research/scout-4b:Q4_K_M
```
Unsloth Desktop
Docker Model Runner
How to use vanta-research/scout-4b with Docker Model Runner:
```
docker model run hf.co/vanta-research/scout-4b:Q4_K_M
```

Lemonade

How to use vanta-research/scout-4b with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull vanta-research/scout-4b:Q4_K_M

Run and chat with the model

lemonade run user.scout-4b-Q4_K_M

List all available models

lemonade list

Atomic Chat

scout-4b / chat_template.jinja

unmodeled-tyler

Upload chat_template.jinja with huggingface_hub

231b552 verified 12 months ago

Raw History Blame Contribute Delete

1.53 kB

{{ bos_token }}
{%- if messages[0]['role'] == 'system' -%}
    {%- if messages[0]['content'] is string -%}
        {%- set first_user_prefix = messages[0]['content'] + '
' -%}
    {%- else -%}
        {%- set first_user_prefix = messages[0]['content'][0]['text'] + '
' -%}
    {%- endif -%}
    {%- set loop_messages = messages[1:] -%}
{%- else -%}
    {%- set first_user_prefix = "" -%}
    {%- set loop_messages = messages -%}
{%- endif -%}
{%- for message in loop_messages -%}
    {%- if (message['role'] == 'user') != (loop.index0 % 2 == 0) -%}
        {{ raise_exception("Conversation roles must alternate user/assistant/user/assistant/...") }}
    {%- endif -%}
    {%- if (message['role'] == 'assistant') -%}
        {%- set role = "model" -%}
    {%- else -%}
        {%- set role = message['role'] -%}
    {%- endif -%}
    {{ '<start_of_turn>' + role + '
' + (first_user_prefix if loop.first else "") }}
    {%- if message['content'] is string -%}
        {{ message['content'] | trim }}
    {%- elif message['content'] is iterable -%}
        {%- for item in message['content'] -%}
            {%- if item['type'] == 'image' -%}
                {{ '<start_of_image>' }}
            {%- elif item['type'] == 'text' -%}
                {{ item['text'] | trim }}
            {%- endif -%}
        {%- endfor -%}
    {%- else -%}
        {{ raise_exception("Invalid content type") }}
    {%- endif -%}
    {{ '<end_of_turn>
' }}
{%- endfor -%}
{%- if add_generation_prompt -%}
    {{'<start_of_turn>model
'}}
{%- endif -%}

	{{ bos_token }}
	{%- if messages[0]['role'] == 'system' -%}
	{%- if messages[0]['content'] is string -%}
	{%- set first_user_prefix = messages[0]['content'] + '

	' -%}
	{%- else -%}
	{%- set first_user_prefix = messages[0]['content'][0]['text'] + '

	' -%}
	{%- endif -%}
	{%- set loop_messages = messages[1:] -%}
	{%- else -%}
	{%- set first_user_prefix = "" -%}
	{%- set loop_messages = messages -%}
	{%- endif -%}
	{%- for message in loop_messages -%}
	{%- if (message['role'] == 'user') != (loop.index0 % 2 == 0) -%}
	{{ raise_exception("Conversation roles must alternate user/assistant/user/assistant/...") }}
	{%- endif -%}
	{%- if (message['role'] == 'assistant') -%}
	{%- set role = "model" -%}
	{%- else -%}
	{%- set role = message['role'] -%}
	{%- endif -%}
	{{ '<start_of_turn>' + role + '
	' + (first_user_prefix if loop.first else "") }}
	{%- if message['content'] is string -%}
	{{ message['content'] \| trim }}
	{%- elif message['content'] is iterable -%}
	{%- for item in message['content'] -%}
	{%- if item['type'] == 'image' -%}
	{{ '<start_of_image>' }}
	{%- elif item['type'] == 'text' -%}
	{{ item['text'] \| trim }}
	{%- endif -%}
	{%- endfor -%}
	{%- else -%}
	{{ raise_exception("Invalid content type") }}
	{%- endif -%}
	{{ '<end_of_turn>
	' }}
	{%- endfor -%}
	{%- if add_generation_prompt -%}
	{{'<start_of_turn>model
	'}}
	{%- endif -%}