Instructions to use SciTools/OnBoard with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Notebooks
Google Colab
Kaggle
Local Apps Settings

How to use SciTools/OnBoard 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 SciTools/OnBoard:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf SciTools/OnBoard:Q4_K_M

Install from WinGet (Windows)

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

Use Docker

docker model run hf.co/SciTools/OnBoard:Q4_K_M

LM Studio
Jan
Ollama
How to use SciTools/OnBoard with Ollama:
```
ollama run hf.co/SciTools/OnBoard:Q4_K_M
```

Unsloth Studio

How to use SciTools/OnBoard 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 SciTools/OnBoard 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 SciTools/OnBoard to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for SciTools/OnBoard to start chatting

How to use SciTools/OnBoard with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf SciTools/OnBoard: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": "SciTools/OnBoard:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use SciTools/OnBoard with Docker Model Runner:
```
docker model run hf.co/SciTools/OnBoard:Q4_K_M
```

Lemonade

How to use SciTools/OnBoard with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull SciTools/OnBoard:Q4_K_M

Run and chat with the model

lemonade run user.OnBoard-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use SciTools/OnBoard with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf SciTools/OnBoard: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 SciTools/OnBoard:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use SciTools/OnBoard with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf SciTools/OnBoard: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 "SciTools/OnBoard: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"

zenpeach commited on 3 days ago

Commit

1c707f2

verified ·

1 Parent(s): a46248e

Update README.md

Browse files

Files changed (1) hide show

README.md +3 -5

README.md CHANGED Viewed

@@ -9,8 +9,8 @@ tags:
 # OnBoard recommended models (GGUF)
-The models OnBoard's installer and `ullama-recommend` offer, mirrored here for
-stable, provenance-clear hosting. All files are 4-bit GGUF quantizations for
 llama.cpp-based serving (shipped with OnBoard/Understand as `ullama`), all
 under the Apache-2.0 license, mirrored unmodified from the source repos below.
@@ -39,9 +39,7 @@ the best chat answers.
 | Gemma 4 E2B | 3.1 GB | OnBoard's default model. Good at both chat and code summaries. |
 | Qwen3.5 2B | 1.3 GB | Writes good code summaries remarkably fast, but struggled in our chat testing. |
-Selection method, scores, and per-model sampling settings are documented in
-the [stinb/ullama](https://github.com/stinb/ullama) repo (`model_info.md`,
-`launcher/ullama-models.conf`).
 ## Files, licensing, and provenance

 # OnBoard recommended models (GGUF)
+The models OnBoard's installer offers, mirrored here for
+stable hosting. All files are 4-bit GGUF quantizations for
 llama.cpp-based serving (shipped with OnBoard/Understand as `ullama`), all
 under the Apache-2.0 license, mirrored unmodified from the source repos below.
 | Gemma 4 E2B | 3.1 GB | OnBoard's default model. Good at both chat and code summaries. |
 | Qwen3.5 2B | 1.3 GB | Writes good code summaries remarkably fast, but struggled in our chat testing. |
 ## Files, licensing, and provenance