Instructions to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Notebooks
Google Colab
Kaggle
Local Apps Settings

How to use Soofi-Project/Soofi-S-Instruct-Preview-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 Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama cli -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M
# Run inference directly in the terminal:
llama cli -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_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 Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M
# Run inference directly in the terminal:
./llama-cli -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_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 Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

Use Docker

docker model run hf.co/Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

LM Studio
Jan

vLLM

How to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

Ollama
How to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with Ollama:
```
ollama run hf.co/Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M
```

Unsloth Studio

How to use Soofi-Project/Soofi-S-Instruct-Preview-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 Soofi-Project/Soofi-S-Instruct-Preview-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 Soofi-Project/Soofi-S-Instruct-Preview-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for Soofi-Project/Soofi-S-Instruct-Preview-GGUF to start chatting

How to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_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": "Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

OpenClaw new

How to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M" \
  --custom-provider-id llama-cpp \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

Docker Model Runner
How to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with Docker Model Runner:
```
docker model run hf.co/Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M
```

Lemonade

How to use Soofi-Project/Soofi-S-Instruct-Preview-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

Run and chat with the model

lemonade run user.Soofi-S-Instruct-Preview-GGUF-Q5_K_M

List all available models

lemonade list

Hermes Agent

How to use Soofi-Project/Soofi-S-Instruct-Preview-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 Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_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 Soofi-Project/Soofi-S-Instruct-Preview-GGUF:Q5_K_M

Run Hermes

hermes

Atomic Chat

Q4 quant missing

by ulymp - opened 28 days ago

Discussion

ulymp

28 days ago

In the description, the Q4_K_M quant is listed, but the file is not in the repository.

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

Tap or paste here to upload images

· Sign up or log in to comment