Instructions to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="MaziyarPanahi/openchat-3.6-8b-20240522-GGUF",
	filename="openchat-3.6-8b-20240522.Q5_K_M.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama-cli -hf MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama-cli -hf MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_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/openchat-3.6-8b-20240522-GGUF:Q5_K_M
# Run inference directly in the terminal:
./llama-cli -hf MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_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/openchat-3.6-8b-20240522-GGUF:Q5_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M

Use Docker

docker model run hf.co/MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M

LM Studio
Jan

vLLM

How to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M

Ollama
How to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with Ollama:
```
ollama run hf.co/MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M
```

Unsloth Studio

How to use MaziyarPanahi/openchat-3.6-8b-20240522-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 MaziyarPanahi/openchat-3.6-8b-20240522-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 MaziyarPanahi/openchat-3.6-8b-20240522-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for MaziyarPanahi/openchat-3.6-8b-20240522-GGUF to start chatting

Atomic Chat new
Docker Model Runner
How to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with Docker Model Runner:
```
docker model run hf.co/MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M
```

Lemonade

How to use MaziyarPanahi/openchat-3.6-8b-20240522-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MaziyarPanahi/openchat-3.6-8b-20240522-GGUF:Q5_K_M

Run and chat with the model

lemonade run user.openchat-3.6-8b-20240522-GGUF-Q5_K_M

List all available models

lemonade list

MaziyarPanahi commited on Oct 31, 2024

Commit

748b743

verified ·

1 Parent(s): 63f3a63

7b16c357814294c2ebb89dfae9b2570d811dcd5d4f842a1bcc5f0a689601bf51

Browse files

Files changed (3) hide show

.gitattributes +1 -0
README.md +46 -0
openchat-3.6-8b-20240522-GGUF_imatrix.dat +3 -0

.gitattributes CHANGED Viewed

@@ -38,3 +38,4 @@ openchat-3.6-8b-20240522.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
 openchat-3.6-8b-20240522.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
 openchat-3.6-8b-20240522.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
 openchat-3.6-8b-20240522.fp16.gguf filter=lfs diff=lfs merge=lfs -text

 openchat-3.6-8b-20240522.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
 openchat-3.6-8b-20240522.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
 openchat-3.6-8b-20240522.fp16.gguf filter=lfs diff=lfs merge=lfs -text
+openchat-3.6-8b-20240522-GGUF_imatrix.dat 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: openchat-3.6-8b-20240522-GGUF
+base_model: openchat/openchat-3.6-8b-20240522
+inference: false
+model_creator: openchat
+pipeline_tag: text-generation
+quantized_by: MaziyarPanahi
+---
+# [MaziyarPanahi/openchat-3.6-8b-20240522-GGUF](https://huggingface.co/MaziyarPanahi/openchat-3.6-8b-20240522-GGUF)
+- Model creator: [openchat](https://huggingface.co/openchat)
+- Original model: [openchat/openchat-3.6-8b-20240522](https://huggingface.co/openchat/openchat-3.6-8b-20240522)
+## Description
+[MaziyarPanahi/openchat-3.6-8b-20240522-GGUF](https://huggingface.co/MaziyarPanahi/openchat-3.6-8b-20240522-GGUF) contains GGUF format model files for [openchat/openchat-3.6-8b-20240522](https://huggingface.co/openchat/openchat-3.6-8b-20240522).
+### 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.

openchat-3.6-8b-20240522-GGUF_imatrix.dat ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:87cc7af09f468d154bcce15b7dbbf3b25e386a6a2fd65f079d98fb3b03ac3a43
+size 4988146