TheBloke commited on
Commit
fc22494
1 Parent(s): f24c243

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +512 -0
README.md ADDED
@@ -0,0 +1,512 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: gorilla-llm/gorilla-openfunctions-v1
3
+ inference: false
4
+ license: apache-2.0
5
+ model_creator: Gorilla LLM (UC Berkeley
6
+ model_name: Gorilla OpenFunctions V1
7
+ model_type: llama
8
+ prompt_template: 'USER: <<question>> {prompt} <<function>> {{function_string}}
9
+
10
+ ASSISTANT:
11
+
12
+ '
13
+ quantized_by: TheBloke
14
+ ---
15
+ <!-- markdownlint-disable MD041 -->
16
+
17
+ <!-- header start -->
18
+ <!-- 200823 -->
19
+ <div style="width: auto; margin-left: auto; margin-right: auto">
20
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
21
+ </div>
22
+ <div style="display: flex; justify-content: space-between; width: 100%;">
23
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
24
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
25
+ </div>
26
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
27
+ <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>
28
+ </div>
29
+ </div>
30
+ <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>
31
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
32
+ <!-- header end -->
33
+
34
+ # Gorilla OpenFunctions V1 - GPTQ
35
+ - Model creator: [Gorilla LLM (UC Berkeley](https://huggingface.co/gorilla-llm)
36
+ - Original model: [Gorilla OpenFunctions V1](https://huggingface.co/gorilla-llm/gorilla-openfunctions-v1)
37
+
38
+ <!-- description start -->
39
+ # Description
40
+
41
+ This repo contains GPTQ model files for [Gorilla LLM (UC Berkeley's Gorilla OpenFunctions V1](https://huggingface.co/gorilla-llm/gorilla-openfunctions-v1).
42
+
43
+ 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.
44
+
45
+ These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
46
+
47
+ <!-- description end -->
48
+ <!-- repositories-available start -->
49
+ ## Repositories available
50
+
51
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-AWQ)
52
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ)
53
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GGUF)
54
+ * [Gorilla LLM (UC Berkeley's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/gorilla-llm/gorilla-openfunctions-v1)
55
+ <!-- repositories-available end -->
56
+
57
+ <!-- prompt-template start -->
58
+ ## Prompt template: Gorilla-OpenFunctions
59
+
60
+ ```
61
+ USER: <<question>> {prompt} <<function>> {{function_string}}
62
+ ASSISTANT:
63
+
64
+ ```
65
+
66
+ <!-- prompt-template end -->
67
+ <!-- licensing start -->
68
+ ## Licensing
69
+
70
+ The creator of the source model has listed its license as `apache-2.0`, and this quantization has therefore used that same license.
71
+
72
+ 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.
73
+
74
+ In the meantime, any questions regarding licensing, and in particular how these two licenses might interact, should be directed to the original model repository: [Gorilla LLM (UC Berkeley's Gorilla OpenFunctions V1](https://huggingface.co/gorilla-llm/gorilla-openfunctions-v1).
75
+ <!-- licensing end -->
76
+
77
+ <!-- README_GPTQ.md-compatible clients start -->
78
+ ## Known compatible clients / servers
79
+
80
+ These GPTQ models are known to work in the following inference servers/webuis.
81
+
82
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
83
+ - [KoboldAI United](https://github.com/henk717/koboldai)
84
+ - [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui)
85
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
86
+
87
+ This may not be a complete list; if you know of others, please let me know!
88
+ <!-- README_GPTQ.md-compatible clients end -->
89
+
90
+ <!-- README_GPTQ.md-provided-files start -->
91
+ ## Provided files, and GPTQ parameters
92
+
93
+ Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
94
+
95
+ Each separate quant is in a different branch. See below for instructions on fetching from different branches.
96
+
97
+ Most GPTQ files are made with AutoGPTQ. Mistral models are currently made with Transformers.
98
+
99
+ <details>
100
+ <summary>Explanation of GPTQ parameters</summary>
101
+
102
+ - Bits: The bit size of the quantised model.
103
+ - GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
104
+ - 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.
105
+ - Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
106
+ - 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).
107
+ - 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.
108
+ - ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama and Mistral models in 4-bit.
109
+
110
+ </details>
111
+
112
+ | Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
113
+ | ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
114
+ | [main](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ/tree/main) | 4 | 128 | Yes | 0.1 | [code](https://huggingface.co/datasets/nickrosh/Evol-Instruct-Code-80k-v1/viewer/) | 4096 | 3.90 GB | Yes | 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. |
115
+ | [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | [code](https://huggingface.co/datasets/nickrosh/Evol-Instruct-Code-80k-v1/viewer/) | 4096 | 4.28 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. |
116
+ | [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | [code](https://huggingface.co/datasets/nickrosh/Evol-Instruct-Code-80k-v1/viewer/) | 4096 | 7.01 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements. |
117
+ | [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | [code](https://huggingface.co/datasets/nickrosh/Evol-Instruct-Code-80k-v1/viewer/) | 4096 | 7.16 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. |
118
+ | [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ/tree/gptq-8bit-32g-actorder_True) | 8 | 32 | Yes | 0.1 | [code](https://huggingface.co/datasets/nickrosh/Evol-Instruct-Code-80k-v1/viewer/) | 4096 | 7.62 GB | No | 8-bit, with group size 32g and Act Order for maximum inference quality. |
119
+ | [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | [code](https://huggingface.co/datasets/nickrosh/Evol-Instruct-Code-80k-v1/viewer/) | 4096 | 4.02 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. |
120
+
121
+ <!-- README_GPTQ.md-provided-files end -->
122
+
123
+ <!-- README_GPTQ.md-download-from-branches start -->
124
+ ## How to download, including from branches
125
+
126
+ ### In text-generation-webui
127
+
128
+ To download from the `main` branch, enter `TheBloke/gorilla-openfunctions-v1-GPTQ` in the "Download model" box.
129
+
130
+ To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/gorilla-openfunctions-v1-GPTQ:gptq-4bit-32g-actorder_True`
131
+
132
+ ### From the command line
133
+
134
+ I recommend using the `huggingface-hub` Python library:
135
+
136
+ ```shell
137
+ pip3 install huggingface-hub
138
+ ```
139
+
140
+ To download the `main` branch to a folder called `gorilla-openfunctions-v1-GPTQ`:
141
+
142
+ ```shell
143
+ mkdir gorilla-openfunctions-v1-GPTQ
144
+ huggingface-cli download TheBloke/gorilla-openfunctions-v1-GPTQ --local-dir gorilla-openfunctions-v1-GPTQ --local-dir-use-symlinks False
145
+ ```
146
+
147
+ To download from a different branch, add the `--revision` parameter:
148
+
149
+ ```shell
150
+ mkdir gorilla-openfunctions-v1-GPTQ
151
+ huggingface-cli download TheBloke/gorilla-openfunctions-v1-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir gorilla-openfunctions-v1-GPTQ --local-dir-use-symlinks False
152
+ ```
153
+
154
+ <details>
155
+ <summary>More advanced huggingface-cli download usage</summary>
156
+
157
+ 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.
158
+
159
+ The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.
160
+
161
+ 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).
162
+
163
+ To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:
164
+
165
+ ```shell
166
+ pip3 install hf_transfer
167
+ ```
168
+
169
+ And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:
170
+
171
+ ```shell
172
+ mkdir gorilla-openfunctions-v1-GPTQ
173
+ HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/gorilla-openfunctions-v1-GPTQ --local-dir gorilla-openfunctions-v1-GPTQ --local-dir-use-symlinks False
174
+ ```
175
+
176
+ Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
177
+ </details>
178
+
179
+ ### With `git` (**not** recommended)
180
+
181
+ To clone a specific branch with `git`, use a command like this:
182
+
183
+ ```shell
184
+ git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/gorilla-openfunctions-v1-GPTQ
185
+ ```
186
+
187
+ 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.)
188
+
189
+ <!-- README_GPTQ.md-download-from-branches end -->
190
+ <!-- README_GPTQ.md-text-generation-webui start -->
191
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
192
+
193
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
194
+
195
+ 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.
196
+
197
+ 1. Click the **Model tab**.
198
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/gorilla-openfunctions-v1-GPTQ`.
199
+
200
+ - To download from a specific branch, enter for example `TheBloke/gorilla-openfunctions-v1-GPTQ:gptq-4bit-32g-actorder_True`
201
+ - see Provided Files above for the list of branches for each option.
202
+
203
+ 3. Click **Download**.
204
+ 4. The model will start downloading. Once it's finished it will say "Done".
205
+ 5. In the top left, click the refresh icon next to **Model**.
206
+ 6. In the **Model** dropdown, choose the model you just downloaded: `gorilla-openfunctions-v1-GPTQ`
207
+ 7. The model will automatically load, and is now ready for use!
208
+ 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.
209
+
210
+ - 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`.
211
+
212
+ 9. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
213
+
214
+ <!-- README_GPTQ.md-text-generation-webui end -->
215
+
216
+ <!-- README_GPTQ.md-use-from-tgi start -->
217
+ ## Serving this model from Text Generation Inference (TGI)
218
+
219
+ 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`
220
+
221
+ Example Docker parameters:
222
+
223
+ ```shell
224
+ --model-id TheBloke/gorilla-openfunctions-v1-GPTQ --port 3000 --quantize gptq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
225
+ ```
226
+
227
+ Example Python code for interfacing with TGI (requires huggingface-hub 0.17.0 or later):
228
+
229
+ ```shell
230
+ pip3 install huggingface-hub
231
+ ```
232
+
233
+ ```python
234
+ from huggingface_hub import InferenceClient
235
+
236
+ endpoint_url = "https://your-endpoint-url-here"
237
+
238
+ prompt = "Tell me about AI"
239
+ prompt_template=f'''USER: <<question>> {prompt} <<function>> {{function_string}}
240
+ ASSISTANT:
241
+ '''
242
+
243
+ client = InferenceClient(endpoint_url)
244
+ response = client.text_generation(prompt,
245
+ max_new_tokens=128,
246
+ do_sample=True,
247
+ temperature=0.7,
248
+ top_p=0.95,
249
+ top_k=40,
250
+ repetition_penalty=1.1)
251
+
252
+ print(f"Model output: {response}")
253
+ ```
254
+ <!-- README_GPTQ.md-use-from-tgi end -->
255
+ <!-- README_GPTQ.md-use-from-python start -->
256
+ ## Python code example: inference from this GPTQ model
257
+
258
+ ### Install the necessary packages
259
+
260
+ Requires: Transformers 4.33.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
261
+
262
+ ```shell
263
+ pip3 install --upgrade transformers optimum
264
+ # If using PyTorch 2.1 + CUDA 12.x:
265
+ pip3 install --upgrade auto-gptq
266
+ # or, if using PyTorch 2.1 + CUDA 11.x:
267
+ pip3 install --upgrade auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/
268
+ ```
269
+
270
+ 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:
271
+
272
+ ```shell
273
+ pip3 uninstall -y auto-gptq
274
+ git clone https://github.com/PanQiWei/AutoGPTQ
275
+ cd AutoGPTQ
276
+ git checkout v0.5.1
277
+ pip3 install .
278
+ ```
279
+
280
+ ### Example Python code
281
+
282
+ ```python
283
+ from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
284
+
285
+ model_name_or_path = "TheBloke/gorilla-openfunctions-v1-GPTQ"
286
+ # To use a different branch, change revision
287
+ # For example: revision="gptq-4bit-32g-actorder_True"
288
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
289
+ device_map="auto",
290
+ trust_remote_code=False,
291
+ revision="main")
292
+
293
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
294
+
295
+ prompt = "Tell me about AI"
296
+ prompt_template=f'''USER: <<question>> {prompt} <<function>> {{function_string}}
297
+ ASSISTANT:
298
+ '''
299
+
300
+ print("\n\n*** Generate:")
301
+
302
+ input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
303
+ output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
304
+ print(tokenizer.decode(output[0]))
305
+
306
+ # Inference can also be done using transformers' pipeline
307
+
308
+ print("*** Pipeline:")
309
+ pipe = pipeline(
310
+ "text-generation",
311
+ model=model,
312
+ tokenizer=tokenizer,
313
+ max_new_tokens=512,
314
+ do_sample=True,
315
+ temperature=0.7,
316
+ top_p=0.95,
317
+ top_k=40,
318
+ repetition_penalty=1.1
319
+ )
320
+
321
+ print(pipe(prompt_template)[0]['generated_text'])
322
+ ```
323
+ <!-- README_GPTQ.md-use-from-python end -->
324
+
325
+ <!-- README_GPTQ.md-compatibility start -->
326
+ ## Compatibility
327
+
328
+ The files provided are tested to work with Transformers. For non-Mistral models, AutoGPTQ can also be used directly.
329
+
330
+ [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.
331
+
332
+ For a list of clients/servers, please see "Known compatible clients / servers", above.
333
+ <!-- README_GPTQ.md-compatibility end -->
334
+
335
+ <!-- footer start -->
336
+ <!-- 200823 -->
337
+ ## Discord
338
+
339
+ For further support, and discussions on these models and AI in general, join us at:
340
+
341
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
342
+
343
+ ## Thanks, and how to contribute
344
+
345
+ Thanks to the [chirper.ai](https://chirper.ai) team!
346
+
347
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
348
+
349
+ 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.
350
+
351
+ 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.
352
+
353
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
354
+
355
+ * Patreon: https://patreon.com/TheBlokeAI
356
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
357
+
358
+ **Special thanks to**: Aemon Algiz.
359
+
360
+ **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
361
+
362
+
363
+ Thank you to all my generous patrons and donaters!
364
+
365
+ And thank you again to a16z for their generous grant.
366
+
367
+ <!-- footer end -->
368
+
369
+ # Original model card: Gorilla LLM (UC Berkeley's Gorilla OpenFunctions V1
370
+
371
+
372
+ 🚀 Try it out on [Colab](https://colab.research.google.com/drive/16M5J2H9F8YQora_W2PDnp120slZH-Mqd?usp=sharing)
373
+ 📣 Read more in our [OpenFunctions blog release](https://gorilla.cs.berkeley.edu/blogs/4_open_functions.html)
374
+
375
+ ## Introduction
376
+ Gorilla OpenFunctions extends Large Language Model(LLM) Chat Completion feature to formulate
377
+ executable APIs call given natural language instructions and API context.
378
+
379
+ ## Models Available
380
+ |model | functionality|
381
+ |---|---|
382
+ |gorilla-openfunctions-v0 | Given a function, and user intent, returns properly formatted json with the right arguments|
383
+ |gorilla-openfunctions-v1 | + Parallel functions, and can choose between functions|
384
+
385
+ ## Example Usage (Hosted)
386
+
387
+ 1. OpenFunctions is compatible with OpenAI Functions
388
+
389
+ ```bash
390
+ !pip install openai==0.28.1
391
+ ```
392
+
393
+ 2. Point to Gorilla hosted servers
394
+
395
+ ```python
396
+ import openai
397
+
398
+ def get_gorilla_response(prompt="Call me an Uber ride type \"Plus\" in Berkeley at zipcode 94704 in 10 minutes", model="gorilla-openfunctions-v0", functions=[]):
399
+ openai.api_key = "EMPTY"
400
+ openai.api_base = "http://luigi.millennium.berkeley.edu:8000/v1"
401
+ try:
402
+ completion = openai.ChatCompletion.create(
403
+ model="gorilla-openfunctions-v1",
404
+ temperature=0.0,
405
+ messages=[{"role": "user", "content": prompt}],
406
+ functions=functions,
407
+ )
408
+ return completion.choices[0].message.content
409
+ except Exception as e:
410
+ print(e, model, prompt)
411
+ ```
412
+
413
+ 3. Pass the user argument and set of functions, Gorilla OpenFunctions returns a fully formatted json
414
+
415
+ ```python
416
+ query = "Call me an Uber ride type \"Plus\" in Berkeley at zipcode 94704 in 10 minutes"
417
+ functions = [
418
+ {
419
+ "name": "Uber Carpool",
420
+ "api_name": "uber.ride",
421
+ "description": "Find suitable ride for customers given the location, type of ride, and the amount of time the customer is willing to wait as parameters",
422
+ "parameters": [{"name": "loc", "description": "location of the starting place of the uber ride"}, {"name":"type", "enum": ["plus", "comfort", "black"], "description": "types of uber ride user is ordering"}, {"name": "time", "description": "the amount of time in minutes the customer is willing to wait"}]
423
+ }
424
+ ]
425
+ get_gorilla_response(query, functions=functions)
426
+ ```
427
+
428
+ 4. Expected output
429
+
430
+ ```bash
431
+ uber.ride(loc="berkeley", type="plus", time=10)
432
+ ```
433
+
434
+ ## Example Usage (Run Locally)
435
+
436
+ ```python
437
+ import json
438
+ import torch
439
+ from transformers import AutoTokenizer, AutoModelForCausalLM, pipeline
440
+
441
+ def get_prompt(user_query: str, functions: list = []) -> str:
442
+ """
443
+ Generates a conversation prompt based on the user's query and a list of functions.
444
+
445
+ Parameters:
446
+ - user_query (str): The user's query.
447
+ - functions (list): A list of functions to include in the prompt.
448
+
449
+ Returns:
450
+ - str: The formatted conversation prompt.
451
+ """
452
+ if len(functions) == 0:
453
+ return f"USER: <<question>> {user_query}\nASSISTANT: "
454
+ functions_string = json.dumps(functions)
455
+ return f"USER: <<question>> {user_query} <<function>> {functions_string}\nASSISTANT: "
456
+
457
+ # Device setup
458
+ device : str = "cuda:0" if torch.cuda.is_available() else "cpu"
459
+ torch_dtype = torch.float16 if torch.cuda.is_available() else torch.float32
460
+
461
+ # Model and tokenizer setup
462
+ model_id : str = "gorilla-llm/gorilla-openfunctions-v1"
463
+ tokenizer = AutoTokenizer.from_pretrained(model_id)
464
+ model = AutoModelForCausalLM.from_pretrained(model_id, torch_dtype=torch_dtype, low_cpu_mem_usage=True)
465
+
466
+ # Move model to device
467
+ model.to(device)
468
+
469
+ # Pipeline setup
470
+ pipe = pipeline(
471
+ "text-generation",
472
+ model=model,
473
+ tokenizer=tokenizer,
474
+ max_new_tokens=128,
475
+ batch_size=16,
476
+ torch_dtype=torch_dtype,
477
+ device=device,
478
+ )
479
+
480
+ # Example usage
481
+ query: str = "Call me an Uber ride type \"Plus\" in Berkeley at zipcode 94704 in 10 minutes"
482
+ functions = [
483
+ {
484
+ "name": "Uber Carpool",
485
+ "api_name": "uber.ride",
486
+ "description": "Find suitable ride for customers given the location, type of ride, and the amount of time the customer is willing to wait as parameters",
487
+ "parameters": [
488
+ {"name": "loc", "description": "Location of the starting place of the Uber ride"},
489
+ {"name": "type", "enum": ["plus", "comfort", "black"], "description": "Types of Uber ride user is ordering"},
490
+ {"name": "time", "description": "The amount of time in minutes the customer is willing to wait"}
491
+ ]
492
+ }
493
+ ]
494
+
495
+ # Generate prompt and obtain model output
496
+ prompt = get_prompt(query, functions=functions)
497
+ output = pipe(prompt)
498
+
499
+ print(output)
500
+ ```
501
+
502
+
503
+ ## Contributing
504
+
505
+ All the models, and data used to train the models is released under Apache 2.0.
506
+ Gorilla is an open source effort from UC Berkeley and we welcome contributors.
507
+ Please email us your comments, criticism, and questions. More information about the project can be found at [https://gorilla.cs.berkeley.edu/](https://gorilla.cs.berkeley.edu/)
508
+
509
+
510
+
511
+
512
+