Update README.md
Browse files
README.md
CHANGED
@@ -1,92 +1,90 @@
|
|
1 |
-
---
|
2 |
-
base_model: tiiuae/Falcon3-10B-Instruct
|
3 |
-
license: other
|
4 |
-
license_name: falcon-llm-license
|
5 |
-
license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
|
6 |
-
model_creator: tiiuae
|
7 |
-
model_name: Falcon3-10B-Instruct
|
8 |
-
quantized_by: Second State Inc.
|
9 |
-
language:
|
10 |
-
- en
|
11 |
-
- fr
|
12 |
-
- es
|
13 |
-
- pt
|
14 |
-
library_name: transformers
|
15 |
-
tags:
|
16 |
-
- falcon3
|
17 |
-
---
|
18 |
-
|
19 |
-
<!-- header start -->
|
20 |
-
<!-- 200823 -->
|
21 |
-
<div style="width: auto; margin-left: auto; margin-right: auto">
|
22 |
-
<img src="https://github.com/LlamaEdge/LlamaEdge/raw/dev/assets/logo.svg" style="width: 100%; min-width: 400px; display: block; margin: auto;">
|
23 |
-
</div>
|
24 |
-
<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
|
25 |
-
<!-- header end -->
|
26 |
-
|
27 |
-
# Falcon3-10B-Instruct-GGUF
|
28 |
-
|
29 |
-
## Original Model
|
30 |
-
|
31 |
-
[tiiuae/Falcon3-10B-Instruct](https://huggingface.co/tiiuae/Falcon3-10B-Instruct)
|
32 |
-
|
33 |
-
## Run with LlamaEdge
|
34 |
-
|
35 |
-
- LlamaEdge version:
|
36 |
-
|
37 |
-
|
38 |
-
|
39 |
-
- Prompt
|
40 |
-
|
41 |
-
- Prompt
|
42 |
-
|
43 |
-
|
44 |
-
|
45 |
-
|
46 |
-
<|
|
47 |
-
|
48 |
-
<|
|
49 |
-
|
50 |
-
|
51 |
-
|
52 |
-
|
53 |
-
-
|
54 |
-
|
55 |
-
|
56 |
-
|
57 |
-
|
58 |
-
|
59 |
-
|
60 |
-
--
|
61 |
-
|
62 |
-
|
63 |
-
|
64 |
-
|
65 |
-
|
66 |
-
|
67 |
-
|
68 |
-
|
69 |
-
|
70 |
-
|
71 |
-
|
72 |
-
|
73 |
-
|
74 |
-
|
75 |
-
|
76 |
-
|
|
77 |
-
|
|
78 |
-
| [Falcon3-10B-Instruct-
|
79 |
-
| [Falcon3-10B-Instruct-
|
80 |
-
| [Falcon3-10B-Instruct-
|
81 |
-
| [Falcon3-10B-Instruct-
|
82 |
-
| [Falcon3-10B-Instruct-
|
83 |
-
| [Falcon3-10B-Instruct-
|
84 |
-
| [Falcon3-10B-Instruct-
|
85 |
-
| [Falcon3-10B-Instruct-
|
86 |
-
| [Falcon3-10B-Instruct-
|
87 |
-
| [Falcon3-10B-Instruct-
|
88 |
-
| [Falcon3-10B-Instruct-
|
89 |
-
|
90 |
-
| [Falcon3-10B-Instruct-f16.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-f16.gguf) | f16 | 16 | 20.6 GB| |
|
91 |
-
|
92 |
*Quantized with llama.cpp b4381*
|
|
|
1 |
+
---
|
2 |
+
base_model: tiiuae/Falcon3-10B-Instruct
|
3 |
+
license: other
|
4 |
+
license_name: falcon-llm-license
|
5 |
+
license_link: https://falconllm.tii.ae/falcon-terms-and-conditions.html
|
6 |
+
model_creator: tiiuae
|
7 |
+
model_name: Falcon3-10B-Instruct
|
8 |
+
quantized_by: Second State Inc.
|
9 |
+
language:
|
10 |
+
- en
|
11 |
+
- fr
|
12 |
+
- es
|
13 |
+
- pt
|
14 |
+
library_name: transformers
|
15 |
+
tags:
|
16 |
+
- falcon3
|
17 |
+
---
|
18 |
+
|
19 |
+
<!-- header start -->
|
20 |
+
<!-- 200823 -->
|
21 |
+
<div style="width: auto; margin-left: auto; margin-right: auto">
|
22 |
+
<img src="https://github.com/LlamaEdge/LlamaEdge/raw/dev/assets/logo.svg" style="width: 100%; min-width: 400px; display: block; margin: auto;">
|
23 |
+
</div>
|
24 |
+
<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
|
25 |
+
<!-- header end -->
|
26 |
+
|
27 |
+
# Falcon3-10B-Instruct-GGUF
|
28 |
+
|
29 |
+
## Original Model
|
30 |
+
|
31 |
+
[tiiuae/Falcon3-10B-Instruct](https://huggingface.co/tiiuae/Falcon3-10B-Instruct)
|
32 |
+
|
33 |
+
## Run with LlamaEdge
|
34 |
+
|
35 |
+
- LlamaEdge version: [v0.16.0](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.16.0) and above
|
36 |
+
|
37 |
+
- Prompt template
|
38 |
+
|
39 |
+
- Prompt type: `falcon3`
|
40 |
+
|
41 |
+
- Prompt string
|
42 |
+
|
43 |
+
```text
|
44 |
+
<|system|>
|
45 |
+
You are a helpful friendly assistant Falcon3 from TII, try to follow instructions as much as possible.
|
46 |
+
<|user|>
|
47 |
+
{user_message}
|
48 |
+
<|assistant|>
|
49 |
+
```
|
50 |
+
|
51 |
+
- Context size: `32000`
|
52 |
+
|
53 |
+
- Run as LlamaEdge service
|
54 |
+
|
55 |
+
```bash
|
56 |
+
wasmedge --dir .:. --nn-preload default:GGML:AUTO:Falcon3-10B-Instruct-Q5_K_M.gguf \
|
57 |
+
llama-api-server.wasm \
|
58 |
+
--model-name Falcon3-10B-Instruct \
|
59 |
+
--prompt-template falcon3 \
|
60 |
+
--ctx-size 32000
|
61 |
+
```
|
62 |
+
|
63 |
+
- Run as LlamaEdge command app
|
64 |
+
|
65 |
+
```bash
|
66 |
+
wasmedge --dir .:. --nn-preload default:GGML:AUTO:Falcon3-10B-Instruct-Q5_K_M.gguf \
|
67 |
+
llama-chat.wasm \
|
68 |
+
--prompt-template falcon3 \
|
69 |
+
--ctx-size 32000
|
70 |
+
```
|
71 |
+
|
72 |
+
## Quantized GGUF Models
|
73 |
+
|
74 |
+
| Name | Quant method | Bits | Size | Use case |
|
75 |
+
| ---- | ---- | ---- | ---- | ----- |
|
76 |
+
| [Falcon3-10B-Instruct-Q2_K.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q2_K.gguf) | Q2_K | 2 | 3.92 GB| smallest, significant quality loss - not recommended for most purposes |
|
77 |
+
| [Falcon3-10B-Instruct-Q3_K_L.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q3_K_L.gguf) | Q3_K_L | 3 | 5.45 GB| small, substantial quality loss |
|
78 |
+
| [Falcon3-10B-Instruct-Q3_K_M.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q3_K_M.gguf) | Q3_K_M | 3 | 5.05 GB| very small, high quality loss |
|
79 |
+
| [Falcon3-10B-Instruct-Q3_K_S.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q3_K_S.gguf) | Q3_K_S | 3 | 4.59 GB| very small, high quality loss |
|
80 |
+
| [Falcon3-10B-Instruct-Q4_0.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q4_0.gguf) | Q4_0 | 4 | 5.91 GB| legacy; small, very high quality loss - prefer using Q3_K_M |
|
81 |
+
| [Falcon3-10B-Instruct-Q4_K_M.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q4_K_M.gguf) | Q4_K_M | 4 | 6.29 GB| medium, balanced quality - recommended |
|
82 |
+
| [Falcon3-10B-Instruct-Q4_K_S.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q4_K_S.gguf) | Q4_K_S | 4 | 5.95 GB| small, greater quality loss |
|
83 |
+
| [Falcon3-10B-Instruct-Q5_0.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q5_0.gguf) | Q5_0 | 5 | 7.14 GB| legacy; medium, balanced quality - prefer using Q4_K_M |
|
84 |
+
| [Falcon3-10B-Instruct-Q5_K_M.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q5_K_M.gguf) | Q5_K_M | 5 | 7.34 GB| large, very low quality loss - recommended |
|
85 |
+
| [Falcon3-10B-Instruct-Q5_K_S.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q5_K_S.gguf) | Q5_K_S | 5 | 7.14 GB| large, low quality loss - recommended |
|
86 |
+
| [Falcon3-10B-Instruct-Q6_K.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q6_K.gguf) | Q6_K | 6 | 8.46 GB| very large, extremely low quality loss |
|
87 |
+
| [Falcon3-10B-Instruct-Q8_0.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-Q8_0.gguf) | Q8_0 | 8 | 11.0 GB| very large, extremely low quality loss - not recommended |
|
88 |
+
| [Falcon3-10B-Instruct-f16.gguf](https://huggingface.co/second-state/Falcon3-10B-Instruct-GGUF/blob/main/Falcon3-10B-Instruct-f16.gguf) | f16 | 16 | 20.6 GB| |
|
89 |
+
|
|
|
|
|
90 |
*Quantized with llama.cpp b4381*
|