Instructions to use shuttleai/shuttle-3 with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use shuttleai/shuttle-3 with Transformers:

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

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

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("shuttleai/shuttle-3")
model = AutoModelForCausalLM.from_pretrained("shuttleai/shuttle-3", device_map="auto")
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 Settings

vLLM

How to use shuttleai/shuttle-3 with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/shuttleai/shuttle-3

SGLang

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

Docker Model Runner
How to use shuttleai/shuttle-3 with Docker Model Runner:
```
docker model run hf.co/shuttleai/shuttle-3
```

xtristan commited on Oct 26, 2024

Commit

506dfd9

verified ·

1 Parent(s): e8a07bc

Update README.md

Browse files

Files changed (1) hide show

README.md +2 -2

README.md CHANGED Viewed

@@ -1,9 +1,9 @@
 <p style="font-size:20px;" align="center">
-<div style="width: 100%; height: 50px; overflow: hidden; border-radius: 15px; margin: auto; position: relative;">
     <img
         src="https://shuttleai.com/shuttle.png"
         alt="ShuttleAI Thumbnail"
-        style="width: 100%; height: auto; display: block; margin: auto; position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); object-fit: cover;">
 </div>
 <p align="center">

 <p style="font-size:20px;" align="center">
+<div style="width: 50px; height: 50px; overflow: hidden; border-radius: 15px; margin: auto; position: relative;">
     <img
         src="https://shuttleai.com/shuttle.png"
         alt="ShuttleAI Thumbnail"
+        style="width: auto; height: auto; display: block; margin: auto; position: absolute; top: 50%; left: 50%; transform: translate(-50%, -50%); object-fit: cover;">
 </div>
 <p align="center">