Instructions to use bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M

Use Docker

docker model run hf.co/bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M

LM Studio
Jan
Ollama
How to use bartowski/Vortex5_Scarlet-Shadow-31B-GGUF with Ollama:
```
ollama run hf.co/bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M
```
Unsloth Desktop

How to use bartowski/Vortex5_Scarlet-Shadow-31B-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @earendil-works/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use bartowski/Vortex5_Scarlet-Shadow-31B-GGUF with Docker Model Runner:
```
docker model run hf.co/bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M
```

Lemonade

How to use bartowski/Vortex5_Scarlet-Shadow-31B-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Vortex5_Scarlet-Shadow-31B-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-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 bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use bartowski/Vortex5_Scarlet-Shadow-31B-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_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 "bartowski/Vortex5_Scarlet-Shadow-31B-GGUF:Q4_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"

bartowski commited on 29 days ago

Commit

08e494b

verified ·

1 Parent(s): 2893987

Upload folder using huggingface_hub

Browse files

Files changed (3) hide show

.gitattributes +2 -0
Vortex5_Scarlet-Shadow-31B-bf16/Vortex5_Scarlet-Shadow-31B-bf16-00001-of-00002.gguf +3 -0
Vortex5_Scarlet-Shadow-31B-bf16/Vortex5_Scarlet-Shadow-31B-bf16-00002-of-00002.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -57,3 +57,5 @@ Vortex5_Scarlet-Shadow-31B-Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
 Vortex5_Scarlet-Shadow-31B-Q6_K_S.gguf filter=lfs diff=lfs merge=lfs -text
 Vortex5_Scarlet-Shadow-31B-Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
 Vortex5_Scarlet-Shadow-31B-Q6_K_L.gguf filter=lfs diff=lfs merge=lfs -text

 Vortex5_Scarlet-Shadow-31B-Q6_K_S.gguf filter=lfs diff=lfs merge=lfs -text
 Vortex5_Scarlet-Shadow-31B-Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
 Vortex5_Scarlet-Shadow-31B-Q6_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+Vortex5_Scarlet-Shadow-31B-bf16/Vortex5_Scarlet-Shadow-31B-bf16-00001-of-00002.gguf filter=lfs diff=lfs merge=lfs -text
+Vortex5_Scarlet-Shadow-31B-bf16/Vortex5_Scarlet-Shadow-31B-bf16-00002-of-00002.gguf filter=lfs diff=lfs merge=lfs -text

Vortex5_Scarlet-Shadow-31B-bf16/Vortex5_Scarlet-Shadow-31B-bf16-00001-of-00002.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:2aa321b5e76f797375087c1ad35009e33649251ab742b30ffe1ec886d817567e
+size 39897592544

Vortex5_Scarlet-Shadow-31B-bf16/Vortex5_Scarlet-Shadow-31B-bf16-00002-of-00002.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:fc351291bfd5197045ba92d7aec069859e7dc0279874a8e458058798efbea64c
+size 21515598272