Instructions to use MaziyarPanahi/Yi-1.5-34B-Chat-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use MaziyarPanahi/Yi-1.5-34B-Chat-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="MaziyarPanahi/Yi-1.5-34B-Chat-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("MaziyarPanahi/Yi-1.5-34B-Chat-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use MaziyarPanahi/Yi-1.5-34B-Chat-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/Yi-1.5-34B-Chat-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf MaziyarPanahi/Yi-1.5-34B-Chat-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/Yi-1.5-34B-Chat-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf MaziyarPanahi/Yi-1.5-34B-Chat-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/Yi-1.5-34B-Chat-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf MaziyarPanahi/Yi-1.5-34B-Chat-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/Yi-1.5-34B-Chat-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf MaziyarPanahi/Yi-1.5-34B-Chat-GGUF:Q4_K_M

Use Docker

docker model run hf.co/MaziyarPanahi/Yi-1.5-34B-Chat-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use MaziyarPanahi/Yi-1.5-34B-Chat-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MaziyarPanahi/Yi-1.5-34B-Chat-GGUF:Q4_K_M

SGLang

How to use MaziyarPanahi/Yi-1.5-34B-Chat-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 "MaziyarPanahi/Yi-1.5-34B-Chat-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": "MaziyarPanahi/Yi-1.5-34B-Chat-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 "MaziyarPanahi/Yi-1.5-34B-Chat-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": "MaziyarPanahi/Yi-1.5-34B-Chat-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use MaziyarPanahi/Yi-1.5-34B-Chat-GGUF with Ollama:
```
ollama run hf.co/MaziyarPanahi/Yi-1.5-34B-Chat-GGUF:Q4_K_M
```
Unsloth Desktop
Docker Model Runner
How to use MaziyarPanahi/Yi-1.5-34B-Chat-GGUF with Docker Model Runner:
```
docker model run hf.co/MaziyarPanahi/Yi-1.5-34B-Chat-GGUF:Q4_K_M
```

Lemonade

How to use MaziyarPanahi/Yi-1.5-34B-Chat-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MaziyarPanahi/Yi-1.5-34B-Chat-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Yi-1.5-34B-Chat-GGUF-Q4_K_M

List all available models

lemonade list

Atomic Chat

MaziyarPanahi commited on May 12, 2024

Commit

744c805

verified ·

1 Parent(s): 5d04ed7

4f55b52796fed7b0eb73503499557b2e6664cd4080ed2f20890a7a2eda14d9fc

Browse files

Files changed (1) hide show

README.md +57 -0

README.md ADDED Viewed

	@@ -0,0 +1,57 @@

+---
+tags:
+- quantized
+- 2-bit
+- 3-bit
+- 4-bit
+- 5-bit
+- 6-bit
+- 8-bit
+- GGUF
+- transformers
+- safetensors
+- gguf
+- llama
+- text-generation
+- conversational
+- arxiv:2403.04652
+- license:apache-2.0
+- autotrain_compatible
+- endpoints_compatible
+- text-generation-inference
+- region:us
+- text-generation
+model_name: Yi-1.5-34B-Chat-GGUF
+base_model: 01-ai/Yi-1.5-34B-Chat
+inference: false
+model_creator: 01-ai
+pipeline_tag: text-generation
+quantized_by: MaziyarPanahi
+---
+# [MaziyarPanahi/Yi-1.5-34B-Chat-GGUF](https://huggingface.co/MaziyarPanahi/Yi-1.5-34B-Chat-GGUF)
+- Model creator: [01-ai](https://huggingface.co/01-ai)
+- Original model: [01-ai/Yi-1.5-34B-Chat](https://huggingface.co/01-ai/Yi-1.5-34B-Chat)
+## Description
+[MaziyarPanahi/Yi-1.5-34B-Chat-GGUF](https://huggingface.co/MaziyarPanahi/Yi-1.5-34B-Chat-GGUF) contains GGUF format model files for [01-ai/Yi-1.5-34B-Chat](https://huggingface.co/01-ai/Yi-1.5-34B-Chat).
+### 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.