Instructions to use defog/llama-3-sqlcoder-8b with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use defog/llama-3-sqlcoder-8b with Transformers:

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

pipe = pipeline("text-generation", model="defog/llama-3-sqlcoder-8b")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("defog/llama-3-sqlcoder-8b")
model = AutoModelForCausalLM.from_pretrained("defog/llama-3-sqlcoder-8b")
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 defog/llama-3-sqlcoder-8b with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/defog/llama-3-sqlcoder-8b

SGLang

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

Docker Model Runner
How to use defog/llama-3-sqlcoder-8b with Docker Model Runner:
```
docker model run hf.co/defog/llama-3-sqlcoder-8b
```

Example prompt?

#17

by fahadh4ilyas - opened Jul 16, 2024

Discussion

fahadh4ilyas

Jul 16, 2024

Could you please show me example prompt? In model card, the prompt is like this:

<|begin_of_text|><|start_header_id|>user<|end_header_id|>

Generate a SQL query to answer this question: `{user_question}`
{instructions}

DDL statements:
{create_table_statements}<|eot_id|><|start_header_id|>assistant<|end_header_id|>

The following SQL query best answers the question `{user_question}`:
```sql

What I don't understand is, do you really need to add ` to the beginning and ending of {user_question}?

jp-defog

Jul 16, 2024

@fahadh4ilyas The prompt in the model card is correct. You don't need to add it to both the beginning and ending, but we've found through our own testing and benchmarks that doing so improves the performance of the model.

teck157713

Aug 16, 2024

•

edited Aug 16, 2024

I have an issue. The prompt does not seem to follow my instructions that I have input in {Instructions}.
"Always return all the columns for TABLE. (Select ..., ...)" but it just refused to listen whenever the query involves joining other tables I have listed.
It also does not convert to MySQL Query as I have listed in the instruction. Not sure if the model is trained for that.

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

· Sign up or log in to comment