MaziyarPanahi commited on
Commit
664df2e
1 Parent(s): 9f00917

Upload folder using huggingface_hub

Browse files
.gitattributes CHANGED
@@ -33,3 +33,13 @@ saved_model/**/* 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
 
 
 
 
 
 
 
 
 
 
 
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
+ TinyMistral-248M-SFT-v4.Q2_K.ggufm filter=lfs diff=lfs merge=lfs -text
37
+ TinyMistral-248M-SFT-v4.Q3_K_L.ggufm filter=lfs diff=lfs merge=lfs -text
38
+ TinyMistral-248M-SFT-v4.Q3_K_M.ggufm filter=lfs diff=lfs merge=lfs -text
39
+ TinyMistral-248M-SFT-v4.Q3_K_S.ggufm filter=lfs diff=lfs merge=lfs -text
40
+ TinyMistral-248M-SFT-v4.Q4_K_M.ggufm filter=lfs diff=lfs merge=lfs -text
41
+ TinyMistral-248M-SFT-v4.Q4_K_S.ggufm filter=lfs diff=lfs merge=lfs -text
42
+ TinyMistral-248M-SFT-v4.Q5_K_M.ggufm filter=lfs diff=lfs merge=lfs -text
43
+ TinyMistral-248M-SFT-v4.Q5_K_S.ggufm filter=lfs diff=lfs merge=lfs -text
44
+ TinyMistral-248M-SFT-v4.Q6_K.ggufm filter=lfs diff=lfs merge=lfs -text
45
+ TinyMistral-248M-SFT-v4.Q8_0.ggufm filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,225 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ tags:
4
+ - quantized
5
+ - 2-bit
6
+ - 3-bit
7
+ - 4-bit
8
+ - 5-bit
9
+ - 6-bit
10
+ - 8-bit
11
+ - GGUF
12
+ - transformers
13
+ - safetensors
14
+ - mistral
15
+ - text-generation
16
+ - dataset:OpenAssistant/oasst_top1_2023-08-25
17
+ - base_model:Locutusque/TinyMistral-248M
18
+ - license:apache-2.0
19
+ - autotrain_compatible
20
+ - has_space
21
+ - text-generation-inference
22
+ - region:us
23
+ model_name: TinyMistral-248M-SFT-v4-GGUF
24
+ base_model: Felladrin/TinyMistral-248M-SFT-v4
25
+ inference: false
26
+ model_creator: Felladrin
27
+ pipeline_tag: text-generation
28
+ quantized_by: MaziyarPanahi
29
+ ---
30
+ # [MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF](https://huggingface.co/MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF)
31
+ - Model creator: [Felladrin](https://huggingface.co/Felladrin)
32
+ - Original model: [Felladrin/TinyMistral-248M-SFT-v4](https://huggingface.co/Felladrin/TinyMistral-248M-SFT-v4)
33
+
34
+ ## Description
35
+ [MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF](https://huggingface.co/MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF) contains GGUF format model files for [Felladrin/TinyMistral-248M-SFT-v4](https://huggingface.co/Felladrin/TinyMistral-248M-SFT-v4).
36
+
37
+ ## How to use
38
+ Thanks to [TheBloke](https://huggingface.co/TheBloke) for preparing an amazing README on how to use GGUF models:
39
+
40
+ ### About GGUF
41
+
42
+ 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.
43
+
44
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
45
+
46
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
47
+ * [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.
48
+ * [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.
49
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
50
+ * [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.
51
+ * [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.
52
+ * [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.
53
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
54
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
55
+ * [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.
56
+
57
+ ### Explanation of quantisation methods
58
+
59
+ <details>
60
+ <summary>Click to see details</summary>
61
+
62
+ The new methods available are:
63
+
64
+ * 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)
65
+ * 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.
66
+ * 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.
67
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
68
+ * 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
69
+
70
+ ## How to download GGUF files
71
+
72
+ **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.
73
+
74
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
75
+
76
+ * LM Studio
77
+ * LoLLMS Web UI
78
+ * Faraday.dev
79
+
80
+ ### In `text-generation-webui`
81
+
82
+ Under Download Model, you can enter the model repo: [MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF](https://huggingface.co/MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF) and below it, a specific filename to download, such as: TinyMistral-248M-SFT-v4-GGUF.Q4_K_M.gguf.
83
+
84
+ Then click Download.
85
+
86
+ ### On the command line, including multiple files at once
87
+
88
+ I recommend using the `huggingface-hub` Python library:
89
+
90
+ ```shell
91
+ pip3 install huggingface-hub
92
+ ```
93
+
94
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
95
+
96
+ ```shell
97
+ huggingface-cli download MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF TinyMistral-248M-SFT-v4-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
98
+ ```
99
+ </details>
100
+ <details>
101
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
102
+
103
+ You can also download multiple files at once with a pattern:
104
+
105
+ ```shell
106
+ huggingface-cli download [MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF](https://huggingface.co/MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF) --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
107
+ ```
108
+
109
+ 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).
110
+
111
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
112
+
113
+ ```shell
114
+ pip3 install hf_transfer
115
+ ```
116
+
117
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
118
+
119
+ ```shell
120
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download MaziyarPanahi/TinyMistral-248M-SFT-v4-GGUF TinyMistral-248M-SFT-v4-GGUF.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
121
+ ```
122
+
123
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
124
+ </details>
125
+
126
+ ## Example `llama.cpp` command
127
+
128
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
129
+
130
+ ```shell
131
+ ./main -ngl 35 -m TinyMistral-248M-SFT-v4-GGUF.Q4_K_M.gguf --color -c 32768 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system
132
+ {system_message}<|im_end|>
133
+ <|im_start|>user
134
+ {prompt}<|im_end|>
135
+ <|im_start|>assistant"
136
+ ```
137
+
138
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
139
+
140
+ Change `-c 32768` 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.
141
+
142
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
143
+
144
+ 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)
145
+
146
+ ## How to run in `text-generation-webui`
147
+
148
+ 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).
149
+
150
+ ## How to run from Python code
151
+
152
+ 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.
153
+
154
+ ### How to load this model in Python code, using llama-cpp-python
155
+
156
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
157
+
158
+ #### First install the package
159
+
160
+ Run one of the following commands, according to your system:
161
+
162
+ ```shell
163
+ # Base ctransformers with no GPU acceleration
164
+ pip install llama-cpp-python
165
+ # With NVidia CUDA acceleration
166
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
167
+ # Or with OpenBLAS acceleration
168
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
169
+ # Or with CLBLast acceleration
170
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
171
+ # Or with AMD ROCm GPU acceleration (Linux only)
172
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
173
+ # Or with Metal GPU acceleration for macOS systems only
174
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
175
+
176
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
177
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
178
+ pip install llama-cpp-python
179
+ ```
180
+
181
+ #### Simple llama-cpp-python example code
182
+
183
+ ```python
184
+ from llama_cpp import Llama
185
+
186
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
187
+ llm = Llama(
188
+ model_path="./TinyMistral-248M-SFT-v4-GGUF.Q4_K_M.gguf", # Download the model file first
189
+ n_ctx=32768, # The max sequence length to use - note that longer sequence lengths require much more resources
190
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
191
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
192
+ )
193
+
194
+ # Simple inference example
195
+ output = llm(
196
+ "<|im_start|>system
197
+ {system_message}<|im_end|>
198
+ <|im_start|>user
199
+ {prompt}<|im_end|>
200
+ <|im_start|>assistant", # Prompt
201
+ max_tokens=512, # Generate up to 512 tokens
202
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
203
+ echo=True # Whether to echo the prompt
204
+ )
205
+
206
+ # Chat Completion API
207
+
208
+ llm = Llama(model_path="./TinyMistral-248M-SFT-v4-GGUF.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
209
+ llm.create_chat_completion(
210
+ messages = [
211
+ {"role": "system", "content": "You are a story writing assistant."},
212
+ {
213
+ "role": "user",
214
+ "content": "Write a story about llamas."
215
+ }
216
+ ]
217
+ )
218
+ ```
219
+
220
+ ## How to use with LangChain
221
+
222
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
223
+
224
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
225
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
TinyMistral-248M-SFT-v4.Q2_K.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:59055f815085ed00895942abcd99906b84133da964e9c7e3a0a83d3345a81d66
3
+ size 105456576
TinyMistral-248M-SFT-v4.Q3_K_L.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:fd9000cac0fc47f3eb3426545b1437051257ff9418a6e66252dca488561c5093
3
+ size 137219328
TinyMistral-248M-SFT-v4.Q3_K_M.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:801cdac661379eb427e25d2ae40aaac6c66ee03b43bca90eeab506f7cd7ee6ca
3
+ size 129027328
TinyMistral-248M-SFT-v4.Q3_K_S.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:795c2a59cb4533d6a3270ce36e502bd317d2d00c0a8689f9e9b9ea99f7329c81
3
+ size 120188160
TinyMistral-248M-SFT-v4.Q4_K_M.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:decb9485d8be30f212b032d14a6d39d74a1492ac2cd7a2d0c9e39130c4c6f00c
3
+ size 155666048
TinyMistral-248M-SFT-v4.Q4_K_S.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:3a08096e1d9b3517fba4fa16cbad6e14088aa68ab456c3ac2e54a447110cc70d
3
+ size 149427840
TinyMistral-248M-SFT-v4.Q5_K_M.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:ad900acc7931754d798dc28c73ffcbd746c646a47dcf452a081d23fe77c28ee0
3
+ size 179226624
TinyMistral-248M-SFT-v4.Q5_K_S.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:43a9c204b03bb6c1b0e322a30a6f97bbd5c13b58eac4fa958eee911a3f62bbc6
3
+ size 175675392
TinyMistral-248M-SFT-v4.Q6_K.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:a571d9ca6f9aae2ef294acdebd19263ef9b425bea55fff8d209ae540bc4c2c8a
3
+ size 204259744
TinyMistral-248M-SFT-v4.Q8_0.ggufm ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1e87af628644ff262f0b5fbaf5399065a39b9a209167515065a5132addbebd97
3
+ size 264320864