Initial GPTQ model commit

README.md

@@ -0,0 +1,292 @@
+---
+inference: false
+language:
+- fr
+library_name: transformers
+license: other
+model_creator: bofenghuang
+model_link: https://huggingface.co/bofenghuang/vigogne-2-7b-chat
+model_name: Vigogne 2 7B Chat
+model_type: llama
+pipeline_tag: text-generation
+quantized_by: TheBloke
+tags:
+- LLM
+- llama
+- llama-2
+---
+
+<!-- header start -->
+<div style="width: 100%;">
+    <img src="https://i.imgur.com/EBdldam.jpg" alt="TheBlokeAI" style="width: 100%; min-width: 400px; display: block; margin: auto;">
+</div>
+<div style="display: flex; justify-content: space-between; width: 100%;">
+    <div style="display: flex; flex-direction: column; align-items: flex-start;">
+        <p><a href="https://discord.gg/theblokeai">Chat & support: my new Discord server</a></p>
+    </div>
+    <div style="display: flex; flex-direction: column; align-items: flex-end;">
+        <p><a href="https://www.patreon.com/TheBlokeAI">Want to contribute? TheBloke's Patreon page</a></p>
+    </div>
+</div>
+<!-- header end -->
+
+# Vigogne 2 7B Chat - GPTQ
+- Model creator: [bofenghuang](https://huggingface.co/bofenghuang)
+- Original model: [Vigogne 2 7B Chat](https://huggingface.co/bofenghuang/vigogne-2-7b-chat)
+
+## Description
+
+This repo contains GPTQ model files for [bofenghuang's Vigogne 2 7B Chat](https://huggingface.co/bofenghuang/vigogne-2-7b-chat).
+
+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.
+
+## Repositories available
+
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GGML)
+* [bofenghuang's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/bofenghuang/vigogne-2-7b-chat)
+
+## Prompt template: Vigogne-Chat
+
+```
+Below is a conversation between a user and an AI assistant named Vigogne.
+Vigogne is polite, emotionally aware, humble-but-knowledgeable, always providing helpful and detailed answers.
+Vigogne is skilled in responding proficiently in the languages its users use and can perform a wide range of tasks such as text editing, translation, question answering, logical reasoning, coding, and many others.
+Vigogne cannot receive or generate audio or visual content and cannot access the internet.
+Vigogne strictly avoids discussing sensitive, offensive, illegal, ethical, or political topics and caveats when unsure of the answer.
+
+<|UTILISATEUR|>: {prompt}
+<|ASSISTANT|>:
+```
+
+## Provided files and GPTQ parameters
+
+Multiple quantisation parameters are provided, to allow you to choose the best one for your hardware and requirements.
+
+Each separate quant is in a different branch.  See below for instructions on fetching from different branches.
+
+All GPTQ files are made with AutoGPTQ.
+
+<details>
+  <summary>Explanation of GPTQ parameters</summary>
+
+- Bits: The bit size of the quantised model.
+- GS: GPTQ group size. Higher numbers use less VRAM, but have lower quantisation accuracy. "None" is the lowest possible value.
+- Act Order: True or False. Also known as `desc_act`. True results in better quantisation accuracy. Some GPTQ clients have issues with models that use Act Order plus Group Size.
+- Damp %: A GPTQ parameter that affects how samples are processed for quantisation. 0.01 is default, but 0.1 results in slightly better accuracy.
+- GPTQ dataset: The dataset used for quantisation. Using a dataset more appropriate to the model's training can improve quantisation accuracy. Note that the GPTQ 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).
+- 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.
+- ExLlama Compatibility: Whether this file can be loaded with ExLlama, which currently only supports Llama models in 4-bit.
+
+</details>
+
+| Branch | Bits | GS | Act Order | Damp % | GPTQ Dataset | Seq Len | Size | ExLlama | Desc |
+| ------ | ---- | -- | --------- | ------ | ------------ | ------- | ---- | ------- | ---- |
+| [main](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/main) | 4 | 128 | No | 0.1 | french | 4096 | 3.90 GB | Yes | Most compatible option. Good inference speed in AutoGPTQ and GPTQ-for-LLaMa. Lower inference quality than other options. | 
+| [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-4bit-32g-actorder_True) | 4 | 32 | Yes | 0.1 | french | 4096 | 4.28 GB | Yes | 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. Poor AutoGPTQ CUDA speed. | 
+| [gptq-4bit-64g-actorder_True](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-4bit-64g-actorder_True) | 4 | 64 | Yes | 0.1 | french | 4096 | 4.02 GB | Yes | 4-bit, with Act Order and group size 64g. Uses less VRAM than 32g, but with slightly lower accuracy. Poor AutoGPTQ CUDA speed. | 
+| [gptq-4bit-128g-actorder_True](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-4bit-128g-actorder_True) | 4 | 128 | Yes | 0.1 | french | 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. Poor AutoGPTQ CUDA speed. | 
+| [gptq-8bit--1g-actorder_True](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-8bit--1g-actorder_True) | 8 | None | Yes | 0.1 | french | 4096 | 7.01 GB | No | 8-bit, with Act Order. No group size, to lower VRAM requirements and to improve AutoGPTQ speed. | 
+| [gptq-8bit-128g-actorder_False](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-8bit-128g-actorder_False) | 8 | 128 | No | 0.1 | french | 4096 | 7.16 GB | No | 8-bit, with group size 128g for higher inference quality and without Act Order to improve AutoGPTQ speed. | 
+| [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-8bit-128g-actorder_True) | 8 | 128 | Yes | 0.1 | french | 4096 | 7.16 GB | No | 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. Poor AutoGPTQ CUDA speed. | 
+| [gptq-8bit-64g-actorder_True](https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ/tree/gptq-8bit-64g-actorder_True) | 8 | 64 | Yes | 0.1 | french | 4096 | 7.31 GB | No | 8-bit, with group size 64g and Act Order for maximum inference quality. Poor AutoGPTQ CUDA speed. |
+
+## How to download from branches
+
+- In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/Vigogne-2-7B-Chat-GPTQ:gptq-4bit-32g-actorder_True`
+- With Git, you can clone a branch with:
+```
+git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Vigogne-2-7B-Chat-GPTQ
+```
+- In Python Transformers code, the branch is the `revision` parameter; see below.
+
+## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
+
+Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
+
+It is strongly recommended to use the text-generation-webui one-click-installers unless you know how to make a manual install.
+
+1. Click the **Model tab**.
+2. Under **Download custom model or LoRA**, enter `TheBloke/Vigogne-2-7B-Chat-GPTQ`.
+  - To download from a specific branch, enter for example `TheBloke/Vigogne-2-7B-Chat-GPTQ:gptq-4bit-32g-actorder_True`
+  - see Provided Files above for the list of branches for each option.
+3. Click **Download**.
+4. The model will start downloading. Once it's finished it will say "Done"
+5. In the top left, click the refresh icon next to **Model**.
+6. In the **Model** dropdown, choose the model you just downloaded: `Vigogne-2-7B-Chat-GPTQ`
+7. The model will automatically load, and is now ready for use!
+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.
+  * Note that you do not need to set GPTQ parameters any more. These are set automatically from the file `quantize_config.json`.
+9. Once you're ready, click the **Text Generation tab** and enter a prompt to get started!
+
+## How to use this GPTQ model from Python code
+
+First make sure you have [AutoGPTQ](https://github.com/PanQiWei/AutoGPTQ) 0.3.1 or later installed:
+
+```
+pip3 install auto-gptq
+```
+
+If you have problems installing AutoGPTQ, please build from source instead:
+```
+pip3 uninstall -y auto-gptq
+git clone https://github.com/PanQiWei/AutoGPTQ
+cd AutoGPTQ
+pip3 install .
+```
+
+Then try the following example code:
+
+```python
+from transformers import AutoTokenizer, pipeline, logging
+from auto_gptq import AutoGPTQForCausalLM, BaseQuantizeConfig
+
+model_name_or_path = "TheBloke/Vigogne-2-7B-Chat-GPTQ"
+
+use_triton = False
+
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
+
+model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
+        use_safetensors=True,
+        trust_remote_code=False,
+        device="cuda:0",
+        use_triton=use_triton,
+        quantize_config=None)
+
+"""
+# To download from a specific branch, use the revision parameter, as in this example:
+# Note that `revision` requires AutoGPTQ 0.3.1 or later!
+
+model = AutoGPTQForCausalLM.from_quantized(model_name_or_path,
+        revision="gptq-4bit-32g-actorder_True",
+        use_safetensors=True,
+        trust_remote_code=False,
+        device="cuda:0",
+        quantize_config=None)
+"""
+
+prompt = "Tell me about AI"
+prompt_template=f'''Below is a conversation between a user and an AI assistant named Vigogne.
+Vigogne is polite, emotionally aware, humble-but-knowledgeable, always providing helpful and detailed answers.
+Vigogne is skilled in responding proficiently in the languages its users use and can perform a wide range of tasks such as text editing, translation, question answering, logical reasoning, coding, and many others.
+Vigogne cannot receive or generate audio or visual content and cannot access the internet.
+Vigogne strictly avoids discussing sensitive, offensive, illegal, ethical, or political topics and caveats when unsure of the answer.
+
+<|UTILISATEUR|>: {prompt}
+<|ASSISTANT|>:
+'''
+
+print("\n\n*** Generate:")
+
+input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
+output = model.generate(inputs=input_ids, temperature=0.7, max_new_tokens=512)
+print(tokenizer.decode(output[0]))
+
+# Inference can also be done using transformers' pipeline
+
+# Prevent printing spurious transformers error when using pipeline with AutoGPTQ
+logging.set_verbosity(logging.CRITICAL)
+
+print("*** Pipeline:")
+pipe = pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+    max_new_tokens=512,
+    temperature=0.7,
+    top_p=0.95,
+    repetition_penalty=1.15
+)
+
+print(pipe(prompt_template)[0]['generated_text'])
+```
+
+## Compatibility
+
+The files provided will work with AutoGPTQ (CUDA and Triton modes), GPTQ-for-LLaMa (only CUDA has been tested), and Occ4m's GPTQ-for-LLaMa fork.
+
+ExLlama works with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
+
+<!-- footer start -->
+## Discord
+
+For further support, and discussions on these models and AI in general, join us at:
+
+[TheBloke AI's Discord server](https://discord.gg/theblokeai)
+
+## Thanks, and how to contribute.
+
+Thanks to the [chirper.ai](https://chirper.ai) team!
+
+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.
+
+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.
+
+Donaters will get priority support on any and all AI/LLM/model questions and requests, access to a private Discord room, plus other benefits.
+
+* Patreon: https://patreon.com/TheBlokeAI
+* Ko-Fi: https://ko-fi.com/TheBlokeAI
+
+**Special thanks to**: Luke from CarbonQuill, Aemon Algiz.
+
+**Patreon special mentions**: Willem Michiel, Ajan Kanaga, Cory Kujawski, Alps Aficionado, Nikolai Manek, Jonathan Leane, Stanislav Ovsiannikov, Michael Levine, Luke Pendergrass, Sid, K, Gabriel Tamborski, Clay Pascal, Kalila, William Sang, Will Dee, Pieter, Nathan LeClaire, ya boyyy, David Flickinger, vamX, Derek Yates, Fen Risland, Jeffrey Morgan, webtim, Daniel P. Andersen, Chadd, Edmond Seymore, Pyrater, Olusegun Samson, Lone Striker, biorpg, alfie_i, Mano Prime, Chris Smitley, Dave, zynix, Trenton Dambrowitz, Johann-Peter Hartmann, Magnesian, Spencer Kim, John Detwiler, Iucharbius, Gabriel Puliatti, LangChain4j, Luke @flexchar, Vadim, Rishabh Srivastava, Preetika Verma, Ai Maven, Femi Adebogun, WelcomeToTheClub, Leonard Tan, Imad Khwaja, Steven Wood, Stefan Sabev, Sebastain Graf, usrbinkat, Dan Guido, Sam, Eugene Pentland, Mandus, transmissions 11, Slarti, Karl Bernard, Spiking Neurons AB, Artur Olbinski, Joseph William Delisle, ReadyPlayerEmma, Olakabola, Asp the Wyvern, Space Cruiser, Matthew Berman, Randy H, subjectnull, danny, John Villwock, Illia Dulskyi, Rainer Wilmers, theTransient, Pierre Kircher, Alexandros Triantafyllidis, Viktor Bowallius, terasurfer, Deep Realms, SuperWojo, senxiiz, Oscar Rangel, Alex, Stephen Murray, Talal Aujan, Raven Klaugh, Sean Connelly, Raymond Fosdick, Fred von Graf, chris gileta, Junyu Yang, Elle
+
+
+Thank you to all my generous patrons and donaters!
+
+<!-- footer end -->
+
+# Original model card: bofenghuang's Vigogne 2 7B Chat
+
+
+<p align="center" width="100%">
+<img src="https://huggingface.co/bofenghuang/vigogne-2-7b-chat/resolve/main/vigogne_logo.png" alt="Vigogne" style="width: 40%; min-width: 300px; display: block; margin: auto;">
+</p>
+
+# Vigogne-2-7B-Chat: A Llama-2 based French chat model
+
+Vigogne-2-7B-Chat is a model based on [LLaMA-2-7B](https://ai.meta.com/llama) that has been fine-tuned to conduct multi-turn dialogues in French between human user and AI assistant.
+
+For more information, please visit the Github repo: https://github.com/bofenghuang/vigogne
+
+**Usage and License Notices**: Vigogne-2-7B-Chat follows the same usage policy as Llama-2, which can be found [here](https://ai.meta.com/llama/use-policy).
+
+## Usage
+
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, GenerationConfig
+from vigogne.preprocess import generate_inference_chat_prompt
+
+model_name_or_path = "bofenghuang/vigogne-2-7b-chat"
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, padding_side="right", use_fast=False)
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path, torch_dtype=torch.float16, device_map="auto")
+
+user_query = "Expliquez la différence entre DoS et phishing."
+prompt = generate_inference_chat_prompt([[user_query, ""]], tokenizer=tokenizer)
+input_ids = tokenizer(prompt, return_tensors="pt")["input_ids"].to(model.device)
+input_length = input_ids.shape[1]
+
+generated_outputs = model.generate(
+    input_ids=input_ids,
+    generation_config=GenerationConfig(
+        temperature=0.1,
+        do_sample=True,
+        repetition_penalty=1.0,
+        max_new_tokens=512,
+    ),
+    return_dict_in_generate=True,
+)
+generated_tokens = generated_outputs.sequences[0, input_length:]
+generated_text = tokenizer.decode(generated_tokens, skip_special_tokens=True)
+print(generated_text)
+```
+
+You can infer this model by using the following Google Colab Notebook.
+
+<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>
+
+## Limitations
+
+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.