Instructions to use inclusionAI/Sing-Guard-8b-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use inclusionAI/Sing-Guard-8b-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="inclusionAI/Sing-Guard-8b-GGUF",
	filename="Sing-Guard-8b-F16.gguf",
)

llm.create_chat_completion(
	messages = "No input example has been defined for this model task."
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use inclusionAI/Sing-Guard-8b-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 inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf inclusionAI/Sing-Guard-8b-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 inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf inclusionAI/Sing-Guard-8b-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 inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf inclusionAI/Sing-Guard-8b-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 inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M

Use Docker

docker model run hf.co/inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M

LM Studio
Jan
Ollama
How to use inclusionAI/Sing-Guard-8b-GGUF with Ollama:
```
ollama run hf.co/inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M
```

Unsloth Studio

How to use inclusionAI/Sing-Guard-8b-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 inclusionAI/Sing-Guard-8b-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 inclusionAI/Sing-Guard-8b-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for inclusionAI/Sing-Guard-8b-GGUF to start chatting

How to use inclusionAI/Sing-Guard-8b-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use inclusionAI/Sing-Guard-8b-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat new
Docker Model Runner
How to use inclusionAI/Sing-Guard-8b-GGUF with Docker Model Runner:
```
docker model run hf.co/inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M
```

Lemonade

How to use inclusionAI/Sing-Guard-8b-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull inclusionAI/Sing-Guard-8b-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Sing-Guard-8b-GGUF-Q4_K_M

List all available models

lemonade list

Add pipeline tag, library name, and GitHub repository link

by nielsr HF Staff - opened 3 days ago

base: refs/heads/main

←

from: refs/pr/2

Discussion Files changed

-4

nielsr

3 days ago

This PR improves the model card by:

Adding the pipeline_tag: image-text-to-text in the metadata for better discoverability.
Adding library_name: transformers in the metadata since the model supports standard Transformers inference.
Adding a link to the official GitHub repository in the header of the README.
Updating the citation with the full list of authors from the repository.

Add pipeline tag, library name, and GitHub repository link6b5930da

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

Tap or paste here to upload images

Ready to merge

This branch is ready to get merged automatically.

· Sign up or log in to comment