TheBloke commited on
Commit
bcbba46
1 Parent(s): 1e57bef

Upload README.md

Browse files
Files changed (1) hide show
  1. README.md +520 -0
README.md ADDED
@@ -0,0 +1,520 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: bofenghuang/vigostral-7b-chat
3
+ inference: false
4
+ language: fr
5
+ license: apache-2.0
6
+ model_creator: bofeng huang
7
+ model_name: Vigostral 7B Chat
8
+ model_type: mistral
9
+ pipeline_tag: text-generation
10
+ prompt_template: "<s>[INST] <<SYS>>\nVous \xEAtes Vigogne, un assistant IA cr\xE9\xE9\
11
+ \ par Zaion Lab. Vous suivez extr\xEAmement bien les instructions. Aidez autant\
12
+ \ que vous le pouvez.\n<</SYS>>\n\n{prompt} [/INST] \n"
13
+ quantized_by: TheBloke
14
+ tags:
15
+ - LLM
16
+ - finetuned
17
+ ---
18
+ <!-- markdownlint-disable MD041 -->
19
+
20
+ <!-- header start -->
21
+ <!-- 200823 -->
22
+ <div style="width: auto; margin-left: auto; margin-right: auto">
23
+ <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
24
+ </div>
25
+ <div style="display: flex; justify-content: space-between; width: 100%;">
26
+ <div style="display: flex; flex-direction: column; align-items: flex-start;">
27
+ <p style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
28
+ </div>
29
+ <div style="display: flex; flex-direction: column; align-items: flex-end;">
30
+ <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>
31
+ </div>
32
+ </div>
33
+ <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>
34
+ <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
35
+ <!-- header end -->
36
+
37
+ # Vigostral 7B Chat - AWQ
38
+ - Model creator: [bofeng huang](https://huggingface.co/bofenghuang)
39
+ - Original model: [Vigostral 7B Chat](https://huggingface.co/bofenghuang/vigostral-7b-chat)
40
+
41
+ <!-- description start -->
42
+ ## Description
43
+
44
+ This repo contains AWQ model files for [bofeng huang's Vigostral 7B Chat](https://huggingface.co/bofenghuang/vigostral-7b-chat).
45
+
46
+
47
+ ### About AWQ
48
+
49
+ AWQ is an efficient, accurate and blazing-fast low-bit weight quantization method, currently supporting 4-bit quantization. Compared to GPTQ, it offers faster Transformers-based inference with equivalent or better quality compared to the most commonly used GPTQ settings.
50
+
51
+ It is supported by:
52
+
53
+ - [Text Generation Webui](https://github.com/oobabooga/text-generation-webui) - using Loader: AutoAWQ
54
+ - [vLLM](https://github.com/vllm-project/vllm) - Llama and Mistral models only
55
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
56
+ - [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) - for use from Python code
57
+
58
+ <!-- description end -->
59
+ <!-- repositories-available start -->
60
+ ## Repositories available
61
+
62
+ * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Vigostral-7B-Chat-AWQ)
63
+ * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Vigostral-7B-Chat-GPTQ)
64
+ * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Vigostral-7B-Chat-GGUF)
65
+ * [bofeng huang's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/bofenghuang/vigostral-7b-chat)
66
+ <!-- repositories-available end -->
67
+
68
+ <!-- prompt-template start -->
69
+ ## Prompt template: Vigogne-Llama-2-Chat
70
+
71
+ ```
72
+ <s>[INST] <<SYS>>
73
+ Vous êtes Vigogne, un assistant IA créé par Zaion Lab. Vous suivez extrêmement bien les instructions. Aidez autant que vous le pouvez.
74
+ <</SYS>>
75
+
76
+ {prompt} [/INST]
77
+
78
+ ```
79
+
80
+ <!-- prompt-template end -->
81
+
82
+
83
+ <!-- README_AWQ.md-provided-files start -->
84
+ ## Provided files, and AWQ parameters
85
+
86
+ For my first release of AWQ models, I am releasing 128g models only. I will consider adding 32g as well if there is interest, and once I have done perplexity and evaluation comparisons, but at this time 32g models are still not fully tested with AutoAWQ and vLLM.
87
+
88
+ Models are released as sharded safetensors files.
89
+
90
+ | Branch | Bits | GS | AWQ Dataset | Seq Len | Size |
91
+ | ------ | ---- | -- | ----------- | ------- | ---- |
92
+ | [main](https://huggingface.co/TheBloke/Vigostral-7B-Chat-AWQ/tree/main) | 4 | 128 | [French news](https://huggingface.co/datasets/gustavecortal/diverse_french_news) | 4096 | 4.15 GB
93
+
94
+ <!-- README_AWQ.md-provided-files end -->
95
+
96
+ <!-- README_AWQ.md-text-generation-webui start -->
97
+ ## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui)
98
+
99
+ Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
100
+
101
+ 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.
102
+
103
+ 1. Click the **Model tab**.
104
+ 2. Under **Download custom model or LoRA**, enter `TheBloke/Vigostral-7B-Chat-AWQ`.
105
+ 3. Click **Download**.
106
+ 4. The model will start downloading. Once it's finished it will say "Done".
107
+ 5. In the top left, click the refresh icon next to **Model**.
108
+ 6. In the **Model** dropdown, choose the model you just downloaded: `Vigostral-7B-Chat-AWQ`
109
+ 7. Select **Loader: AutoAWQ**.
110
+ 8. Click Load, and the model will load and is now ready for use.
111
+ 9. 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.
112
+ 10. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
113
+ <!-- README_AWQ.md-text-generation-webui end -->
114
+
115
+ <!-- README_AWQ.md-use-from-vllm start -->
116
+ ## Multi-user inference server: vLLM
117
+
118
+ Documentation on installing and using vLLM [can be found here](https://vllm.readthedocs.io/en/latest/).
119
+
120
+ - Please ensure you are using vLLM version 0.2 or later.
121
+ - When using vLLM as a server, pass the `--quantization awq` parameter.
122
+
123
+ For example:
124
+
125
+ ```shell
126
+ python3 python -m vllm.entrypoints.api_server --model TheBloke/Vigostral-7B-Chat-AWQ --quantization awq
127
+ ```
128
+
129
+ - When using vLLM from Python code, again set `quantization=awq`.
130
+
131
+ For example:
132
+
133
+ ```python
134
+ from vllm import LLM, SamplingParams
135
+
136
+ prompts = [
137
+ "Tell me about AI",
138
+ "Write a story about llamas",
139
+ "What is 291 - 150?",
140
+ "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
141
+ ]
142
+ prompt_template=f'''<s>[INST] <<SYS>>
143
+ Vous êtes Vigogne, un assistant IA créé par Zaion Lab. Vous suivez extrêmement bien les instructions. Aidez autant que vous le pouvez.
144
+ <</SYS>>
145
+
146
+ {prompt} [/INST]
147
+ '''
148
+
149
+ prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]
150
+
151
+ sampling_params = SamplingParams(temperature=0.8, top_p=0.95)
152
+
153
+ llm = LLM(model="TheBloke/Vigostral-7B-Chat-AWQ", quantization="awq", dtype="auto")
154
+
155
+ outputs = llm.generate(prompts, sampling_params)
156
+
157
+ # Print the outputs.
158
+ for output in outputs:
159
+ prompt = output.prompt
160
+ generated_text = output.outputs[0].text
161
+ print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
162
+ ```
163
+ <!-- README_AWQ.md-use-from-vllm start -->
164
+
165
+ <!-- README_AWQ.md-use-from-tgi start -->
166
+ ## Multi-user inference server: Hugging Face Text Generation Inference (TGI)
167
+
168
+ Use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
169
+
170
+ Example Docker parameters:
171
+
172
+ ```shell
173
+ --model-id TheBloke/Vigostral-7B-Chat-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
174
+ ```
175
+
176
+ Example Python code for interfacing with TGI (requires [huggingface-hub](https://github.com/huggingface/huggingface_hub) 0.17.0 or later):
177
+
178
+ ```shell
179
+ pip3 install huggingface-hub
180
+ ```
181
+
182
+ ```python
183
+ from huggingface_hub import InferenceClient
184
+
185
+ endpoint_url = "https://your-endpoint-url-here"
186
+
187
+ prompt = "Tell me about AI"
188
+ prompt_template=f'''<s>[INST] <<SYS>>
189
+ Vous êtes Vigogne, un assistant IA créé par Zaion Lab. Vous suivez extrêmement bien les instructions. Aidez autant que vous le pouvez.
190
+ <</SYS>>
191
+
192
+ {prompt} [/INST]
193
+ '''
194
+
195
+ client = InferenceClient(endpoint_url)
196
+ response = client.text_generation(prompt,
197
+ max_new_tokens=128,
198
+ do_sample=True,
199
+ temperature=0.7,
200
+ top_p=0.95,
201
+ top_k=40,
202
+ repetition_penalty=1.1)
203
+
204
+ print(f"Model output: ", response)
205
+ ```
206
+ <!-- README_AWQ.md-use-from-tgi end -->
207
+
208
+ <!-- README_AWQ.md-use-from-python start -->
209
+ ## Inference from Python code using AutoAWQ
210
+
211
+ ### Install the AutoAWQ package
212
+
213
+ Requires: [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) 0.1.1 or later.
214
+
215
+ ```shell
216
+ pip3 install autoawq
217
+ ```
218
+
219
+ If you have problems installing [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) using the pre-built wheels, install it from source instead:
220
+
221
+ ```shell
222
+ pip3 uninstall -y autoawq
223
+ git clone https://github.com/casper-hansen/AutoAWQ
224
+ cd AutoAWQ
225
+ pip3 install .
226
+ ```
227
+
228
+ ### AutoAWQ example code
229
+
230
+ ```python
231
+ from awq import AutoAWQForCausalLM
232
+ from transformers import AutoTokenizer
233
+
234
+ model_name_or_path = "TheBloke/Vigostral-7B-Chat-AWQ"
235
+
236
+ # Load tokenizer
237
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, trust_remote_code=False)
238
+ # Load model
239
+ model = AutoAWQForCausalLM.from_quantized(model_name_or_path, fuse_layers=True,
240
+ trust_remote_code=False, safetensors=True)
241
+
242
+ prompt = "Tell me about AI"
243
+ prompt_template=f'''<s>[INST] <<SYS>>
244
+ Vous êtes Vigogne, un assistant IA créé par Zaion Lab. Vous suivez extrêmement bien les instructions. Aidez autant que vous le pouvez.
245
+ <</SYS>>
246
+
247
+ {prompt} [/INST]
248
+ '''
249
+
250
+ print("*** Running model.generate:")
251
+
252
+ token_input = tokenizer(
253
+ prompt_template,
254
+ return_tensors='pt'
255
+ ).input_ids.cuda()
256
+
257
+ # Generate output
258
+ generation_output = model.generate(
259
+ token_input,
260
+ do_sample=True,
261
+ temperature=0.7,
262
+ top_p=0.95,
263
+ top_k=40,
264
+ max_new_tokens=512
265
+ )
266
+
267
+ # Get the tokens from the output, decode them, print them
268
+ token_output = generation_output[0]
269
+ text_output = tokenizer.decode(token_output)
270
+ print("LLM output: ", text_output)
271
+
272
+ """
273
+ # Inference should be possible with transformers pipeline as well in future
274
+ # But currently this is not yet supported by AutoAWQ (correct as of September 25th 2023)
275
+ from transformers import pipeline
276
+
277
+ print("*** Pipeline:")
278
+ pipe = pipeline(
279
+ "text-generation",
280
+ model=model,
281
+ tokenizer=tokenizer,
282
+ max_new_tokens=512,
283
+ do_sample=True,
284
+ temperature=0.7,
285
+ top_p=0.95,
286
+ top_k=40,
287
+ repetition_penalty=1.1
288
+ )
289
+
290
+ print(pipe(prompt_template)[0]['generated_text'])
291
+ """
292
+ ```
293
+ <!-- README_AWQ.md-use-from-python end -->
294
+
295
+ <!-- README_AWQ.md-compatibility start -->
296
+ ## Compatibility
297
+
298
+ The files provided are tested to work with:
299
+
300
+ - [text-generation-webui](https://github.com/oobabooga/text-generation-webui) using `Loader: AutoAWQ`.
301
+ - [vLLM](https://github.com/vllm-project/vllm) version 0.2.0 and later.
302
+ - [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) version 1.1.0 and later.
303
+ - [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) version 0.1.1 and later.
304
+
305
+ <!-- README_AWQ.md-compatibility end -->
306
+
307
+ <!-- footer start -->
308
+ <!-- 200823 -->
309
+ ## Discord
310
+
311
+ For further support, and discussions on these models and AI in general, join us at:
312
+
313
+ [TheBloke AI's Discord server](https://discord.gg/theblokeai)
314
+
315
+ ## Thanks, and how to contribute
316
+
317
+ Thanks to the [chirper.ai](https://chirper.ai) team!
318
+
319
+ Thanks to Clay from [gpus.llm-utils.org](llm-utils)!
320
+
321
+ 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.
322
+
323
+ 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.
324
+
325
+ Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
326
+
327
+ * Patreon: https://patreon.com/TheBlokeAI
328
+ * Ko-Fi: https://ko-fi.com/TheBlokeAI
329
+
330
+ **Special thanks to**: Aemon Algiz.
331
+
332
+ **Patreon special mentions**: Pierre Kircher, Stanislav Ovsiannikov, Michael Levine, Eugene Pentland, Andrey, 준교 김, Randy H, Fred von Graf, Artur Olbinski, Caitlyn Gatomon, terasurfer, Jeff Scroggin, James Bentley, Vadim, Gabriel Puliatti, Harry Royden McLaughlin, Sean Connelly, Dan Guido, Edmond Seymore, Alicia Loh, subjectnull, AzureBlack, Manuel Alberto Morcote, Thomas Belote, Lone Striker, Chris Smitley, Vitor Caleffi, Johann-Peter Hartmann, Clay Pascal, biorpg, Brandon Frisco, sidney chen, transmissions 11, Pedro Madruga, jinyuan sun, Ajan Kanaga, Emad Mostaque, Trenton Dambrowitz, Jonathan Leane, Iucharbius, usrbinkat, vamX, George Stoitzev, Luke Pendergrass, theTransient, Olakabola, Swaroop Kallakuri, Cap'n Zoog, Brandon Phillips, Michael Dempsey, Nikolai Manek, danny, Matthew Berman, Gabriel Tamborski, alfie_i, Raymond Fosdick, Tom X Nguyen, Raven Klaugh, LangChain4j, Magnesian, Illia Dulskyi, David Ziegler, Mano Prime, Luis Javier Navarrete Lozano, Erik Bjäreholt, 阿明, Nathan Dryer, Alex, Rainer Wilmers, zynix, TL, Joseph William Delisle, John Villwock, Nathan LeClaire, Willem Michiel, Joguhyik, GodLy, OG, Alps Aficionado, Jeffrey Morgan, ReadyPlayerEmma, Tiffany J. Kim, Sebastain Graf, Spencer Kim, Michael Davis, webtim, Talal Aujan, knownsqashed, John Detwiler, Imad Khwaja, Deo Leter, Jerry Meng, Elijah Stavena, Rooh Singh, Pieter, SuperWojo, Alexandros Triantafyllidis, Stephen Murray, Ai Maven, ya boyyy, Enrico Ros, Ken Nordquist, Deep Realms, Nicholas, Spiking Neurons AB, Elle, Will Dee, Jack West, RoA, Luke @flexchar, Viktor Bowallius, Derek Yates, Subspace Studios, jjj, Toran Billups, Asp the Wyvern, Fen Risland, Ilya, NimbleBox.ai, Chadd, Nitin Borwankar, Emre, Mandus, Leonard Tan, Kalila, K, Trailburnt, S_X, Cory Kujawski
333
+
334
+
335
+ Thank you to all my generous patrons and donaters!
336
+
337
+ And thank you again to a16z for their generous grant.
338
+
339
+ <!-- footer end -->
340
+
341
+ # Original model card: bofeng huang's Vigostral 7B Chat
342
+
343
+
344
+ # Vigostral-7B-Chat: A French chat LLM
345
+
346
+ ***Preview*** of Vigostral-7B-Chat, a new addition to the Vigogne LLMs family, fine-tuned on [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1).
347
+
348
+ For more information, please visit the [Github repository](https://github.com/bofenghuang/vigogne).
349
+
350
+ **License**: A significant portion of the training data is distilled from GPT-3.5-Turbo and GPT-4, kindly use it cautiously to avoid any violations of OpenAI's [terms of use](https://openai.com/policies/terms-of-use).
351
+
352
+ ## Prompt Template
353
+
354
+ We used a prompt template adapted from the chat format of Llama-2.
355
+
356
+ You can apply this formatting using the [chat template](https://huggingface.co/docs/transformers/main/chat_templating) through the `apply_chat_template()` method.
357
+
358
+ ```python
359
+ from transformers import AutoTokenizer
360
+
361
+ tokenizer = AutoTokenizer.from_pretrained("bofenghuang/vigostral-7b-chat")
362
+
363
+ conversation = [
364
+ {"role": "user", "content": "Bonjour ! Comment ça va aujourd'hui ?"},
365
+ {"role": "assistant", "content": "Bonjour ! Je suis une IA, donc je n'ai pas de sentiments, mais je suis prêt à vous aider. Comment puis-je vous assister aujourd'hui ?"},
366
+ {"role": "user", "content": "Quelle est la hauteur de la Tour Eiffel ?"},
367
+ {"role": "assistant", "content": "La Tour Eiffel mesure environ 330 mètres de hauteur."},
368
+ {"role": "user", "content": "Comment monter en haut ?"},
369
+ ]
370
+
371
+ print(tokenizer.apply_chat_template(conversation, tokenize=False, add_generation_prompt=True))
372
+ ```
373
+
374
+ You will get
375
+
376
+ ```
377
+ <s>[INST] <<SYS>>
378
+ Vous êtes Vigogne, un assistant IA créé par Zaion Lab. Vous suivez extrêmement bien les instructions. Aidez autant que vous le pouvez.
379
+ <</SYS>>
380
+
381
+ Bonjour ! Comment ça va aujourd'hui ? [/INST] Bonjour ! Je suis une IA, donc je n'ai pas de sentiments, mais je suis prêt à vous aider. Comment puis-je vous assister aujourd'hui ? </s>[INST] Quelle est la hauteur de la Tour Eiffel ? [/INST] La Tour Eiffel mesure environ 330 mètres de hauteur. </s>[INST] Comment monter en haut ? [/INST]
382
+ ```
383
+
384
+ ## Usage
385
+
386
+ ### Inference using the unquantized model with 🤗 Transformers
387
+
388
+ ```python
389
+ from typing import Dict, List, Optional
390
+ import torch
391
+ from transformers import AutoModelForCausalLM, AutoTokenizer, GenerationConfig, TextStreamer
392
+
393
+ model_name_or_path = "bofenghuang/vigostral-7b-chat"
394
+ tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, padding_side="right", use_fast=False)
395
+ model = AutoModelForCausalLM.from_pretrained(model_name_or_path, torch_dtype=torch.float16, device_map="auto")
396
+
397
+ streamer = TextStreamer(tokenizer, timeout=10.0, skip_prompt=True, skip_special_tokens=True)
398
+
399
+
400
+ def chat(
401
+ query: str,
402
+ history: Optional[List[Dict]] = None,
403
+ temperature: float = 0.7,
404
+ top_p: float = 1.0,
405
+ top_k: float = 0,
406
+ repetition_penalty: float = 1.1,
407
+ max_new_tokens: int = 1024,
408
+ **kwargs,
409
+ ):
410
+ if history is None:
411
+ history = []
412
+
413
+ history.append({"role": "user", "content": query})
414
+
415
+ input_ids = tokenizer.apply_chat_template(history, return_tensors="pt").to(model.device)
416
+ input_length = input_ids.shape[1]
417
+
418
+ generated_outputs = model.generate(
419
+ input_ids=input_ids,
420
+ generation_config=GenerationConfig(
421
+ temperature=temperature,
422
+ do_sample=temperature > 0.0,
423
+ top_p=top_p,
424
+ top_k=top_k,
425
+ repetition_penalty=repetition_penalty,
426
+ max_new_tokens=max_new_tokens,
427
+ pad_token_id=tokenizer.eos_token_id,
428
+ **kwargs,
429
+ ),
430
+ streamer=streamer,
431
+ return_dict_in_generate=True,
432
+ )
433
+
434
+ generated_tokens = generated_outputs.sequences[0, input_length:]
435
+ generated_text = tokenizer.decode(generated_tokens, skip_special_tokens=True)
436
+
437
+ history.append({"role": "assistant", "content": generated_text})
438
+
439
+ return generated_text, history
440
+
441
+ # 1st round
442
+ response, history = chat("Un escargot parcourt 100 mètres en 5 heures. Quelle est sa vitesse ?", history=None)
443
+ # Pour calculer la vitesse d'un escargot qui parcourt 100 mètres en 5 heures, nous devons diviser la distance parcourue par le temps écoulé. Voici comment procédons :
444
+ #
445
+ # Vitesse = Distance / Temps
446
+ #
447
+ # Dans ce cas, la distance est de 100 mètres et le temps est de 5 heures. Donc, nous avons :
448
+ #
449
+ # Vitesse = 100 mètres / 5 heures
450
+ # Vitesse = 20 mètres par heure
451
+ #
452
+ # L'escargot parcourt donc une vitesse de 20 mètres par heure.
453
+
454
+ # 2nd round
455
+ response, history = chat("Quand il peut dépasser le lapin ?", history=history)
456
+ # Malheureusement, je ne peux pas répondre à cette question car elle contient des informations inexactes ou incorrectes. La vitesse de l'escargot est de 20 mètres par heure, tandis que la vitesse du lapin n'est pas mentionnée dans votre question initiale. Pour comparer les vitesses des deux animaux, nous aurions besoin de connaître la vitesse du lapin.
457
+
458
+ # 3rd round
459
+ response, history = chat("Écris une histoire imaginative qui met en scène une compétition de course entre un escargot et un lapin.", history=history)
460
+ # Il était une fois deux athlètes extraordinaires : un escargot nommé Escargo et un lapin appelé Lapin Rapide. Un jour, ils ont décidé de participer à une grande course pour déterminer qui était le plus rapide des deux. Tout le monde était curieux de savoir qui serait le gagnant, car ils étaient tous émerveillés par la vitesse de ces deux champions.
461
+ #
462
+ # La course commença dans une forêt dense, avec Escargo départageant un peu lentement, car il faut être prudent lorsqu'on est escargot. Mais au fur et à mesure qu'il avançait, il commença à ralentir encore plus. Les spectateurs commencèrent à pencher pour Lapin Rapide, qui fonçait rapidement vers la ligne d'arrivée.
463
+ #
464
+ # Mais soudain, Escargo se transforma en une force incroyable. Au lieu de marcher lentement comme un escargot, il courait à toute allure, faisant preuve d'une vitesse surprenante. Les spectateurs essayaient de se remémorer leurs notes de mathématiques pour calculer sa vélocité actuelle.
465
+ #
466
+ # Pendant ce temps, Lapin Rapide ralentissait légèrement, trouvant l'air frais trop confortable pour continuer à courir aussi vite. Il décida alors de prendre quelques pauses pour profiter de son environnement.
467
+ #
468
+ # Escargo continuait à courir à toute vitesse, en dépit de son handicap d'être un escargot. Les spectateurs étaient émerveillés par sa persévérance et sa volonté de gagner. Finalement, Escargo franchit la ligne d'arrivée en premier, et tous criaurent en joie.
469
+ #
470
+ # Les habitants de la forêt décidèrent de lui décerner le titre d'"athlète le plus courageux" pour sa performance incroyable. Quant à Lapin Rapide, il fut content de sa deuxième place, se disant simplement que les pauses étaient bien plus agréables que la compétition. Et tous vécurent heureux et satisfaits de cette course mémorable.
471
+ ```
472
+
473
+ You can also use the Google Colab Notebook provided below.
474
+
475
+ <a href="https://colab.research.google.com/github/bofenghuang/vigogne/blob/main/notebooks/infer_chat.ipynb" target="_blank"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
476
+
477
+ ### Inference using the unquantized model with vLLM
478
+
479
+ Set up an OpenAI-compatible server with the following command:
480
+
481
+ ```bash
482
+ # Install vLLM
483
+ # This may take 5-10 minutes.
484
+ # pip install vllm
485
+
486
+ # Start server for Vigostral-Chat models
487
+ python -m vllm.entrypoints.openai.api_server --model bofenghuang/vigostral-7b-chat
488
+
489
+ # List models
490
+ # curl http://localhost:8000/v1/models
491
+ ```
492
+
493
+ Query the model using the openai python package.
494
+
495
+ ```python
496
+ import openai
497
+
498
+ # Modify OpenAI's API key and API base to use vLLM's API server.
499
+ openai.api_key = "EMPTY"
500
+ openai.api_base = "http://localhost:8000/v1"
501
+
502
+ # First model
503
+ models = openai.Model.list()
504
+ model = models["data"][0]["id"]
505
+
506
+ # Chat completion API
507
+ chat_completion = openai.ChatCompletion.create(
508
+ model=model,
509
+ messages=[
510
+ {"role": "user", "content": "Parle-moi de toi-même."},
511
+ ],
512
+ max_tokens=1024,
513
+ temperature=0.7,
514
+ )
515
+ print("Chat completion results:", chat_completion)
516
+ ```
517
+
518
+ ## Limitations
519
+
520
+ Vigogne is still under development, and there are many limitations that have to be addressed. Please note that it is possible that the model generates harmful or biased content, incorrect information or generally unhelpful answers.