Instructions to use stabilityai/stable-code-instruct-3b with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use stabilityai/stable-code-instruct-3b with Transformers:

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

pipe = pipeline("text-generation", model="stabilityai/stable-code-instruct-3b")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("stabilityai/stable-code-instruct-3b")
model = AutoModelForCausalLM.from_pretrained("stabilityai/stable-code-instruct-3b")
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]:]))

llama-cpp-python

How to use stabilityai/stable-code-instruct-3b with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="stabilityai/stable-code-instruct-3b",
	filename="stable-code-3b-q4_k_m.gguf",
)

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

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use stabilityai/stable-code-instruct-3b with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf stabilityai/stable-code-instruct-3b:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf stabilityai/stable-code-instruct-3b:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf stabilityai/stable-code-instruct-3b:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf stabilityai/stable-code-instruct-3b: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 stabilityai/stable-code-instruct-3b:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf stabilityai/stable-code-instruct-3b: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 stabilityai/stable-code-instruct-3b:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf stabilityai/stable-code-instruct-3b:Q4_K_M

Use Docker

docker model run hf.co/stabilityai/stable-code-instruct-3b:Q4_K_M

LM Studio
Jan

vLLM

How to use stabilityai/stable-code-instruct-3b with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/stabilityai/stable-code-instruct-3b:Q4_K_M

SGLang

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

Ollama
How to use stabilityai/stable-code-instruct-3b with Ollama:
```
ollama run hf.co/stabilityai/stable-code-instruct-3b:Q4_K_M
```

Unsloth Studio new

How to use stabilityai/stable-code-instruct-3b 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 stabilityai/stable-code-instruct-3b 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 stabilityai/stable-code-instruct-3b to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for stabilityai/stable-code-instruct-3b to start chatting

Docker Model Runner
How to use stabilityai/stable-code-instruct-3b with Docker Model Runner:
```
docker model run hf.co/stabilityai/stable-code-instruct-3b:Q4_K_M
```

Lemonade

How to use stabilityai/stable-code-instruct-3b with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull stabilityai/stable-code-instruct-3b:Q4_K_M

Run and chat with the model

lemonade run user.stable-code-instruct-3b-Q4_K_M

List all available models

lemonade list

jojopp commited on Jul 10, 2024

Commit

20e21f0

verified ·

1 Parent(s): 29f3e24

Update README.md

Browse files

Files changed (1) hide show

README.md +3 -3

README.md CHANGED Viewed

@@ -88,7 +88,7 @@ The model is finetuned to make it useable in tasks like,
   - General purpose Code/Software Engineering like conversations.
   - SQL related generation and conversation.
-Please note: For commercial use, please refer to https://stability.ai/membership.
 ## Usage
 Here's how you can run the model use the model:
@@ -138,8 +138,8 @@ output = tokenizer.batch_decode(tokens[:, inputs.input_ids.shape[-1]:], skip_spe
 * **Paper**: [Stable Code Technical Report](https://drive.google.com/file/d/16-DGsR5-qwoPztZ6HcM7KSRUxIXrjlSm/view)
 * **Library**: [Alignment Handbook](https://github.com/huggingface/alignment-handbook.git)
 * **Finetuned from model**: [https://huggingface.co/stabilityai/stable-code-3b](https://huggingface.co/stabilityai/stable-code-3b)
-* **License**: [StabilityAI Non-Commercial Research Community License](https://huggingface.co/stabilityai/stable-code-instruct-3b/blob/main/LICENSE).
-* **Commercial License**: to use this model commercially, please refer to https://stability.ai/membership
 * **Contact**: For questions and comments about the model, please email `lm@stability.ai`

   - General purpose Code/Software Engineering like conversations.
   - SQL related generation and conversation.
+Please note: For commercial use, please refer to https://stability.ai/license.
 ## Usage
 Here's how you can run the model use the model:
 * **Paper**: [Stable Code Technical Report](https://drive.google.com/file/d/16-DGsR5-qwoPztZ6HcM7KSRUxIXrjlSm/view)
 * **Library**: [Alignment Handbook](https://github.com/huggingface/alignment-handbook.git)
 * **Finetuned from model**: [https://huggingface.co/stabilityai/stable-code-3b](https://huggingface.co/stabilityai/stable-code-3b)
+* **License**: [StabilityAI Community License](https://huggingface.co/stabilityai/stable-code-instruct-3b/blob/main/LICENSE.md).
+* **Commercial License**: to use this model commercially, please refer to https://stability.ai/license
 * **Contact**: For questions and comments about the model, please email `lm@stability.ai`