Instructions to use openchat/openchat-3.5-0106 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use openchat/openchat-3.5-0106 with Transformers:

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

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

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("openchat/openchat-3.5-0106")
model = AutoModelForCausalLM.from_pretrained("openchat/openchat-3.5-0106")
messages = [
    {"role": "user", "content": "Who are you?"},
]
inputs = tokenizer.apply_chat_template(
	messages,
	add_generation_prompt=True,
	tokenize=True,
	return_dict=True,
	return_tensors="pt",
).to(model.device)

outputs = model.generate(**inputs, max_new_tokens=40)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Inference
Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use openchat/openchat-3.5-0106 with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "openchat/openchat-3.5-0106"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "openchat/openchat-3.5-0106",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/openchat/openchat-3.5-0106

SGLang

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

Docker Model Runner
How to use openchat/openchat-3.5-0106 with Docker Model Runner:
```
docker model run hf.co/openchat/openchat-3.5-0106
```

Update examples in README to be compatible with soon-to-come ChatWidget

by Wauplin HF Staff - opened Feb 29, 2024

base: refs/heads/main

←

from: refs/pr/4

Discussion Files changed

-0

Files changed (1) hide show

README.md +9 -0

README.md CHANGED Viewed

@@ -7,6 +7,15 @@ tags:
 - C-RLFT
 library_name: transformers
 pipeline_tag: text-generation
 ---
 <div align="center">
   <img src="https://raw.githubusercontent.com/imoneoi/openchat/master/assets/logo_new.png" style="width: 65%">

 - C-RLFT
 library_name: transformers
 pipeline_tag: text-generation
+widget:
+- example_title: Hello
+  messages:
+  - role: user
+    content: Hello, how are you today?
+- example_title: Mathematical reasoning
+  messages:
+  - role: user
+    content: 10.3 − 7988.8133
 ---
 <div align="center">
   <img src="https://raw.githubusercontent.com/imoneoi/openchat/master/assets/logo_new.png" style="width: 65%">