Instructions to use second-state/Falcon3-10B-Instruct-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use second-state/Falcon3-10B-Instruct-GGUF with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="second-state/Falcon3-10B-Instruct-GGUF")

# pip install -U transformers accelerate
# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("second-state/Falcon3-10B-Instruct-GGUF")
model = AutoModelForCausalLM.from_pretrained("second-state/Falcon3-10B-Instruct-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf second-state/Falcon3-10B-Instruct-GGUF:Q4_K_M

Use Docker

docker model run hf.co/second-state/Falcon3-10B-Instruct-GGUF:Q4_K_M

Llama new
LM Studio
Jan

vLLM

How to use second-state/Falcon3-10B-Instruct-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/second-state/Falcon3-10B-Instruct-GGUF:Q4_K_M

SGLang

How to use second-state/Falcon3-10B-Instruct-GGUF with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "second-state/Falcon3-10B-Instruct-GGUF" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "second-state/Falcon3-10B-Instruct-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "second-state/Falcon3-10B-Instruct-GGUF" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "second-state/Falcon3-10B-Instruct-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use second-state/Falcon3-10B-Instruct-GGUF with Ollama:
```
ollama run hf.co/second-state/Falcon3-10B-Instruct-GGUF:Q4_K_M
```
Unsloth Desktop

How to use second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use second-state/Falcon3-10B-Instruct-GGUF with Docker Model Runner:
```
docker model run hf.co/second-state/Falcon3-10B-Instruct-GGUF:Q4_K_M
```

Lemonade

How to use second-state/Falcon3-10B-Instruct-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull second-state/Falcon3-10B-Instruct-GGUF:Q4_K_M

Run and chat with the model

lemonade run user.Falcon3-10B-Instruct-GGUF-Q4_K_M

List all available models

lemonade list

Hermes Agent

How to use second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-GGUF:Q4_K_M

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use second-state/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-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/Falcon3-10B-Instruct-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 Dec 23, 2024

Commit

c680dd7

verified ·

1 Parent(s): 0249403

Update models

Browse files

Files changed (15) hide show

.gitattributes +13 -0
Falcon3-10B-Instruct-Q2_K.gguf +3 -0
Falcon3-10B-Instruct-Q3_K_L.gguf +3 -0
Falcon3-10B-Instruct-Q3_K_M.gguf +3 -0
Falcon3-10B-Instruct-Q3_K_S.gguf +3 -0
Falcon3-10B-Instruct-Q4_0.gguf +3 -0
Falcon3-10B-Instruct-Q4_K_M.gguf +3 -0
Falcon3-10B-Instruct-Q4_K_S.gguf +3 -0
Falcon3-10B-Instruct-Q5_0.gguf +3 -0
Falcon3-10B-Instruct-Q5_K_M.gguf +3 -0
Falcon3-10B-Instruct-Q5_K_S.gguf +3 -0
Falcon3-10B-Instruct-Q6_K.gguf +3 -0
Falcon3-10B-Instruct-Q8_0.gguf +3 -0
Falcon3-10B-Instruct-f16.gguf +3 -0
config.json +28 -0

@@ -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
+Falcon3-10B-Instruct-Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q4_0.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q5_0.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
+Falcon3-10B-Instruct-f16.gguf filter=lfs diff=lfs merge=lfs -text

+{
+  "architectures": [
+    "LlamaForCausalLM"
+  ],
+  "attention_bias": false,
+  "attention_dropout": 0.0,
+  "bos_token_id": 11,
+  "eos_token_id": 11,
+  "head_dim": 256,
+  "hidden_act": "silu",
+  "hidden_size": 3072,
+  "intermediate_size": 23040,
+  "max_position_embeddings": 32768,
+  "mlp_bias": false,
+  "model_type": "llama",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 40,
+  "num_key_value_heads": 4,
+  "pretraining_tp": 1,
+  "rms_norm_eps": 1e-06,
+  "rope_scaling": null,
+  "rope_theta": 1000042,
+  "tie_word_embeddings": false,
+  "torch_dtype": "bfloat16",
+  "transformers_version": "4.46.1",
+  "use_cache": true,
+  "vocab_size": 131072
+}

+version https://git-lfs.github.com/spec/v1
+oid sha256:4067977ccbfb6c0def8786a693970722d370ed2971d7bd44deb6be4ed80418a0
+size 3924047264

+version https://git-lfs.github.com/spec/v1
+oid sha256:391c0b1538f430bd434c690642e464ca8f8173790899defa078d0464736639e8
+size 5450806688

+version https://git-lfs.github.com/spec/v1
+oid sha256:9b28fc6a168d8032c77adb31d90dbd49aa1215a1e65c7bf73fc2961414398bd9
+size 5052478880

+version https://git-lfs.github.com/spec/v1
+oid sha256:7b191ee8bcd6b8cabea7c7d38d8e2828f3e184db2d878a9527a4ee706989d116
+size 4591138208

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:0710b0eee168b52279db4507ced89cd2ad7400605bc94781b506c0df0149485a
+size 6287521184

+version https://git-lfs.github.com/spec/v1
+oid sha256:7677005715bba79fcb97e6a5752562dc43bd13319e0047a8b7a11a87666af1d9
+size 5952157088

+version https://git-lfs.github.com/spec/v1
+oid sha256:8532cb48319b0c0618068010d4c858035cd2ca53529e84547f7d960a0bcf1cf4
+size 7144191392

+version https://git-lfs.github.com/spec/v1
+oid sha256:21aa4e0ffd723e44050fb606fb06c6f751b61272d0a3eb230b7d0b0c0096e7ec
+size 7340553632

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

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

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

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

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

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:68f5dfc8589711205d954f2d281324c793fb6c8bd4ecf37711b89be1cdc4377d
+size 20616557984