Instructions to use MaziyarPanahi/calme-3.3-instruct-3b-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 MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M

Use Docker

docker model run hf.co/MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use MaziyarPanahi/calme-3.3-instruct-3b-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "MaziyarPanahi/calme-3.3-instruct-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": "MaziyarPanahi/calme-3.3-instruct-3b-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M

Ollama
How to use MaziyarPanahi/calme-3.3-instruct-3b-GGUF with Ollama:
```
ollama run hf.co/MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M
```
Unsloth Desktop

How to use MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-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": "MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use MaziyarPanahi/calme-3.3-instruct-3b-GGUF with Docker Model Runner:
```
docker model run hf.co/MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M
```

Lemonade

How to use MaziyarPanahi/calme-3.3-instruct-3b-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.calme-3.3-instruct-3b-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-3b-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use MaziyarPanahi/calme-3.3-instruct-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 MaziyarPanahi/calme-3.3-instruct-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 "MaziyarPanahi/calme-3.3-instruct-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"

MaziyarPanahi commited on Nov 8, 2024

Commit

9f81a2c

verified ·

1 Parent(s): 939793d

Upload folder using huggingface_hub (#2)

Browse files

- a420ed963e2a67cf8c22adc09d21dd92fb2b90d91a3c7f8c1451c4cb26ebf498 (947e765a91f04118bb963c48f7b3c15fd6321313)
- 8bdb996822bf7aab6d795f1fe7946f4d2d825110d820b33386bb5f22409b7dc0 (ddde04a13e170db3de1cdbecfd1d0ec1f500aa7e)
- 578bf2b4df9683f984ce4fdc20d0ba3fa35fe11a130f562b0ada5f57db30bdc7 (0ec2b1e252b620a8606a48fff40d096be27356c5)
- 0c8276ccb58f4938f9e083ab66fcc84956739f5dc1016d51616a810c2bf53a0e (f1b1aea87f18495d24b212e1846f115093385ccc)
- cb5b94ca601a3c08a107b0573cb903e1b526cb5d75a3550e141554b6b757ee67 (9e5023ce9883459dfab36bcab6fa319876f7c245)

Files changed (5) hide show

README.md +6 -7
calme-3.3-instruct-3b.Q5_K_M.gguf +2 -2
calme-3.3-instruct-3b.Q6_K.gguf +2 -2
calme-3.3-instruct-3b.Q8_0.gguf +2 -2
calme-3.3-instruct-3b.fp16.gguf +2 -2

README.md CHANGED Viewed

@@ -1,4 +1,10 @@
 ---
 tags:
 - quantized
 - 2-bit
@@ -9,13 +15,6 @@ tags:
 - 8-bit
 - GGUF
 - text-generation
-- text-generation
-model_name: calme-3.3-instruct-3b-GGUF
-base_model: MaziyarPanahi/calme-3.3-instruct-3b
-inference: false
-model_creator: MaziyarPanahi
-pipeline_tag: text-generation
-quantized_by: MaziyarPanahi
 ---
 # [MaziyarPanahi/calme-3.3-instruct-3b-GGUF](https://huggingface.co/MaziyarPanahi/calme-3.3-instruct-3b-GGUF)
 - Model creator: [MaziyarPanahi](https://huggingface.co/MaziyarPanahi)

 ---
+base_model: MaziyarPanahi/calme-3.3-instruct-3b
+inference: false
+model_creator: MaziyarPanahi
+model_name: calme-3.3-instruct-3b-GGUF
+pipeline_tag: text-generation
+quantized_by: MaziyarPanahi
 tags:
 - quantized
 - 2-bit
 - 8-bit
 - GGUF
 - text-generation
 ---
 # [MaziyarPanahi/calme-3.3-instruct-3b-GGUF](https://huggingface.co/MaziyarPanahi/calme-3.3-instruct-3b-GGUF)
 - Model creator: [MaziyarPanahi](https://huggingface.co/MaziyarPanahi)

calme-3.3-instruct-3b.Q5_K_M.gguf CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:b71228ce4c485c849272d8ff5dea82dc79e0a5e8ae40ac8db18cd9e80eca62df
-size 2225423520

 version https://git-lfs.github.com/spec/v1
+oid sha256:453f76e0ad70829a0d3bb6685953449433950524dfc6d9c1d66241d498949f9a
+size 2224815264

calme-3.3-instruct-3b.Q6_K.gguf CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:a096ccd26e18576f5e2d3bfbe80599348c5e7714d5b11534bc797af30f24816a
-size 2538767520

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

calme-3.3-instruct-3b.Q8_0.gguf CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:071c1dabed4bf8751a280971d1fce91bccf9af4eab1009d8b93f35235b05d6af
-size 3286084768

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

calme-3.3-instruct-3b.fp16.gguf CHANGED Viewed

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:af8989e044181ca7469bb6138e2adc2c06f4d2cd622088f7a2723914240c1a44
-size 6178925472

 version https://git-lfs.github.com/spec/v1
+oid sha256:62559e290f19ebab68ad0112eab225be377a693c9f3a9609e56b1f7cb7cf424f
+size 6178317472