apepkuss79 commited on
Commit
036788a
1 Parent(s): 1e57684

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +87 -38
README.md CHANGED
@@ -1,38 +1,87 @@
1
- # FACET
2
-
3
- ## How to run
4
-
5
- ```bash
6
- python main.py --full-name <hf-account-name/hf-model-name> -s <target-directory-to-save-git-clone> --enable-converter -c <path-to-python-convert-script> --enable-quantizer -q <path-to-llamacpp-quantizer> -t q4_0
7
- ```
8
-
9
- For example,
10
-
11
- ```bash
12
- python main.py --full-name baichuan-inc/Baichuan2-13B-Chat -s /home/ubuntu/workspace/models/ --enable-converter -c /home/ubuntu/workspace/llama.cpp/convert.py --enable-quantizer -q llama-cpp-quantizer -t Q5_K_M
13
- ```
14
-
15
- ## Allowed quantization types
16
-
17
- ```text
18
- 2 or Q4_0 : 3.56G, +0.2166 ppl @ LLaMA-v1-7B
19
- 3 or Q4_1 : 3.90G, +0.1585 ppl @ LLaMA-v1-7B
20
- 8 or Q5_0 : 4.33G, +0.0683 ppl @ LLaMA-v1-7B
21
- 9 or Q5_1 : 4.70G, +0.0349 ppl @ LLaMA-v1-7B
22
- 10 or Q2_K : 2.63G, +0.6717 ppl @ LLaMA-v1-7B
23
- 12 or Q3_K : alias for Q3_K_M
24
- 11 or Q3_K_S : 2.75G, +0.5551 ppl @ LLaMA-v1-7B
25
- 12 or Q3_K_M : 3.07G, +0.2496 ppl @ LLaMA-v1-7B
26
- 13 or Q3_K_L : 3.35G, +0.1764 ppl @ LLaMA-v1-7B
27
- 15 or Q4_K : alias for Q4_K_M
28
- 14 or Q4_K_S : 3.59G, +0.0992 ppl @ LLaMA-v1-7B
29
- 15 or Q4_K_M : 3.80G, +0.0532 ppl @ LLaMA-v1-7B
30
- 17 or Q5_K : alias for Q5_K_M
31
- 16 or Q5_K_S : 4.33G, +0.0400 ppl @ LLaMA-v1-7B
32
- 17 or Q5_K_M : 4.45G, +0.0122 ppl @ LLaMA-v1-7B
33
- 18 or Q6_K : 5.15G, -0.0008 ppl @ LLaMA-v1-7B
34
- 7 or Q8_0 : 6.70G, +0.0004 ppl @ LLaMA-v1-7B
35
- 1 or F16 : 13.00G @ 7B
36
- 0 or F32 : 26.00G @ 7B
37
- COPY : only copy tensors, no quantizing
38
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: Qwen/Qwen2.5-3B-Instruct
3
+ license: other
4
+ license_name: qwen-research
5
+ license_link: https://huggingface.co/Qwen/Qwen2.5-3B-Instruct/blob/main/LICENSEE
6
+ model_creator: Qwen
7
+ model_name: QQwen2.5-3B-Instruct
8
+ quantized_by: Second State Inc.
9
+ language:
10
+ - en
11
+ pipeline_tag: text-generation
12
+ tags:
13
+ - chat
14
+ ---
15
+
16
+ <!-- header start -->
17
+ <!-- 200823 -->
18
+ <div style="width: auto; margin-left: auto; margin-right: auto">
19
+ <img src="https://github.com/LlamaEdge/LlamaEdge/raw/dev/assets/logo.svg" style="width: 100%; min-width: 400px; display: block; margin: auto;">
20
+ </div>
21
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
22
+ <!-- header end -->
23
+
24
+ # Qwen2.5-3B-Instruct-GGUF
25
+
26
+ ## Original Model
27
+
28
+ [Qwen/Qwen2.5-3B-Instruct](https://huggingface.co/Qwen/Qwen2.5-3B-Instruct)
29
+
30
+ ## Run with LlamaEdge
31
+
32
+ - LlamaEdge version: [v0.14.3](https://github.com/LlamaEdge/LlamaEdge/releases/tag/0.14.3) and above
33
+
34
+ - Prompt template
35
+
36
+ - Prompt type: `chatml`
37
+
38
+ - Prompt string
39
+
40
+ ```text
41
+ <|im_start|>system
42
+ {system_message}<|im_end|>
43
+ <|im_start|>user
44
+ {prompt}<|im_end|>
45
+ <|im_start|>assistant
46
+ ```
47
+
48
+ - Context size: `32000`
49
+
50
+ - Run as LlamaEdge service
51
+
52
+ ```bash
53
+ wasmedge --dir .:. --nn-preload default:GGML:AUTO:QQwen2.5-3B-Instruct-Q5_K_M.gguf \
54
+ llama-api-server.wasm \
55
+ --model-name QQwen2.5-3B-Instruct \
56
+ --prompt-template chatml \
57
+ --ctx-size 32000
58
+ ```
59
+
60
+ - Run as LlamaEdge command app
61
+
62
+ ```bash
63
+ wasmedge --dir .:. --nn-preload default:GGML:AUTO:QQwen2.5-3B-Instruct-Q5_K_M.gguf \
64
+ llama-chat.wasm \
65
+ --prompt-template chatml \
66
+ --ctx-size 32000
67
+ ```
68
+
69
+ ## Quantized GGUF Models
70
+
71
+ | Name | Quant method | Bits | Size | Use case |
72
+ | ---- | ---- | ---- | ---- | ----- |
73
+ | [QQwen2.5-3B-Instruct-Q2_K.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q2_K.gguf) | Q2_K | 2 | 676 MB| smallest, significant quality loss - not recommended for most purposes |
74
+ | [QQwen2.5-3B-Instruct-Q3_K_L.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q3_K_L.gguf) | Q3_K_L | 3 | 880 MB| small, substantial quality loss |
75
+ | [QQwen2.5-3B-Instruct-Q3_K_M.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q3_K_M.gguf) | Q3_K_M | 3 | 824 MB| very small, high quality loss |
76
+ | [QQwen2.5-3B-Instruct-Q3_K_S.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q3_K_S.gguf) | Q3_K_S | 3 | 761 MB| very small, high quality loss |
77
+ | [QQwen2.5-3B-Instruct-Q4_0.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q4_0.gguf) | Q4_0 | 4 | 935 MB| legacy; small, very high quality loss - prefer using Q3_K_M |
78
+ | [QQwen2.5-3B-Instruct-Q4_K_M.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q4_K_M.gguf) | Q4_K_M | 4 | 986 MB| medium, balanced quality - recommended |
79
+ | [QQwen2.5-3B-Instruct-Q4_K_S.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q4_K_S.gguf) | Q4_K_S | 4 | 940 MB| small, greater quality loss |
80
+ | [QQwen2.5-3B-Instruct-Q5_0.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q5_0.gguf) | Q5_0 | 5 | 1.1 GB| legacy; medium, balanced quality - prefer using Q4_K_M |
81
+ | [QQwen2.5-3B-Instruct-Q5_K_M.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q5_K_M.gguf) | Q5_K_M | 5 | 1.13 GB| large, very low quality loss - recommended |
82
+ | [QQwen2.5-3B-Instruct-Q5_K_S.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q5_K_S.gguf) | Q5_K_S | 5 | 1.1 GB| large, low quality loss - recommended |
83
+ | [QQwen2.5-3B-Instruct-Q6_K.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q6_K.gguf) | Q6_K | 6 | 1.27 GB| very large, extremely low quality loss |
84
+ | [QQwen2.5-3B-Instruct-Q8_0.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-Q8_0.gguf) | Q8_0 | 8 | 1.65 GB| very large, extremely low quality loss - not recommended |
85
+ | [QQwen2.5-3B-Instruct-f16.gguf](https://huggingface.co/second-state/QQwen2.5-3B-Instruct-GGUF/blob/main/QQwen2.5-3B-Instruct-f16.gguf) | f16 | 16 | 3.09 GB| |
86
+
87
+ *Quantized with llama.cpp b3751*