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

Libraries

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

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

pipe = pipeline("text-generation", model="second-state/Falcon3-3B-Instruct-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("second-state/Falcon3-3B-Instruct-GGUF")
model = AutoModelForCausalLM.from_pretrained("second-state/Falcon3-3B-Instruct-GGUF")

llama-cpp-python

How to use second-state/Falcon3-3B-Instruct-GGUF with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="second-state/Falcon3-3B-Instruct-GGUF",
	filename="Falcon3-3B-Instruct-Q2_K.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use second-state/Falcon3-3B-Instruct-GGUF with llama.cpp:

Install from brew

brew install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf second-state/Falcon3-3B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf second-state/Falcon3-3B-Instruct-GGUF:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama-server -hf second-state/Falcon3-3B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
llama-cli -hf second-state/Falcon3-3B-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-3B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf second-state/Falcon3-3B-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-3B-Instruct-GGUF:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf second-state/Falcon3-3B-Instruct-GGUF:Q4_K_M

Use Docker

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

LM Studio
Jan

vLLM

How to use second-state/Falcon3-3B-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-3B-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-3B-Instruct-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

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

SGLang

How to use second-state/Falcon3-3B-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-3B-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-3B-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-3B-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-3B-Instruct-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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

Unsloth Studio

How to use second-state/Falcon3-3B-Instruct-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 second-state/Falcon3-3B-Instruct-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 second-state/Falcon3-3B-Instruct-GGUF to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for second-state/Falcon3-3B-Instruct-GGUF to start chatting

How to use second-state/Falcon3-3B-Instruct-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf second-state/Falcon3-3B-Instruct-GGUF: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": "second-state/Falcon3-3B-Instruct-GGUF:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use second-state/Falcon3-3B-Instruct-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama-server -hf second-state/Falcon3-3B-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-3B-Instruct-GGUF:Q4_K_M

Run Hermes

hermes

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

Lemonade

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

Pull the model

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

Run and chat with the model

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

List all available models

lemonade list

apepkuss79 commited on Dec 23, 2024

Commit

e37417c

verified ·

1 Parent(s): 74a314d

Update models

Browse files

Files changed (15) hide show

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

+{
+  "architectures": [
+    "LlamaForCausalLM"
+  ],
+  "attention_bias": false,
+  "attention_dropout": 0.0,
+  "eos_token_id": 11,
+  "head_dim": 256,
+  "hidden_act": "silu",
+  "hidden_size": 3072,
+  "initializer_range": 0.02,
+  "intermediate_size": 9216,
+  "max_position_embeddings": 32768,
+  "mlp_bias": false,
+  "model_type": "llama",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 22,
+  "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:14f071708306325cfbb2dc7a66d59e20253b3118d1939b8b74ac314ff9630763
+size 1353879552

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

+version https://git-lfs.github.com/spec/v1
+oid sha256:0afbb1accc0b788f894d19100b426d7713eab032a99248bb17d86e3a64c91ff5
+size 1673220096

+version https://git-lfs.github.com/spec/v1
+oid sha256:44a7f8c67b77099e0933bcc02d7eb4d70d544e6b7e16d36f6b6833e84fc00998
+size 1549406208

+version https://git-lfs.github.com/spec/v1
+oid sha256:1a09e857ac89d8deb4307efffbd8c5de72e39be1c884916e34e5d43349e60e3d
+size 1924583424

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

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

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

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

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

	@@ -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:f2aecbcb874a19ad35d68803a01adca4b937de24c826fc603bacc1af7e311660
+size 3434532864

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