Instructions to use TheBloke/sqlcoder-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use TheBloke/sqlcoder-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="TheBloke/sqlcoder-GGUF")

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("TheBloke/sqlcoder-GGUF", dtype="auto")

llama-cpp-python

How to use TheBloke/sqlcoder-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="TheBloke/sqlcoder-GGUF",
	filename="sqlcoder.Q2_K.gguf",
)

output = llm(
	"Once upon a time,",
	max_tokens=512,
	echo=True
)
print(output)

Notebooks
Google Colab
Kaggle
Local Apps

llama.cpp

How to use TheBloke/sqlcoder-GGUF with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf TheBloke/sqlcoder-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf TheBloke/sqlcoder-GGUF:Q4_K_M

Install from WinGet (Windows)

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

Use Docker

docker model run hf.co/TheBloke/sqlcoder-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use TheBloke/sqlcoder-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "TheBloke/sqlcoder-GGUF"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "TheBloke/sqlcoder-GGUF",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/TheBloke/sqlcoder-GGUF:Q4_K_M

SGLang

How to use TheBloke/sqlcoder-GGUF 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 "TheBloke/sqlcoder-GGUF" \
    --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": "TheBloke/sqlcoder-GGUF",
		"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 "TheBloke/sqlcoder-GGUF" \
        --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": "TheBloke/sqlcoder-GGUF",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Ollama
How to use TheBloke/sqlcoder-GGUF with Ollama:
```
ollama run hf.co/TheBloke/sqlcoder-GGUF:Q4_K_M
```

Unsloth Studio new

How to use TheBloke/sqlcoder-GGUF 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 TheBloke/sqlcoder-GGUF 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 TheBloke/sqlcoder-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for TheBloke/sqlcoder-GGUF to start chatting

Docker Model Runner
How to use TheBloke/sqlcoder-GGUF with Docker Model Runner:
```
docker model run hf.co/TheBloke/sqlcoder-GGUF:Q4_K_M
```

Lemonade

How to use TheBloke/sqlcoder-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull TheBloke/sqlcoder-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.sqlcoder-GGUF-Q4_K_M

List all available models

lemonade list

TheBloke commited on Sep 27, 2023

Commit

f07f4bf

1 Parent(s): 49e3373

Update README.md

Browse files

Files changed (1) hide show

README.md +0 -34

README.md CHANGED Viewed

@@ -59,7 +59,6 @@ Here is an incomplate list of clients and libraries that are known to support GG
 * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
 * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
-* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
 * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
 * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
@@ -207,44 +206,11 @@ For other parameters and how to use them, please refer to [the llama.cpp documen
 Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
-## How to run from Python code
-You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries.
-### How to load this model in Python code, using ctransformers
-#### First install the package
-Run one of the following commands, according to your system:
-```shell
-# Base ctransformers with no GPU acceleration
-pip install ctransformers
-# Or with CUDA GPU acceleration
-pip install ctransformers[cuda]
-# Or with AMD ROCm GPU acceleration (Linux only)
-CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers
-# Or with Metal GPU acceleration for macOS systems only
-CT_METAL=1 pip install ctransformers --no-binary ctransformers
-```
-#### Simple ctransformers example code
-```python
-from ctransformers import AutoModelForCausalLM
-# Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
-llm = AutoModelForCausalLM.from_pretrained("TheBloke/sqlcoder-GGUF", model_file="sqlcoder.Q4_K_M.gguf", model_type="starcoder", gpu_layers=50)
-print(llm("AI is going to"))
-```
 ## How to use with LangChain
 Here are guides on using llama-cpp-python and ctransformers with LangChain:
 * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
-* [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
 <!-- README_GGUF.md-how-to-run end -->

 * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
 * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
 * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
 * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
 Further instructions here: [text-generation-webui/docs/llama.cpp.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/llama.cpp.md).
 ## How to use with LangChain
 Here are guides on using llama-cpp-python and ctransformers with LangChain:
 * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
 <!-- README_GGUF.md-how-to-run end -->