Instructions to use second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf second-state/functionary-small-v3.1-GGUF:Q4_K_M

Use Docker

docker model run hf.co/second-state/functionary-small-v3.1-GGUF:Q4_K_M

LM Studio
Jan
Ollama
How to use second-state/functionary-small-v3.1-GGUF with Ollama:
```
ollama run hf.co/second-state/functionary-small-v3.1-GGUF:Q4_K_M
```
Unsloth Desktop

How to use second-state/functionary-small-v3.1-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf second-state/functionary-small-v3.1-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": "second-state/functionary-small-v3.1-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use second-state/functionary-small-v3.1-GGUF with Docker Model Runner:
```
docker model run hf.co/second-state/functionary-small-v3.1-GGUF:Q4_K_M
```

Lemonade

How to use second-state/functionary-small-v3.1-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull second-state/functionary-small-v3.1-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.functionary-small-v3.1-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-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 second-state/functionary-small-v3.1-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use second-state/functionary-small-v3.1-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf second-state/functionary-small-v3.1-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 "second-state/functionary-small-v3.1-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"

apepkuss79 commited on Oct 9, 2024

Commit

e4a4162

verified ·

1 Parent(s): a676819

Update models

Browse files

Files changed (15) hide show

.gitattributes +13 -0
config.json +43 -0
functionary-small-v3.1-Q2_K.gguf +3 -0
functionary-small-v3.1-Q3_K_L.gguf +3 -0
functionary-small-v3.1-Q3_K_M.gguf +3 -0
functionary-small-v3.1-Q3_K_S.gguf +3 -0
functionary-small-v3.1-Q4_0.gguf +3 -0
functionary-small-v3.1-Q4_K_M.gguf +3 -0
functionary-small-v3.1-Q4_K_S.gguf +3 -0
functionary-small-v3.1-Q5_0.gguf +3 -0
functionary-small-v3.1-Q5_K_M.gguf +3 -0
functionary-small-v3.1-Q5_K_S.gguf +3 -0
functionary-small-v3.1-Q6_K.gguf +3 -0
functionary-small-v3.1-Q8_0.gguf +3 -0
functionary-small-v3.1-f16.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,16 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text

 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q4_0.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q5_0.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+functionary-small-v3.1-f16.gguf filter=lfs diff=lfs merge=lfs -text

config.json ADDED Viewed

	@@ -0,0 +1,43 @@

+{
+  "_name_or_path": "meta-llama/Meta-Llama-3.1-8B-Instruct",
+  "architectures": [
+    "LlamaForCausalLM"
+  ],
+  "auto_map": {
+    "AutoModelForCausalLM": "modeling_functionary.FunctionaryForCausalLM"
+  },
+  "attention_bias": false,
+  "attention_dropout": 0.0,
+  "bos_token_id": 128000,
+  "eos_token_id": [
+    128001,
+    128008,
+    128009
+  ],
+  "hidden_act": "silu",
+  "hidden_size": 4096,
+  "initializer_range": 0.02,
+  "intermediate_size": 14336,
+  "max_position_embeddings": 131072,
+  "mlp_bias": false,
+  "model_type": "llama",
+  "num_attention_heads": 32,
+  "num_hidden_layers": 32,
+  "num_key_value_heads": 8,
+  "pretraining_tp": 1,
+  "rms_norm_eps": 1e-05,
+  "rope_scaling": {
+    "factor": 8.0,
+    "high_freq_factor": 4.0,
+    "low_freq_factor": 1.0,
+    "original_max_position_embeddings": 8192,
+    "rope_type": "llama3"
+  },
+  "rope_theta": 500000.0,
+  "sliding_window": 16384,
+  "tie_word_embeddings": false,
+  "torch_dtype": "bfloat16",
+  "transformers_version": "4.44.0.dev0",
+  "use_cache": false,
+  "vocab_size": 128256
+}

functionary-small-v3.1-Q2_K.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:499da47aa606ba0ce70efba239e8e1f073c4523506d19e6939be90e6b98819bc
+size 3179134560

functionary-small-v3.1-Q3_K_L.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q3_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:76687186471f75c4c80d2fbb0b7c68e8e3141f2a9dd5e4e9fcb6e1ae8dd8500e
+size 4018921056

functionary-small-v3.1-Q3_K_S.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q4_0.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q4_K_M.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q4_K_S.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q5_0.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q5_K_M.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:4a3b603347a34909899096e7653264cb8d3f2686918249b82eb0b6e28b36dbc3
+size 5732990560

functionary-small-v3.1-Q5_K_S.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q6_K.gguf ADDED Viewed

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

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

functionary-small-v3.1-Q8_0.gguf ADDED Viewed

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

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

functionary-small-v3.1-f16.gguf ADDED Viewed

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:936444ff3eccdede50d55c0c4247dfc018ae28797e5d194c721741902b7317b6
+size 16068894304