Mistral-7B-Instruct-v0.1-GPTQ / README.md

Update README.md

6ae1e4a 9 months ago

No virus

20.9 kB

	---
	base_model: mistralai/Mistral-7B-Instruct-v0.1
	inference: false
	license: apache-2.0
	model_creator: Mistral AI
	model_name: Mistral 7B Instruct v0.1
	model_type: mistral
	pipeline_tag: text-generation
	prompt_template: '<s>[INST] {prompt} [/INST]'
	quantized_by: TheBloke
	tags:
	- finetuned
	---

	<!-- header start -->
	<!-- 200823 -->
	<div style="width: auto; margin-left: auto; margin-right: auto">
	<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 style="margin-top: 0.5em; margin-bottom: 0em;"><a href="https://discord.gg/theblokeai">Chat & support: TheBloke's Discord server</a></p>
	</div>
	<div style="display: flex; flex-direction: column; align-items: flex-end;">
	<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>
	</div>
	</div>
	<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>
	<hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
	<!-- header end -->

	# Mistral 7B Instruct v0.1 - GPTQ
	- Model creator: [Mistral AI](https://huggingface.co/mistralai)
	- Original model: [Mistral 7B Instruct v0.1](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1)

	<!-- description start -->
	## Description

	This repo contains GPTQ model files for [Mistral AI's Mistral 7B Instruct v0.1](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1).

	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.

	### GPTQs will work in ExLlama, or via Transformers (requiring Transformers from Github)

	These models are confirmed to work with ExLlama v1.

	At the time of writing (September 28th), AutoGPTQ has not yet added support for the new Mistral models.

	These GPTQs were made directly from Transformers, and so can be loaded via the Transformers interface. They can't be loaded directly from AutoGPTQ.

	To load them via Transformers, you will need to install Transformers from Github, with:
	```
	pip3 install git+https://github.com/huggingface/transformers.git@72958fcd3c98a7afdc61f953aa58c544ebda2f79
	```

	<!-- description end -->
	<!-- repositories-available start -->
	## Repositories available

	* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-AWQ)
	* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GPTQ)
	* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GGUF)
	* [Mistral AI's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1)
	<!-- repositories-available end -->

	<!-- prompt-template start -->
	## Prompt template: Mistral

	```
	<s>[INST] {prompt} [/INST]

	```

	<!-- prompt-template end -->


	<!-- README_GPTQ.md-provided-files start -->
	## 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.

	These files were made with Transformers 4.34.0.dev0, from commit 72958fcd3c98a7afdc61f953aa58c544ebda2f79.

	<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 had issues with models that use Act Order plus Group Size, but this is generally resolved now.
	- 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 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).
	- 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/Mistral-7B-Instruct-v0.1-GPTQ/tree/main) \| 4 \| 128 \| Yes \| 0.1 \| [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) \| 32768 \| 4.16 GB \| Yes \| 4-bit, with Act Order and group size 128g. Uses even less VRAM than 64g, but with slightly lower accuracy. \|
	\| [gptq-4bit-32g-actorder_True](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GPTQ/tree/gptq-4bit-32g-actorder_True) \| 4 \| 32 \| Yes \| 0.1 \| [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) \| 32768 \| 4.57 GB \| Yes \| 4-bit, with Act Order and group size 32g. Gives highest possible inference quality, with maximum VRAM usage. \|
	\| [gptq-8bit-128g-actorder_True](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GPTQ/tree/gptq-8bit-128g-actorder_True) \| 8 \| 128 \| Yes \| 0.1 \| [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) \| 32768 \| 7.68 GB \| Yes \| 8-bit, with group size 128g for higher inference quality and with Act Order for even higher accuracy. \|
	\| [gptq-8bit-32g-actorder_True](https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GPTQ/tree/gptq-8bit-32g-actorder_True) \| 8 \| 32 \| Yes \| 0.1 \| [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) \| 32768 \| 8.17 GB \| Yes \| 8-bit, with group size 32g and Act Order for maximum inference quality. \|

	<!-- README_GPTQ.md-provided-files end -->

	<!-- README_GPTQ.md-download-from-branches start -->
	## How to download, including from branches

	### In text-generation-webui

	To download from the `main` branch, enter `TheBloke/Mistral-7B-Instruct-v0.1-GPTQ` in the "Download model" box.

	To download from another branch, add `:branchname` to the end of the download name, eg `TheBloke/Mistral-7B-Instruct-v0.1-GPTQ:gptq-4bit-32g-actorder_True`

	### From the command line

	I recommend using the `huggingface-hub` Python library:

	```shell
	pip3 install huggingface-hub
	```

	To download the `main` branch to a folder called `Mistral-7B-Instruct-v0.1-GPTQ`:

	```shell
	mkdir Mistral-7B-Instruct-v0.1-GPTQ
	huggingface-cli download TheBloke/Mistral-7B-Instruct-v0.1-GPTQ --local-dir Mistral-7B-Instruct-v0.1-GPTQ --local-dir-use-symlinks False
	```

	To download from a different branch, add the `--revision` parameter:

	```shell
	mkdir Mistral-7B-Instruct-v0.1-GPTQ
	huggingface-cli download TheBloke/Mistral-7B-Instruct-v0.1-GPTQ --revision gptq-4bit-32g-actorder_True --local-dir Mistral-7B-Instruct-v0.1-GPTQ --local-dir-use-symlinks False
	```

	<details>
	<summary>More advanced huggingface-cli download usage</summary>

	If you remove the `--local-dir-use-symlinks False` parameter, the files will instead be stored in the central Huggingface 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.

	The cache location can be changed with the `HF_HOME` environment variable, and/or the `--cache-dir` parameter to `huggingface-cli`.

	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).

	To accelerate downloads on fast connections (1Gbit/s or higher), install `hf_transfer`:

	```shell
	pip3 install hf_transfer
	```

	And set environment variable `HF_HUB_ENABLE_HF_TRANSFER` to `1`:

	```shell
	mkdir Mistral-7B-Instruct-v0.1-GPTQ
	HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Mistral-7B-Instruct-v0.1-GPTQ --local-dir Mistral-7B-Instruct-v0.1-GPTQ --local-dir-use-symlinks False
	```

	Windows Command Line users: You can set the environment variable by running `set HF_HUB_ENABLE_HF_TRANSFER=1` before the download command.
	</details>

	### With `git` (not recommended)

	To clone a specific branch with `git`, use a command like this:

	```shell
	git clone --single-branch --branch gptq-4bit-32g-actorder_True https://huggingface.co/TheBloke/Mistral-7B-Instruct-v0.1-GPTQ
	```

	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.)

	<!-- README_GPTQ.md-download-from-branches end -->
	<!-- README_GPTQ.md-text-generation-webui start -->
	## How to easily download and use this model in [text-generation-webui](https://github.com/oobabooga/text-generation-webui).

	These models are confirmed to work via the ExLlama Loader in text-generation-webui.

	Use Loader: ExLlama - or Transformers may work too. AutoGPTQ will not work.

	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're sure you know how to make a manual install.

	1. Click the Model tab.
	2. Under Download custom model or LoRA, enter `TheBloke/Mistral-7B-Instruct-v0.1-GPTQ`.
	- To download from a specific branch, enter for example `TheBloke/Mistral-7B-Instruct-v0.1-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: `Mistral-7B-Instruct-v0.1-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 and should not set manual 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!
	<!-- README_GPTQ.md-text-generation-webui end -->

	<!-- README_GPTQ.md-use-from-python start -->
	## How to use this GPTQ model from Python code

	### Install the necessary packages

	Requires: Transformers 4.34.0.dev0 from Github source, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.

	```shell
	pip3 install optimum
	pip3 install git+https://github.com/huggingface/transformers.git@72958fcd3c98a7afdc61f953aa58c544ebda2f79
	pip3 install auto-gptq --extra-index-url https://huggingface.github.io/autogptq-index/whl/cu118/ # Use cu117 if on CUDA 11.7
	```

	If you have problems installing AutoGPTQ using the pre-built wheels, install it from source instead:

	```shell
	pip3 uninstall -y auto-gptq
	git clone https://github.com/PanQiWei/AutoGPTQ
	cd AutoGPTQ
	git checkout v0.4.2
	pip3 install .
	```

	### You can then use the following code

	```python
	from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline

	model_name_or_path = "TheBloke/Mistral-7B-Instruct-v0.1-GPTQ"
	# To use a different branch, change revision
	# For example: revision="gptq-4bit-32g-actorder_True"
	model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
	device_map="auto",
	trust_remote_code=False,
	revision="main")

	tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)

	prompt = "Tell me about AI"
	prompt_template=f'''<s>[INST] {prompt} [/INST]
	'''

	print("\n\n*** Generate:")

	input_ids = tokenizer(prompt_template, return_tensors='pt').input_ids.cuda()
	output = model.generate(inputs=input_ids, temperature=0.7, do_sample=True, top_p=0.95, top_k=40, max_new_tokens=512)
	print(tokenizer.decode(output[0]))

	# Inference can also be done using transformers' pipeline

	print("*** Pipeline:")
	pipe = pipeline(
	"text-generation",
	model=model,
	tokenizer=tokenizer,
	max_new_tokens=512,
	do_sample=True,
	temperature=0.7,
	top_p=0.95,
	top_k=40,
	repetition_penalty=1.1
	)

	print(pipe(prompt_template)[0]['generated_text'])
	```
	<!-- README_GPTQ.md-use-from-python end -->

	<!-- README_GPTQ.md-compatibility start -->
	## Compatibility

	The files provided are only tested to work with ExLlama v1, and Transformers 4.34.0.dev0 as of commit 72958fcd3c98a7afdc61f953aa58c544ebda2f79.

	<!-- README_GPTQ.md-compatibility end -->

	<!-- footer start -->
	<!-- 200823 -->
	## 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!

	Thanks to Clay from [gpus.llm-utils.org](llm-utils)!

	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: Aemon Algiz.

	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


	Thank you to all my generous patrons and donaters!

	And thank you again to a16z for their generous grant.

	<!-- footer end -->

	# Original model card: Mistral AI's Mistral 7B Instruct v0.1


	# Model Card for Mistral-7B-Instruct-v0.1

	The Mistral-7B-Instruct-v0.1 Large Language Model (LLM) is a instruct fine-tuned version of the [Mistral-7B-v0.1](https://huggingface.co/mistralai/Mistral-7B-v0.1) generative text model using a variety of publicly available conversation datasets.

	For full details of this model please read our [release blog post](https://mistral.ai/news/announcing-mistral-7b/)

	## Instruction format

	In order to leverage instruction fine-tuning, your prompt should be surrounded by `[INST]` and `[\INST]` tokens. The very first instruction should begin with a begin of sentence id. The next instructions should not. The assistant generation will be ended by the end-of-sentence token id.

	E.g.
	```
	text = "<s>[INST] What is your favourite condiment? [/INST]"
	"Well, I'm quite partial to a good squeeze of fresh lemon juice. It adds just the right amount of zesty flavour to whatever I'm cooking up in the kitchen!</s> "
	"[INST] Do you have mayonnaise recipes? [/INST]"
	```

	This format is available as a [chat template](https://huggingface.co/docs/transformers/main/chat_templating) via the `apply_chat_template()` method:

	```python
	from transformers import AutoModelForCausalLM, AutoTokenizer

	device = "cuda" # the device to load the model onto

	model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-Instruct-v0.1")
	tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-Instruct-v0.1")

	messages = [
	{"role": "user", "content": "What is your favourite condiment?"},
	{"role": "assistant", "content": "Well, I'm quite partial to a good squeeze of fresh lemon juice. It adds just the right amount of zesty flavour to whatever I'm cooking up in the kitchen!"},
	{"role": "user", "content": "Do you have mayonnaise recipes?"}
	]

	encodeds = tokenizer.apply_chat_template(messages, return_tensors="pt")

	model_inputs = encodeds.to(device)
	model.to(device)

	generated_ids = model.generate(model_inputs, max_new_tokens=1000, do_sample=True)
	decoded = tokenizer.batch_decode(generated_ids)
	print(decoded[0])
	```

	## Model Architecture
	This instruction model is based on Mistral-7B-v0.1, a transformer model with the following architecture choices:
	- Grouped-Query Attention
	- Sliding-Window Attention
	- Byte-fallback BPE tokenizer

	## Troubleshooting
	- If you see the following error:
	```
	Traceback (most recent call last):
	File "", line 1, in
	File "/transformers/models/auto/auto_factory.py", line 482, in from_pretrained
	config, kwargs = AutoConfig.from_pretrained(
	File "/transformers/models/auto/configuration_auto.py", line 1022, in from_pretrained
	config_class = CONFIG_MAPPING[config_dict["model_type"]]
	File "/transformers/models/auto/configuration_auto.py", line 723, in getitem
	raise KeyError(key)
	KeyError: 'mistral'
	```

	Installing transformers from source should solve the issue
	pip install git+https://github.com/huggingface/transformers

	This should not be required after transformers-v4.33.4.

	## Limitations

	The Mistral 7B Instruct model is a quick demonstration that the base model can be easily fine-tuned to achieve compelling performance.
	It does not have any moderation mechanisms. We're looking forward to engaging with the community on ways to
	make the model finely respect guardrails, allowing for deployment in environments requiring moderated outputs.

	## The Mistral AI Team

	Albert Jiang, Alexandre Sablayrolles, Arthur Mensch, Chris Bamford, Devendra Singh Chaplot, Diego de las Casas, Florian Bressand, Gianna Lengyel, Guillaume Lample, Lélio Renard Lavaud, Lucile Saulnier, Marie-Anne Lachaux, Pierre Stock, Teven Le Scao, Thibaut Lavril, Thomas Wang, Timothée Lacroix, William El Sayed.