Commit
•
48128cf
1
Parent(s):
e4a4162
Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
@@ -1,3 +1,112 @@
|
|
1 |
---
|
2 |
-
|
|
|
|
|
|
|
|
|
3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
+
base_model: meetkai/functionary-small-v3.1
|
3 |
+
license: mit
|
4 |
+
model_creator: meetkai
|
5 |
+
model_name: functionary-small-v3.1
|
6 |
+
quantized_by: Second State Inc.
|
7 |
---
|
8 |
+
|
9 |
+
<!-- header start -->
|
10 |
+
<!-- 200823 -->
|
11 |
+
<div style="width: auto; margin-left: auto; margin-right: auto">
|
12 |
+
<img src="https://github.com/LlamaEdge/LlamaEdge/raw/dev/assets/logo.svg" style="width: 100%; min-width: 400px; display: block; margin: auto;">
|
13 |
+
</div>
|
14 |
+
<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
|
15 |
+
<!-- header end -->
|
16 |
+
|
17 |
+
# functionary-small-v3.1-GGUF
|
18 |
+
|
19 |
+
## Original Model
|
20 |
+
|
21 |
+
[meetkai/functionary-small-v3.1](https://huggingface.co/meetkai/functionary-small-v3.1)
|
22 |
+
|
23 |
+
## Run with LlamaEdge
|
24 |
+
|
25 |
+
- LlamaEdge version: coming soon
|
26 |
+
|
27 |
+
<!-- - LlamaEdge version: [v0.14.3](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.14.3) -->
|
28 |
+
|
29 |
+
- Prompt template
|
30 |
+
|
31 |
+
- Prompt type: `functionary-31`
|
32 |
+
|
33 |
+
- Prompt string
|
34 |
+
|
35 |
+
```text
|
36 |
+
<|start_header_id|>system<|end_header_id|>
|
37 |
+
|
38 |
+
Environment: ipython
|
39 |
+
|
40 |
+
Cutting Knowledge Date: December 2023
|
41 |
+
|
42 |
+
|
43 |
+
You have access to the following functions:
|
44 |
+
|
45 |
+
Use the function 'get_current_weather' to 'Get the current weather'
|
46 |
+
{"name":"get_current_weather","description":"Get the current weather","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g. San Francisco, CA"}},"required":["location"]}}
|
47 |
+
|
48 |
+
|
49 |
+
Think very carefully before calling functions.
|
50 |
+
If a you choose to call a function ONLY reply in the following format:
|
51 |
+
<{start_tag}={function_name}>{parameters}{end_tag}
|
52 |
+
where
|
53 |
+
|
54 |
+
start_tag => `<function`
|
55 |
+
parameters => a JSON dict with the function argument name as key and function argument value as value.
|
56 |
+
end_tag => `</function>`
|
57 |
+
|
58 |
+
Here is an example,
|
59 |
+
<function=example_function_name>{"example_name": "example_value"}</function>
|
60 |
+
|
61 |
+
Reminder:
|
62 |
+
- If looking for real time information use relevant functions before falling back to brave_search
|
63 |
+
- Function calls MUST follow the specified format, start with <function= and end with </function>
|
64 |
+
- Required parameters MUST be specified
|
65 |
+
- Only call one function at a time
|
66 |
+
- Put the entire function call reply on one line
|
67 |
+
|
68 |
+
<|eot_id|><|start_header_id|>user<|end_header_id|>
|
69 |
+
|
70 |
+
What is the weather like in Beijing today?<|eot_id|><|start_header_id|>assistant<|end_header_id|>
|
71 |
+
```
|
72 |
+
|
73 |
+
- Context size: `128000`
|
74 |
+
|
75 |
+
- Run as LlamaEdge service
|
76 |
+
|
77 |
+
```bash
|
78 |
+
wasmedge --dir .:. --nn-preload default:GGML:AUTO:functionary-small-v3.1-Q5_K_M.gguf \
|
79 |
+
llama-api-server.wasm \
|
80 |
+
--model-name functionary-small-v3.1 \
|
81 |
+
--prompt-template functionary-31 \
|
82 |
+
--ctx-size 128000
|
83 |
+
```
|
84 |
+
|
85 |
+
- Run as LlamaEdge command app
|
86 |
+
|
87 |
+
```bash
|
88 |
+
wasmedge --dir .:. --nn-preload default:GGML:AUTO:functionary-small-v3.1-Q5_K_M.gguf \
|
89 |
+
llama-chat.wasm \
|
90 |
+
--prompt-template functionary-31 \
|
91 |
+
--ctx-size 128000
|
92 |
+
```
|
93 |
+
|
94 |
+
## Quantized GGUF Models
|
95 |
+
|
96 |
+
| Name | Quant method | Bits | Size | Use case |
|
97 |
+
| ---- | ---- | ---- | ---- | ----- |
|
98 |
+
| [functionary-small-v3.1-Q2_K.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q2_K.gguf) | Q2_K | 2 | 3.18 GB| smallest, significant quality loss - not recommended for most purposes |
|
99 |
+
| [functionary-small-v3.1-Q3_K_L.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q3_K_L.gguf) | Q3_K_L | 3 | 4.32 GB| small, substantial quality loss |
|
100 |
+
| [functionary-small-v3.1-Q3_K_M.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q3_K_M.gguf) | Q3_K_M | 3 | 4.02 GB| very small, high quality loss |
|
101 |
+
| [functionary-small-v3.1-Q3_K_S.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q3_K_S.gguf) | Q3_K_S | 3 | 3.66 GB| very small, high quality loss |
|
102 |
+
| [functionary-small-v3.1-Q4_0.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q4_0.gguf) | Q4_0 | 4 | 4.66 GB| legacy; small, very high quality loss - prefer using Q3_K_M |
|
103 |
+
| [functionary-small-v3.1-Q4_K_M.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q4_K_M.gguf) | Q4_K_M | 4 | 4.92 GB| medium, balanced quality - recommended |
|
104 |
+
| [functionary-small-v3.1-Q4_K_S.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q4_K_S.gguf) | Q4_K_S | 4 | 4.69 GB| small, greater quality loss |
|
105 |
+
| [functionary-small-v3.1-Q5_0.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q5_0.gguf) | Q5_0 | 5 | 5.60 GB| legacy; medium, balanced quality - prefer using Q4_K_M |
|
106 |
+
| [functionary-small-v3.1-Q5_K_M.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q5_K_M.gguf) | Q5_K_M | 5 | 5.73 GB| large, very low quality loss - recommended |
|
107 |
+
| [functionary-small-v3.1-Q5_K_S.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q5_K_S.gguf) | Q5_K_S | 5 | 5.60 GB| large, low quality loss - recommended |
|
108 |
+
| [functionary-small-v3.1-Q6_K.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q6_K.gguf) | Q6_K | 6 | 6.60 GB| very large, extremely low quality loss |
|
109 |
+
| [functionary-small-v3.1-Q8_0.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-Q8_0.gguf) | Q8_0 | 8 | 8.54 GB| very large, extremely low quality loss - not recommended |
|
110 |
+
| [functionary-small-v3.1-f16.gguf](https://huggingface.co/second-state/functionary-small-v3.1-GGUF/blob/main/functionary-small-v3.1-f16.gguf) | f16 | 16 | 16.1 GB| |
|
111 |
+
|
112 |
+
*Quantized with llama.cpp b3807*
|