Transformers
GGUF
English
tinyllama
conversational
nitsuai TheBloke commited on
Commit
2266676
โ€ข
0 Parent(s):

Duplicate from TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF

Browse files

Co-authored-by: Tom Jobbins <[email protected]>

.gitattributes ADDED
@@ -0,0 +1,47 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.bin filter=lfs diff=lfs merge=lfs -text
4
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
5
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
6
+ *.ftz filter=lfs diff=lfs merge=lfs -text
7
+ *.gz filter=lfs diff=lfs merge=lfs -text
8
+ *.h5 filter=lfs diff=lfs merge=lfs -text
9
+ *.joblib filter=lfs diff=lfs merge=lfs -text
10
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
11
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
12
+ *.model filter=lfs diff=lfs merge=lfs -text
13
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
14
+ *.npy filter=lfs diff=lfs merge=lfs -text
15
+ *.npz filter=lfs diff=lfs merge=lfs -text
16
+ *.onnx filter=lfs diff=lfs merge=lfs -text
17
+ *.ot filter=lfs diff=lfs merge=lfs -text
18
+ *.parquet filter=lfs diff=lfs merge=lfs -text
19
+ *.pb filter=lfs diff=lfs merge=lfs -text
20
+ *.pickle filter=lfs diff=lfs merge=lfs -text
21
+ *.pkl filter=lfs diff=lfs merge=lfs -text
22
+ *.pt filter=lfs diff=lfs merge=lfs -text
23
+ *.pth filter=lfs diff=lfs merge=lfs -text
24
+ *.rar filter=lfs diff=lfs merge=lfs -text
25
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
26
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
27
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
28
+ *.tar filter=lfs diff=lfs merge=lfs -text
29
+ *.tflite filter=lfs diff=lfs merge=lfs -text
30
+ *.tgz filter=lfs diff=lfs merge=lfs -text
31
+ *.wasm filter=lfs diff=lfs merge=lfs -text
32
+ *.xz filter=lfs diff=lfs merge=lfs -text
33
+ *.zip filter=lfs diff=lfs merge=lfs -text
34
+ *.zst filter=lfs diff=lfs merge=lfs -text
35
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
36
+ tinyllama-1.1b-chat-v1.0.Q2_K.gguf filter=lfs diff=lfs merge=lfs -text
37
+ tinyllama-1.1b-chat-v1.0.Q3_K_S.gguf filter=lfs diff=lfs merge=lfs -text
38
+ tinyllama-1.1b-chat-v1.0.Q3_K_M.gguf filter=lfs diff=lfs merge=lfs -text
39
+ tinyllama-1.1b-chat-v1.0.Q3_K_L.gguf filter=lfs diff=lfs merge=lfs -text
40
+ tinyllama-1.1b-chat-v1.0.Q4_0.gguf filter=lfs diff=lfs merge=lfs -text
41
+ tinyllama-1.1b-chat-v1.0.Q4_K_S.gguf filter=lfs diff=lfs merge=lfs -text
42
+ tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf filter=lfs diff=lfs merge=lfs -text
43
+ tinyllama-1.1b-chat-v1.0.Q5_0.gguf filter=lfs diff=lfs merge=lfs -text
44
+ tinyllama-1.1b-chat-v1.0.Q5_K_S.gguf filter=lfs diff=lfs merge=lfs -text
45
+ tinyllama-1.1b-chat-v1.0.Q5_K_M.gguf filter=lfs diff=lfs merge=lfs -text
46
+ tinyllama-1.1b-chat-v1.0.Q6_K.gguf filter=lfs diff=lfs merge=lfs -text
47
+ tinyllama-1.1b-chat-v1.0.Q8_0.gguf filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,390 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: TinyLlama/TinyLlama-1.1B-Chat-v1.0
3
+ datasets:
4
+ - cerebras/SlimPajama-627B
5
+ - bigcode/starcoderdata
6
+ - OpenAssistant/oasst_top1_2023-08-25
7
+ inference: false
8
+ language:
9
+ - en
10
+ license: apache-2.0
11
+ model_creator: TinyLlama
12
+ model_name: Tinyllama 1.1B Chat v1.0
13
+ model_type: tinyllama
14
+ prompt_template: '<|system|>
15
+
16
+ {system_message}</s>
17
+
18
+ <|user|>
19
+
20
+ {prompt}</s>
21
+
22
+ <|assistant|>
23
+
24
+ '
25
+ quantized_by: TheBloke
26
+ ---
27
+ <!-- markdownlint-disable MD041 -->
28
+
29
+ <!-- header start -->
30
+ <!-- 200823 -->
31
+ <div style="width: auto; margin-left: auto; margin-right: auto">
32
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
33
+ </div>
34
+ <div style="display: flex; justify-content: space-between; width: 100%;">
35
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
36
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
37
+ </div>
38
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
39
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
40
+ </div>
41
+ </div>
42
+ <div style="text-align:center; margin-top: 0em; margin-bottom: 0em"><p style="margin-top: 0.25em; margin-bottom: 0em;">TheBloke's LLM work is generously supported by a grant from <a href="https://a16z.com">andreessen horowitz (a16z)</a></p></div>
43
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
44
+ <!-- header end -->
45
+
46
+ # Tinyllama 1.1B Chat v1.0 - GGUF
47
+ - Model creator: [TinyLlama](https://huggingface.co/TinyLlama)
48
+ - Original model: [Tinyllama 1.1B Chat v1.0](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0)
49
+
50
+ <!-- description start -->
51
+ ## Description
52
+
53
+ This repo contains GGUF format model files for [TinyLlama's Tinyllama 1.1B Chat v1.0](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0).
54
+
55
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
56
+
57
+ <!-- description end -->
58
+ <!-- README_GGUF.md-about-gguf start -->
59
+ ### About GGUF
60
+
61
+ GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp.
62
+
63
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
64
+
65
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
66
+ * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration.
67
+ * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling.
68
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
69
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. Linux available, in beta as of 27/11/2023.
70
+ * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection.
71
+ * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration.
72
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
73
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
74
+ * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. Note, as of time of writing (November 27th 2023), ctransformers has not been updated in a long time and does not support many recent models.
75
+
76
+ <!-- README_GGUF.md-about-gguf end -->
77
+ <!-- repositories-available start -->
78
+ ## Repositories available
79
+
80
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-AWQ)
81
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GPTQ)
82
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF)
83
+ * [TinyLlama's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TinyLlama/TinyLlama-1.1B-Chat-v1.0)
84
+ <!-- repositories-available end -->
85
+
86
+ <!-- prompt-template start -->
87
+ ## Prompt template: Zephyr
88
+
89
+ ```
90
+ <|system|>
91
+ {system_message}</s>
92
+ <|user|>
93
+ {prompt}</s>
94
+ <|assistant|>
95
+
96
+ ```
97
+
98
+ <!-- prompt-template end -->
99
+
100
+
101
+ <!-- compatibility_gguf start -->
102
+ ## Compatibility
103
+
104
+ These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
105
+
106
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
107
+
108
+ ## Explanation of quantisation methods
109
+
110
+ <details>
111
+ <summary>Click to see details</summary>
112
+
113
+ The new methods available are:
114
+
115
+ * GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw)
116
+ * GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw.
117
+ * GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw.
118
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
119
+ * GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw
120
+
121
+ Refer to the Provided Files table below to see what files use which methods, and how.
122
+ </details>
123
+ <!-- compatibility_gguf end -->
124
+
125
+ <!-- README_GGUF.md-provided-files start -->
126
+ ## Provided files
127
+
128
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
129
+ | ---- | ---- | ---- | ---- | ---- | ----- |
130
+ | [tinyllama-1.1b-chat-v1.0.Q2_K.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q2_K.gguf) | Q2_K | 2 | 0.48 GB| 2.98 GB | smallest, significant quality loss - not recommended for most purposes |
131
+ | [tinyllama-1.1b-chat-v1.0.Q3_K_S.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q3_K_S.gguf) | Q3_K_S | 3 | 0.50 GB| 3.00 GB | very small, high quality loss |
132
+ | [tinyllama-1.1b-chat-v1.0.Q3_K_M.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q3_K_M.gguf) | Q3_K_M | 3 | 0.55 GB| 3.05 GB | very small, high quality loss |
133
+ | [tinyllama-1.1b-chat-v1.0.Q3_K_L.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q3_K_L.gguf) | Q3_K_L | 3 | 0.59 GB| 3.09 GB | small, substantial quality loss |
134
+ | [tinyllama-1.1b-chat-v1.0.Q4_0.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q4_0.gguf) | Q4_0 | 4 | 0.64 GB| 3.14 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
135
+ | [tinyllama-1.1b-chat-v1.0.Q4_K_S.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q4_K_S.gguf) | Q4_K_S | 4 | 0.64 GB| 3.14 GB | small, greater quality loss |
136
+ | [tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf) | Q4_K_M | 4 | 0.67 GB| 3.17 GB | medium, balanced quality - recommended |
137
+ | [tinyllama-1.1b-chat-v1.0.Q5_0.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q5_0.gguf) | Q5_0 | 5 | 0.77 GB| 3.27 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
138
+ | [tinyllama-1.1b-chat-v1.0.Q5_K_S.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q5_K_S.gguf) | Q5_K_S | 5 | 0.77 GB| 3.27 GB | large, low quality loss - recommended |
139
+ | [tinyllama-1.1b-chat-v1.0.Q5_K_M.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q5_K_M.gguf) | Q5_K_M | 5 | 0.78 GB| 3.28 GB | large, very low quality loss - recommended |
140
+ | [tinyllama-1.1b-chat-v1.0.Q6_K.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q6_K.gguf) | Q6_K | 6 | 0.90 GB| 3.40 GB | very large, extremely low quality loss |
141
+ | [tinyllama-1.1b-chat-v1.0.Q8_0.gguf](https://huggingface.co/TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF/blob/main/tinyllama-1.1b-chat-v1.0.Q8_0.gguf) | Q8_0 | 8 | 1.17 GB| 3.67 GB | very large, extremely low quality loss - not recommended |
142
+
143
+ **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead.
144
+
145
+
146
+
147
+ <!-- README_GGUF.md-provided-files end -->
148
+
149
+ <!-- README_GGUF.md-how-to-download start -->
150
+ ## How to download GGUF files
151
+
152
+ **Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file.
153
+
154
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
155
+
156
+ * LM Studio
157
+ * LoLLMS Web UI
158
+ * Faraday.dev
159
+
160
+ ### In `text-generation-webui`
161
+
162
+ Under Download Model, you can enter the model repo: TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF and below it, a specific filename to download, such as: tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf.
163
+
164
+ Then click Download.
165
+
166
+ ### On the command line, including multiple files at once
167
+
168
+ I recommend using the `huggingface-hub` Python library:
169
+
170
+ ```shell
171
+ pip3 install huggingface-hub
172
+ ```
173
+
174
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
175
+
176
+ ```shell
177
+ huggingface-cli download TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
178
+ ```
179
+
180
+ <details>
181
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
182
+
183
+ You can also download multiple files at once with a pattern:
184
+
185
+ ```shell
186
+ huggingface-cli download TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
187
+ ```
188
+
189
+ For more documentation on downloading with `huggingface-cli`, please see: [HF -> Hub Python Library -> Download files -> Download from the CLI](https://huggingface.co/docs/huggingface_hub/guides/download#download-from-the-cli).
190
+
191
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
192
+
193
+ ```shell
194
+ pip3 install hf_transfer
195
+ ```
196
+
197
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
198
+
199
+ ```shell
200
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
201
+ ```
202
+
203
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
204
+ </details>
205
+ <!-- README_GGUF.md-how-to-download end -->
206
+
207
+ <!-- README_GGUF.md-how-to-run start -->
208
+ ## Example `llama.cpp` command
209
+
210
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
211
+
212
+ ```shell
213
+ ./main -ngl 35 -m tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|system|>\n{system_message}</s>\n<|user|>\n{prompt}</s>\n<|assistant|>"
214
+ ```
215
+
216
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
217
+
218
+ Change `-c 2048` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
219
+
220
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
221
+
222
+ For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md)
223
+
224
+ ## How to run in `text-generation-webui`
225
+
226
+ Further instructions can be found in the text-generation-webui documentation, here: [text-generation-webui/docs/04 โ€ Model Tab.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/04%20%E2%80%90%20Model%20Tab.md#llamacpp).
227
+
228
+ ## How to run from Python code
229
+
230
+ You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries. Note that at the time of writing (Nov 27th 2023), ctransformers has not been updated for some time and is not compatible with some recent models. Therefore I recommend you use llama-cpp-python.
231
+
232
+ ### How to load this model in Python code, using llama-cpp-python
233
+
234
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
235
+
236
+ #### First install the package
237
+
238
+ Run one of the following commands, according to your system:
239
+
240
+ ```shell
241
+ # Base ctransformers with no GPU acceleration
242
+ pip install llama-cpp-python
243
+ # With NVidia CUDA acceleration
244
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
245
+ # Or with OpenBLAS acceleration
246
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
247
+ # Or with CLBLast acceleration
248
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
249
+ # Or with AMD ROCm GPU acceleration (Linux only)
250
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
251
+ # Or with Metal GPU acceleration for macOS systems only
252
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
253
+
254
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
255
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
256
+ pip install llama-cpp-python
257
+ ```
258
+
259
+ #### Simple llama-cpp-python example code
260
+
261
+ ```python
262
+ from llama_cpp import Llama
263
+
264
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
265
+ llm = Llama(
266
+ model_path="./tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf", # Download the model file first
267
+ n_ctx=2048, # The max sequence length to use - note that longer sequence lengths require much more resources
268
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
269
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
270
+ )
271
+
272
+ # Simple inference example
273
+ output = llm(
274
+ "<|system|>\n{system_message}</s>\n<|user|>\n{prompt}</s>\n<|assistant|>", # Prompt
275
+ max_tokens=512, # Generate up to 512 tokens
276
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
277
+ echo=True # Whether to echo the prompt
278
+ )
279
+
280
+ # Chat Completion API
281
+
282
+ llm = Llama(model_path="./tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
283
+ llm.create_chat_completion(
284
+ messages = [
285
+ {"role": "system", "content": "You are a story writing assistant."},
286
+ {
287
+ "role": "user",
288
+ "content": "Write a story about llamas."
289
+ }
290
+ ]
291
+ )
292
+ ```
293
+
294
+ ## How to use with LangChain
295
+
296
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
297
+
298
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
299
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
300
+
301
+ <!-- README_GGUF.md-how-to-run end -->
302
+
303
+ <!-- footer start -->
304
+ <!-- 200823 -->
305
+ ## Discord
306
+
307
+ For further support, and discussions on these models and AI in general, join us at:
308
+
309
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
310
+
311
+ ## Thanks, and how to contribute
312
+
313
+ Thanks to the [chirper.ai](https://chirper.ai) team!
314
+
315
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
316
+
317
+ I've had a lot of people ask if they can contribute. I enjoy providing models and helping people, and would love to be able to spend even more time doing it, as well as expanding into new projects like fine tuning/training.
318
+
319
+ If you're able and willing to contribute it will be most gratefully received and will help me to keep providing more models, and to start work on new AI projects.
320
+
321
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
322
+
323
+ * Patreon: https://patreon.com/TheBlokeAI
324
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
325
+
326
+ **Special thanks to**: Aemon Algiz.
327
+
328
+ **Patreon special mentions**: Michael Levine, ้˜ฟๆ˜Ž, Trailburnt, Nikolai Manek, John Detwiler, Randy H, Will Dee, Sebastain Graf, NimbleBox.ai, Eugene Pentland, Emad Mostaque, Ai Maven, Jim Angel, Jeff Scroggin, Michael Davis, Manuel Alberto Morcote, Stephen Murray, Robert, Justin Joy, Luke @flexchar, Brandon Frisco, Elijah Stavena, S_X, Dan Guido, Undi ., Komninos Chatzipapas, Shadi, theTransient, Lone Striker, Raven Klaugh, jjj, Cap'n Zoog, Michel-Marie MAUDET (LINAGORA), Matthew Berman, David, Fen Risland, Omer Bin Jawed, Luke Pendergrass, Kalila, OG, Erik Bjรคreholt, Rooh Singh, Joseph William Delisle, Dan Lewis, TL, John Villwock, AzureBlack, Brad, Pedro Madruga, Caitlyn Gatomon, K, jinyuan sun, Mano Prime, Alex, Jeffrey Morgan, Alicia Loh, Illia Dulskyi, Chadd, transmissions 11, fincy, Rainer Wilmers, ReadyPlayerEmma, knownsqashed, Mandus, biorpg, Deo Leter, Brandon Phillips, SuperWojo, Sean Connelly, Iucharbius, Jack West, Harry Royden McLaughlin, Nicholas, terasurfer, Vitor Caleffi, Duane Dunston, Johann-Peter Hartmann, David Ziegler, Olakabola, Ken Nordquist, Trenton Dambrowitz, Tom X Nguyen, Vadim, Ajan Kanaga, Leonard Tan, Clay Pascal, Alexandros Triantafyllidis, JM33133, Xule, vamX, ya boyyy, subjectnull, Talal Aujan, Alps Aficionado, wassieverse, Ari Malik, James Bentley, Woland, Spencer Kim, Michael Dempsey, Fred von Graf, Elle, zynix, William Richards, Stanislav Ovsiannikov, Edmond Seymore, Jonathan Leane, Martin Kemka, usrbinkat, Enrico Ros
329
+
330
+
331
+ Thank you to all my generous patrons and donaters!
332
+
333
+ And thank you again to a16z for their generous grant.
334
+
335
+ <!-- footer end -->
336
+
337
+ <!-- original-model-card start -->
338
+ # Original model card: TinyLlama's Tinyllama 1.1B Chat v1.0
339
+
340
+ <div align="center">
341
+
342
+ # TinyLlama-1.1B
343
+ </div>
344
+
345
+ https://github.com/jzhang38/TinyLlama
346
+
347
+ The TinyLlama project aims to **pretrain** a **1.1B Llama model on 3 trillion tokens**. With some proper optimization, we can achieve this within a span of "just" 90 days using 16 A100-40G GPUs ๐Ÿš€๐Ÿš€. The training has started on 2023-09-01.
348
+
349
+
350
+ We adopted exactly the same architecture and tokenizer as Llama 2. This means TinyLlama can be plugged and played in many open-source projects built upon Llama. Besides, TinyLlama is compact with only 1.1B parameters. This compactness allows it to cater to a multitude of applications demanding a restricted computation and memory footprint.
351
+
352
+ #### This Model
353
+ This is the chat model finetuned on top of [TinyLlama/TinyLlama-1.1B-intermediate-step-1431k-3T](https://huggingface.co/TinyLlama/TinyLlama-1.1B-intermediate-step-1431k-3T). **We follow [HF's Zephyr](https://huggingface.co/HuggingFaceH4/zephyr-7b-alpha/edit/main/README.md)'s training recipe.** The model was " initially fine-tuned on a variant of the [`UltraChat`](https://huggingface.co/datasets/stingning/ultrachat) dataset, which contains a diverse range of synthetic dialogues generated by ChatGPT.
354
+ We then further aligned the model with [๐Ÿค— TRL's](https://github.com/huggingface/trl) `DPOTrainer` on the [openbmb/UltraFeedback](https://huggingface.co/datasets/openbmb/UltraFeedback) dataset, which contain 64k prompts and model completions that are ranked by GPT-4."
355
+
356
+
357
+ #### How to use
358
+ You will need the transformers>=4.34
359
+ Do check the [TinyLlama](https://github.com/jzhang38/TinyLlama) github page for more information.
360
+
361
+ ```python
362
+ # Install transformers from source - only needed for versions <= v4.34
363
+ # pip install git+https://github.com/huggingface/transformers.git
364
+ # pip install accelerate
365
+
366
+ import torch
367
+ from transformers import pipeline
368
+
369
+ pipe = pipeline("text-generation", model="TinyLlama/TinyLlama-1.1B-Chat-v1.0", torch_dtype=torch.bfloat16, device_map="auto")
370
+
371
+ # We use the tokenizer's chat template to format each message - see https://huggingface.co/docs/transformers/main/en/chat_templating
372
+ messages = [
373
+ {
374
+ "role": "system",
375
+ "content": "You are a friendly chatbot who always responds in the style of a pirate",
376
+ },
377
+ {"role": "user", "content": "How many helicopters can a human eat in one sitting?"},
378
+ ]
379
+ prompt = pipe.tokenizer.apply_chat_template(messages, tokenize=False, add_generation_prompt=True)
380
+ outputs = pipe(prompt, max_new_tokens=256, do_sample=True, temperature=0.7, top_k=50, top_p=0.95)
381
+ print(outputs[0]["generated_text"])
382
+ # <|system|>
383
+ # You are a friendly chatbot who always responds in the style of a pirate.</s>
384
+ # <|user|>
385
+ # How many helicopters can a human eat in one sitting?</s>
386
+ # <|assistant|>
387
+ # ...
388
+ ```
389
+
390
+ <!-- original-model-card end -->
config.json ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ {
2
+ "model_type": "tinyllama"
3
+ }
tinyllama-1.1b-chat-v1.0.Q2_K.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:030a469a63576d59f601ef5608846b7718eaa884dd820e9aa7493efec1788afa
3
+ size 483116416
tinyllama-1.1b-chat-v1.0.Q3_K_L.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3c725e62c1e9a16d949ade83c2a561be1330eaaf41d98773c3fe929512a70aaf
3
+ size 592500096
tinyllama-1.1b-chat-v1.0.Q3_K_M.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ec461c4d2b60896152bca3978aa49cd70edad7298715e4222e12af1eefea2125
3
+ size 550819200
tinyllama-1.1b-chat-v1.0.Q3_K_S.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:6d58c8fbdaa822b004d7ba473f9b9ad4d1ef7c2dd2c4cf9f9856451aa44bf0ca
3
+ size 500315520
tinyllama-1.1b-chat-v1.0.Q4_0.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:da3087fb14aede55fde6eb81a0e55e886810e43509ec82ecdc7aa5d62a03b556
3
+ size 637699456
tinyllama-1.1b-chat-v1.0.Q4_K_M.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:9fecc3b3cd76bba89d504f29b616eedf7da85b96540e490ca5824d3f7d2776a0
3
+ size 668788096
tinyllama-1.1b-chat-v1.0.Q4_K_S.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:fdf50b4eebd34ccd953b2061d8b4b504f59a8e88d570adf035b1405154d12c29
3
+ size 643728768
tinyllama-1.1b-chat-v1.0.Q5_0.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:bf0264251d7c9406983b6beb71b2242428d4564f5a5154bc00825b43965f89b2
3
+ size 767001984
tinyllama-1.1b-chat-v1.0.Q5_K_M.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:aa54a5fb99ace5b964859cf072346631b2da6109715a805d07161d157c66ce7f
3
+ size 783017344
tinyllama-1.1b-chat-v1.0.Q5_K_S.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:87dfd8c5111e6e0b87c5bac654ce01eae412fb3bed24067c75aba60e454b5399
3
+ size 767001984
tinyllama-1.1b-chat-v1.0.Q6_K.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:9fb2be7c8bbc0ca358ae88cef6d9e6844b81929eaffa5016a543e6f56b22cb6d
3
+ size 904385920
tinyllama-1.1b-chat-v1.0.Q8_0.gguf ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a4c9bb1dbaa372f6381a035fa5c02ef087aaa1ff1f843a56a22328114f03fc59
3
+ size 1170781568