Upload README.md
Browse files
README.md
ADDED
@@ -0,0 +1,472 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
base_model: KoboldAI/LLaMA2-13B-Estopia
|
3 |
+
inference: false
|
4 |
+
license: cc-by-nc-4.0
|
5 |
+
model_creator: KoboldAI
|
6 |
+
model_name: Llama2 13B Estopia
|
7 |
+
model_type: llama
|
8 |
+
prompt_template: 'Below is an instruction that describes a task. Write a response
|
9 |
+
that appropriately completes the request.
|
10 |
+
|
11 |
+
|
12 |
+
### Instruction:
|
13 |
+
|
14 |
+
{prompt}
|
15 |
+
|
16 |
+
|
17 |
+
### Response:
|
18 |
+
|
19 |
+
'
|
20 |
+
quantized_by: TheBloke
|
21 |
+
tags:
|
22 |
+
- mergekit
|
23 |
+
- merge
|
24 |
+
---
|
25 |
+
<!-- markdownlint-disable MD041 -->
|
26 |
+
|
27 |
+
<!-- header start -->
|
28 |
+
<!-- 200823 -->
|
29 |
+
<div style="width: auto; margin-left: auto; margin-right: auto">
|
30 |
+
<img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
|
31 |
+
</div>
|
32 |
+
<div style="display: flex; justify-content: space-between; width: 100%;">
|
33 |
+
<div style="display: flex; flex-direction: column; align-items: flex-start;">
|
34 |
+
<p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
|
35 |
+
</div>
|
36 |
+
<div style="display: flex; flex-direction: column; align-items: flex-end;">
|
37 |
+
<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>
|
38 |
+
</div>
|
39 |
+
</div>
|
40 |
+
<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>
|
41 |
+
<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
|
42 |
+
<!-- header end -->
|
43 |
+
|
44 |
+
# Llama2 13B Estopia - GGUF
|
45 |
+
- Model creator: [KoboldAI](https://huggingface.co/KoboldAI)
|
46 |
+
- Original model: [Llama2 13B Estopia](https://huggingface.co/KoboldAI/LLaMA2-13B-Estopia)
|
47 |
+
|
48 |
+
<!-- description start -->
|
49 |
+
## Description
|
50 |
+
|
51 |
+
This repo contains GGUF format model files for [KoboldAI's Llama2 13B Estopia](https://huggingface.co/KoboldAI/LLaMA2-13B-Estopia).
|
52 |
+
|
53 |
+
These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
|
54 |
+
|
55 |
+
<!-- description end -->
|
56 |
+
<!-- README_GGUF.md-about-gguf start -->
|
57 |
+
### About GGUF
|
58 |
+
|
59 |
+
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.
|
60 |
+
|
61 |
+
Here is an incomplete list of clients and libraries that are known to support GGUF:
|
62 |
+
|
63 |
+
* [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
|
64 |
+
* [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.
|
65 |
+
* [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.
|
66 |
+
* [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
|
67 |
+
* [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.
|
68 |
+
* [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.
|
69 |
+
* [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.
|
70 |
+
* [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
|
71 |
+
* [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
|
72 |
+
* [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.
|
73 |
+
|
74 |
+
<!-- README_GGUF.md-about-gguf end -->
|
75 |
+
<!-- repositories-available start -->
|
76 |
+
## Repositories available
|
77 |
+
|
78 |
+
* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-AWQ)
|
79 |
+
* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GPTQ)
|
80 |
+
* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF)
|
81 |
+
* [KoboldAI's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/KoboldAI/LLaMA2-13B-Estopia)
|
82 |
+
<!-- repositories-available end -->
|
83 |
+
|
84 |
+
<!-- prompt-template start -->
|
85 |
+
## Prompt template: Alpaca
|
86 |
+
|
87 |
+
```
|
88 |
+
Below is an instruction that describes a task. Write a response that appropriately completes the request.
|
89 |
+
|
90 |
+
### Instruction:
|
91 |
+
{prompt}
|
92 |
+
|
93 |
+
### Response:
|
94 |
+
|
95 |
+
```
|
96 |
+
|
97 |
+
<!-- prompt-template end -->
|
98 |
+
<!-- licensing start -->
|
99 |
+
## Licensing
|
100 |
+
|
101 |
+
The creator of the source model has listed its license as `cc-by-nc-4.0`, and this quantization has therefore used that same license.
|
102 |
+
|
103 |
+
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.
|
104 |
+
|
105 |
+
In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [KoboldAI's Llama2 13B Estopia](https://huggingface.co/KoboldAI/LLaMA2-13B-Estopia).
|
106 |
+
<!-- licensing end -->
|
107 |
+
<!-- compatibility_gguf start -->
|
108 |
+
## Compatibility
|
109 |
+
|
110 |
+
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)
|
111 |
+
|
112 |
+
They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
|
113 |
+
|
114 |
+
## Explanation of quantisation methods
|
115 |
+
|
116 |
+
<details>
|
117 |
+
<summary>Click to see details</summary>
|
118 |
+
|
119 |
+
The new methods available are:
|
120 |
+
|
121 |
+
* 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)
|
122 |
+
* 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.
|
123 |
+
* 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.
|
124 |
+
* GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
|
125 |
+
* 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
|
126 |
+
|
127 |
+
Refer to the Provided Files table below to see what files use which methods, and how.
|
128 |
+
</details>
|
129 |
+
<!-- compatibility_gguf end -->
|
130 |
+
|
131 |
+
<!-- README_GGUF.md-provided-files start -->
|
132 |
+
## Provided files
|
133 |
+
|
134 |
+
| Name | Quant method | Bits | Size | Max RAM required | Use case |
|
135 |
+
| ---- | ---- | ---- | ---- | ---- | ----- |
|
136 |
+
| [llama2-13b-estopia.Q2_K.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q2_K.gguf) | Q2_K | 2 | 4.85 GB| 7.35 GB | significant quality loss - not recommended for most purposes |
|
137 |
+
| [llama2-13b-estopia.Q3_K_S.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q3_K_S.gguf) | Q3_K_S | 3 | 5.66 GB| 8.16 GB | very small, high quality loss |
|
138 |
+
| [llama2-13b-estopia.Q3_K_M.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q3_K_M.gguf) | Q3_K_M | 3 | 6.34 GB| 8.84 GB | very small, high quality loss |
|
139 |
+
| [llama2-13b-estopia.Q3_K_L.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q3_K_L.gguf) | Q3_K_L | 3 | 6.93 GB| 9.43 GB | small, substantial quality loss |
|
140 |
+
| [llama2-13b-estopia.Q4_0.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q4_0.gguf) | Q4_0 | 4 | 7.37 GB| 9.87 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
|
141 |
+
| [llama2-13b-estopia.Q4_K_S.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q4_K_S.gguf) | Q4_K_S | 4 | 7.42 GB| 9.92 GB | small, greater quality loss |
|
142 |
+
| [llama2-13b-estopia.Q4_K_M.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q4_K_M.gguf) | Q4_K_M | 4 | 7.87 GB| 10.37 GB | medium, balanced quality - recommended |
|
143 |
+
| [llama2-13b-estopia.Q5_0.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q5_0.gguf) | Q5_0 | 5 | 8.97 GB| 11.47 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
|
144 |
+
| [llama2-13b-estopia.Q5_K_S.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q5_K_S.gguf) | Q5_K_S | 5 | 8.97 GB| 11.47 GB | large, low quality loss - recommended |
|
145 |
+
| [llama2-13b-estopia.Q5_K_M.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q5_K_M.gguf) | Q5_K_M | 5 | 9.23 GB| 11.73 GB | large, very low quality loss - recommended |
|
146 |
+
| [llama2-13b-estopia.Q6_K.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q6_K.gguf) | Q6_K | 6 | 10.68 GB| 13.18 GB | very large, extremely low quality loss |
|
147 |
+
| [llama2-13b-estopia.Q8_0.gguf](https://huggingface.co/TheBloke/LLaMA2-13B-Estopia-GGUF/blob/main/llama2-13b-estopia.Q8_0.gguf) | Q8_0 | 8 | 13.83 GB| 16.33 GB | very large, extremely low quality loss - not recommended |
|
148 |
+
|
149 |
+
**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.
|
150 |
+
|
151 |
+
|
152 |
+
|
153 |
+
<!-- README_GGUF.md-provided-files end -->
|
154 |
+
|
155 |
+
<!-- README_GGUF.md-how-to-download start -->
|
156 |
+
## How to download GGUF files
|
157 |
+
|
158 |
+
**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.
|
159 |
+
|
160 |
+
The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
|
161 |
+
|
162 |
+
* LM Studio
|
163 |
+
* LoLLMS Web UI
|
164 |
+
* Faraday.dev
|
165 |
+
|
166 |
+
### In `text-generation-webui`
|
167 |
+
|
168 |
+
Under Download Model, you can enter the model repo: TheBloke/LLaMA2-13B-Estopia-GGUF and below it, a specific filename to download, such as: llama2-13b-estopia.Q4_K_M.gguf.
|
169 |
+
|
170 |
+
Then click Download.
|
171 |
+
|
172 |
+
### On the command line, including multiple files at once
|
173 |
+
|
174 |
+
I recommend using the `huggingface-hub` Python library:
|
175 |
+
|
176 |
+
```shell
|
177 |
+
pip3 install huggingface-hub
|
178 |
+
```
|
179 |
+
|
180 |
+
Then you can download any individual model file to the current directory, at high speed, with a command like this:
|
181 |
+
|
182 |
+
```shell
|
183 |
+
huggingface-cli download TheBloke/LLaMA2-13B-Estopia-GGUF llama2-13b-estopia.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
|
184 |
+
```
|
185 |
+
|
186 |
+
<details>
|
187 |
+
<summary>More advanced huggingface-cli download usage (click to read)</summary>
|
188 |
+
|
189 |
+
You can also download multiple files at once with a pattern:
|
190 |
+
|
191 |
+
```shell
|
192 |
+
huggingface-cli download TheBloke/LLaMA2-13B-Estopia-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
|
193 |
+
```
|
194 |
+
|
195 |
+
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).
|
196 |
+
|
197 |
+
To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
|
198 |
+
|
199 |
+
```shell
|
200 |
+
pip3 install hf_transfer
|
201 |
+
```
|
202 |
+
|
203 |
+
And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
|
204 |
+
|
205 |
+
```shell
|
206 |
+
HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/LLaMA2-13B-Estopia-GGUF llama2-13b-estopia.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
|
207 |
+
```
|
208 |
+
|
209 |
+
Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
|
210 |
+
</details>
|
211 |
+
<!-- README_GGUF.md-how-to-download end -->
|
212 |
+
|
213 |
+
<!-- README_GGUF.md-how-to-run start -->
|
214 |
+
## Example `llama.cpp` command
|
215 |
+
|
216 |
+
Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
|
217 |
+
|
218 |
+
```shell
|
219 |
+
./main -ngl 35 -m llama2-13b-estopia.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:"
|
220 |
+
```
|
221 |
+
|
222 |
+
Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
|
223 |
+
|
224 |
+
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. Note that longer sequence lengths require much more resources, so you may need to reduce this value.
|
225 |
+
|
226 |
+
If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
|
227 |
+
|
228 |
+
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)
|
229 |
+
|
230 |
+
## How to run in `text-generation-webui`
|
231 |
+
|
232 |
+
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).
|
233 |
+
|
234 |
+
## How to run from Python code
|
235 |
+
|
236 |
+
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.
|
237 |
+
|
238 |
+
### How to load this model in Python code, using llama-cpp-python
|
239 |
+
|
240 |
+
For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
|
241 |
+
|
242 |
+
#### First install the package
|
243 |
+
|
244 |
+
Run one of the following commands, according to your system:
|
245 |
+
|
246 |
+
```shell
|
247 |
+
# Base ctransformers with no GPU acceleration
|
248 |
+
pip install llama-cpp-python
|
249 |
+
# With NVidia CUDA acceleration
|
250 |
+
CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
|
251 |
+
# Or with OpenBLAS acceleration
|
252 |
+
CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
|
253 |
+
# Or with CLBLast acceleration
|
254 |
+
CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
|
255 |
+
# Or with AMD ROCm GPU acceleration (Linux only)
|
256 |
+
CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
|
257 |
+
# Or with Metal GPU acceleration for macOS systems only
|
258 |
+
CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
|
259 |
+
|
260 |
+
# In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
|
261 |
+
$env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
|
262 |
+
pip install llama-cpp-python
|
263 |
+
```
|
264 |
+
|
265 |
+
#### Simple llama-cpp-python example code
|
266 |
+
|
267 |
+
```python
|
268 |
+
from llama_cpp import Llama
|
269 |
+
|
270 |
+
# Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
|
271 |
+
llm = Llama(
|
272 |
+
model_path="./llama2-13b-estopia.Q4_K_M.gguf", # Download the model file first
|
273 |
+
n_ctx=4096, # The max sequence length to use - note that longer sequence lengths require much more resources
|
274 |
+
n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
|
275 |
+
n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
|
276 |
+
)
|
277 |
+
|
278 |
+
# Simple inference example
|
279 |
+
output = llm(
|
280 |
+
"Below is an instruction that describes a task. Write a response that appropriately completes the request.\n\n### Instruction:\n{prompt}\n\n### Response:", # Prompt
|
281 |
+
max_tokens=512, # Generate up to 512 tokens
|
282 |
+
stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
|
283 |
+
echo=True # Whether to echo the prompt
|
284 |
+
)
|
285 |
+
|
286 |
+
# Chat Completion API
|
287 |
+
|
288 |
+
llm = Llama(model_path="./llama2-13b-estopia.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
|
289 |
+
llm.create_chat_completion(
|
290 |
+
messages = [
|
291 |
+
{"role": "system", "content": "You are a story writing assistant."},
|
292 |
+
{
|
293 |
+
"role": "user",
|
294 |
+
"content": "Write a story about llamas."
|
295 |
+
}
|
296 |
+
]
|
297 |
+
)
|
298 |
+
```
|
299 |
+
|
300 |
+
## How to use with LangChain
|
301 |
+
|
302 |
+
Here are guides on using llama-cpp-python and ctransformers with LangChain:
|
303 |
+
|
304 |
+
* [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
|
305 |
+
* [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
|
306 |
+
|
307 |
+
<!-- README_GGUF.md-how-to-run end -->
|
308 |
+
|
309 |
+
<!-- footer start -->
|
310 |
+
<!-- 200823 -->
|
311 |
+
## Discord
|
312 |
+
|
313 |
+
For further support, and discussions on these models and AI in general, join us at:
|
314 |
+
|
315 |
+
[TheBloke AI's Discord server](https://discord.gg/theblokeai)
|
316 |
+
|
317 |
+
## Thanks, and how to contribute
|
318 |
+
|
319 |
+
Thanks to the [chirper.ai](https://chirper.ai) team!
|
320 |
+
|
321 |
+
Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
|
322 |
+
|
323 |
+
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.
|
324 |
+
|
325 |
+
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.
|
326 |
+
|
327 |
+
Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
|
328 |
+
|
329 |
+
* Patreon: https://patreon.com/TheBlokeAI
|
330 |
+
* Ko-Fi: https://ko-fi.com/TheBlokeAI
|
331 |
+
|
332 |
+
**Special thanks to**: Aemon Algiz.
|
333 |
+
|
334 |
+
**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
|
335 |
+
|
336 |
+
|
337 |
+
Thank you to all my generous patrons and donaters!
|
338 |
+
|
339 |
+
And thank you again to a16z for their generous grant.
|
340 |
+
|
341 |
+
<!-- footer end -->
|
342 |
+
|
343 |
+
<!-- original-model-card start -->
|
344 |
+
# Original model card: KoboldAI's Llama2 13B Estopia
|
345 |
+
|
346 |
+
# Introduction
|
347 |
+
- Estopia is a model focused on improving the dialogue and prose returned when using the instruct format. As a side benefit, character cards and similar seem to have also improved, remembering details well in many cases.
|
348 |
+
- It focuses on "guided narratives" - using instructions to guide or explore fictional stories, where you act as a guide for the AI to narrate and fill in the details.
|
349 |
+
- It has primarily been tested around prose, using instructions to guide narrative, detail retention and "neutrality" - in particular with regards to plot armour. Unless you define different rules for your adventure / narrative with instructions, it should be realistic in the responses provided.
|
350 |
+
- It has been tested using different modes, such as instruct, chat, adventure and story modes - and should be able to do them all to a degree, with it's strengths being instruct and adventure, with story being a close second.
|
351 |
+
# Usage
|
352 |
+
- The Estopia model has been tested primarily using the Alpaca format, but with the range of models included likely has some understanding of others. Some examples of tested formats are below:
|
353 |
+
- ```\n### Instruction:\nWhat colour is the sky?\n### Response:\nThe sky is...```
|
354 |
+
- ```<Story text>\n***\nWrite a summary of the text above\n***\nThe story starts by...```
|
355 |
+
- Using the Kobold Lite AI adventure mode
|
356 |
+
- ```User:Hello there!\nAssistant:Good morning...\n```
|
357 |
+
- For settings, the following are recommended for general use:
|
358 |
+
- Temperature: 0.8-1.2
|
359 |
+
- Min P: 0.05-0.1
|
360 |
+
- Max P: 0.92, or 1 if using a Min P greater than 0
|
361 |
+
- Top K: 0
|
362 |
+
- Response length: Higher than your usual amount most likely - for example a common value selected is 512.
|
363 |
+
- Note: Response lengths are not guaranteed to always be this length. On occasion, responses may be shorter if they convey the response entirely, other times they could be upwards of this value. It depends mostly on the character card, instructions, etc.
|
364 |
+
- Rep Pen: 1.1
|
365 |
+
- Rep Pen Range: 2 or 3x your response length
|
366 |
+
- Stopping tokens (Not needed, but can help if the AI is writing too much):
|
367 |
+
- ```##||$||---||$||ASSISTANT:||$||[End||$||</s>``` - A single string for Kobold Lite combining the ones below
|
368 |
+
- ```##```
|
369 |
+
- ```---```
|
370 |
+
- ```ASSISTANT:```
|
371 |
+
- ```[End```
|
372 |
+
- ```</s>```
|
373 |
+
- The settings above should provide a generally good experience balancing instruction following and creativity. Generally the higher you set the temperature, the greater the creativity and higher chance of logical errors when providing responses from the AI.
|
374 |
+
# Recipe
|
375 |
+
This model was made in three stages, along with many experimental stages which will be skipped for brevity. The first was internally referred to as EstopiaV9, which has a high degree of instruction following and creativity in responses, though they were generally shorter and a little more restricted in the scope of outputs, but conveyed nuance better.
|
376 |
+
```yaml
|
377 |
+
merge_method: task_arithmetic
|
378 |
+
base_model: TheBloke/Llama-2-13B-fp16
|
379 |
+
models:
|
380 |
+
- model: TheBloke/Llama-2-13B-fp16
|
381 |
+
- model: Undi95/UtopiaXL-13B
|
382 |
+
parameters:
|
383 |
+
weight: 1.0
|
384 |
+
- model: Doctor-Shotgun/cat-v1.0-13b
|
385 |
+
parameters:
|
386 |
+
weight: 0.02
|
387 |
+
- model: PygmalionAI/mythalion-13b
|
388 |
+
parameters:
|
389 |
+
weight: 0.10
|
390 |
+
- model: Undi95/Emerhyst-13B
|
391 |
+
parameters:
|
392 |
+
weight: 0.05
|
393 |
+
- model: CalderaAI/13B-Thorns-l2
|
394 |
+
parameters:
|
395 |
+
weight: 0.05
|
396 |
+
- model: KoboldAI/LLaMA2-13B-Tiefighter
|
397 |
+
parameters:
|
398 |
+
weight: 0.20
|
399 |
+
dtype: float16
|
400 |
+
```
|
401 |
+
The second part of the merge was known as EstopiaV13. This produced responses which were long, but tended to write beyond good stopping points for further instructions to be added as it leant heavily on novel style prose. It did however benefit from a greater degree of neutrality as described above, and retained many of the detail tracking abilities of V9.
|
402 |
+
```yaml
|
403 |
+
merge_method: task_arithmetic
|
404 |
+
base_model: TheBloke/Llama-2-13B-fp16
|
405 |
+
models:
|
406 |
+
- model: TheBloke/Llama-2-13B-fp16
|
407 |
+
- model: Undi95/UtopiaXL-13B
|
408 |
+
parameters:
|
409 |
+
weight: 1.0
|
410 |
+
- model: Doctor-Shotgun/cat-v1.0-13b
|
411 |
+
parameters:
|
412 |
+
weight: 0.01
|
413 |
+
- model: chargoddard/rpguild-chatml-13b
|
414 |
+
parameters:
|
415 |
+
weight: 0.02
|
416 |
+
- model: PygmalionAI/mythalion-13b
|
417 |
+
parameters:
|
418 |
+
weight: 0.08
|
419 |
+
- model: CalderaAI/13B-Thorns-l2
|
420 |
+
parameters:
|
421 |
+
weight: 0.02
|
422 |
+
- model: KoboldAI/LLaMA2-13B-Tiefighter
|
423 |
+
parameters:
|
424 |
+
weight: 0.20
|
425 |
+
dtype: float16
|
426 |
+
```
|
427 |
+
The third step was a merge between the two to retain the benefits of both as much as possible. This was performed using the dare merging technique.
|
428 |
+
```yaml
|
429 |
+
# task-arithmetic style
|
430 |
+
models:
|
431 |
+
- model: EstopiaV9
|
432 |
+
parameters:
|
433 |
+
weight: 1
|
434 |
+
density: 1
|
435 |
+
- model: EstopiaV13
|
436 |
+
parameters:
|
437 |
+
weight: 0.05
|
438 |
+
density: 0.30
|
439 |
+
merge_method: dare_ties
|
440 |
+
base_model: TheBloke/Llama-2-13B-fp16
|
441 |
+
parameters:
|
442 |
+
int8_mask: true
|
443 |
+
dtype: bfloat16
|
444 |
+
```
|
445 |
+
# Model selection
|
446 |
+
- Undi95/UtopiaXL-13B
|
447 |
+
- Solid all around base for models, with the ability to write longer responses and generally good retension to detail.
|
448 |
+
- Doctor-Shotgun/cat-v1.0-13b
|
449 |
+
- A medical focused model which is added to focus a little more on the human responses, such as for psycology.
|
450 |
+
- PygmalionAI/mythalion-13b
|
451 |
+
- A roleplay and instruct focused model, which improves attentiveness to character card details and the variety of responses
|
452 |
+
- Undi95/Emerhyst-13B
|
453 |
+
- A roleplay but also longer form response model. It can be quite variable, but helps add to the depth and possible options the AI can respond with during narratives.
|
454 |
+
- CalderaAI/13B-Thorns-l2
|
455 |
+
- A neutral and very attentive model. It is good at chat and following instructions, which help benefit these modes.
|
456 |
+
- KoboldAI/LLaMA2-13B-Tiefighter
|
457 |
+
- A solid all around model, focusing on story writing and adventure modes. It provides all around benefits to creativity and the prose in models, along with adventure mode support.
|
458 |
+
- chargoddard/rpguild-chatml-13b
|
459 |
+
- A roleplay model, which introduces new data and also improves the detail retention in longer narratives.
|
460 |
+
# Notes
|
461 |
+
- With the differing models inside, this model will not have perfect end of sequence tokens which is a problem many merges can share. While attempts have been made to minimise this, you may occasionally get oddly behaving tokens - this should be possible to resolve with a quick manual edit once and the model should pick up on it.
|
462 |
+
- Chat is one of the least tested areas for this model. It works fairly well, but it can be quite character card dependant.
|
463 |
+
- This is a narrative and prose focused model. As a result, it can and will talk for you if guided to do so (such as asking it to act as a co-author or narrator) within instructions or other contexts. This can be mitigated mostly by adding instructions to limit this, or using chat mode instead.
|
464 |
+
# Future areas
|
465 |
+
- Llava
|
466 |
+
- Some success has been had with merging the llava lora on this. While no in depth testing has been performed, more narrative responses based on the images could be obtained - though there were drawbacks in the form of degraded performance in other areas, and hallucinations due to the fictional focus of this model.
|
467 |
+
- Stheno
|
468 |
+
- A merge which has similar promise from Sao. Some merge attempts have been made between the two and were promising, but not entirely consistent at the moment. With some possible refinement, this could produce an even stronger model.
|
469 |
+
- DynamicFactor
|
470 |
+
- All the merges used have been based on llama two in this merge, but a dare merge with dynamic factor (an attempted refinement of llama two) showed a beneficial improvement to the instruction abilities of the model, along with lengthy responses. It lost a little of the variety of responses, so perhaps if a balance of it could be added the instruction abilities and reasoning could be improved even further.
|
471 |
+
|
472 |
+
<!-- original-model-card end -->
|