Instructions to use inclusionAI/ZwZ-2B-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use inclusionAI/ZwZ-2B-GGUF with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("image-text-to-text", model="inclusionAI/ZwZ-2B-GGUF")
messages = [
    {
        "role": "user",
        "content": [
            {"type": "image", "url": "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/p-blog/candy.JPG"},
            {"type": "text", "text": "What animal is on the candy?"}
        ]
    },
]
pipe(text=messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("inclusionAI/ZwZ-2B-GGUF", dtype="auto")

llama-cpp-python

How to use inclusionAI/ZwZ-2B-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="inclusionAI/ZwZ-2B-GGUF",
	filename="ZwZ-2B-F16.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": [
				{
					"type": "text",
					"text": "Describe this image in one sentence."
				},
				{
					"type": "image_url",
					"image_url": {
						"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
					}
				}
			]
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf inclusionAI/ZwZ-2B-GGUF:Q4_K_M

Use Docker

docker model run hf.co/inclusionAI/ZwZ-2B-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use inclusionAI/ZwZ-2B-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "inclusionAI/ZwZ-2B-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": "inclusionAI/ZwZ-2B-GGUF",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker

docker model run hf.co/inclusionAI/ZwZ-2B-GGUF:Q4_K_M

SGLang

How to use inclusionAI/ZwZ-2B-GGUF with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "inclusionAI/ZwZ-2B-GGUF" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "inclusionAI/ZwZ-2B-GGUF",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "inclusionAI/ZwZ-2B-GGUF" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "inclusionAI/ZwZ-2B-GGUF",
		"messages": [
			{
				"role": "user",
				"content": [
					{
						"type": "text",
						"text": "Describe this image in one sentence."
					},
					{
						"type": "image_url",
						"image_url": {
							"url": "https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg"
						}
					}
				]
			}
		]
	}'

Ollama
How to use inclusionAI/ZwZ-2B-GGUF with Ollama:
```
ollama run hf.co/inclusionAI/ZwZ-2B-GGUF:Q4_K_M
```

Unsloth Studio

How to use inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for inclusionAI/ZwZ-2B-GGUF to start chatting

How to use inclusionAI/ZwZ-2B-GGUF with Pi:

Start the llama.cpp server

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

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-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 inclusionAI/ZwZ-2B-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat new
Docker Model Runner
How to use inclusionAI/ZwZ-2B-GGUF with Docker Model Runner:
```
docker model run hf.co/inclusionAI/ZwZ-2B-GGUF:Q4_K_M
```

Lemonade

How to use inclusionAI/ZwZ-2B-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull inclusionAI/ZwZ-2B-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.ZwZ-2B-GGUF-Q4_K_M

List all available models

lemonade list

langdaohlb commited on Mar 5

Commit

da058f7

verified ·

1 Parent(s): e6e5075

Add ZwZ-2B-GGUF model weights

Browse files

Files changed (8) hide show

.gitattributes +6 -0
REDME.md +10 -0
ZwZ-2B-F16.gguf +3 -0
ZwZ-2B-Q4_K_M.gguf +3 -0
ZwZ-2B-Q8_0.gguf +3 -0
mmproj-ZwZ-2B-F16.gguf +3 -0
mmproj-ZwZ-2B-Q4_K_M.gguf +3 -0
mmproj-ZwZ-2B-Q8_0.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,9 @@ 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
+ZwZ-2B-F16.gguf filter=lfs diff=lfs merge=lfs -text
+ZwZ-2B-Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+ZwZ-2B-Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+mmproj-ZwZ-2B-F16.gguf filter=lfs diff=lfs merge=lfs -text
+mmproj-ZwZ-2B-Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+mmproj-ZwZ-2B-Q8_0.gguf filter=lfs diff=lfs merge=lfs -text

REDME.md ADDED Viewed

	@@ -0,0 +1,10 @@

+**ZwZ-2B-GGUF**
+This repository provides GGUF-format weights for [ZwZ-2B](https://huggingface.co/inclusionAI/ZwZ-2B), split into two components:
+ - Language model (LLM): FP16, Q8_0, Q4_K_M
+ - Vision encoder (mmproj): FP16, Q8_0, Q4_K_M
+These files are compatible with llama.cpp, Ollama, and other GGUF-based tools, supporting inference on CPU, NVIDIA GPU (CUDA), Apple Silicon (Metal), Intel GPUs (SYCL), and more. You can mix precision levels for the language and vision components based on your hardware and performance needs, and even perform custom quantization starting from the FP16 weights.
+Enjoy running this multimodal model on your personal device! 🚀

ZwZ-2B-F16.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:2aa2db0e35a67a37e4c695a9310ff3d53e0dbbfe2082e411a6a5561e32301434
+size 4069680064

ZwZ-2B-Q4_K_M.gguf ADDED Viewed

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

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

ZwZ-2B-Q8_0.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:335b075e96966003832826fb17dffb17b179af9c9efcdbb318fe6578675d35e9
+size 2165040064

mmproj-ZwZ-2B-F16.gguf ADDED Viewed

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

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

mmproj-ZwZ-2B-Q4_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:3a63f1091267b600401fd4d815c504d2889741bd335d6cc8bfba17566e24c27b
+size 275970176

mmproj-ZwZ-2B-Q8_0.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:9037f53b860bd4dad00833c90e43bbd03ee5dd14954e52a00f09a174075088f9
+size 441907328