Instructions to use second-state/OpenChat-3.5-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use second-state/OpenChat-3.5-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="second-state/OpenChat-3.5-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("second-state/OpenChat-3.5-GGUF")
model = AutoModelForCausalLM.from_pretrained("second-state/OpenChat-3.5-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

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

Use Docker

docker model run hf.co/second-state/OpenChat-3.5-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use second-state/OpenChat-3.5-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/second-state/OpenChat-3.5-GGUF:Q4_K_M

SGLang

How to use second-state/OpenChat-3.5-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 "second-state/OpenChat-3.5-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": "second-state/OpenChat-3.5-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 "second-state/OpenChat-3.5-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": "second-state/OpenChat-3.5-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use second-state/OpenChat-3.5-GGUF with Ollama:
```
ollama run hf.co/second-state/OpenChat-3.5-GGUF:Q4_K_M
```
Unsloth Desktop
Docker Model Runner
How to use second-state/OpenChat-3.5-GGUF with Docker Model Runner:
```
docker model run hf.co/second-state/OpenChat-3.5-GGUF:Q4_K_M
```

Lemonade

How to use second-state/OpenChat-3.5-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull second-state/OpenChat-3.5-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.OpenChat-3.5-GGUF-Q4_K_M

List all available models

lemonade list

Atomic Chat

OpenChat-3.5-GGUF / README.md

apepkuss79

Update README.md

d84e10f verified over 2 years ago

preview code

Raw

History Blame Contribute Delete

3.73 kB

	---
	base_model: openchat/openchat_3.5
	inference: false
	license: apache-2.0
	model_creator: OpenChat
	model_name: OpenChat 3.5 7B
	model_type: mistral
	pipeline_tag: text-generation
	quantized_by: Second State Inc.
	tags:
	- openchat
	---

	<!-- header start -->
	<!-- 200823 -->
	<div style="width: auto; margin-left: auto; margin-right: auto">
	<img src="https://github.com/LlamaEdge/LlamaEdge/raw/dev/assets/logo.svg" style="width: 100%; min-width: 400px; display: block; margin: auto;">
	</div>
	<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
	<!-- header end -->

	# OpenChat-3.5-GGUF

	## Original Model

	[openchat/openchat_3.5](https://huggingface.co/openchat/openchat_3.5)

	## Run with LlamaEdge

	- LlamaEdge version: [v0.2.8](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.2.8) and above

	- Prompt template

	- Prompt type: `openchat`

	- Prompt string

	```text
	GPT4 User: {prompt}<\|end_of_turn\|>GPT4 Assistant:
	```

	- Reverse prompt: `<\|end_of_turn\|>`

	- Context size: `4096`

	- Run as LlamaEdge service

	```bash
	wasmedge --dir .:. --nn-preload default:GGML:AUTO:openchat-3.5-0106-Q5_K_M.gguf llama-api-server.wasm -p openchat -r '<\|end_of_turn\|>'
	```

	- Run as LlamaEdge command app

	```bash
	wasmedge --dir .:. --nn-preload default:GGML:AUTO:openchat_3.5.Q5_K_M.gguf llama-chat.wasm -p openchat -r '<\|end_of_turn\|>'
	```

	## Quantized GGUF Models

	\| Name \| Quant method \| Bits \| Size \| Use case \|
	\| ---- \| ---- \| ---- \| ---- \| ----- \|
	\| [openchat_3.5-Q2_K.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q2_K.gguf) \| Q2_K \| 2 \| 2.72 GB\| smallest, significant quality loss - not recommended for most purposes \|
	\| [openchat_3.5-Q3_K_L.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q3_K_L.gguf) \| Q3_K_L \| 3 \| 3.82 GB\| small, substantial quality loss \|
	\| [openchat_3.5-Q3_K_M.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q3_K_M.gguf) \| Q3_K_M \| 3 \| 3.52 GB\| very small, high quality loss \|
	\| [openchat_3.5-Q3_K_S.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q3_K_S.gguf) \| Q3_K_S \| 3 \| 3.16 GB\| very small, high quality loss \|
	\| [openchat_3.5-Q4_0.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q4_0.gguf) \| Q4_0 \| 4 \| 4.11 GB\| legacy; small, very high quality loss - prefer using Q3_K_M \|
	\| [openchat_3.5-Q4_K_M.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q4_K_M.gguf) \| Q4_K_M \| 4 \| 4.37 GB\| medium, balanced quality - recommended \|
	\| [openchat_3.5-Q4_K_S.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q4_K_S.gguf) \| Q4_K_S \| 4 \| 4.14 GB\| small, greater quality loss \|
	\| [openchat_3.5-Q5_0.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q5_0.gguf) \| Q5_0 \| 5 \| 5.00 GB\| legacy; medium, balanced quality - prefer using Q4_K_M \|
	\| [openchat_3.5-Q5_K_M.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q5_K_M.gguf) \| Q5_K_M \| 5 \| 5.13 GB\| large, very low quality loss - recommended \|
	\| [openchat_3.5-Q5_K_S.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q5_K_S.gguf) \| Q5_K_S \| 5 \| 5.00 GB\| large, low quality loss - recommended \|
	\| [openchat_3.5-Q6_K.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q6_K.gguf) \| Q6_K \| 6 \| 5.94 GB\| very large, extremely low quality loss \|
	\| [openchat_3.5-Q8_0.gguf](https://huggingface.co/second-state/OpenChat-3.5-GGUF/blob/main/openchat_3.5-Q8_0.gguf) \| Q8_0 \| 8 \| 7.70 GB\| very large, extremely low quality loss - not recommended \|