Instructions to use brekJ/openchat_3.5-Q4_K_M-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use brekJ/openchat_3.5-Q4_K_M-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="brekJ/openchat_3.5-Q4_K_M-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("brekJ/openchat_3.5-Q4_K_M-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

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

Use Docker

docker model run hf.co/brekJ/openchat_3.5-Q4_K_M-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use brekJ/openchat_3.5-Q4_K_M-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "brekJ/openchat_3.5-Q4_K_M-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": "brekJ/openchat_3.5-Q4_K_M-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/brekJ/openchat_3.5-Q4_K_M-GGUF:Q4_K_M

SGLang

How to use brekJ/openchat_3.5-Q4_K_M-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 "brekJ/openchat_3.5-Q4_K_M-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": "brekJ/openchat_3.5-Q4_K_M-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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 "brekJ/openchat_3.5-Q4_K_M-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": "brekJ/openchat_3.5-Q4_K_M-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use brekJ/openchat_3.5-Q4_K_M-GGUF with Ollama:
```
ollama run hf.co/brekJ/openchat_3.5-Q4_K_M-GGUF:Q4_K_M
```
Unsloth Desktop
Docker Model Runner
How to use brekJ/openchat_3.5-Q4_K_M-GGUF with Docker Model Runner:
```
docker model run hf.co/brekJ/openchat_3.5-Q4_K_M-GGUF:Q4_K_M
```

Lemonade

How to use brekJ/openchat_3.5-Q4_K_M-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull brekJ/openchat_3.5-Q4_K_M-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.openchat_3.5-Q4_K_M-GGUF-Q4_K_M

List all available models

lemonade list

Atomic Chat

openchat_3.5-Q4_K_M-GGUF / README.md

brekJ

Upload README.md with huggingface_hub

f3474fa verified about 2 years ago

preview code

Raw

History Blame Contribute Delete

2.05 kB

	---
	base_model: openchat/openchat_3.5
	datasets:
	- openchat/openchat_sharegpt4_dataset
	- imone/OpenOrca_FLAN
	- LDJnr/LessWrong-Amplify-Instruct
	- LDJnr/Pure-Dove
	- LDJnr/Verified-Camel
	- tiedong/goat
	- glaiveai/glaive-code-assistant
	- meta-math/MetaMathQA
	- OpenAssistant/oasst_top1_2023-08-25
	- TIGER-Lab/MathInstruct
	library_name: transformers
	license: apache-2.0
	pipeline_tag: text-generation
	tags:
	- openchat
	- mistral
	- C-RLFT
	- llama-cpp
	- gguf-my-repo
	---

	# brekJ/openchat_3.5-Q4_K_M-GGUF
	This model was converted to GGUF format from [`openchat/openchat_3.5`](https://huggingface.co/openchat/openchat_3.5) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
	Refer to the [original model card](https://huggingface.co/openchat/openchat_3.5) for more details on the model.

	## Use with llama.cpp
	Install llama.cpp through brew (works on Mac and Linux)

	```bash
	brew install llama.cpp

	```
	Invoke the llama.cpp server or the CLI.

	### CLI:
	```bash
	llama-cli --hf-repo brekJ/openchat_3.5-Q4_K_M-GGUF --hf-file openchat_3.5-q4_k_m.gguf -p "The meaning to life and the universe is"
	```

	### Server:
	```bash
	llama-server --hf-repo brekJ/openchat_3.5-Q4_K_M-GGUF --hf-file openchat_3.5-q4_k_m.gguf -c 2048
	```

	Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.

	Step 1: Clone llama.cpp from GitHub.
	```
	git clone https://github.com/ggerganov/llama.cpp
	```

	Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
	```
	cd llama.cpp && LLAMA_CURL=1 make
	```

	Step 3: Run inference through the main binary.
	```
	./llama-cli --hf-repo brekJ/openchat_3.5-Q4_K_M-GGUF --hf-file openchat_3.5-q4_k_m.gguf -p "The meaning to life and the universe is"
	```
	or
	```
	./llama-server --hf-repo brekJ/openchat_3.5-Q4_K_M-GGUF --hf-file openchat_3.5-q4_k_m.gguf -c 2048
	```