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

Libraries

How to use 01-ai/Yi-34B-Chat with Transformers:

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

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

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("01-ai/Yi-34B-Chat")
model = AutoModelForCausalLM.from_pretrained("01-ai/Yi-34B-Chat")
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]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use 01-ai/Yi-34B-Chat with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/01-ai/Yi-34B-Chat

SGLang

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

Docker Model Runner
How to use 01-ai/Yi-34B-Chat with Docker Model Runner:
```
docker model run hf.co/01-ai/Yi-34B-Chat
```

Fix pipeline tag

by osanseviero - opened Nov 23, 2023

base: refs/heads/main

←

from: refs/pr/1

Discussion Files changed

-6

Files changed (1) hide show

README.md +6 -6

README.md CHANGED Viewed

@@ -3,11 +3,11 @@ license: other
 license_name: yi-license
 license_link: LICENSE
 widget:
-  - example_title: "Yi-34B-Chat"
-  - text: "hi"
-    output:
-      text: "Hello! How can I assist you today?"
-pipeline_tag: question-answering
 ---
 <div align="center">
@@ -417,4 +417,4 @@ are fully open for academic research and free commercial usage with permission
 via applications. All usage must adhere to the [Model License
 Agreement 2.0](https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt).
 To apply for the official commercial license, please contact us
-([yi@01.ai](mailto:yi@01.ai)).

 license_name: yi-license
 license_link: LICENSE
 widget:
+- example_title: Yi-34B-Chat
+- text: hi
+  output:
+    text: Hello! How can I assist you today?
+pipeline_tag: text-generation
 ---
 <div align="center">
 via applications. All usage must adhere to the [Model License
 Agreement 2.0](https://github.com/01-ai/Yi/blob/main/MODEL_LICENSE_AGREEMENT.txt).
 To apply for the official commercial license, please contact us
+([yi@01.ai](mailto:yi@01.ai)).