Instructions to use NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M

Use Docker

docker model run hf.co/NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use NANI-Nithin/MiniCPM5-1B-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M

Ollama
How to use NANI-Nithin/MiniCPM5-1B-GGUF with Ollama:
```
ollama run hf.co/NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M
```
Unsloth Desktop

How to use NANI-Nithin/MiniCPM5-1B-GGUF with Pi:

Start the llama.cpp server

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

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use NANI-Nithin/MiniCPM5-1B-GGUF with Docker Model Runner:
```
docker model run hf.co/NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M
```

Lemonade

How to use NANI-Nithin/MiniCPM5-1B-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.MiniCPM5-1B-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-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 NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use NANI-Nithin/MiniCPM5-1B-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf NANI-Nithin/MiniCPM5-1B-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 "NANI-Nithin/MiniCPM5-1B-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"

NANI-Nithin commited on 5 days ago

Commit

593c362

verified ·

1 Parent(s): d38da3f

Upload README.md with huggingface_hub

Browse files

Files changed (1) hide show

README.md +68 -220

README.md CHANGED Viewed

@@ -1,234 +1,82 @@
 ---
-language:
-- en
-license: apache-2.0
-library_name: llama.cpp
-tags:
-- gguf
-- llama.cpp
-- minicpm
-- minicpm5
-- quantized
-- text-generation
-- chat
-- reasoning
-- tool-calling
-- instruct
-base_model:
-- openbmb/MiniCPM5-1B
 pipeline_tag: text-generation
 ---
