TheBloke commited on
Commit
cd555da
1 Parent(s): a7cb522

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +490 -0
README.md ADDED
@@ -0,0 +1,490 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: Nanbeige/Nanbeige-16B-Base-32K
3
+ inference: false
4
+ language:
5
+ - en
6
+ - zh
7
+ library_name: transformers
8
+ license: apache-2.0
9
+ model_creator: Nanbeige LLM Lab
10
+ model_name: Nanbeige 16B Base 32K
11
+ model_type: nanbeige
12
+ pipeline_tag: text-generation
13
+ prompt_template: '{prompt}
14
+
15
+ '
16
+ quantized_by: TheBloke
17
+ tags:
18
+ - llm
19
+ - nanbeige
20
+ - custom_code
21
+ ---
22
+ <!-- markdownlint-disable MD041 -->
23
+
24
+ <!-- header start -->
25
+ <!-- 200823 -->
26
+ <div style="width: auto; margin-left: auto; margin-right: auto">
27
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
28
+ </div>
29
+ <div style="display: flex; justify-content: space-between; width: 100%;">
30
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
31
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
32
+ </div>
33
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
34
+ <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>
35
+ </div>
36
+ </div>
37
+ <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>
38
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
39
+ <!-- header end -->
40
+
41
+ # Nanbeige 16B Base 32K - GPTQ
42
+ - Model creator: [Nanbeige LLM Lab](https://huggingface.co/Nanbeige)
43
+ - Original model: [Nanbeige 16B Base 32K](https://huggingface.co/Nanbeige/Nanbeige-16B-Base-32K)
44
+
45
+ <!-- description start -->
46
+ # Description
47
+
48
+ This repo contains GPTQ model files for [Nanbeige LLM Lab's Nanbeige 16B Base 32K](https://huggingface.co/Nanbeige/Nanbeige-16B-Base-32K).
49
+
50
+ Multiple GPTQ parameter permutations are provided; see Provided Files below for details of the options provided, their parameters, and the software used to create them.
51
+
52
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
53
+
54
+ <!-- description end -->
55
+ <!-- repositories-available start -->
56
+ ## Repositories available
57
+
58
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ)
59
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GGUF)
60
+ * [Nanbeige LLM Lab's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Nanbeige/Nanbeige-16B-Base-32K)
61
+ <!-- repositories-available end -->
62
+
63
+ <!-- prompt-template start -->
64
+ ## Prompt template: None
65
+
66
+ ```
67
+ {prompt}
68
+
69
+ ```
70
+
71
+ <!-- prompt-template end -->
72
+
73
+
74
+
75
+ <!-- README_GPTQ.md-compatible clients start -->
76
+ ## Known compatible clients / servers
77
+
78
+ These GPTQ models are known to work in the following inference servers/webuis.
79
+
80
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
81
+ - [KoboldAI United](https://github.com/henk717/koboldai)
82
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
83
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
84
+
85
+ This may not be a complete list; if you know of others, please let me know!
86
+ <!-- README_GPTQ.md-compatible clients end -->
87
+
88
+ <!-- README_GPTQ.md-provided-files start -->
89
+ ## Provided files, and GPTQ parameters
90
+
91
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
92
+
93
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
94
+
95
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
96
+
97
+ <details>
98
+ <summary>Explanation of GPTQ parameters</summary>
99
+
100
+ - Bits: The bit size of the quantised model.
101
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
102
+ - Act Order: True or False. Also known as `desc_act`. True results in better quantisation accuracy. Some GPTQ clients have had issues with models that use Act Order plus Group Size, but this is generally resolved now.
103
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
104
+ - GPTQ dataset: The calibration dataset used during quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ calibration dataset is not the same as the dataset used to train the model - please refer to the original model repo for details of the training dataset(s).
105
+ - Sequence Length: The length of the dataset sequences used for quantisation. Ideally this is the same as the model sequence length. For some very long sequence models (16+K), a lower sequence length may have to be used. Note that a lower sequence length does not limit the sequence length of the quantised model. It only impacts the quantisation accuracy on longer inference sequences.
106
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
107
+
108
+ </details>
109
+
110
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
111
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
112
+ | [main](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.99 GB | No | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
113
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.98 GB | No | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
114
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.98 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
115
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.94 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
116
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.97 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
117
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-raw-v1) | 4096 | 4.99 GB | No | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
118
+
119
+ <!-- README_GPTQ.md-provided-files end -->
120
+
121
+ <!-- README_GPTQ.md-download-from-branches start -->
122
+ ## How to download, including from branches
123
+
124
+ ### In text-generation-webui
125
+
126
+ To download from the `main` branch, enter `TheBloke/Nanbeige-16B-Base-32K-GPTQ` in the "Download model" box.
127
+
128
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/Nanbeige-16B-Base-32K-GPTQ:gptq-4bit-32g-actorder_True`
129
+
130
+ ### From the command line
131
+
132
+ I recommend using the `huggingface-hub` Python library:
133
+
134
+ ```shell
135
+ pip3 install huggingface-hub
136
+ ```
137
+
138
+ To download the `main` branch to a folder called `Nanbeige-16B-Base-32K-GPTQ`:
139
+
140
+ ```shell
141
+ mkdir Nanbeige-16B-Base-32K-GPTQ
142
+ huggingface-cli download TheBloke/Nanbeige-16B-Base-32K-GPTQ --local-dir Nanbeige-16B-Base-32K-GPTQ --local-dir-use-symlinks False
143
+ ```
144
+
145
+ To download from a different branch, add the `--revision` parameter:
146
+
147
+ ```shell
148
+ mkdir Nanbeige-16B-Base-32K-GPTQ
149
+ huggingface-cli download TheBloke/Nanbeige-16B-Base-32K-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir Nanbeige-16B-Base-32K-GPTQ --local-dir-use-symlinks False
150
+ ```
151
+
152
+ <details>
153
+ <summary>More advanced huggingface-cli download usage</summary>
154
+
155
+ If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Hugging Face cache directory (default location on Linux is: `~/.cache/huggingface`), and symlinks will be added to the specified `--local-dir`, pointing to their real location in the cache. This allows for interrupted downloads to be resumed, and allows you to quickly clone the repo to multiple places on disk without triggering a download again. The downside, and the reason why I don't list that as the default option, is that the files are then hidden away in a cache folder and it's harder to know where your disk space is being used, and to clear it up if/when you want to remove a download model.
156
+
157
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
158
+
159
+ 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).
160
+
161
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
162
+
163
+ ```shell
164
+ pip3 install hf_transfer
165
+ ```
166
+
167
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
168
+
169
+ ```shell
170
+ mkdir Nanbeige-16B-Base-32K-GPTQ
171
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Nanbeige-16B-Base-32K-GPTQ --local-dir Nanbeige-16B-Base-32K-GPTQ --local-dir-use-symlinks False
172
+ ```
173
+
174
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
175
+ </details>
176
+
177
+ ### With `git` (**not** recommended)
178
+
179
+ To clone a specific branch with `git`, use a command like this:
180
+
181
+ ```shell
182
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Nanbeige-16B-Base-32K-GPTQ
183
+ ```
184
+
185
+ Note that using Git with HF repos is strongly discouraged. It will be much slower than using `huggingface-hub`, and will use twice as much disk space as it has to store the model files twice (it stores every byte both in the intended target folder, and again in the `.git` folder as a blob.)
186
+
187
+ <!-- README_GPTQ.md-download-from-branches end -->
188
+ <!-- README_GPTQ.md-text-generation-webui start -->
189
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
190
+
191
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
192
+
193
+ It is strongly recommended to use the text-generation-webui one-click-installers unless you're sure you know how to make a manual install.
194
+
195
+ 1. Click the **Model tab**.
196
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Nanbeige-16B-Base-32K-GPTQ`.
197
+
198
+ - To download from a specific branch, enter for example `TheBloke/Nanbeige-16B-Base-32K-GPTQ:gptq-4bit-32g-actorder_True`
199
+ - see Provided Files above for the list of branches for each option.
200
+
201
+ 3. Click **Download**.
202
+ 4. The model will start downloading. Once it's finished it will say "Done".
203
+ 5. In the top left, click the refresh icon next to **Model**.
204
+ 6. In the **Model** dropdown, choose the model you just downloaded: `Nanbeige-16B-Base-32K-GPTQ`
205
+ 7. The model will automatically load, and is now ready for use!
206
+ 8. If you want any custom settings, set them and then click **Save settings for this model** followed by **Reload the Model** in the top right.
207
+
208
+ - Note that you do not need to and should not set manual GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
209
+
210
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
211
+
212
+ <!-- README_GPTQ.md-text-generation-webui end -->
213
+
214
+ <!-- README_GPTQ.md-use-from-tgi start -->
215
+ ## Serving this model from Text Generation Inference (TGI)
216
+
217
+ It's recommended to use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
218
+
219
+ Example Docker parameters:
220
+
221
+ ```shell
222
+ --model-id TheBloke/Nanbeige-16B-Base-32K-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
223
+ ```
224
+
225
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
226
+
227
+ ```shell
228
+ pip3 install huggingface-hub
229
+ ```
230
+
231
+ ```python
232
+ from huggingface_hub import InferenceClient
233
+
234
+ endpoint_url = "https://your-endpoint-url-here"
235
+
236
+ prompt = "Tell me about AI"
237
+ prompt_template=f'''{prompt}
238
+ '''
239
+
240
+ client = InferenceClient(endpoint_url)
241
+ response = client.text_generation(prompt,
242
+ max_new_tokens=128,
243
+ do_sample=True,
244
+ temperature=0.7,
245
+ top_p=0.95,
246
+ top_k=40,
247
+ repetition_penalty=1.1)
248
+
249
+ print(f"Model output: {response}")
250
+ ```
251
+ <!-- README_GPTQ.md-use-from-tgi end -->
252
+ <!-- README_GPTQ.md-use-from-python start -->
253
+ ## Python code example: inference from this GPTQ model
254
+
255
+ ### Install the necessary packages
256
+
257
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
258
+
259
+ ```shell
260
+ pip3 install --upgrade transformers optimum
261
+ # If using PyTorch 2.1 + CUDA 12.x:
262
+ pip3 install --upgrade auto-gptq
263
+ # or, if using PyTorch 2.1 + CUDA 11.x:
264
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
265
+ ```
266
+
267
+ If you are using PyTorch 2.0, you will need to install AutoGPTQ from source. Likewise if you have problems with the pre-built wheels, you should try building from source:
268
+
269
+ ```shell
270
+ pip3 uninstall -y auto-gptq
271
+ git clone https://github.com/PanQiWei/AutoGPTQ
272
+ cd AutoGPTQ
273
+ git checkout v0.5.1
274
+ pip3 install .
275
+ ```
276
+
277
+ ### Example Python code
278
+
279
+ ```python
280
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
281
+
282
+ model_name_or_path = "TheBloke/Nanbeige-16B-Base-32K-GPTQ"
283
+ # To use a different branch, change revision
284
+ # For example: revision="gptq-4bit-32g-actorder_True"
285
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
286
+ device_map="auto",
287
+ trust_remote_code=True,
288
+ revision="main")
289
+
290
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
291
+
292
+ prompt = "Tell me about AI"
293
+ prompt_template=f'''{prompt}
294
+ '''
295
+
296
+ print("\n\n*** Generate:")
297
+
298
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
299
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
300
+ print(tokenizer.decode(output[0]))
301
+
302
+ # Inference can also be done using transformers' pipeline
303
+
304
+ print("*** Pipeline:")
305
+ pipe = pipeline(
306
+ "text-generation",
307
+ model=model,
308
+ tokenizer=tokenizer,
309
+ max_new_tokens=512,
310
+ do_sample=True,
311
+ temperature=0.7,
312
+ top_p=0.95,
313
+ top_k=40,
314
+ repetition_penalty=1.1
315
+ )
316
+
317
+ print(pipe(prompt_template)[0]['generated_text'])
318
+ ```
319
+ <!-- README_GPTQ.md-use-from-python end -->
320
+
321
+ <!-- README_GPTQ.md-compatibility start -->
322
+ ## Compatibility
323
+
324
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
325
+
326
+ [ExLlama](https://github.com/turboderp/exllama) is compatible with Llama and Mistral models in 4-bit. Please see the Provided Files table above for per-file compatibility.
327
+
328
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
329
+ <!-- README_GPTQ.md-compatibility end -->
330
+
331
+ <!-- footer start -->
332
+ <!-- 200823 -->
333
+ ## Discord
334
+
335
+ For further support, and discussions on these models and AI in general, join us at:
336
+
337
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
338
+
339
+ ## Thanks, and how to contribute
340
+
341
+ Thanks to the [chirper.ai](https://chirper.ai) team!
342
+
343
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
344
+
345
+ 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.
346
+
347
+ 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.
348
+
349
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
350
+
351
+ * Patreon: https://patreon.com/TheBlokeAI
352
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
353
+
354
+ **Special thanks to**: Aemon Algiz.
355
+
356
+ **Patreon special mentions**: Brandon Frisco, LangChain4j, Spiking Neurons AB, transmissions 11, Joseph William Delisle, Nitin Borwankar, Willem Michiel, Michael Dempsey, vamX, Jeffrey Morgan, zynix, jjj, Omer Bin Jawed, Sean Connelly, jinyuan sun, Jeromy Smith, Shadi, Pawan Osman, Chadd, Elijah Stavena, Illia Dulskyi, Sebastain Graf, Stephen Murray, terasurfer, Edmond Seymore, Celu Ramasamy, Mandus, Alex, biorpg, Ajan Kanaga, Clay Pascal, Raven Klaugh, 阿明, K, ya boyyy, usrbinkat, Alicia Loh, John Villwock, ReadyPlayerEmma, Chris Smitley, Cap'n Zoog, fincy, GodLy, S_X, sidney chen, Cory Kujawski, OG, Mano Prime, AzureBlack, Pieter, Kalila, Spencer Kim, Tom X Nguyen, Stanislav Ovsiannikov, Michael Levine, Andrey, Trailburnt, Vadim, Enrico Ros, Talal Aujan, Brandon Phillips, Jack West, Eugene Pentland, Michael Davis, Will Dee, webtim, Jonathan Leane, Alps Aficionado, Rooh Singh, Tiffany J. Kim, theTransient, Luke @flexchar, Elle, Caitlyn Gatomon, Ari Malik, subjectnull, Johann-Peter Hartmann, Trenton Dambrowitz, Imad Khwaja, Asp the Wyvern, Emad Mostaque, Rainer Wilmers, Alexandros Triantafyllidis, Nicholas, Pedro Madruga, SuperWojo, Harry Royden McLaughlin, James Bentley, Olakabola, David Ziegler, Ai Maven, Jeff Scroggin, Nikolai Manek, Deo Leter, Matthew Berman, Fen Risland, Ken Nordquist, Manuel Alberto Morcote, Luke Pendergrass, TL, Fred von Graf, Randy H, Dan Guido, NimbleBox.ai, Vitor Caleffi, Gabriel Tamborski, knownsqashed, Lone Striker, Erik Bjäreholt, John Detwiler, Leonard Tan, Iucharbius
357
+
358
+
359
+ Thank you to all my generous patrons and donaters!
360
+
361
+ And thank you again to a16z for their generous grant.
362
+
363
+ <!-- footer end -->
364
+
365
+ # Original model card: Nanbeige LLM Lab's Nanbeige 16B Base 32K
366
+
367
+
368
+ <!-- markdownlint-disable first-line-h1 -->
369
+
370
+ <!-- markdownlint-disable html -->
371
+
372
+ <div align="center">
373
+ <h1>
374
+ Nanbeige-16B-Base-32k
375
+ </h1>
376
+ </div>
377
+
378
+ <p align="center">
379
+ <a href="https://github.com/Nanbeige/Nanbeige" target="_blank">💻Github</a>
380
+ </p>
381
+
382
+
383
+ # <span id="Introduction">模型介绍(Introduction)</span>
384
+
385
+ Nanbeige-16B(南北阁-16B)是南北阁大模型实验室研发的160亿参数规模的大语言模型,采用了2.5T Tokens进行预训练,数据包含大量互联网高质量语料、各类书籍、代码等领域脱敏文本,在各个权威测评数据集上都取得了不错的效果。本次发布包含有 Base、Chat 以及扩展上下文长度的 Base-32k、Chat-32k 版本。
386
+
387
+ Base-32k 版本基于Nanbeige-16B-Base模型,采用YaRN插值方法对位置编码进行修改,并以32k为最大长度进行了20B Tokens的中文、英文、代码语料的全参数增量预训练。
388
+
389
+ Chat 版本和 Chat-32k 版本分别基于Nanbeige-16B-Base模型和Nanbeige-16B-Base-32k模型,经过了大量人类对齐训练,能够更好、更安全地回复用户的问题。
390
+
391
+ 如果您需要处理更长的上下文,我们推荐您使用Nanbeige-16B-Base-32k和Nanbeige-16B-Chat-32k。
392
+
393
+ 本仓库为 Nanbeige-16B-Base-32k 的模型仓库。
394
+
395
+ Nanbeige-16B is a 16 billion parameter language model developed by Nanbeige LLM Lab. It uses 2.5T Tokens for pre-training. The training data includes a large amount of high-quality internet corpus, various books, code, etc. It has achieved good results on various authoritative evaluation data sets. This release includes the Base, Chat, Base-32k and Chat-32k.
396
+
397
+ The Base-32k version is based on the Nanbeige-16B-Base model, which uses YaRN interpolation method to modify the position encoding, and performs full parameter incremental pre-training with 20 billion tokens of Chinese, English, and code corpora, under 32k max length.
398
+
399
+ The Chat version and Chat-32k version are based on the Nanbeige-16B-Base model and Nanbeige-16B-Base-32k model respectively. They have undergone extensive human-aligned training.
400
+
401
+ If you need to deal with longer contexts, we recommend using Nanbeige-16B-Base-32k and Nanbeige-16B-Chat-32k.
402
+
403
+ This repository is the one for Nanbeige-16B-Base-32k model.
404
+
405
+ ##
406
+ | | Base Model | Base-32k Model | Chat Model | Chat-32k Model |
407
+ |:-------:|:-------:|:-------:|:---------:|:--------:|
408
+ | 16B | 🤗 [Nanbeige-16B-Base](https://huggingface.co/Nanbeige/Nanbeige-16B-Base) | 🤗 [Nanbeige-16B-Base-32k](https://huggingface.co/Nanbeige/Nanbeige-16B-Base-32k) | 🤗 [Nanbeige-16B-Chat](https://huggingface.co/Nanbeige/Nanbeige-16B-Chat) |🤗 [Nanbeige-16B-Chat-32k](https://huggingface.co/Nanbeige/Nanbeige-16B-Chat-32k) |
409
+
410
+
411
+ ##
412
+ # <span id="Inference">模型推理 (Inference)</span>
413
+
414
+ ## 相关依赖
415
+
416
+ - python 3.8及以上版本
417
+
418
+ - transformers 4.33.3
419
+
420
+ - pytorch 2.0及以上版本
421
+
422
+ - python 3.8 and above
423
+
424
+ - transformers 4.33.3
425
+
426
+ - pytorch 2.0及以上版本
427
+
428
+ - deepspeed 0.11.1及以上版本
429
+
430
+ 可以通过以下pip命令安装相关依赖库
431
+
432
+ You can install the dependent libraries with the following pip command
433
+
434
+ ```
435
+ pip install transformers==4.33.3 transformers_stream_generator deepspeed einops==0.3.2 datasets==2.10.0 deepspeed==0.11.1
436
+ ```
437
+
438
+ ## 推理代码
439
+
440
+ 通过以下代码可以调用模型进行续写生成:
441
+
442
+ The following code can be used to invoke the model for text generation:
443
+
444
+ ```python
445
+ import torch
446
+ from transformers import AutoModelForCausalLM, AutoTokenizer
447
+ from transformers.generation.utils import GenerationConfig
448
+ import deepspeed
449
+ import os
450
+
451
+ tokenizer = AutoTokenizer.from_pretrained("Nanbeige/Nanbeige-16B-Base-32k", use_fast=False, trust_remote_code=True)
452
+ model = AutoModelForCausalLM.from_pretrained("Nanbeige/Nanbeige-16B-Base-32k", device_map="auto", torch_dtype=torch.bfloat16, trust_remote_code=True)
453
+ world_size = int(os.getenv('WORLD_SIZE', '1'))
454
+ model = deepspeed.init_inference(model.eval(),
455
+ dtype="bfloat16",
456
+ replace_with_kernel_inject=False,
457
+ mp_size=world_size)
458
+ inputs = tokenizer('中国的首都是北京\n德国的首都是柏林\n孟加拉的首都是', return_tensors='pt')
459
+ inputs = inputs.to(model.device)
460
+ pred = model.generate(**inputs, max_new_tokens=32000)
461
+ print(tokenizer.decode(pred.cpu()[0], skip_special_tokens=True))
462
+ ```
463
+
464
+ ##
465
+ # <span id="Evaluation">性能测评(Performance Evaluation)</span>
466
+
467
+ ### 长文本理解
468
+ 我们使用LongBench的LSHT、LCC、Multifiled_QA_ZH数据集,对 Nanbeige-16B-Base-32k 模型进行了测评,相较具有长文本理解能力的同参数规模Base模型取得了不错的结果。
469
+
470
+ We evaluated the Nanbeige-16B-Base-32k model using LSHT, LCC, and Multifiled_QA_ZH from LongBench datasets. Compared to the Base model of the same parameter size with long-context comprehension capabilities, it achieved impressive results.
471
+
472
+ | | LSHT (分类) | LCC (代码) | Multifiled_QA_ZH (问答) |
473
+ |----------------------------|--------|-------|------------------|
474
+ | Chinese-Llama2-13B-16k | 31.0 | 9.6 | 36.4 |
475
+ | Qwen-14B-Dynamnic_ntk-Logn | 16.0 | 66.7 | 30.0 |
476
+ | Nanbeige-16B-Base-32k | 40.3 | 70.7 | 47.2 |
477
+
478
+
479
+ ##
480
+ # <span id="Limitations">局限性(Limitations)</span>
481
+
482
+ 虽然我们在训练过程中非常注重模型的安全性,力求确保其输出符合伦理和法律要求的文本,但由于模型大小和概率生成范式的限制,无法完全避免产生各种不符合预期的输出情况。这些输出可能包含偏见、歧视等有害内容,请勿传播这些内容。我们不承担因传播不良信息而导致的任何后果。
483
+
484
+ While we place great emphasis on the safety of the model during the training process, striving to ensure that its outputs align with ethical and legal requirements, it may not completely avoid generating unexpected outputs due to the model's size and probabilistic nature. These outputs may include harmful content such as bias or discrimination. Please don't propagate such content. We do not assume any responsibility for the consequences resulting from the dissemination of inappropriate information.
485
+
486
+ # <span id="License">协议(License)</span>
487
+
488
+ 使用 Nanbeige 模型时,您必须遵守 Apache 2.0 许可证和[《南北阁大语言模型许可协议》](https://huggingface.co/Nanbeige/Nanbeige-16B-Base-32k/resolve/main/南北阁大语言模型许可协议.pdf)。如果您打算将 Nanbeige 模型或其衍生产品用于商业目的,请通过以下联系邮箱 [email protected] 提交申请材料,以满足《南北阁大语言模型许可协议》的要求。经过审核后,我们将授予您非排他性、全球范围内、不可转让、不可再许可、可撤销的商业版权许可。
489
+
490
+ When using the Nanbeige models, you must comply with the Apache 2.0 License and the [License Agreement for Large Language Models Nanbeige](https://huggingface.co/Nanbeige/Nanbeige-16B-Base-32k/resolve/main/License_Agreement_for_Large_Language_Models_Nanbeige.pdf). If you intend to use the Nanbeige Models or its derivatives for commercial purposes, please submit application materials to meet the requirements of the Nanbeige Models Community License Agreement by contacting [email protected]. After review, We will grant you a non-exclusive, worldwide, non-transferable, non-sublicensable and revocable commercial copyright license.