Instructions to use MoMonir/granite-8b-code-instruct-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use MoMonir/granite-8b-code-instruct-GGUF with Transformers:

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

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

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("MoMonir/granite-8b-code-instruct-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use MoMonir/granite-8b-code-instruct-GGUF with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M

Install from WinGet (Windows)

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

Use Docker

docker model run hf.co/MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use MoMonir/granite-8b-code-instruct-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M

SGLang

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

Ollama
How to use MoMonir/granite-8b-code-instruct-GGUF with Ollama:
```
ollama run hf.co/MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M
```

Unsloth Studio

How to use MoMonir/granite-8b-code-instruct-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 MoMonir/granite-8b-code-instruct-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 MoMonir/granite-8b-code-instruct-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for MoMonir/granite-8b-code-instruct-GGUF to start chatting

Atomic Chat new
Docker Model Runner
How to use MoMonir/granite-8b-code-instruct-GGUF with Docker Model Runner:
```
docker model run hf.co/MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M
```

Lemonade

How to use MoMonir/granite-8b-code-instruct-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull MoMonir/granite-8b-code-instruct-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.granite-8b-code-instruct-GGUF-Q4_K_M

List all available models

lemonade list

MoMonir commited on May 14, 2024

Commit

8877244

verified ·

1 Parent(s): e871862

Update README.md

Browse files

Files changed (1) hide show

README.md +25 -3

README.md CHANGED Viewed

@@ -85,9 +85,31 @@ model-index:
       name: pass@1
 ---
-# MoMonir/granite-8b-code-instruct-Q4_K_M-GGUF
 This model was converted to GGUF format from [`ibm-granite/granite-8b-code-instruct`](https://huggingface.co/ibm-granite/granite-8b-code-instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
 Refer to the [original model card](https://huggingface.co/ibm-granite/granite-8b-code-instruct) for more details on the model.
 ## Use with llama.cpp
 Install llama.cpp through brew.
@@ -100,13 +122,13 @@ Invoke the llama.cpp server or the CLI.
 CLI:
 ```bash
-llama-cli --hf-repo MoMonir/granite-8b-code-instruct-Q4_K_M-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -p "The meaning to life and the universe is"
 ```
 Server:
 ```bash
-llama-server --hf-repo MoMonir/granite-8b-code-instruct-Q4_K_M-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -c 2048
 ```
 Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.

       name: pass@1
 ---
+# MoMonir/granite-8b-code-instruct-GGUF
 This model was converted to GGUF format from [`ibm-granite/granite-8b-code-instruct`](https://huggingface.co/ibm-granite/granite-8b-code-instruct) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
 Refer to the [original model card](https://huggingface.co/ibm-granite/granite-8b-code-instruct) for more details on the model.
+<!-- README_GGUF.md-about-gguf start -->
+### About GGUF ([TheBloke](https://huggingface.co/TheBloke) Description)
+GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
+Here is an incomplete list of clients and libraries that are known to support GGUF:
+* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
+* [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
+* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
+* [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
+* [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.
+* [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
+<!-- README_GGUF.md-about-gguf end -->
 ## Use with llama.cpp
 Install llama.cpp through brew.
 CLI:
 ```bash
+llama-cli --hf-repo MoMonir/granite-8b-code-instruct-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -p "The meaning to life and the universe is"
 ```
 Server:
 ```bash
+llama-server --hf-repo MoMonir/granite-8b-code-instruct-GGUF --model granite-8b-code-instruct.Q4_K_M.gguf -c 2048
 ```
 Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.