Instructions to use kampkelly/sql-generator with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use kampkelly/sql-generator with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="kampkelly/sql-generator")# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("kampkelly/sql-generator", dtype="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps
- vLLM
How to use kampkelly/sql-generator with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "kampkelly/sql-generator" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "kampkelly/sql-generator", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/kampkelly/sql-generator
- SGLang
How to use kampkelly/sql-generator 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 "kampkelly/sql-generator" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "kampkelly/sql-generator", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'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 "kampkelly/sql-generator" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "kampkelly/sql-generator", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use kampkelly/sql-generator with Docker Model Runner:
docker model run hf.co/kampkelly/sql-generator
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 "kampkelly/sql-generator" \
--host 0.0.0.0 \
--port 30000# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
-H "Content-Type: application/json" \
--data '{
"model": "kampkelly/sql-generator",
"prompt": "Once upon a time,",
"max_tokens": 512,
"temperature": 0.5
}'YAML Metadata Warning:The pipeline tag "text2text-generation" is not in the official list: text-classification, token-classification, table-question-answering, question-answering, zero-shot-classification, translation, summarization, feature-extraction, text-generation, fill-mask, sentence-similarity, text-to-speech, text-to-audio, automatic-speech-recognition, audio-to-audio, audio-classification, audio-text-to-text, voice-activity-detection, depth-estimation, image-classification, object-detection, image-segmentation, text-to-image, image-to-text, image-to-image, image-to-video, unconditional-image-generation, video-classification, reinforcement-learning, robotics, tabular-classification, tabular-regression, tabular-to-text, table-to-text, multiple-choice, text-ranking, text-retrieval, time-series-forecasting, text-to-video, image-text-to-text, image-text-to-image, image-text-to-video, visual-question-answering, document-question-answering, zero-shot-image-classification, graph-ml, mask-generation, zero-shot-object-detection, text-to-3d, image-to-3d, image-feature-extraction, video-text-to-text, keypoint-detection, visual-document-retrieval, any-to-any, video-to-video, other
Model Card for Model ID
Model Details
Model Description
This model is fine-trained from the google/flan-t5-base model to achieve better accuracy on generating SQL Queries. It has been trained to generate sql queries given a question and database schema(s).
It can be used in any of such applications where sql queries are needed (particularly Postgres queries).
This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
- Developed by: Oghenerunor Adjekpiyede
- Model type: Text2TextGeneration
- Language(s) (NLP): English
- License: MIT
- Finetuned from model [optional]: google/flan-t5-base
Model Sources [optional]
- Repository: https://huggingface.co/kampkelly/sql-generator
Uses
This model is to be used and performs well for generating SQL queries. This model for other tasks may not give satisfactory performance on generating text in other general use cases.
Direct Use
Use with transformers
from peft import PeftModel
from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
model_base = AutoModelForSeq2SeqLM.from_pretrained("google/flan-t5-base", torch_dtype=torch.bfloat16, trust_remote_code=True)
model = PeftModel.from_pretrained(model_base,
peft_model_path,
torch_dtype=torch.bfloat16,
is_trainable=False)
input_ids = tokenizer(prompt, padding="max_length", max_length=300, truncation=True, return_tensors="pt").input_ids
model_output = model.generate(input_ids=input_ids, max_new_tokens = 300, use_cache = True,
num_beams=3,
do_sample=True,
top_k=50,
top_p=0.75,
temperature=0.1,
early_stopping=True
)
model_text_output = tokenizer.decode(model_output[0], skip_special_tokens=True)
print(model_text)
Bias, Risks, and Limitations
This model is particularly good for generating SQL Select statement queries. Other types of query statements such as Create, Delete, Update, etc are not fully supported.
Install from pip and serve model
# Install SGLang from pip: pip install sglang# Start the SGLang server: python3 -m sglang.launch_server \ --model-path "kampkelly/sql-generator" \ --host 0.0.0.0 \ --port 30000# Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "kampkelly/sql-generator", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'