Instructions to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Notebooks
Google Colab
Kaggle
Local Apps Settings

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M

Use Docker

docker model run hf.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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": "ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M

Ollama
How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with Ollama:
```
ollama run hf.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M
```

Unsloth Studio

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF to start chatting

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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": "ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat new

OpenClaw new

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 "ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-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 ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with Docker Model Runner:
```
docker model run hf.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M
```

Lemonade

How to use ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.MiniCPM5-1B-Agentic-Tooluse-v3-GGUF-Q4_K_M

List all available models

lemonade list

ewinregirgojr commited on 2 days ago

Commit

d006253

verified ·

1 Parent(s): ed23be2

Fix table formatting: remove blank lines between rows throughout README

Browse files

Files changed (1) hide show

README.md +0 -51

README.md CHANGED Viewed

@@ -74,32 +74,18 @@ pipeline_tag: text-generation
 ---
 # MiniCPM5-1B-Agentic-Tooluse-v3-GGUF
 **GGUF quantizations of a 1B-parameter agentic tool-calling / function-calling model**, ready to run locally with [llama.cpp](https://github.com/ggerganov/llama.cpp), [Ollama](https://ollama.com/), [LM Studio](https://lmstudio.ai/), koboldcpp, text-generation-webui, or any other GGUF-compatible runtime — fully offline, private, and CPU-friendly.
 Searching for a **local function-calling model**, a **small LLM you can run on CPU or a phone**, a **GGUF model for AI agents**, or a **fast, private alternative to cloud-hosted function calling**? This is built specifically for that.
 ## Why this model
 MiniCPM5-1B-Agentic-Tooluse-v3 is a compact **1B-parameter** model fine-tuned specifically for agentic tool/function calling: it parses a tool schema plus a user request and reliably emits a structured, correctly-named, correctly-valued function call — the core capability behind LangChain agents, MCP servers, ReAct loops, home-automation assistants, and any app that needs an LLM to reliably drive external APIs and tools.
 Unlike most small open tool-calling models, this one went through a **two-stage pipeline**: QLoRA supervised fine-tuning followed by **GRPO reinforcement learning**, specifically rewarding exact function-name and exact argument-value correctness.
 ## Results
 Evaluated on a held-out 300-example test slice drawn from a **seeded shuffle** of ToolACE (see *Split integrity*).
@@ -165,27 +151,16 @@ directly across the two methodologies. See the *Results* section above for v3-er
   `</function>` tag with no trailing tokens. Use a parser that treats the first completed
   `<function>...</function>` block as the action boundary — do not rely on natural end-of-generation.
 ## Available quantizations
 | File | Quant | Size | Best for |
 |------|-------|------|----------|
 | `MiniCPM5-1B-Agentic-Tooluse-v3.F16.gguf`    | F16    | ~2.02 GB | Maximum quality, GPU or high-RAM CPU inference |
 | `MiniCPM5-1B-Agentic-Tooluse-v3.Q8_0.gguf`   | Q8_0   | ~1.07 GB | Near-lossless quality, recommended default for most users |
 | `MiniCPM5-1B-Agentic-Tooluse-v3.Q4_K_M.gguf` | Q4_K_M | ~656 MB  | Smallest, fastest — best for edge devices, phones, and CPU-only/low-RAM machines |
 ## Quickstart
 **llama.cpp:**
 ```bash
@@ -194,8 +169,6 @@ directly across the two methodologies. See the *Results* section above for v3-er
 ```
 **llama-server (OpenAI-compatible API, works with most agent frameworks):**
 ```bash
@@ -204,8 +177,6 @@ directly across the two methodologies. See the *Results* section above for v3-er
 ```
 **Ollama:**
 ```bash
@@ -220,16 +191,10 @@ ollama run minicpm5-tooluse-v3
 ```
 **LM Studio:** just download one of the `.gguf` files above directly through the LM Studio search/download UI.
 ## Ideal use cases
 - Fully local / offline / private AI agents (no data leaves your machine)
 - Home automation and smart-home voice assistants
@@ -242,37 +207,21 @@ ollama run minicpm5-tooluse-v3
 - Hobbyist and researcher experimentation with small-model agentic reasoning
 ## FAQ
 **Which quant should I use?** Q8_0 for the best quality-to-size tradeoff on most machines; Q4_K_M if you need the smallest possible footprint or are running on a phone/Raspberry Pi-class device; F16 if you have plenty of RAM/VRAM and want maximum fidelity.
 **Do I need a GPU?** No — that's the point of this model. All three quantizations run well on CPU; a GPU just makes it faster.
 **How was this trained?** QLoRA supervised fine-tuning on tool-calling trajectories, followed by GRPO (Group Relative Policy Optimization) reinforcement-learning refinement targeting exact argument correctness.
 ## Related repos
 - LoRA adapter (PEFT, smallest download, for fine-tuning further): [MiniCPM5-1B-Agentic-Tooluse-QLoRA-v3](https://huggingface.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-QLoRA-v3)
 - Merged full-weight FP16 build (for `transformers`/vLLM/SGLang serving): [MiniCPM5-1B-Agentic-Tooluse-v3-Merged-FP16](https://huggingface.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-Merged-FP16)
 ## Base model
 Built on [MiniCPM5-1B](https://huggingface.co/openbmb/MiniCPM5-1B) by OpenBMB, fine-tuned for agentic tool/function calling and refined with GRPO reinforcement learning.

 ---
 # MiniCPM5-1B-Agentic-Tooluse-v3-GGUF
 **GGUF quantizations of a 1B-parameter agentic tool-calling / function-calling model**, ready to run locally with [llama.cpp](https://github.com/ggerganov/llama.cpp), [Ollama](https://ollama.com/), [LM Studio](https://lmstudio.ai/), koboldcpp, text-generation-webui, or any other GGUF-compatible runtime — fully offline, private, and CPU-friendly.
 Searching for a **local function-calling model**, a **small LLM you can run on CPU or a phone**, a **GGUF model for AI agents**, or a **fast, private alternative to cloud-hosted function calling**? This is built specifically for that.
 ## Why this model
 MiniCPM5-1B-Agentic-Tooluse-v3 is a compact **1B-parameter** model fine-tuned specifically for agentic tool/function calling: it parses a tool schema plus a user request and reliably emits a structured, correctly-named, correctly-valued function call — the core capability behind LangChain agents, MCP servers, ReAct loops, home-automation assistants, and any app that needs an LLM to reliably drive external APIs and tools.
 Unlike most small open tool-calling models, this one went through a **two-stage pipeline**: QLoRA supervised fine-tuning followed by **GRPO reinforcement learning**, specifically rewarding exact function-name and exact argument-value correctness.
 ## Results
 Evaluated on a held-out 300-example test slice drawn from a **seeded shuffle** of ToolACE (see *Split integrity*).
   `</function>` tag with no trailing tokens. Use a parser that treats the first completed
   `<function>...</function>` block as the action boundary — do not rely on natural end-of-generation.
 ## Available quantizations
 | File | Quant | Size | Best for |
 |------|-------|------|----------|
 | `MiniCPM5-1B-Agentic-Tooluse-v3.F16.gguf`    | F16    | ~2.02 GB | Maximum quality, GPU or high-RAM CPU inference |
 | `MiniCPM5-1B-Agentic-Tooluse-v3.Q8_0.gguf`   | Q8_0   | ~1.07 GB | Near-lossless quality, recommended default for most users |
 | `MiniCPM5-1B-Agentic-Tooluse-v3.Q4_K_M.gguf` | Q4_K_M | ~656 MB  | Smallest, fastest — best for edge devices, phones, and CPU-only/low-RAM machines |
 ## Quickstart
 **llama.cpp:**
 ```bash
 ```
 **llama-server (OpenAI-compatible API, works with most agent frameworks):**
 ```bash
 ```
 **Ollama:**
 ```bash
 ```
 **LM Studio:** just download one of the `.gguf` files above directly through the LM Studio search/download UI.
 ## Ideal use cases
 - Fully local / offline / private AI agents (no data leaves your machine)
 - Home automation and smart-home voice assistants
 - Hobbyist and researcher experimentation with small-model agentic reasoning
 ## FAQ
 **Which quant should I use?** Q8_0 for the best quality-to-size tradeoff on most machines; Q4_K_M if you need the smallest possible footprint or are running on a phone/Raspberry Pi-class device; F16 if you have plenty of RAM/VRAM and want maximum fidelity.
 **Do I need a GPU?** No — that's the point of this model. All three quantizations run well on CPU; a GPU just makes it faster.
 **How was this trained?** QLoRA supervised fine-tuning on tool-calling trajectories, followed by GRPO (Group Relative Policy Optimization) reinforcement-learning refinement targeting exact argument correctness.
 ## Related repos
 - LoRA adapter (PEFT, smallest download, for fine-tuning further): [MiniCPM5-1B-Agentic-Tooluse-QLoRA-v3](https://huggingface.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-QLoRA-v3)
 - Merged full-weight FP16 build (for `transformers`/vLLM/SGLang serving): [MiniCPM5-1B-Agentic-Tooluse-v3-Merged-FP16](https://huggingface.co/ewinregirgojr/MiniCPM5-1B-Agentic-Tooluse-v3-Merged-FP16)
 ## Base model
 Built on [MiniCPM5-1B](https://huggingface.co/openbmb/MiniCPM5-1B) by OpenBMB, fine-tuned for agentic tool/function calling and refined with GRPO reinforcement learning.