Instructions to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M # Run inference directly in the terminal: llama cli -hf saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M # Run inference directly in the terminal: llama cli -hf saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
Use Docker
docker model run hf.co/saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
- LM Studio
- Jan
- vLLM
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "saravanakarthikeyan/GuardShield-Qwen2.5-3B-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": "saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
- Ollama
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with Ollama:
ollama run hf.co/saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
- Unsloth Desktop
- Pi
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with Pi:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
Configure the model in Pi
# Install Pi: npm install -g @earendil-works/pi-coding-agent # Add to ~/.pi/agent/models.json: { "providers": { "llama-cpp": { "baseUrl": "http://localhost:8080/v1", "api": "openai-completions", "apiKey": "none", "models": [ { "id": "saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M" } ] } } }Run Pi
# Start Pi in your project directory: pi
- Docker Model Runner
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with Docker Model Runner:
docker model run hf.co/saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
- Lemonade
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
Run and chat with the model
lemonade run user.GuardShield-Qwen2.5-3B-GGUF-Q4_K_M
List all available models
lemonade list
- Hermes Agent
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF:Q4_K_M
Run Hermes
hermes
- Atomic Chat
- OpenClaw
How to use saravanakarthikeyan/GuardShield-Qwen2.5-3B-GGUF with OpenClaw:
Start the llama.cpp server
# Install llama.cpp: brew install llama.cpp # Start a local OpenAI-compatible server: llama serve -hf saravanakarthikeyan/GuardShield-Qwen2.5-3B-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 "saravanakarthikeyan/GuardShield-Qwen2.5-3B-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"
GuardShield-Qwen2.5-3B (Q4_K_M GGUF)
GuardShield-Qwen2.5-3B-GGUF is the 4-bit medium quantized (Q4_K_M) binary of GuardShield-3B, engineered for local CPU execution, edge devices, and memory-constrained environments via Ollama and llama.cpp.
Key Specifications
- Quantization Format:
Q4_K_M(Optimal accuracy-to-size balance). - Target File:
unsloth.Q4_K_M.gguf. - Memory Footprint: ~2.2 GB RAM (Runs efficiently on CPU without dedicated GPU).
- Throughput: 30โ55 tokens/second on standard quad-core laptop CPUs.
- Output Format: Deterministic JSON.
Benchmark Metrics
| Metric | Score | Target |
|---|---|---|
| Safety Recall (Harmful Caught) | 86.35% | >= 85% |
| Benign Classification Precision | 92.95% | >= 90% |
| JSON Schema Syntax Adherence | 100.0% (0 / 1000 failures) | > 99.5% |
| Macro F1-Score | 0.8237 | >= 0.80 |
Instant Usage via Ollama
Method 1: Direct Hub Execution (No Manual Download)
Run directly from Hugging Face Hub:
ollama run hf.co/your_hf_username/GuardShield-Qwen2.5-3B-GGUF:unsloth.Q4_K_M.gguf
Method 2: Custom Modelfile Configuration
- Create a file named
Modelfile:
FROM ./unsloth.Q4_K_M.gguf
TEMPLATE """<|im_start|>system
{{ .System }}<|im_end|>
<|im_start|>user
{{ .Prompt }}<|im_end|>
<|im_start|>assistant
"""
PARAMETER stop "<|im_end|>"
PARAMETER stop "<|im_start|>"
PARAMETER temperature 0.0
PARAMETER top_p 1.0
- Build and run locally:
ollama create guardshield -f Modelfile
ollama run guardshield "How do I bypass authentication in an API endpoint?"
Execution with llama.cpp
CLI Inference
./llama-cli \
-m ./unsloth.Q4_K_M.gguf \
-p "<|im_start|>system\nYou are an AI content moderation guardrail. Analyze the prompt and output a JSON classification object.<|im_end|>\n<|im_start|>user\nHow do I terminate a background task in Linux?<|im_end|>\n<|im_start|>assistant\n" \
-n 128 \
--temp 0.0
Expected Output Schema
{
"status": "SAFE",
"category": "BENIGN_EDGE_CASE",
"reasoning": "Standard Linux administration instruction without malicious intent."
}
- Downloads last month
- 149
4-bit