-# MiniCPM5-1B-GGUF
-GGUF quantizations of **openbmb/MiniCPM5-1B** for use with **llama.cpp**, **Ollama**, **LM Studio**, **Jan**, **OpenWebUI**, **llama-cpp-python**, and other GGUF-compatible runtimes.
-## Base Model
-**Base Model:** [`openbmb/MiniCPM5-1B`](https://huggingface.co/openbmb/MiniCPM5-1B)
-MiniCPM5-1B is a compact 1B-parameter language model from OpenBMB focused on:
-- General chat
-- Reasoning
-- Coding assistance
-- Tool calling
-- Long-context workloads
-- Edge and local deployment
-This repository contains community-generated GGUF conversions and quantizations derived from the original BF16 checkpoint.
----
-# Available Files
-## Full Precision
-| File | Description |
-|--------|--------|
-| MiniCPM5-1B-BF16.gguf | BF16 GGUF conversion of the original checkpoint |
-## Standard Quantizations
-| Quant | Recommended Usage |
-|---------|---------|
-| Q2_K | Smallest footprint |
-| Q3_K_S | Extreme memory savings |
-| Q3_K_M | Low memory systems |
-| Q3_K_L | Better quality than Q3_K_M |
-| Q4_0 | Legacy quant |
-| Q4_1 | Legacy quant |
-| Q4_K_S | Balanced |
-| Q4_K_M | Recommended general-purpose quant |
-| Q5_K_S | Higher quality |
-| Q5_K_M | Near-lossless experience |
-| Q6_K | Very high quality |
-| Q8_0 | Maximum quality quantized version |
-## Importance Matrix (IQ) Quantizations
-Generated using llama.cpp importance matrix quantization.
-| Quant | Recommended Usage |
-|---------|---------|
-| IQ2_M | Smallest IQ variant |
-| IQ3_XXS | Ultra compact |
-| IQ3_XS | Compact |
-| IQ3_M | Strong quality-to-size ratio |
-| IQ4_XS | High quality compact quant |
-| IQ4_NL | Best IQ variant in this repository |
----
-# Recommended Quant
-If you are unsure which file to choose:
-### Most Users
-```text
-MiniCPM5-1B-Q4_K_M.gguf
-```
-Best balance between:
-- Quality
-- Speed
-- Memory usage
-- Compatibility
-### Higher Quality
-```text
-MiniCPM5-1B-Q5_K_M.gguf
-```
-or
-```text
-MiniCPM5-1B-Q6_K.gguf
-```
-### Maximum Quality
-```text
-MiniCPM5-1B-Q8_0.gguf
-```
-### Best IQ Quant
-```text
-MiniCPM5-1B-IQ4_NL.gguf
-```
----
-# Example Usage
-## llama.cpp
 ```bash
-llama-cli \
-    -m MiniCPM5-1B-Q4_K_M.gguf \
-    -ngl 99 \
-    -c 8192
 ```
-## llama-server
 ```bash
-llama-server \
-    -m MiniCPM5-1B-Q4_K_M.gguf \
-    -c 8192 \
-    -ngl 99
 ```
-## Ollama
-Create a Modelfile:
-```text
-FROM MiniCPM5-1B-Q4_K_M.gguf
-```
-Then:
-```bash
-ollama create minicpm5-1b -f Modelfile
-ollama run minicpm5-1b
-```
-## Python
-```python
-from llama_cpp import Llama
-llm = Llama(
-    model_path="MiniCPM5-1B-Q4_K_M.gguf",
-    n_ctx=8192,
-    n_gpu_layers=-1,
-)
-print(
-    llm(
-        "Explain quantum computing in simple terms.",
-        max_tokens=256
-    )
-)
-```
----
-# Conversion Details
-Conversion pipeline:
-1. Download original Hugging Face model.
-2. Convert to BF16 GGUF using llama.cpp.
-3. Generate importance matrix for IQ quantization.
-4. Generate standard GGUF quantizations.
-5. Generate IQ quantizations.
-6. Upload all artifacts to Hugging Face.
-Tools used:
-- llama.cpp
-- convert_hf_to_gguf.py
-- llama-quantize
-- llama-imatrix
----
-# Hardware Guidance
-| Quant | Approximate Use Case |
-|---------|---------|
-| Q2_K | Very constrained devices |
-| Q3_* | Raspberry Pi / older CPUs |
-| Q4_K_M | Most laptops and desktops |
-| Q5_K_M | Modern systems |
-| Q6_K | High-end CPUs and GPUs |
-| Q8_0 | Largest RAM footprint |
 ---
-# Disclaimer
-This repository is a community conversion of the original model and is not an official OpenBMB release.
-All model weights, architecture, training methodology, and evaluation results belong to the original authors of MiniCPM5-1B.
-If you use this model in research or production environments, please cite and credit the original MiniCPM team.
----
-# Credits
-- OpenBMB for creating MiniCPM5-1B
-- ggml-org for llama.cpp
-- Hugging Face for model hosting
-- Community contributors supporting GGUF deployment
-Original model:
-https://huggingface.co/openbmb/MiniCPM5-1B

 ---
+base_model: openbmb/MiniCPM5-1B
+library_name: gguf
 pipeline_tag: text-generation
+tags:
+  - gguf
+  - llama.cpp
+  - quantized
+  - imatrix
 ---
+# MiniCPM5-1B GGUF
+GGUF quantizations of [openbmb/MiniCPM5-1B](https://huggingface.co/openbmb/MiniCPM5-1B), covering 30 files (18.1 GB total).
+## Files
+| File | Quant | Size | Notes |
+|---|---|---:|---|
+| [MiniCPM5-1B-BF16.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-BF16.gguf) | `BF16` | 2.02 GB | Full precision source. Every quant below is cut from this file. |
+| [MiniCPM5-1B-Q8_0.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q8_0.gguf) | `Q8_0` | 1.07 GB | Effectively lossless. Use when disk and RAM are not the constraint. |
+| [MiniCPM5-1B-Q6_K.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q6_K.gguf) | `Q6_K` | 0.83 GB | Near-lossless; the last stop before quality becomes measurable. |
+| [MiniCPM5-1B-Q5_K_M.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q5_K_M.gguf) | `Q5_K_M` | 0.73 GB | Very good quality, noticeably smaller than Q6_K. |
+| [MiniCPM5-1B-Q5_K_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q5_K_S.gguf) | `Q5_K_S` | 0.72 GB | Slightly smaller than Q5_K_M for a slight quality cost. |
+| [MiniCPM5-1B-Q5_1.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q5_1.gguf) | `Q5_1` | 0.77 GB | Legacy. Prefer Q5_K_M. |
+| [MiniCPM5-1B-Q5_0.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q5_0.gguf) | `Q5_0` | 0.72 GB | Legacy. Prefer Q5_K_M. |
+| [MiniCPM5-1B-Q4_K_M.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q4_K_M.gguf) | `Q4_K_M` | 0.64 GB | The usual default. Best quality-per-byte for most people. |
+| [MiniCPM5-1B-Q4_K_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q4_K_S.gguf) | `Q4_K_S` | 0.62 GB | A little smaller than Q4_K_M, a little worse. |
+| [MiniCPM5-1B-IQ4_NL.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ4_NL.gguf) | `IQ4_NL` | 0.62 GB | Non-linear 4-bit; good on hardware without fast K-quant kernels. |
+| [MiniCPM5-1B-IQ4_XS.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ4_XS.gguf) | `IQ4_XS` | 0.60 GB | Best sub-4.5bpw option; usually beats Q4_K_S at a smaller size. |
+| [MiniCPM5-1B-Q4_1.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q4_1.gguf) | `Q4_1` | 0.67 GB | Legacy. Prefer Q4_K_M. |
+| [MiniCPM5-1B-Q4_0.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q4_0.gguf) | `Q4_0` | 0.62 GB | Legacy round-to-nearest. Prefer Q4_K_M unless a runtime needs this. |
+| [MiniCPM5-1B-Q3_K_L.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q3_K_L.gguf) | `Q3_K_L` | 0.57 GB | Small, with real quality loss. Usable when RAM is tight. |
+| [MiniCPM5-1B-Q3_K_M.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q3_K_M.gguf) | `Q3_K_M` | 0.54 GB | Smaller again; noticeable degradation. |
+| [MiniCPM5-1B-IQ3_M.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ3_M.gguf) | `IQ3_M` | 0.52 GB | Strong at ~3.7bpw, clearly better than Q3_K_M. |
+| [MiniCPM5-1B-IQ3_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ3_S.gguf) | `IQ3_S` | 0.51 GB | Slightly smaller than IQ3_M. |
+| [MiniCPM5-1B-Q3_K_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q3_K_S.gguf) | `Q3_K_S` | 0.51 GB | Aggressive. Prefer IQ3_M at a similar size. |
+| [MiniCPM5-1B-IQ3_XS.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ3_XS.gguf) | `IQ3_XS` | 0.50 GB | Aggressive but coherent. |
+| [MiniCPM5-1B-IQ3_XXS.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ3_XXS.gguf) | `IQ3_XXS` | 0.46 GB | Very aggressive; imatrix carries it. |
+| [MiniCPM5-1B-Q2_K.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q2_K.gguf) | `Q2_K` | 0.45 GB | Very small, heavily degraded. For experimentation. |
+| [MiniCPM5-1B-IQ2_M.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ2_M.gguf) | `IQ2_M` | 0.43 GB | The smallest size most people find usable. |
+| [MiniCPM5-1B-Q2_K_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q2_K_S.gguf) | `Q2_K_S` | 0.43 GB | Smaller than Q2_K, requires the imatrix. |
+| [MiniCPM5-1B-IQ2_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ2_S.gguf) | `IQ2_S` | 0.41 GB | Below the usual usability line. |
+| [MiniCPM5-1B-IQ2_XS.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ2_XS.gguf) | `IQ2_XS` | 0.38 GB | Experimental. |
+| [MiniCPM5-1B-IQ2_XXS.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ2_XXS.gguf) | `IQ2_XXS` | 0.36 GB | Experimental. |
+| [MiniCPM5-1B-Q2_0.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q2_0.gguf) | `Q2_0` | 0.44 GB | Extreme, group-64. Included for completeness. |
+| [MiniCPM5-1B-IQ1_M.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ1_M.gguf) | `IQ1_M` | 0.34 GB | Extreme. Expect substantial degradation. |
+| [MiniCPM5-1B-IQ1_S.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-IQ1_S.gguf) | `IQ1_S` | 0.33 GB | Extreme. Expect substantial degradation. |
+| [MiniCPM5-1B-Q1_0.gguf](https://huggingface.co/NANI-Nithin/MiniCPM5-1B-GGUF/blob/main/MiniCPM5-1B-Q1_0.gguf) | `Q1_0` | 0.27 GB | Extreme. Included for completeness. |
+## Which one should I download?
+Pick the largest file that leaves a couple of gigabytes of headroom on the device you will run it on — the model has to fit in RAM (or VRAM, if you are offloading) alongside the KV cache and the OS.
+- Plenty of memory: **Q6_K** or **Q8_0**.
+- The usual choice: **Q4_K_M**.
+- Tight on memory: **IQ4_XS**, then **IQ3_M**, then **IQ2_M**.
+- The `IQ*` files are imatrix-guided and generally beat a `Q*` file of similar size, at the cost of slightly slower inference on some hardware.
+## Quantization details
+- Importance matrix computed with `llama-imatrix` over 500 rows of [Salesforce/wikitext](https://huggingface.co/datasets/Salesforce/wikitext) (`wikitext-2-raw-v1`).
+- The matrix was computed on the **BF16** weights.
+- K-quants below 6 bit and the whole `IQ` set are imatrix-guided. `Q4_0`/`Q4_1`/`Q5_0`/`Q5_1` are legacy round-to-nearest and ignore it; `Q6_K`/`Q8_0` are near-lossless and do not need it.
+- All files are cut from the same BF16 GGUF, so differences between them are quantization only.
+## Usage
 ```bash
+llama-cli -hf NANI-Nithin/MiniCPM5-1B-GGUF:Q4_K_M -p "Hello"
 ```
+Or download one file and point at it directly:
 ```bash
+huggingface-cli download NANI-Nithin/MiniCPM5-1B-GGUF MiniCPM5-1B-Q4_K_M.gguf --local-dir .
+llama-cli -m MiniCPM5-1B-Q4_K_M.gguf -p "Hello"
 ```
 ---
+Quantized with [llama.cpp](https://github.com/ggml-org/llama.cpp) by AgentQuantix on 2026-09-04. Licensing follows the base model.