TheBloke commited on
Commit
7b70903
1 Parent(s): b8e3d1f

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +506 -0
README.md ADDED
@@ -0,0 +1,506 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: sophosympatheia/Aurora-Nights-70B-v1.0
3
+ inference: false
4
+ language:
5
+ - en
6
+ license: llama2
7
+ model_creator: Sophosympatheia
8
+ model_name: Aurora Nights 70B v1.0
9
+ model_type: llama
10
+ prompt_template: '{system_message}
11
+
12
+ <|user|>
13
+
14
+ {prompt}
15
+
16
+ <|assistant|>
17
+
18
+ '
19
+ quantized_by: TheBloke
20
+ ---
21
+ <!-- markdownlint-disable MD041 -->
22
+
23
+ <!-- header start -->
24
+ <!-- 200823 -->
25
+ <div style="width: auto; margin-left: auto; margin-right: auto">
26
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
27
+ </div>
28
+ <div style="display: flex; justify-content: space-between; width: 100%;">
29
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
30
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
31
+ </div>
32
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
33
+ <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>
34
+ </div>
35
+ </div>
36
+ <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>
37
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
38
+ <!-- header end -->
39
+
40
+ # Aurora Nights 70B v1.0 - GGUF
41
+ - Model creator: [Sophosympatheia](https://huggingface.co/sophosympatheia)
42
+ - Original model: [Aurora Nights 70B v1.0](https://huggingface.co/sophosympatheia/Aurora-Nights-70B-v1.0)
43
+
44
+ <!-- description start -->
45
+ ## Description
46
+
47
+ This repo contains GGUF format model files for [Sophosympatheia's Aurora Nights 70B v1.0](https://huggingface.co/sophosympatheia/Aurora-Nights-70B-v1.0).
48
+
49
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
50
+
51
+ <!-- description end -->
52
+ <!-- README_GGUF.md-about-gguf start -->
53
+ ### About GGUF
54
+
55
+ 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.
56
+
57
+ Here is an incomplete list of clients and libraries that are known to support GGUF:
58
+
59
+ * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option.
60
+ * [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.
61
+ * [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.
62
+ * [GPT4All](https://gpt4all.io/index.html), a free and open source local running GUI, supporting Windows, Linux and macOS with full GPU accel.
63
+ * [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.
64
+ * [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.
65
+ * [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.
66
+ * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server.
67
+ * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use.
68
+ * [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.
69
+
70
+ <!-- README_GGUF.md-about-gguf end -->
71
+ <!-- repositories-available start -->
72
+ ## Repositories available
73
+
74
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-AWQ)
75
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GPTQ)
76
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF)
77
+ * [Sophosympatheia's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/sophosympatheia/Aurora-Nights-70B-v1.0)
78
+ <!-- repositories-available end -->
79
+
80
+ <!-- prompt-template start -->
81
+ ## Prompt template: ToRA-System
82
+
83
+ ```
84
+ {system_message}
85
+ <|user|>
86
+ {prompt}
87
+ <|assistant|>
88
+
89
+ ```
90
+
91
+ <!-- prompt-template end -->
92
+
93
+
94
+ <!-- compatibility_gguf start -->
95
+ ## Compatibility
96
+
97
+ 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)
98
+
99
+ They are also compatible with many third party UIs and libraries - please see the list at the top of this README.
100
+
101
+ ## Explanation of quantisation methods
102
+
103
+ <details>
104
+ <summary>Click to see details</summary>
105
+
106
+ The new methods available are:
107
+
108
+ * 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)
109
+ * 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.
110
+ * 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.
111
+ * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw
112
+ * 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
113
+
114
+ Refer to the Provided Files table below to see what files use which methods, and how.
115
+ </details>
116
+ <!-- compatibility_gguf end -->
117
+
118
+ <!-- README_GGUF.md-provided-files start -->
119
+ ## Provided files
120
+
121
+ | Name | Quant method | Bits | Size | Max RAM required | Use case |
122
+ | ---- | ---- | ---- | ---- | ---- | ----- |
123
+ | [aurora-nights-70b-v1.0.Q2_K.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q2_K.gguf) | Q2_K | 2 | 29.28 GB| 31.78 GB | smallest, significant quality loss - not recommended for most purposes |
124
+ | [aurora-nights-70b-v1.0.Q3_K_S.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q3_K_S.gguf) | Q3_K_S | 3 | 29.92 GB| 32.42 GB | very small, high quality loss |
125
+ | [aurora-nights-70b-v1.0.Q3_K_M.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q3_K_M.gguf) | Q3_K_M | 3 | 33.19 GB| 35.69 GB | very small, high quality loss |
126
+ | [aurora-nights-70b-v1.0.Q3_K_L.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q3_K_L.gguf) | Q3_K_L | 3 | 36.15 GB| 38.65 GB | small, substantial quality loss |
127
+ | [aurora-nights-70b-v1.0.Q4_0.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q4_0.gguf) | Q4_0 | 4 | 38.87 GB| 41.37 GB | legacy; small, very high quality loss - prefer using Q3_K_M |
128
+ | [aurora-nights-70b-v1.0.Q4_K_S.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q4_K_S.gguf) | Q4_K_S | 4 | 39.07 GB| 41.57 GB | small, greater quality loss |
129
+ | [aurora-nights-70b-v1.0.Q4_K_M.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q4_K_M.gguf) | Q4_K_M | 4 | 41.42 GB| 43.92 GB | medium, balanced quality - recommended |
130
+ | [aurora-nights-70b-v1.0.Q5_0.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q5_0.gguf) | Q5_0 | 5 | 47.46 GB| 49.96 GB | legacy; medium, balanced quality - prefer using Q4_K_M |
131
+ | [aurora-nights-70b-v1.0.Q5_K_S.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q5_K_S.gguf) | Q5_K_S | 5 | 47.46 GB| 49.96 GB | large, low quality loss - recommended |
132
+ | [aurora-nights-70b-v1.0.Q5_K_M.gguf](https://huggingface.co/TheBloke/Aurora-Nights-70B-v1.0-GGUF/blob/main/aurora-nights-70b-v1.0.Q5_K_M.gguf) | Q5_K_M | 5 | 48.75 GB| 51.25 GB | large, very low quality loss - recommended |
133
+ | aurora-nights-70b-v1.0.Q6_K.gguf | Q6_K | 6 | 56.59 GB| 59.09 GB | very large, extremely low quality loss |
134
+ | aurora-nights-70b-v1.0.Q8_0.gguf | Q8_0 | 8 | 73.29 GB| 75.79 GB | very large, extremely low quality loss - not recommended |
135
+
136
+ **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.
137
+
138
+ ### Q6_K and Q8_0 files are split and require joining
139
+
140
+ **Note:** HF does not support uploading files larger than 50GB. Therefore I have uploaded the Q6_K and Q8_0 files as split files.
141
+
142
+ <details>
143
+ <summary>Click for instructions regarding Q6_K and Q8_0 files</summary>
144
+
145
+ ### q6_K
146
+ Please download:
147
+ * `aurora-nights-70b-v1.0.Q6_K.gguf-split-a`
148
+ * `aurora-nights-70b-v1.0.Q6_K.gguf-split-b`
149
+
150
+ ### q8_0
151
+ Please download:
152
+ * `aurora-nights-70b-v1.0.Q8_0.gguf-split-a`
153
+ * `aurora-nights-70b-v1.0.Q8_0.gguf-split-b`
154
+
155
+ To join the files, do the following:
156
+
157
+ Linux and macOS:
158
+ ```
159
+ cat aurora-nights-70b-v1.0.Q6_K.gguf-split-* > aurora-nights-70b-v1.0.Q6_K.gguf && rm aurora-nights-70b-v1.0.Q6_K.gguf-split-*
160
+ cat aurora-nights-70b-v1.0.Q8_0.gguf-split-* > aurora-nights-70b-v1.0.Q8_0.gguf && rm aurora-nights-70b-v1.0.Q8_0.gguf-split-*
161
+ ```
162
+ Windows command line:
163
+ ```
164
+ COPY /B aurora-nights-70b-v1.0.Q6_K.gguf-split-a + aurora-nights-70b-v1.0.Q6_K.gguf-split-b aurora-nights-70b-v1.0.Q6_K.gguf
165
+ del aurora-nights-70b-v1.0.Q6_K.gguf-split-a aurora-nights-70b-v1.0.Q6_K.gguf-split-b
166
+
167
+ COPY /B aurora-nights-70b-v1.0.Q8_0.gguf-split-a + aurora-nights-70b-v1.0.Q8_0.gguf-split-b aurora-nights-70b-v1.0.Q8_0.gguf
168
+ del aurora-nights-70b-v1.0.Q8_0.gguf-split-a aurora-nights-70b-v1.0.Q8_0.gguf-split-b
169
+ ```
170
+
171
+ </details>
172
+ <!-- README_GGUF.md-provided-files end -->
173
+
174
+ <!-- README_GGUF.md-how-to-download start -->
175
+ ## How to download GGUF files
176
+
177
+ **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.
178
+
179
+ The following clients/libraries will automatically download models for you, providing a list of available models to choose from:
180
+
181
+ * LM Studio
182
+ * LoLLMS Web UI
183
+ * Faraday.dev
184
+
185
+ ### In `text-generation-webui`
186
+
187
+ Under Download Model, you can enter the model repo: TheBloke/Aurora-Nights-70B-v1.0-GGUF and below it, a specific filename to download, such as: aurora-nights-70b-v1.0.Q4_K_M.gguf.
188
+
189
+ Then click Download.
190
+
191
+ ### On the command line, including multiple files at once
192
+
193
+ I recommend using the `huggingface-hub` Python library:
194
+
195
+ ```shell
196
+ pip3 install huggingface-hub
197
+ ```
198
+
199
+ Then you can download any individual model file to the current directory, at high speed, with a command like this:
200
+
201
+ ```shell
202
+ huggingface-cli download TheBloke/Aurora-Nights-70B-v1.0-GGUF aurora-nights-70b-v1.0.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
203
+ ```
204
+
205
+ <details>
206
+ <summary>More advanced huggingface-cli download usage (click to read)</summary>
207
+
208
+ You can also download multiple files at once with a pattern:
209
+
210
+ ```shell
211
+ huggingface-cli download TheBloke/Aurora-Nights-70B-v1.0-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf'
212
+ ```
213
+
214
+ 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).
215
+
216
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
217
+
218
+ ```shell
219
+ pip3 install hf_transfer
220
+ ```
221
+
222
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
223
+
224
+ ```shell
225
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Aurora-Nights-70B-v1.0-GGUF aurora-nights-70b-v1.0.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False
226
+ ```
227
+
228
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
229
+ </details>
230
+ <!-- README_GGUF.md-how-to-download end -->
231
+
232
+ <!-- README_GGUF.md-how-to-run start -->
233
+ ## Example `llama.cpp` command
234
+
235
+ Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later.
236
+
237
+ ```shell
238
+ ./main -ngl 35 -m aurora-nights-70b-v1.0.Q4_K_M.gguf --color -c 4096 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "{system_message}\n<|user|>\n{prompt}\n<|assistant|>"
239
+ ```
240
+
241
+ Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration.
242
+
243
+ 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.
244
+
245
+ If you want to have a chat-style conversation, replace the `-p <PROMPT>` argument with `-i -ins`
246
+
247
+ 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)
248
+
249
+ ## How to run in `text-generation-webui`
250
+
251
+ 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).
252
+
253
+ ## How to run from Python code
254
+
255
+ 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.
256
+
257
+ ### How to load this model in Python code, using llama-cpp-python
258
+
259
+ For full documentation, please see: [llama-cpp-python docs](https://abetlen.github.io/llama-cpp-python/).
260
+
261
+ #### First install the package
262
+
263
+ Run one of the following commands, according to your system:
264
+
265
+ ```shell
266
+ # Base ctransformers with no GPU acceleration
267
+ pip install llama-cpp-python
268
+ # With NVidia CUDA acceleration
269
+ CMAKE_ARGS="-DLLAMA_CUBLAS=on" pip install llama-cpp-python
270
+ # Or with OpenBLAS acceleration
271
+ CMAKE_ARGS="-DLLAMA_BLAS=ON -DLLAMA_BLAS_VENDOR=OpenBLAS" pip install llama-cpp-python
272
+ # Or with CLBLast acceleration
273
+ CMAKE_ARGS="-DLLAMA_CLBLAST=on" pip install llama-cpp-python
274
+ # Or with AMD ROCm GPU acceleration (Linux only)
275
+ CMAKE_ARGS="-DLLAMA_HIPBLAS=on" pip install llama-cpp-python
276
+ # Or with Metal GPU acceleration for macOS systems only
277
+ CMAKE_ARGS="-DLLAMA_METAL=on" pip install llama-cpp-python
278
+
279
+ # In windows, to set the variables CMAKE_ARGS in PowerShell, follow this format; eg for NVidia CUDA:
280
+ $env:CMAKE_ARGS = "-DLLAMA_OPENBLAS=on"
281
+ pip install llama-cpp-python
282
+ ```
283
+
284
+ #### Simple llama-cpp-python example code
285
+
286
+ ```python
287
+ from llama_cpp import Llama
288
+
289
+ # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system.
290
+ llm = Llama(
291
+ model_path="./aurora-nights-70b-v1.0.Q4_K_M.gguf", # Download the model file first
292
+ n_ctx=4096, # The max sequence length to use - note that longer sequence lengths require much more resources
293
+ n_threads=8, # The number of CPU threads to use, tailor to your system and the resulting performance
294
+ n_gpu_layers=35 # The number of layers to offload to GPU, if you have GPU acceleration available
295
+ )
296
+
297
+ # Simple inference example
298
+ output = llm(
299
+ "{system_message}\n<|user|>\n{prompt}\n<|assistant|>", # Prompt
300
+ max_tokens=512, # Generate up to 512 tokens
301
+ stop=["</s>"], # Example stop token - not necessarily correct for this specific model! Please check before using.
302
+ echo=True # Whether to echo the prompt
303
+ )
304
+
305
+ # Chat Completion API
306
+
307
+ llm = Llama(model_path="./aurora-nights-70b-v1.0.Q4_K_M.gguf", chat_format="llama-2") # Set chat_format according to the model you are using
308
+ llm.create_chat_completion(
309
+ messages = [
310
+ {"role": "system", "content": "You are a story writing assistant."},
311
+ {
312
+ "role": "user",
313
+ "content": "Write a story about llamas."
314
+ }
315
+ ]
316
+ )
317
+ ```
318
+
319
+ ## How to use with LangChain
320
+
321
+ Here are guides on using llama-cpp-python and ctransformers with LangChain:
322
+
323
+ * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp)
324
+ * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers)
325
+
326
+ <!-- README_GGUF.md-how-to-run end -->
327
+
328
+ <!-- footer start -->
329
+ <!-- 200823 -->
330
+ ## Discord
331
+
332
+ For further support, and discussions on these models and AI in general, join us at:
333
+
334
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
335
+
336
+ ## Thanks, and how to contribute
337
+
338
+ Thanks to the [chirper.ai](https://chirper.ai) team!
339
+
340
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
341
+
342
+ 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.
343
+
344
+ 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.
345
+
346
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
347
+
348
+ * Patreon: https://patreon.com/TheBlokeAI
349
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
350
+
351
+ **Special thanks to**: Aemon Algiz.
352
+
353
+ **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
354
+
355
+
356
+ Thank you to all my generous patrons and donaters!
357
+
358
+ And thank you again to a16z for their generous grant.
359
+
360
+ <!-- footer end -->
361
+
362
+ <!-- original-model-card start -->
363
+ # Original model card: Sophosympatheia's Aurora Nights 70B v1.0
364
+
365
+ <div style="width: auto; margin-left: auto; margin-right: auto">
366
+ <img src="https://i.imgur.com/aGUU0O9.png" alt="AuroraNights" style="width: 100%; min-width: 400px; display: block; margin: auto;">
367
+ </div>
368
+
369
+ ### Overview
370
+
371
+ This model is a blend of [allenai/tulu-2-dpo-70b](https://huggingface.co/allenai/tulu-2-dpo-70b), [Xwin-LM/Xwin-LM-70B-V0.1](https://huggingface.co/Xwin-LM/Xwin-LM-70B-V0.1), and [dreamgen/opus-v0.5-70b](https://huggingface.co/dreamgen/opus-v0.5-70b). I then merged [nRuaif/fiction.live-Kimiko-V2-70B](https://huggingface.co/nRuaif/fiction.live-Kimiko-V2-70B) into the resultant blend. See the bottom of this card for the exact settings used.
372
+
373
+ This model is good at both following instructions and producing creative, uncensored storytelling and roleplaying content.
374
+ This model turned out quite uncensored. *You are responsible for whatever you do with it.*
375
+
376
+ This model was designed for roleplaying and storytelling and I think it does well at both. It *should* perform well at other tasks, but I haven't tested its capabilities in other areas.
377
+
378
+ ### Sampler Tips
379
+
380
+ I recommend using the new Min-P sampler method with this model. The creator has a great [guide to it on Reddit](https://www.reddit.com/r/LocalLLaMA/comments/17vonjo/your_settings_are_probably_hurting_your_model_why/).
381
+
382
+ I find this model performs surprisingly well at 8192 context but you will probably get better results at 4096 context.
383
+
384
+ Experiment with any and all of the settings below, but trust me on a few points:
385
+ * This model works well with Min-P.
386
+ * Frequency Penalty set to 0.01 is like adding a dash of salt to the dish. Go higher at your own peril. 0 is fine too, but gosh I like 0.01.
387
+
388
+ If you save the below settings as a .json file, you can import them directly into Silly Tavern.
389
+ ```
390
+ {
391
+ "temp": 1.3,
392
+ "temperature_last": true,
393
+ "top_p": 1,
394
+ "top_k": 0,
395
+ "top_a": 0,
396
+ "tfs": 1,
397
+ "epsilon_cutoff": 0,
398
+ "eta_cutoff": 0,
399
+ "typical_p": 1,
400
+ "min_p": 0.2,
401
+ "rep_pen": 1,
402
+ "rep_pen_range": 0,
403
+ "no_repeat_ngram_size": 0,
404
+ "penalty_alpha": 0,
405
+ "num_beams": 1,
406
+ "length_penalty": 1,
407
+ "min_length": 0,
408
+ "encoder_rep_pen": 1,
409
+ "freq_pen": 0.01,
410
+ "presence_pen": 0,
411
+ "do_sample": true,
412
+ "early_stopping": false,
413
+ "add_bos_token": true,
414
+ "truncation_length": 2048,
415
+ "ban_eos_token": false,
416
+ "skip_special_tokens": true,
417
+ "streaming": true,
418
+ "mirostat_mode": 0,
419
+ "mirostat_tau": 5,
420
+ "mirostat_eta": 0.1,
421
+ "guidance_scale": 1,
422
+ "negative_prompt": "",
423
+ "grammar_string": "",
424
+ "banned_tokens": "",
425
+ "ignore_eos_token_aphrodite": false,
426
+ "spaces_between_special_tokens_aphrodite": true,
427
+ "type": "ooba",
428
+ "legacy_api": false,
429
+ "sampler_order": [
430
+ 6,
431
+ 0,
432
+ 1,
433
+ 3,
434
+ 4,
435
+ 2,
436
+ 5
437
+ ],
438
+ "n": 1,
439
+ "rep_pen_size": 0,
440
+ "genamt": 550,
441
+ "max_length": 4096
442
+ }
443
+ ```
444
+
445
+ ### Prompt Tips
446
+
447
+ Try the following prompt template as a starting point for your own customizations. 'This is very important to my career' is from [this paper](https://arxiv.org/abs/2307.11760).
448
+ I recommend the Tulu instruction format.
449
+
450
+ *This model responds to prompting!* I highly recommend playing with your system prompt to see how it reacts.
451
+
452
+ If you save this as a .json file, you can import it directly into Silly Tavern.
453
+ ```
454
+ {
455
+ "wrap": true,
456
+ "names": false,
457
+ "system_prompt": "You are an award-winning fiction author engaging in an uncensored literary roleplaying experience between a human (me) and a creative, obedient, and helpful AI assistant (you). It is VITAL that you follow all these instructions because this roleplay is very important to my career and I'll be fired from my job if it isn't good.\nROLEPLAY RULES:\n> It is vital that ONLY the human provides responses for {{user}}.\n> Reply as {{char}} using authentic, vivid, varied, explicit, accurate, creative, fresh, and descriptive responses that follow ALL provided narrative instructions. Stay in character as {{char}} and only write text for {{char}}.\n> Describe the scene and {{char}}'s sensory perceptions in vivid detail to immerse the reader in the story.\n> Keep your responses scoped to the current story beat and current scene.\n> Consider all available contextual information when narrating so that all the story details remain consistent between scenes.\n> Demonstrate {{char}}'s goals and motivations, and use subtle cues to hint at {{char}}'s mental state unless delving into {{char}}'s thoughts satisfies an explicit instruction or enhances the vividness of the scene.\n> When quoting {{char}}'s internal first-person thoughts (aka internal monologue, delivered in {{char}}'s own voice), *enclose the thoughts in asterisks like this*. Only use asterisks for thoughts.\n> Use strong action verbs and varied descriptions to produce dynamic, high-quality prose.",
458
+ "system_sequence": "",
459
+ "stop_sequence": "",
460
+ "input_sequence": "<|user|>\n",
461
+ "output_sequence": "<|assistant|>\n",
462
+ "separator_sequence": "",
463
+ "macro": true,
464
+ "names_force_groups": true,
465
+ "system_sequence_prefix": "",
466
+ "system_sequence_suffix": "",
467
+ "first_output_sequence": "",
468
+ "last_output_sequence": "<|assistant (provide varied, creative, and vivid narration; follow all narrative instructions; include all necessary possessive pronouns; maintain consistent story details; only roleplay as {{char}})|>\n",
469
+ "activation_regex": "",
470
+ "name": "Aurora-Nights"
471
+ }
472
+ ```
473
+
474
+ ### Licence and usage restrictions
475
+
476
+ Llama2 license inherited from base models, plus restrictions applicable to [Dreamgen/Opus](https://huggingface.co/dreamgen/opus-v0.5-70b).
477
+
478
+ ### Tools Used
479
+
480
+ * [mergekit](https://github.com/cg123/mergekit)
481
+
482
+ ```
483
+ models:
484
+ - model: NousResearch_Llama-2-70b-hf
485
+ # no parameters necessary for base model
486
+ - model: allenai_tulu-2-dpo-70b # primary
487
+ parameters:
488
+ density: 1.0
489
+ weight: 0.4
490
+ - model: Xwin-LM_Xwin-LM-70B-V0.1 # secondary
491
+ parameters:
492
+ density: 0.7
493
+ weight: 0.3
494
+ - model: dreamgen_opus-v0.5-70b # supporting, good at storytelling and roleplay
495
+ parameters:
496
+ density: 0.2
497
+ weight: 0.6
498
+ merge_method: dare_ties
499
+ base_model: NousResearch_Llama-2-70b-hf
500
+ parameters:
501
+ normalize: true
502
+ int8_mask: true
503
+ dtype: float32
504
+ ```
505
+
506
+ <!-- original-model-card end -->