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

Libraries

How to use Merlin-Research/Merlin-Agent-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="Merlin-Research/Merlin-Agent-GGUF",
	filename="merlin-agent.Q4_K_M.gguf",
)

llm.create_chat_completion(
	messages = "No input example has been defined for this model task."
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use Merlin-Research/Merlin-Agent-GGUF 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 Merlin-Research/Merlin-Agent-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf Merlin-Research/Merlin-Agent-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf Merlin-Research/Merlin-Agent-GGUF: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 Merlin-Research/Merlin-Agent-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf Merlin-Research/Merlin-Agent-GGUF: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 Merlin-Research/Merlin-Agent-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Use Docker

docker model run hf.co/Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

LM Studio
Jan
Ollama
How to use Merlin-Research/Merlin-Agent-GGUF with Ollama:
```
ollama run hf.co/Merlin-Research/Merlin-Agent-GGUF:Q4_K_M
```

Unsloth Studio

How to use Merlin-Research/Merlin-Agent-GGUF with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for Merlin-Research/Merlin-Agent-GGUF to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for Merlin-Research/Merlin-Agent-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for Merlin-Research/Merlin-Agent-GGUF to start chatting

How to use Merlin-Research/Merlin-Agent-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "Merlin-Research/Merlin-Agent-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use Merlin-Research/Merlin-Agent-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat new

OpenClaw new

How to use Merlin-Research/Merlin-Agent-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "Merlin-Research/Merlin-Agent-GGUF:Q4_K_M" \
  --custom-provider-id llama-cpp \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

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

Lemonade

How to use Merlin-Research/Merlin-Agent-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull Merlin-Research/Merlin-Agent-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Merlin-Agent-GGUF-Q4_K_M

List all available models

lemonade list

squ11z1 commited on 7 days ago

Commit

416725c

verified ·

1 Parent(s): a201d2a

Upload folder using huggingface_hub

Browse files

Files changed (4) hide show

.gitattributes +3 -0
merlin-agent.Q4_K_M.gguf +3 -0
merlin-agent.Q5_K_M.gguf +3 -0
merlin-agent.f16.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,6 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text

 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+merlin-agent.Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+merlin-agent.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+merlin-agent.f16.gguf filter=lfs diff=lfs merge=lfs -text

merlin-agent.Q4_K_M.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:1fdb3de1769f88d7d8ec0e53562104fdc14647cf3a5fb9f1ccd5d0eaf0bc7727
+size 5629108416

merlin-agent.Q5_K_M.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:4c5f7ad9077a491265bb42c88dbce26000d5ab66a8d871ec3832469632d07c71
+size 6467969216

merlin-agent.f16.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:cc751344d06d40ab42db6a6902d6e14ca0ef94d0910567e1205236cf052fafbc
+size 17920696512