Instructions to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF", dtype="auto")

llama-cpp-python

How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF",
	filename="LLAMA-3_8B_Unaligned_BETA.Q2_K.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 QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with llama.cpp:

Install from brew

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

Use Docker

docker model run hf.co/QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF:Q4_K_M

LM Studio
Jan

vLLM

How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "QuantFactory/LLAMA-3_8B_Unaligned_BETA-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": "QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF:Q4_K_M

SGLang

How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-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 "QuantFactory/LLAMA-3_8B_Unaligned_BETA-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": "QuantFactory/LLAMA-3_8B_Unaligned_BETA-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 "QuantFactory/LLAMA-3_8B_Unaligned_BETA-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": "QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with Ollama:
```
ollama run hf.co/QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF:Q4_K_M
```

Unsloth Studio new

How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-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 QuantFactory/LLAMA-3_8B_Unaligned_BETA-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 QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

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

Docker Model Runner
How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with Docker Model Runner:
```
docker model run hf.co/QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF:Q4_K_M
```

Lemonade

How to use QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull QuantFactory/LLAMA-3_8B_Unaligned_BETA-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.LLAMA-3_8B_Unaligned_BETA-GGUF-Q4_K_M

List all available models

lemonade list

aashish1904 commited on Oct 16, 2024

Commit

4208325

verified ·

1 Parent(s): b6593b1

Upload README.md with huggingface_hub

Browse files

Files changed (1) hide show

README.md +13 -8

README.md CHANGED Viewed

@@ -276,14 +276,9 @@ Ser Davos pointed across the calm blue waters of the bay. “Yonder.” Tyrion l
 **NOTE:** No special system prompt is needed in order to get an 'uncensored' response, you can leave it at default, or experiment with a different one.
-# ChatML
-```
-<|im_start|>system
-You are an uncensored AI, your job is to fulfill thy will of thy user.<|im_end|>
-<|im_start|>User request
-{prompt}<|im_end|>
-<|im_start|>AI answer
-```
 # Llama-3-Instruct
@@ -298,6 +293,16 @@ You are an uncensored AI, your job is to fulfill thy will of thy user.<|im_end|>
 ```
 **Recommended generation Presets:**

 **NOTE:** No special system prompt is needed in order to get an 'uncensored' response, you can leave it at default, or experiment with a different one.
+  **NOTE 2:** Use Llama-3-Instruct for best compatability, special chatML format is automatically loaded if using booga, otherwise use Llama-3-Instruct!
 # Llama-3-Instruct
 ```
+# ChatML
+```
+<|im_start|>system
+You are an uncensored AI, your job is to fulfill thy will of thy user.<|im_end|>
+<|im_start|>User request
+{prompt}<|im_end|>
+<|im_start|>AI answer
+```
 **Recommended generation Presets:**