Instructions to use mradermacher/Canarim-7B-Instruct-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use mradermacher/Canarim-7B-Instruct-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="mradermacher/Canarim-7B-Instruct-GGUF")

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("mradermacher/Canarim-7B-Instruct-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

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

Use Docker

docker model run hf.co/mradermacher/Canarim-7B-Instruct-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use mradermacher/Canarim-7B-Instruct-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "mradermacher/Canarim-7B-Instruct-GGUF"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "mradermacher/Canarim-7B-Instruct-GGUF",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/mradermacher/Canarim-7B-Instruct-GGUF:Q4_K_M

SGLang

How to use mradermacher/Canarim-7B-Instruct-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 "mradermacher/Canarim-7B-Instruct-GGUF" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "mradermacher/Canarim-7B-Instruct-GGUF",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

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 "mradermacher/Canarim-7B-Instruct-GGUF" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "mradermacher/Canarim-7B-Instruct-GGUF",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Ollama
How to use mradermacher/Canarim-7B-Instruct-GGUF with Ollama:
```
ollama run hf.co/mradermacher/Canarim-7B-Instruct-GGUF:Q4_K_M
```

Unsloth Studio

How to use mradermacher/Canarim-7B-Instruct-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 mradermacher/Canarim-7B-Instruct-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 mradermacher/Canarim-7B-Instruct-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for mradermacher/Canarim-7B-Instruct-GGUF to start chatting

Docker Model Runner
How to use mradermacher/Canarim-7B-Instruct-GGUF with Docker Model Runner:
```
docker model run hf.co/mradermacher/Canarim-7B-Instruct-GGUF:Q4_K_M
```

Lemonade

How to use mradermacher/Canarim-7B-Instruct-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull mradermacher/Canarim-7B-Instruct-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Canarim-7B-Instruct-GGUF-Q4_K_M

List all available models

lemonade list

Atomic Chat

mradermacher commited on Dec 29, 2024

Commit

78e80c0

verified ·

1 Parent(s): 356379e

auto-patch README.md

Browse files

Files changed (1) hide show

README.md +4 -0

README.md CHANGED Viewed

@@ -41,10 +41,14 @@ more details, including on how to concatenate multi-part files.
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q3_K_S.gguf) | Q3_K_S | 3.0 |  |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q3_K_M.gguf) | Q3_K_M | 3.4 | lower quality |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q3_K_L.gguf) | Q3_K_L | 3.7 |  |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q4_K_S.gguf) | Q4_K_S | 4.0 | fast, recommended |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q4_K_M.gguf) | Q4_K_M | 4.2 | fast, recommended |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q6_K.gguf) | Q6_K | 5.6 | very good quality |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q8_0.gguf) | Q8_0 | 7.3 | fast, best quality |
 Here is a handy graph by ikawrakow comparing some lower-quality quant
 types (lower is better):

 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q3_K_S.gguf) | Q3_K_S | 3.0 |  |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q3_K_M.gguf) | Q3_K_M | 3.4 | lower quality |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q3_K_L.gguf) | Q3_K_L | 3.7 |  |
+| [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.IQ4_XS.gguf) | IQ4_XS | 3.7 |  |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q4_K_S.gguf) | Q4_K_S | 4.0 | fast, recommended |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q4_K_M.gguf) | Q4_K_M | 4.2 | fast, recommended |
+| [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q5_K_S.gguf) | Q5_K_S | 4.8 |  |
+| [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q5_K_M.gguf) | Q5_K_M | 4.9 |  |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q6_K.gguf) | Q6_K | 5.6 | very good quality |
 | [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.Q8_0.gguf) | Q8_0 | 7.3 | fast, best quality |
+| [GGUF](https://huggingface.co/mradermacher/Canarim-7B-Instruct-GGUF/resolve/main/Canarim-7B-Instruct.f16.gguf) | f16 | 13.6 | 16 bpw, overkill |
 Here is a handy graph by ikawrakow comparing some lower-quality quant
 types (lower is better):