TheBloke commited on
Commit
f89908b
1 Parent(s): f6ebf30

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +93 -21
README.md CHANGED
@@ -1,13 +1,18 @@
1
  ---
 
2
  inference: false
3
  language:
4
  - en
5
- license: llama2
6
  model_creator: nRuaif
7
- model_link: https://huggingface.co/nRuaif/Kimiko-v2-13B
8
  model_name: Kimiko v2 13B
9
  model_type: llama
10
  pipeline_tag: text-generation
 
 
 
 
 
11
  quantized_by: TheBloke
12
  ---
13
 
@@ -32,23 +37,25 @@ quantized_by: TheBloke
32
  - Model creator: [nRuaif](https://huggingface.co/nRuaif)
33
  - Original model: [Kimiko v2 13B](https://huggingface.co/nRuaif/Kimiko-v2-13B)
34
 
 
35
  ## Description
36
 
37
  This repo contains GGUF format model files for [nRuaif's Kimiko v2 13B](https://huggingface.co/nRuaif/Kimiko-v2-13B).
38
 
 
39
  <!-- README_GGUF.md-about-gguf start -->
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
- The key benefit of GGUF is that it is a extensible, future-proof format which stores more information about the model as metadata. It also includes significantly improved tokenization code, including for the first time full support for special tokens. This should improve performance, especially with models that use new special tokens and implement custom prompt templates.
45
 
46
- Here are a list of clients and libraries that are known to support GGUF:
47
- * [llama.cpp](https://github.com/ggerganov/llama.cpp).
48
- * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions.
49
- * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with full GPU accel across multiple platforms and GPU architectures. Especially good for story telling.
50
- * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI with GPU acceleration on both Windows (NVidia and AMD), and macOS.
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
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
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.
@@ -57,9 +64,9 @@ Here are a list of clients and libraries that are known to support GGUF:
57
  <!-- repositories-available start -->
58
  ## Repositories available
59
 
 
60
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Kimiko-v2-13B-GPTQ)
61
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Kimiko-v2-13B-GGUF)
62
- * [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/Kimiko-v2-13B-GGML)
63
  * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/Kimiko-v2-13B-fp16)
64
  * [nRuaif's original LoRA adapter, which can be merged on to the base model.](https://huggingface.co/nRuaif/Kimiko-v2-13B)
65
  <!-- repositories-available end -->
@@ -73,12 +80,21 @@ A chat between a curious user and an artificial intelligence assistant. The assi
73
  ```
74
 
75
  <!-- prompt-template end -->
 
 
 
 
 
 
 
 
 
76
  <!-- compatibility_gguf start -->
77
  ## Compatibility
78
 
79
- These quantised GGUF files are compatible with llama.cpp from August 21st 2023 onwards, as of commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9)
80
 
81
- They are now also compatible with many third party UIs and libraries - please see the list at the top of the README.
82
 
83
  ## Explanation of quantisation methods
84
  <details>
@@ -119,21 +135,75 @@ Refer to the Provided Files table below to see what files use which methods, and
119
 
120
  <!-- README_GGUF.md-provided-files end -->
121
 
122
- <!-- README_GGUF.md-how-to-run start -->
123
- ## Example `llama.cpp` command
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
124
 
125
- Make sure you are using `llama.cpp` from commit [6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9](https://github.com/ggerganov/llama.cpp/commit/6381d4e110bd0ec02843a60bbeb8b6fc37a9ace9) or later.
 
126
 
127
- For compatibility with older versions of llama.cpp, or for any third-party libraries or clients that haven't yet updated for GGUF, please use GGML files instead.
128
 
 
 
129
  ```
130
- ./main -t 10 -ngl 32 -m kimiko-v2-13b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. USER: {prompt} ASSISTANT:"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
131
  ```
132
- Change `-t 10` to the number of physical CPU cores you have. For example if your system has 8 cores/16 threads, use `-t 8`. If offloading all layers to GPU, set `-t 1`.
133
 
134
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
135
 
136
- Change `-c 4096` to the desired sequence length for this model. 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.
137
 
138
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
139
 
@@ -190,10 +260,12 @@ For further support, and discussions on these models and AI in general, join us
190
 
191
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
192
 
193
- ## Thanks, and how to contribute.
194
 
195
  Thanks to the [chirper.ai](https://chirper.ai) team!
196
 
 
 
197
  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.
198
 
199
  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.
@@ -205,7 +277,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
205
 
206
  **Special thanks to**: Aemon Algiz.
207
 
208
- **Patreon special mentions**: Russ Johnson, J, alfie_i, Alex, NimbleBox.ai, Chadd, Mandus, Nikolai Manek, Ken Nordquist, ya boyyy, Illia Dulskyi, Viktor Bowallius, vamX, Iucharbius, zynix, Magnesian, Clay Pascal, Pierre Kircher, Enrico Ros, Tony Hughes, Elle, Andrey, knownsqashed, Deep Realms, Jerry Meng, Lone Striker, Derek Yates, Pyrater, Mesiah Bishop, James Bentley, Femi Adebogun, Brandon Frisco, SuperWojo, Alps Aficionado, Michael Dempsey, Vitor Caleffi, Will Dee, Edmond Seymore, usrbinkat, LangChain4j, Kacper Wikieł, Luke Pendergrass, John Detwiler, theTransient, Nathan LeClaire, Tiffany J. Kim, biorpg, Eugene Pentland, Stanislav Ovsiannikov, Fred von Graf, terasurfer, Kalila, Dan Guido, Nitin Borwankar, 阿明, Ai Maven, John Villwock, Gabriel Puliatti, Stephen Murray, Asp the Wyvern, danny, Chris Smitley, ReadyPlayerEmma, S_X, Daniel P. Andersen, Olakabola, Jeffrey Morgan, Imad Khwaja, Caitlyn Gatomon, webtim, Alicia Loh, Trenton Dambrowitz, Swaroop Kallakuri, Erik Bjäreholt, Leonard Tan, Spiking Neurons AB, Luke @flexchar, Ajan Kanaga, Thomas Belote, Deo Leter, RoA, Willem Michiel, transmissions 11, subjectnull, Matthew Berman, Joseph William Delisle, David Ziegler, Michael Davis, Johann-Peter Hartmann, Talal Aujan, senxiiz, Artur Olbinski, Rainer Wilmers, Spencer Kim, Fen Risland, Cap'n Zoog, Rishabh Srivastava, Michael Levine, Geoffrey Montalvo, Sean Connelly, Alexandros Triantafyllidis, Pieter, Gabriel Tamborski, Sam, Subspace Studios, Junyu Yang, Pedro Madruga, Vadim, Cory Kujawski, K, Raven Klaugh, Randy H, Mano Prime, Sebastain Graf, Space Cruiser
209
 
210
 
211
  Thank you to all my generous patrons and donaters!
 
1
  ---
2
+ base_model: https://huggingface.co/nRuaif/Kimiko-v2-13B
3
  inference: false
4
  language:
5
  - en
6
+ license: creativeml-openrail-m
7
  model_creator: nRuaif
 
8
  model_name: Kimiko v2 13B
9
  model_type: llama
10
  pipeline_tag: text-generation
11
+ prompt_template: 'A chat between a curious user and an artificial intelligence assistant.
12
+ The assistant gives helpful, detailed, and polite answers to the user''s questions.
13
+ USER: {prompt} ASSISTANT:
14
+
15
+ '
16
  quantized_by: TheBloke
17
  ---
18
 
 
37
  - Model creator: [nRuaif](https://huggingface.co/nRuaif)
38
  - Original model: [Kimiko v2 13B](https://huggingface.co/nRuaif/Kimiko-v2-13B)
39
 
40
+ <!-- description start -->
41
  ## Description
42
 
43
  This repo contains GGUF format model files for [nRuaif's Kimiko v2 13B](https://huggingface.co/nRuaif/Kimiko-v2-13B).
44
 
45
+ <!-- description end -->
46
  <!-- README_GGUF.md-about-gguf start -->
47
  ### About GGUF
48
 
49
+ 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. GGUF offers numerous advantages over GGML, such as better tokenisation, and support for special tokens. It is also supports metadata, and is designed to be extensible.
50
 
51
+ Here is an incomplate list of clients and libraries that are known to support GGUF:
52
 
53
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
54
+ * [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.
55
+ * [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.
56
+ * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration.
 
57
  * [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.
58
+ * [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.
59
  * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server.
60
  * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
61
  * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
 
64
  <!-- repositories-available start -->
65
  ## Repositories available
66
 
67
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Kimiko-v2-13B-AWQ)
68
  * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Kimiko-v2-13B-GPTQ)
69
  * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Kimiko-v2-13B-GGUF)
 
70
  * [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/TheBloke/Kimiko-v2-13B-fp16)
71
  * [nRuaif's original LoRA adapter, which can be merged on to the base model.](https://huggingface.co/nRuaif/Kimiko-v2-13B)
72
  <!-- repositories-available end -->
 
80
  ```
81
 
82
  <!-- prompt-template end -->
83
+ <!-- licensing start -->
84
+ ## Licensing
85
+
86
+ The creator of the source model has listed its license as `creativeml-openrail-m`, and this quantization has therefore used that same license.
87
+
88
+ As this model is based on Llama 2, it is also subject to the Meta Llama 2 license terms, and the license files for that are additionally included. It should therefore be considered as being claimed to be licensed under both licenses. I contacted Hugging Face for clarification on dual licensing but they do not yet have an official position. Should this change, or should Meta provide any feedback on this situation, I will update this section accordingly.
89
+
90
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [nRuaif's Kimiko v2 13B](https://huggingface.co/nRuaif/Kimiko-v2-13B).
91
+ <!-- licensing end -->
92
  <!-- compatibility_gguf start -->
93
  ## Compatibility
94
 
95
+ These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221)
96
 
97
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
98
 
99
  ## Explanation of quantisation methods
100
  <details>
 
135
 
136
  <!-- README_GGUF.md-provided-files end -->
137
 
138
+ <!-- README_GGUF.md-how-to-download start -->
139
+ ## How to download GGUF files
140
+
141
+ **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.
142
+
143
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
144
+ - LM Studio
145
+ - LoLLMS Web UI
146
+ - Faraday.dev
147
+
148
+ ### In `text-generation-webui`
149
+
150
+ Under Download Model, you can enter the model repo: TheBloke/Kimiko-v2-13B-GGUF and below it, a specific filename to download, such as: kimiko-v2-13b.q4_K_M.gguf.
151
+
152
+ Then click Download.
153
+
154
+ ### On the command line, including multiple files at once
155
+
156
+ I recommend using the `huggingface-hub` Python library:
157
+
158
+ ```shell
159
+ pip3 install huggingface-hub>=0.17.1
160
+ ```
161
+
162
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
163
+
164
+ ```shell
165
+ huggingface-cli download TheBloke/Kimiko-v2-13B-GGUF kimiko-v2-13b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
166
+ ```
167
 
168
+ <details>
169
+ <summary>More advanced huggingface-cli download usage</summary>
170
 
171
+ You can also download multiple files at once with a pattern:
172
 
173
+ ```shell
174
+ huggingface-cli download TheBloke/Kimiko-v2-13B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
175
  ```
176
+
177
+ 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).
178
+
179
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
180
+
181
+ ```shell
182
+ pip3 install hf_transfer
183
+ ```
184
+
185
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
186
+
187
+ ```shell
188
+ HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Kimiko-v2-13B-GGUF kimiko-v2-13b.q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
189
+ ```
190
+
191
+ Windows CLI users: Use `set HUGGINGFACE_HUB_ENABLE_HF_TRANSFER=1` before running the download command.
192
+ </details>
193
+ <!-- README_GGUF.md-how-to-download end -->
194
+
195
+ <!-- README_GGUF.md-how-to-run start -->
196
+ ## Example `llama.cpp` command
197
+
198
+ Make sure you are using `llama.cpp` from commit [d0cee0d36d5be95a0d9088b674dbb27354107221](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
199
+
200
+ ```shell
201
+ ./main -ngl 32 -m kimiko-v2-13b.q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "A chat between a curious user and an artificial intelligence assistant. The assistant gives helpful, detailed, and polite answers to the user's questions. USER: {prompt} ASSISTANT:"
202
  ```
 
203
 
204
  Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
205
 
206
+ Change `-c 4096` 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.
207
 
208
  If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
209
 
 
260
 
261
  [TheBloke AI's Discord server](https://discord.gg/theblokeai)
262
 
263
+ ## Thanks, and how to contribute
264
 
265
  Thanks to the [chirper.ai](https://chirper.ai) team!
266
 
267
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
268
+
269
  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.
270
 
271
  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.
 
277
 
278
  **Special thanks to**: Aemon Algiz.
279
 
280
+ **Patreon special mentions**: Alicia Loh, Stephen Murray, K, Ajan Kanaga, RoA, Magnesian, Deo Leter, Olakabola, Eugene Pentland, zynix, Deep Realms, Raymond Fosdick, Elijah Stavena, Iucharbius, Erik Bjäreholt, Luis Javier Navarrete Lozano, Nicholas, theTransient, John Detwiler, alfie_i, knownsqashed, Mano Prime, Willem Michiel, Enrico Ros, LangChain4j, OG, Michael Dempsey, Pierre Kircher, Pedro Madruga, James Bentley, Thomas Belote, Luke @flexchar, Leonard Tan, Johann-Peter Hartmann, Illia Dulskyi, Fen Risland, Chadd, S_X, Jeff Scroggin, Ken Nordquist, Sean Connelly, Artur Olbinski, Swaroop Kallakuri, Jack West, Ai Maven, David Ziegler, Russ Johnson, transmissions 11, John Villwock, Alps Aficionado, Clay Pascal, Viktor Bowallius, Subspace Studios, Rainer Wilmers, Trenton Dambrowitz, vamX, Michael Levine, 준교 김, Brandon Frisco, Kalila, Trailburnt, Randy H, Talal Aujan, Nathan Dryer, Vadim, 阿明, ReadyPlayerEmma, Tiffany J. Kim, George Stoitzev, Spencer Kim, Jerry Meng, Gabriel Tamborski, Cory Kujawski, Jeffrey Morgan, Spiking Neurons AB, Edmond Seymore, Alexandros Triantafyllidis, Lone Striker, Cap'n Zoog, Nikolai Manek, danny, ya boyyy, Derek Yates, usrbinkat, Mandus, TL, Nathan LeClaire, subjectnull, Imad Khwaja, webtim, Raven Klaugh, Asp the Wyvern, Gabriel Puliatti, Caitlyn Gatomon, Joseph William Delisle, Jonathan Leane, Luke Pendergrass, SuperWojo, Sebastain Graf, Will Dee, Fred von Graf, Andrey, Dan Guido, Daniel P. Andersen, Nitin Borwankar, Elle, Vitor Caleffi, biorpg, jjj, NimbleBox.ai, Pieter, Matthew Berman, terasurfer, Michael Davis, Alex, Stanislav Ovsiannikov
281
 
282
 
283
  Thank you to all my generous patrons and donaters!