Text Generation
Transformers
Safetensors
English
llama
finance
text-generation-inference
4-bit precision
TheBloke commited on
Commit
1f5b732
1 Parent(s): e3e0b59

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +461 -0
README.md ADDED
@@ -0,0 +1,461 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: AdaptLLM/finance-LLM-13B
3
+ datasets:
4
+ - Open-Orca/OpenOrca
5
+ - GAIR/lima
6
+ - WizardLM/WizardLM_evol_instruct_V2_196k
7
+ inference: false
8
+ language:
9
+ - en
10
+ license: other
11
+ metrics:
12
+ - accuracy
13
+ model_creator: AdaptLLM
14
+ model_name: Finance LLM 13B
15
+ model_type: llama
16
+ pipeline_tag: text-generation
17
+ prompt_template: '### User Input:
18
+
19
+ {prompt}
20
+
21
+
22
+ ### Assistant Output:
23
+
24
+ '
25
+ quantized_by: TheBloke
26
+ tags:
27
+ - finance
28
+ ---
29
+ <!-- markdownlint-disable MD041 -->
30
+
31
+ <!-- header start -->
32
+ <!-- 200823 -->
33
+ <div style="width: auto; margin-left: auto; margin-right: auto">
34
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
35
+ </div>
36
+ <div style="display: flex; justify-content: space-between; width: 100%;">
37
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
38
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
39
+ </div>
40
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
41
+ <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>
42
+ </div>
43
+ </div>
44
+ <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>
45
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
46
+ <!-- header end -->
47
+
48
+ # Finance LLM 13B - GPTQ
49
+ - Model creator: [AdaptLLM](https://huggingface.co/AdaptLLM)
50
+ - Original model: [Finance LLM 13B](https://huggingface.co/AdaptLLM/finance-LLM-13B)
51
+
52
+ <!-- description start -->
53
+ # Description
54
+
55
+ This repo contains GPTQ model files for [AdaptLLM's Finance LLM 13B](https://huggingface.co/AdaptLLM/finance-LLM-13B).
56
+
57
+ 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.
58
+
59
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
60
+
61
+ <!-- description end -->
62
+ <!-- repositories-available start -->
63
+ ## Repositories available
64
+
65
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/finance-LLM-13B-AWQ)
66
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ)
67
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/finance-LLM-13B-GGUF)
68
+ * [AdaptLLM's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/AdaptLLM/finance-LLM-13B)
69
+ <!-- repositories-available end -->
70
+
71
+ <!-- prompt-template start -->
72
+ ## Prompt template: AdaptLLM
73
+
74
+ ```
75
+ ### User Input:
76
+ {prompt}
77
+
78
+ ### Assistant Output:
79
+
80
+ ```
81
+
82
+ <!-- prompt-template end -->
83
+
84
+
85
+
86
+ <!-- README_GPTQ.md-compatible clients start -->
87
+ ## Known compatible clients / servers
88
+
89
+ GPTQ models are currently supported on Linux (NVidia/AMD) and Windows (NVidia only). macOS users: please use GGUF models.
90
+
91
+ These GPTQ models are known to work in the following inference servers/webuis.
92
+
93
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
94
+ - [KoboldAI United](https://github.com/henk717/koboldai)
95
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
96
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
97
+
98
+ This may not be a complete list; if you know of others, please let me know!
99
+ <!-- README_GPTQ.md-compatible clients end -->
100
+
101
+ <!-- README_GPTQ.md-provided-files start -->
102
+ ## Provided files, and GPTQ parameters
103
+
104
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
105
+
106
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
107
+
108
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
109
+
110
+ <details>
111
+ <summary>Explanation of GPTQ parameters</summary>
112
+
113
+ - Bits: The bit size of the quantised model.
114
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
115
+ - 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.
116
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
117
+ - 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).
118
+ - 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.
119
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
120
+
121
+ </details>
122
+
123
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
124
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
125
+ | [main](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 2048 | 7.26 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
126
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 2048 | 8.00 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
127
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 2048 | 13.36 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
128
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 2048 | 13.65 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
129
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 2048 | 14.55 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
130
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [VMware Open Instruct](https://huggingface.co/datasets/VMware/open-instruct/viewer/) | 2048 | 7.51 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
131
+
132
+ <!-- README_GPTQ.md-provided-files end -->
133
+
134
+ <!-- README_GPTQ.md-download-from-branches start -->
135
+ ## How to download, including from branches
136
+
137
+ ### In text-generation-webui
138
+
139
+ To download from the `main` branch, enter `TheBloke/finance-LLM-13B-GPTQ` in the "Download model" box.
140
+
141
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/finance-LLM-13B-GPTQ:gptq-4bit-32g-actorder_True`
142
+
143
+ ### From the command line
144
+
145
+ I recommend using the `huggingface-hub` Python library:
146
+
147
+ ```shell
148
+ pip3 install huggingface-hub
149
+ ```
150
+
151
+ To download the `main` branch to a folder called `finance-LLM-13B-GPTQ`:
152
+
153
+ ```shell
154
+ mkdir finance-LLM-13B-GPTQ
155
+ huggingface-cli download TheBloke/finance-LLM-13B-GPTQ --local-dir finance-LLM-13B-GPTQ --local-dir-use-symlinks False
156
+ ```
157
+
158
+ To download from a different branch, add the `--revision` parameter:
159
+
160
+ ```shell
161
+ mkdir finance-LLM-13B-GPTQ
162
+ huggingface-cli download TheBloke/finance-LLM-13B-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir finance-LLM-13B-GPTQ --local-dir-use-symlinks False
163
+ ```
164
+
165
+ <details>
166
+ <summary>More advanced huggingface-cli download usage</summary>
167
+
168
+ 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.
169
+
170
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
171
+
172
+ 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).
173
+
174
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
175
+
176
+ ```shell
177
+ pip3 install hf_transfer
178
+ ```
179
+
180
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
181
+
182
+ ```shell
183
+ mkdir finance-LLM-13B-GPTQ
184
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/finance-LLM-13B-GPTQ --local-dir finance-LLM-13B-GPTQ --local-dir-use-symlinks False
185
+ ```
186
+
187
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
188
+ </details>
189
+
190
+ ### With `git` (**not** recommended)
191
+
192
+ To clone a specific branch with `git`, use a command like this:
193
+
194
+ ```shell
195
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/finance-LLM-13B-GPTQ
196
+ ```
197
+
198
+ 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.)
199
+
200
+ <!-- README_GPTQ.md-download-from-branches end -->
201
+ <!-- README_GPTQ.md-text-generation-webui start -->
202
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
203
+
204
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
205
+
206
+ 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.
207
+
208
+ 1. Click the **Model tab**.
209
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/finance-LLM-13B-GPTQ`.
210
+
211
+ - To download from a specific branch, enter for example `TheBloke/finance-LLM-13B-GPTQ:gptq-4bit-32g-actorder_True`
212
+ - see Provided Files above for the list of branches for each option.
213
+
214
+ 3. Click **Download**.
215
+ 4. The model will start downloading. Once it's finished it will say "Done".
216
+ 5. In the top left, click the refresh icon next to **Model**.
217
+ 6. In the **Model** dropdown, choose the model you just downloaded: `finance-LLM-13B-GPTQ`
218
+ 7. The model will automatically load, and is now ready for use!
219
+ 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.
220
+
221
+ - 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`.
222
+
223
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
224
+
225
+ <!-- README_GPTQ.md-text-generation-webui end -->
226
+
227
+ <!-- README_GPTQ.md-use-from-tgi start -->
228
+ ## Serving this model from Text Generation Inference (TGI)
229
+
230
+ 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`
231
+
232
+ Example Docker parameters:
233
+
234
+ ```shell
235
+ --model-id TheBloke/finance-LLM-13B-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
236
+ ```
237
+
238
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
239
+
240
+ ```shell
241
+ pip3 install huggingface-hub
242
+ ```
243
+
244
+ ```python
245
+ from huggingface_hub import InferenceClient
246
+
247
+ endpoint_url = "https://your-endpoint-url-here"
248
+
249
+ prompt = "Tell me about AI"
250
+ prompt_template=f'''### User Input:
251
+ {prompt}
252
+
253
+ ### Assistant Output:
254
+ '''
255
+
256
+ client = InferenceClient(endpoint_url)
257
+ response = client.text_generation(
258
+ prompt_template,
259
+ max_new_tokens=128,
260
+ do_sample=True,
261
+ temperature=0.7,
262
+ top_p=0.95,
263
+ top_k=40,
264
+ repetition_penalty=1.1
265
+ )
266
+
267
+ print(f"Model output: {response}")
268
+ ```
269
+ <!-- README_GPTQ.md-use-from-tgi end -->
270
+ <!-- README_GPTQ.md-use-from-python start -->
271
+ ## Python code example: inference from this GPTQ model
272
+
273
+ ### Install the necessary packages
274
+
275
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
276
+
277
+ ```shell
278
+ pip3 install --upgrade transformers optimum
279
+ # If using PyTorch 2.1 + CUDA 12.x:
280
+ pip3 install --upgrade auto-gptq
281
+ # or, if using PyTorch 2.1 + CUDA 11.x:
282
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
283
+ ```
284
+
285
+ 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:
286
+
287
+ ```shell
288
+ pip3 uninstall -y auto-gptq
289
+ git clone https://github.com/PanQiWei/AutoGPTQ
290
+ cd AutoGPTQ
291
+ git checkout v0.5.1
292
+ pip3 install .
293
+ ```
294
+
295
+ ### Example Python code
296
+
297
+ ```python
298
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
299
+
300
+ model_name_or_path = "TheBloke/finance-LLM-13B-GPTQ"
301
+ # To use a different branch, change revision
302
+ # For example: revision="gptq-4bit-32g-actorder_True"
303
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
304
+ device_map="auto",
305
+ trust_remote_code=False,
306
+ revision="main")
307
+
308
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
309
+
310
+ prompt = "Write a story about llamas"
311
+ system_message = "You are a story writing assistant"
312
+ prompt_template=f'''### User Input:
313
+ {prompt}
314
+
315
+ ### Assistant Output:
316
+ '''
317
+
318
+ print("\n\n*** Generate:")
319
+
320
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
321
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
322
+ print(tokenizer.decode(output[0]))
323
+
324
+ # Inference can also be done using transformers' pipeline
325
+
326
+ print("*** Pipeline:")
327
+ pipe = pipeline(
328
+ "text-generation",
329
+ model=model,
330
+ tokenizer=tokenizer,
331
+ max_new_tokens=512,
332
+ do_sample=True,
333
+ temperature=0.7,
334
+ top_p=0.95,
335
+ top_k=40,
336
+ repetition_penalty=1.1
337
+ )
338
+
339
+ print(pipe(prompt_template)[0]['generated_text'])
340
+ ```
341
+ <!-- README_GPTQ.md-use-from-python end -->
342
+
343
+ <!-- README_GPTQ.md-compatibility start -->
344
+ ## Compatibility
345
+
346
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
347
+
348
+ [ExLlama](https://github.com/turboderp/exllama) is compatible with Llama architecture models (including Mistral, Yi, DeepSeek, SOLAR, etc) in 4-bit. Please see the Provided Files table above for per-file compatibility.
349
+
350
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
351
+ <!-- README_GPTQ.md-compatibility end -->
352
+
353
+ <!-- footer start -->
354
+ <!-- 200823 -->
355
+ ## Discord
356
+
357
+ For further support, and discussions on these models and AI in general, join us at:
358
+
359
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
360
+
361
+ ## Thanks, and how to contribute
362
+
363
+ Thanks to the [chirper.ai](https://chirper.ai) team!
364
+
365
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
366
+
367
+ 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.
368
+
369
+ 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.
370
+
371
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
372
+
373
+ * Patreon: https://patreon.com/TheBlokeAI
374
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
375
+
376
+ **Special thanks to**: Aemon Algiz.
377
+
378
+ **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
379
+
380
+
381
+ Thank you to all my generous patrons and donaters!
382
+
383
+ And thank you again to a16z for their generous grant.
384
+
385
+ <!-- footer end -->
386
+
387
+ # Original model card: AdaptLLM's Finance LLM 13B
388
+
389
+
390
+ # Adapt (Large) Language Models to Domains
391
+ This repo contains the domain-specific base model developed from **LLaMA-1-13B**, using the method in our paper [Adapting Large Language Models via Reading Comprehension](https://huggingface.co/papers/2309.09530).
392
+
393
+ We explore **continued pre-training on domain-specific corpora** for large language models. While this approach enriches LLMs with domain knowledge, it significantly hurts their prompting ability for question answering. Inspired by human learning via reading comprehension, we propose a simple method to **transform large-scale pre-training corpora into reading comprehension texts**, consistently improving prompting performance across tasks in biomedicine, finance, and law domains. **Our 7B model competes with much larger domain-specific models like BloombergGPT-50B**.
394
+
395
+ ### 🤗 We are currently working hard on developing models across different domains, scales and architectures! Please stay tuned! ��
396
+
397
+ **************************** **Updates** ****************************
398
+ * 12/19: Released our [13B base models](https://huggingface.co/AdaptLLM/finance-LLM-13B) developed from LLaMA-1-13B.
399
+ * 12/8: Released our [chat models](https://huggingface.co/AdaptLLM/finance-chat) developed from LLaMA-2-Chat-7B.
400
+ * 9/18: Released our [paper](https://huggingface.co/papers/2309.09530), [code](https://github.com/microsoft/LMOps), [data](https://huggingface.co/datasets/AdaptLLM/finance-tasks), and [base models](https://huggingface.co/AdaptLLM/finance-LLM) developed from LLaMA-1-7B.
401
+
402
+
403
+ ## Domain-Specific LLaMA-1
404
+ ### LLaMA-1-7B
405
+ In our paper, we develop three domain-specific models from LLaMA-1-7B, which are also available in Huggingface: [Biomedicine-LLM](https://huggingface.co/AdaptLLM/medicine-LLM), [Finance-LLM](https://huggingface.co/AdaptLLM/finance-LLM) and [Law-LLM](https://huggingface.co/AdaptLLM/law-LLM), the performances of our AdaptLLM compared to other domain-specific LLMs are:
406
+
407
+ <p align='center'>
408
+ <img src="https://cdn-uploads.huggingface.co/production/uploads/650801ced5578ef7e20b33d4/6efPwitFgy-pLTzvccdcP.png" width="700">
409
+ </p>
410
+
411
+ ### LLaMA-1-13B
412
+ Moreover, we scale up our base model to LLaMA-1-13B to see if **our method is similarly effective for larger-scale models**, and the results are consistently positive too: [Biomedicine-LLM-13B](https://huggingface.co/AdaptLLM/medicine-LLM-13B), [Finance-LLM-13B](https://huggingface.co/AdaptLLM/finance-LLM-13B) and [Law-LLM-13B](https://huggingface.co/AdaptLLM/law-LLM-13B).
413
+
414
+ ## Domain-Specific LLaMA-2-Chat
415
+ Our method is also effective for aligned models! LLaMA-2-Chat requires a [specific data format](https://huggingface.co/blog/llama2#how-to-prompt-llama-2), and our **reading comprehension can perfectly fit the data format** by transforming the reading comprehension into a multi-turn conversation. We have also open-sourced chat models in different domains: [Biomedicine-Chat](https://huggingface.co/AdaptLLM/medicine-chat), [Finance-Chat](https://huggingface.co/AdaptLLM/finance-chat) and [Law-Chat](https://huggingface.co/AdaptLLM/law-chat)
416
+
417
+ For example, to chat with the finance model:
418
+ ```python
419
+ from transformers import AutoModelForCausalLM, AutoTokenizer
420
+
421
+ model = AutoModelForCausalLM.from_pretrained("AdaptLLM/finance-LLM-13B")
422
+ tokenizer = AutoTokenizer.from_pretrained("AdaptLLM/finance-LLM-13B", use_fast=False)
423
+
424
+ # Put your input here:
425
+ user_input = '''Use this fact to answer the question: Title of each class Trading Symbol(s) Name of each exchange on which registered
426
+ Common Stock, Par Value $.01 Per Share MMM New York Stock Exchange
427
+ MMM Chicago Stock Exchange, Inc.
428
+ 1.500% Notes due 2026 MMM26 New York Stock Exchange
429
+ 1.750% Notes due 2030 MMM30 New York Stock Exchange
430
+ 1.500% Notes due 2031 MMM31 New York Stock Exchange
431
+
432
+ Which debt securities are registered to trade on a national securities exchange under 3M's name as of Q2 of 2023?'''
433
+
434
+ # Simply use your input as the prompt for base models
435
+ prompt = user_input
436
+
437
+ inputs = tokenizer(prompt, return_tensors="pt", add_special_tokens=False).input_ids.to(model.device)
438
+ outputs = model.generate(input_ids=inputs, max_length=2048)[0]
439
+
440
+ answer_start = int(inputs.shape[-1])
441
+ pred = tokenizer.decode(outputs[answer_start:], skip_special_tokens=True)
442
+
443
+ print(f'### User Input:\n{user_input}\n\n### Assistant Output:\n{pred}')
444
+ ```
445
+
446
+ ## Domain-Specific Tasks
447
+ To easily reproduce our results, we have uploaded the filled-in zero/few-shot input instructions and output completions of each domain-specific task: [biomedicine-tasks](https://huggingface.co/datasets/AdaptLLM/medicine-tasks), [finance-tasks](https://huggingface.co/datasets/AdaptLLM/finance-tasks), and [law-tasks](https://huggingface.co/datasets/AdaptLLM/law-tasks).
448
+
449
+ **Note:** those filled-in instructions are specifically tailored for models before alignment and do NOT fit for the specific data format required for chat models.
450
+
451
+ ## Citation
452
+ If you find our work helpful, please cite us:
453
+ ```bibtex
454
+ @article{adaptllm,
455
+ title = {Adapting Large Language Models via Reading Comprehension},
456
+ author = {Daixuan Cheng and Shaohan Huang and Furu Wei},
457
+ journal = {CoRR},
458
+ volume = {abs/2309.09530},
459
+ year = {2023}
460
+ }
461
+ ```