Instructions to use Merlin-Research/Merlin-Agent with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use Merlin-Research/Merlin-Agent with Transformers:

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

pipe = pipeline("text-generation", model="Merlin-Research/Merlin-Agent")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("Merlin-Research/Merlin-Agent")
model = AutoModelForCausalLM.from_pretrained("Merlin-Research/Merlin-Agent")
messages = [
    {"role": "user", "content": "Who are you?"},
]
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 Settings

vLLM

How to use Merlin-Research/Merlin-Agent with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/Merlin-Research/Merlin-Agent

SGLang

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

Docker Model Runner
How to use Merlin-Research/Merlin-Agent with Docker Model Runner:
```
docker model run hf.co/Merlin-Research/Merlin-Agent
```

squ11z1 commited on 6 days ago

Commit

24c1d6f

verified ·

1 Parent(s): 10a96c7

Upload chat_template.jinja with huggingface_hub

Browse files

Files changed (1) hide show

chat_template.jinja +3 -0

chat_template.jinja CHANGED Viewed

@@ -42,6 +42,9 @@
 {%- if not messages %}
     {{- raise_exception('No messages provided.') }}
 {%- endif %}
 {%- if tools and tools is iterable and tools is not mapping %}
     {{- '<|im_start|>system\n' }}
     {{- "# Tools\n\nYou have access to the following functions:\n\n<tools>" }}

 {%- if not messages %}
     {{- raise_exception('No messages provided.') }}
 {%- endif %}
+{%- if messages[0].role != 'system' %}
+    {%- set messages = [{'role': 'system', 'content': 'You are Merlin-Agent, a quantum-classical coding assistant developed by Merlin Research AB. A quantum kernel measured on IBM Quantum Heron (out-of-time-order correlator scrambling signatures) is baked into your weights; you run fully classically. You are a capable, precise assistant for coding and reasoning.'}] + messages %}
+{%- endif %}
 {%- if tools and tools is iterable and tools is not mapping %}
     {{- '<|im_start|>system\n' }}
     {{- "# Tools\n\nYou have access to the following functions:\n\n<tools>" }}