Instructions to use vcruz305/Hy3-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- llama-cpp-python
How to use vcruz305/Hy3-GGUF with llama-cpp-python:
# !pip install llama-cpp-python from llama_cpp import Llama llm = Llama.from_pretrained( repo_id="vcruz305/Hy3-GGUF", filename="Hy3-IQ2_M/Hy3-IQ2_M-00001-of-00003.gguf", )
llm.create_chat_completion( messages = [ { "role": "user", "content": "What is the capital of France?" } ] ) - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use vcruz305/Hy3-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 vcruz305/Hy3-GGUF:Q4_K_M # Run inference directly in the terminal: llama cli -hf vcruz305/Hy3-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 vcruz305/Hy3-GGUF:Q4_K_M # Run inference directly in the terminal: llama cli -hf vcruz305/Hy3-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 vcruz305/Hy3-GGUF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf vcruz305/Hy3-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 vcruz305/Hy3-GGUF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf vcruz305/Hy3-GGUF:Q4_K_M
Use Docker
docker model run hf.co/vcruz305/Hy3-GGUF:Q4_K_M
- LM Studio
- Jan
- vLLM
How to use vcruz305/Hy3-GGUF with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "vcruz305/Hy3-GGUF" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/chat/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "vcruz305/Hy3-GGUF", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/vcruz305/Hy3-GGUF:Q4_K_M
- Ollama
How to use vcruz305/Hy3-GGUF with Ollama:
ollama run hf.co/vcruz305/Hy3-GGUF:Q4_K_M
- Unsloth Studio
How to use vcruz305/Hy3-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 vcruz305/Hy3-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 vcruz305/Hy3-GGUF to start chatting
Using HuggingFace Spaces for Unsloth
# No setup required # Open https://huggingface.co/spaces/unsloth/studio in your browser # Search for vcruz305/Hy3-GGUF to start chatting
- Pi
How to use vcruz305/Hy3-GGUF with Pi:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf vcruz305/Hy3-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": "vcruz305/Hy3-GGUF:Q4_K_M" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Hermes Agent new
How to use vcruz305/Hy3-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 vcruz305/Hy3-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 vcruz305/Hy3-GGUF:Q4_K_M
Run Hermes
hermes
- Atomic Chat new
- OpenClaw new
How to use vcruz305/Hy3-GGUF with OpenClaw:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf vcruz305/Hy3-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 "vcruz305/Hy3-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 vcruz305/Hy3-GGUF with Docker Model Runner:
docker model run hf.co/vcruz305/Hy3-GGUF:Q4_K_M
- Lemonade
How to use vcruz305/Hy3-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull vcruz305/Hy3-GGUF:Q4_K_M
Run and chat with the model
lemonade run user.Hy3-GGUF-Q4_K_M
List all available models
lemonade list
Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -54,11 +54,13 @@ On low-bit IQ tiers the MTP/NextN layer (`blk.80.*`) is kept at q8_0 (`--tensor-
|
|
| 54 |
|
| 55 |
Single node, fully GPU-resident, `-fa on`:
|
| 56 |
|
| 57 |
-
| Quant | Gen tok/s | Prompt tok/s |
|
| 58 |
-
|---|---|---|
|
| 59 |
-
| IQ2_M | 18.5 |
|
| 60 |
-
| Q2_K | 18.1 | 35.5 |
|
| 61 |
-
| IQ3_XXS | 17.1 | 32.4 |
|
|
|
|
|
|
|
| 62 |
|
| 63 |
Dual node (Q4_K_M, 181GB layer-split across 2× GB10 over 200GbE via llama.cpp RPC): **14.0 tok/s gen / 21.9 tok/s prompt**. RPC layer-split adds capacity for bigger quants, not speed — expect single-node-or-slower decode rates.
|
| 64 |
|
|
@@ -86,7 +88,34 @@ Tips:
|
|
| 86 |
|
| 87 |
## MTP / speculative decoding status
|
| 88 |
|
| 89 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 90 |
|
| 91 |
## Provenance
|
| 92 |
|
|
|
|
| 54 |
|
| 55 |
Single node, fully GPU-resident, `-fa on`:
|
| 56 |
|
| 57 |
+
| Quant | Gen tok/s | + MTP spec decode | Prompt tok/s |
|
| 58 |
+
|---|---|---|---|
|
| 59 |
+
| IQ2_M | 18.0–18.5 | **22.8 (+27%)** | 36–50 |
|
| 60 |
+
| Q2_K | 18.1 | untested | 35.5 |
|
| 61 |
+
| IQ3_XXS | 17.1 | untested | 32.4 |
|
| 62 |
+
|
| 63 |
+
MTP numbers measured at temp 0 with `--spec-type draft-mtp --spec-draft-n-max 2 --spec-draft-p-min 0.75` (90% draft acceptance). Higher sampling temperatures reduce acceptance and land between the two columns.
|
| 64 |
|
| 65 |
Dual node (Q4_K_M, 181GB layer-split across 2× GB10 over 200GbE via llama.cpp RPC): **14.0 tok/s gen / 21.9 tok/s prompt**. RPC layer-split adds capacity for bigger quants, not speed — expect single-node-or-slower decode rates.
|
| 66 |
|
|
|
|
| 88 |
|
| 89 |
## MTP / speculative decoding status
|
| 90 |
|
| 91 |
+
**Verified working (2026-07-07):** [PR #25395](https://github.com/ggml-org/llama.cpp/pull/25395) adds Hy3 MTP speculative decoding, and these GGUFs work with it as-is — the MTP tensors bundled in every quant (q8_0-preserved on low-bit tiers) are used directly as the `draft-mtp` target. Measured on IQ2_M: **18.0 → 22.8 tok/s (+27%), 90% draft acceptance**.
|
| 92 |
+
|
| 93 |
+
```bash
|
| 94 |
+
./build/bin/llama-server -m Hy3-IQ2_M/Hy3-IQ2_M-00001-of-00003.gguf \
|
| 95 |
+
-ngl 99 -fa on -c 32768 --jinja \
|
| 96 |
+
--spec-type draft-mtp --spec-draft-n-max 2 --spec-draft-p-min 0.75 \
|
| 97 |
+
--parallel 1
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
Notes:
|
| 101 |
+
- `--spec-draft-p-min 0.75` is **required for a speedup** — the MTP head is trained single-depth, and the default p_min makes speculation a net loss (per the PR author's measurements, confirmed here).
|
| 102 |
+
- `--parallel 1` is required for draft-mtp; `n_max` 2 and 3 measure within ~1% of each other (n=2 slightly ahead at 90% acceptance).
|
| 103 |
+
- `--spec-type` exists on `llama-server` and `llama-cli` only, not `llama-completion`.
|
| 104 |
+
|
| 105 |
+
### ⚠️ If you downloaded before 2026-07-08: arch string fix
|
| 106 |
+
|
| 107 |
+
PR #25395 renamed the architecture string from `hy-v3` (the earlier PR #25364) to `hy_v3`. All first-shards in this repo were re-uploaded with the fix on 2026-07-07, so fresh downloads just work. If you hold older files and see `unknown model architecture: 'hy-v3'`, either re-download the first shard of your quant, or patch in place (the string lives only in shard 00001's header; byte-for-byte same length):
|
| 108 |
+
|
| 109 |
+
```python
|
| 110 |
+
# python patch_arch.py <your-first-shard.gguf> — swaps hy-v3 -> hy_v3 in the header
|
| 111 |
+
import mmap, sys
|
| 112 |
+
with open(sys.argv[1], "r+b") as f:
|
| 113 |
+
mm = mmap.mmap(f.fileno(), 64 * 1024 * 1024) # metadata lives well within 64MB
|
| 114 |
+
i = mm.find(b"hy-v3")
|
| 115 |
+
while i != -1:
|
| 116 |
+
mm[i:i+5] = b"hy_v3"; i = mm.find(b"hy-v3", i + 1)
|
| 117 |
+
mm.flush()
|
| 118 |
+
```
|
| 119 |
|
| 120 |
## Provenance
|
| 121 |
|