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

Use Docker

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

LM Studio
Jan

vLLM

How to use MaziyarPanahi/calme-3.2-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.2-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.2-instruct-3b-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

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

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

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

Run Pi

# Start Pi in your project directory:
pi

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

Lemonade

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

Pull the model

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

Run and chat with the model

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

List all available models

lemonade list

Hermes Agent

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

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use MaziyarPanahi/calme-3.2-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.2-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.2-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 7, 2024

Commit

5bd8d67

verified ·

1 Parent(s): 339efbf

Upload folder using huggingface_hub (#1)

Browse files

- 82e8a9b628a6d1cf243d8e90a24ff40fb9688a5bf33bbef47b12c342f29c1d4a (69e1e353d5b7371c60b2a787fcd37b9a9aa9ecea)
- 03f88813208cf994464447454080a3b5feab5c3ee22e4861c03c4c9206cd58fa (c81e7561f4cb8f8aef2c843cfeba508b295425da)
- 53d751af3bb4ce69d1153cad6e898f9f01dcc02204c9abb76ff7d78459106373 (f668224c320037515c60f4ccbabb745033b24a72)
- 119ab6f2a27567740fd4a5a9403787ab8fce4de05c893c3bb26b19ad5b145e5b (3da1b4ccff4470fdccfd30e91e034a5be81bb1d9)
- 2ea1a77384829c5358c278686aad5d4dd0ac15de970036d674edf515d161b664 (83dc67b3d7b6809ed5bdd06d5807320852c71850)
- bbf385ce1b3cf3ee4e515807c802ec6ad22564ecb0acc8dd657e93e1376693a0 (dace8cd1f8b7de49e4eb347ce1dcd9706ee90ab9)
- 0442e5610371f1f34d94ede834d5dc12dba4dd73db8dfc940d1e99ec602f1161 (6c99634d2f55c785dfdb624cea2fe83ef74ae9cf)
- e87442123388b2b5578a1d56bc1f63ab66dcb4c70788064aa0d24c9f50c59519 (734dfbf5c0b5f6710921b68fc34ced90a951a6ee)
- d53872959aaf056dcc7d2bffd5ac968a7f56d32bb15ab788baa6418b4bc14d00 (f19dede90e37f9a9ec0d561b7d9fb93cd69fbb17)
- 798c09c779ba4ff119172a5311a37357f15ea24d63fe3e83547178f9beef58ab (149ebb98427e196d4f50a9b89d5029ea130f19e0)

Files changed (13) hide show

.gitattributes +11 -0
README.md +46 -0
calme-3.2-instruct-3b-GGUF_imatrix.dat +3 -0
calme-3.2-instruct-3b.Q2_K.gguf +3 -0
calme-3.2-instruct-3b.Q3_K_L.gguf +3 -0
calme-3.2-instruct-3b.Q3_K_M.gguf +3 -0
calme-3.2-instruct-3b.Q4_K_M.gguf +3 -0
calme-3.2-instruct-3b.Q4_K_S.gguf +3 -0
calme-3.2-instruct-3b.Q5_K_M.gguf +3 -0
calme-3.2-instruct-3b.Q5_K_S.gguf +3 -0
calme-3.2-instruct-3b.Q6_K.gguf +3 -0
calme-3.2-instruct-3b.Q8_0.gguf +3 -0
calme-3.2-instruct-3b.fp16.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,14 @@ 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
+calme-3.2-instruct-3b-GGUF_imatrix.dat filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.fp16.gguf filter=lfs diff=lfs merge=lfs -text
+calme-3.2-instruct-3b.Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text

README.md ADDED Viewed

	@@ -0,0 +1,46 @@

+---
+tags:
+- quantized
+- 2-bit
+- 3-bit
+- 4-bit
+- 5-bit
+- 6-bit
+- 8-bit
+- GGUF
+- text-generation
+- text-generation
+model_name: calme-3.2-instruct-3b-GGUF
+base_model: MaziyarPanahi/calme-3.2-instruct-3b
+inference: false
+model_creator: MaziyarPanahi
+pipeline_tag: text-generation
+quantized_by: MaziyarPanahi
+---
+# [MaziyarPanahi/calme-3.2-instruct-3b-GGUF](https://huggingface.co/MaziyarPanahi/calme-3.2-instruct-3b-GGUF)
+- Model creator: [MaziyarPanahi](https://huggingface.co/MaziyarPanahi)
+- Original model: [MaziyarPanahi/calme-3.2-instruct-3b](https://huggingface.co/MaziyarPanahi/calme-3.2-instruct-3b)
+## Description
+[MaziyarPanahi/calme-3.2-instruct-3b-GGUF](https://huggingface.co/MaziyarPanahi/calme-3.2-instruct-3b-GGUF) contains GGUF format model files for [MaziyarPanahi/calme-3.2-instruct-3b](https://huggingface.co/MaziyarPanahi/calme-3.2-instruct-3b).
+### About GGUF
+GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+Here is an incomplete list of clients and libraries that are known to support GGUF:
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
+* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
+* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
+* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
+* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
+* [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
+* [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
+* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
+* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
+## Special thanks
+🙏 Special thanks to [Georgi Gerganov](https://github.com/ggerganov) and the whole team working on [llama.cpp](https://github.com/ggerganov/llama.cpp/) for making all of this possible.

calme-3.2-instruct-3b-GGUF_imatrix.dat ADDED Viewed

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

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

calme-3.2-instruct-3b.Q2_K.gguf ADDED Viewed

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

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

calme-3.2-instruct-3b.Q3_K_L.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:7ebe65fd4f5f41fcf970672bfd7776c367346071c4414a231982ae72b9159da5
+size 1708000416

calme-3.2-instruct-3b.Q3_K_M.gguf ADDED Viewed

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

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

calme-3.2-instruct-3b.Q4_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:616dd0f7ae2d7bdcb74fb8e14ab0c825fcd0aae1e35af03d43b16a96e350e99e
+size 1930511520

calme-3.2-instruct-3b.Q4_K_S.gguf ADDED Viewed

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

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

calme-3.2-instruct-3b.Q5_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:0d50102755dbd14f2cfd668601d2c209fa1fbfa489b57ac733041c81874ebc25
+size 2225423520

calme-3.2-instruct-3b.Q5_K_S.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:7c795321009887279d55b0fcabff6b61dc23d8917b46c6b6d24b6e582cc2cd0a
+size 2170274976

calme-3.2-instruct-3b.Q6_K.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:61025a7ef7c47aa50df08330cdaf59b30d671ef39ad6170419c2e2dd75eeb4dc
+size 2538767520

calme-3.2-instruct-3b.Q8_0.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:0ade8cff2368882624e0563da866b16207f0c100a57e146ce999f6e376986ac3
+size 3286084768

calme-3.2-instruct-3b.fp16.gguf ADDED Viewed

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

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