Upload README.md

README.md

@@ -1,6 +1,21 @@
 ---
+base_model: https://huggingface.co/FPHam/Karen_theEditor_13b_HF
 inference: false
 license: other
+model_creator: FPHam
+model_name: Karen The Editor 13B
+model_type: llama
+prompt_template: 'You are a helpful AI assistant.
+
+
+  USER: {prompt}
+
+  ASSISTANT:
+
+  '
+quantized_by: TheBloke
+tags:
+- lora
 ---
 
 <!-- header start -->
@@ -20,66 +35,186 @@ license: other
 <hr style="margin-top: 1.0em; margin-bottom: 1.0em;">
 <!-- header end -->
 
-# FPHam's Karen The Editor 13B GPTQ
+# Karen The Editor 13B - GPTQ
+- Model creator: [FPHam](https://huggingface.co/FPHam)
+- Original model: [Karen The Editor 13B](https://huggingface.co/FPHam/Karen_theEditor_13b_HF)
 
-These files are GPTQ 4bit model files for [FPHam's Karen The Editor 13B](https://huggingface.co/FPHam/Karen_theEditor_13b_HF).
+<!-- description start -->
+## Description
 
-It is the result of quantising to 4bit using [GPTQ-for-LLaMa](https://github.com/qwopqwop200/GPTQ-for-LLaMa).
+This repo contains GPTQ model files for [FPHam's Karen The Editor 13B](https://huggingface.co/FPHam/Karen_theEditor_13b_HF).
 
-## Other repositories available
+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.
 
-* [4-bit GPTQ models for GPU inference](https://huggingface.co/TheBloke/Karen_theEditor_13B-GPTQ)
-* [4-bit, 5-bit and 8-bit GGML models for CPU(+GPU) inference](https://huggingface.co/TheBloke/Karen_theEditor_13B-GGML)
-* [Unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/FPHam/Karen_theEditor_13b_HF
+<!-- description end -->
+<!-- repositories-available start -->
+## Repositories available
 
-## Prompt template
+* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Karen_theEditor_13B-AWQ)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Karen_theEditor_13B-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Karen_theEditor_13B-GGUF)
+* [FPHam's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/FPHam/Karen_theEditor_13b_HF)
+<!-- repositories-available end -->
+
+<!-- prompt-template start -->
+## Prompt template: Vicuna-Short
 
 ```
-USER: Edit the following for spelling and grammar mistakes:
+You are a helpful AI assistant.
+
+USER: {prompt}
 ASSISTANT:
+
+```
+
+<!-- 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.
+
+All recent GPTQ files are made with AutoGPTQ, and all files in non-main branches are made with AutoGPTQ. Files in the `main` branch which were uploaded before August 2023 were made with GPTQ-for-LLaMa.
+
+<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 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/Karen_theEditor_13B-GPTQ/tree/main) | 4 | 128 | No | 0.01 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 2048 | 7.45 GB | Yes | 4-bit, without Act Order and group size 128g. |
+
+<!-- README_GPTQ.md-provided-files end -->
+
+<!-- README_GPTQ.md-download-from-branches start -->
+## How to download from branches
+
+- In text-generation-webui, you can add `:branch` to the end of the download name, eg `TheBloke/Karen_theEditor_13B-GPTQ:main`
+- With Git, you can clone a branch with:
+```
+git clone --single-branch --branch main https://huggingface.co/TheBloke/Karen_theEditor_13B-GPTQ
 ```
+- In Python Transformers code, the branch is the `revision` parameter; see below.
+<!-- 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).
 
-## How to easily download and use this model in text-generation-webui
+Please make sure you're using the latest version of [text-generation-webui](https://github.com/oobabooga/text-generation-webui).
 
-### Downloading the model
+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/Karen_theEditor_13B-GPTQ`.
+  - To download from a specific branch, enter for example `TheBloke/Karen_theEditor_13B-GPTQ:main`
+  - see Provided Files above for the list of branches for each option.
 3. Click **Download**.
-4. Wait until it says it's finished downloading.
-5. Untick "Autoload model"
-6. Click the **Refresh** icon next to **Model** in the top left.
+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: `Karen_theEditor_13B-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.32.0 or later, Optimum 1.12.0 or later, and AutoGPTQ 0.4.2 or later.
+
+```shell
+pip3 install transformers>=4.32.0 optimum>=1.12.0
+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
+pip3 install .
+```
+
+### For CodeLlama models only: you must use Transformers 4.33.0 or later.
+
+If 4.33.0 is not yet released when you read this, you will need to install Transformers from source:
+```shell
+pip3 uninstall -y transformers
+pip3 install git+https://github.com/huggingface/transformers.git
+```
+
+### You can then use the following code
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
 
-### To use with AutoGPTQ (if installed)
+model_name_or_path = "TheBloke/Karen_theEditor_13B-GPTQ"
+# To use a different branch, change revision
+# For example: revision="main"
+model = AutoModelForCausalLM.from_pretrained(model_name_or_path,
+                                             device_map="auto",
+                                             trust_remote_code=False,
+                                             revision="main")
 
-1. In the **Model drop-down**: choose the model you just downloaded, `Karen_theEditor_13B-GPTQ`.
-2. Under **GPTQ**, tick **AutoGPTQ**.
-3. Click **Save settings for this model** in the top right.
-4. Click **Reload the Model** in the top right.
-5. Once it says it's loaded, click the **Text Generation tab** and enter a prompt!
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, use_fast=True)
 
-### To use with GPTQ-for-LLaMa
+prompt = "Tell me about AI"
+prompt_template=f'''You are a helpful AI assistant.
+
+USER: {prompt}
+ASSISTANT:
 
-1. In the **Model drop-down**: choose the model you just downloaded, `Karen_theEditor_13B-GPTQ`.
-2. If you see an error in the bottom right, ignore it - it's temporary.
-3. Fill out the `GPTQ parameters` on the right: `Bits = 4`, `Groupsize = 128`, `model_type = Llama`
-4. Click **Save settings for this model** in the top right.
-5. Click **Reload the Model** in the top right.
-6. Once it says it's loaded, click the **Text Generation tab** and enter a prompt!
+'''
 
-## Provided files
+print("\n\n*** Generate:")
 
-**Karen-The-Editor-GPTQ-4bit-128g.no-act.order.safetensors**
+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 -->
 
-This will work with all versions of GPTQ-for-LLaMa, and with AutoGPTQ.
+<!-- README_GPTQ.md-compatibility start -->
+## Compatibility
 
-It was created with
+The files provided are tested to work with AutoGPTQ, both via Transformers and using AutoGPTQ directly. They should also work with [Occ4m's GPTQ-for-LLaMa fork](https://github.com/0cc4m/KoboldAI).
 
-* `Karen-The-Editor-GPTQ-4bit-128g.no-act.order.safetensors`
-  * Works with all versions of GPTQ-for-LLaMa code, both Triton and CUDA branches
-  * Works with AutoGPTQ
-  * Works with text-generation-webui one-click-installers
-  * Parameters: Groupsize = 128. Act Order / desc_act = False.
+[ExLlama](https://github.com/turboderp/exllama) is compatible with Llama models in 4-bit. Please see the Provided Files table above for per-file compatibility.
+
+[Huggingface Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) is compatible with all GPTQ models.
+<!-- README_GPTQ.md-compatibility end -->
 
 <!-- footer start -->
 <!-- 200823 -->
@@ -89,10 +224,12 @@ For further support, and discussions on these models and AI in general, join us
 
 [TheBloke AI's Discord server](https://discord.gg/theblokeai)
 
-## Thanks, and how to contribute.
+## 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.
@@ -104,7 +241,7 @@ Donaters will get priority support on any and all AI/LLM/model questions and req
 
 **Special thanks to**: Aemon Algiz.
 
-**Patreon special mentions**: Sam, theTransient, Jonathan Leane, Steven Wood, webtim, Johann-Peter Hartmann, Geoffrey Montalvo, Gabriel Tamborski, Willem Michiel, John Villwock, Derek Yates, Mesiah Bishop, Eugene Pentland, Pieter, Chadd, Stephen Murray, Daniel P. Andersen, terasurfer, Brandon Frisco, Thomas Belote, Sid, Nathan LeClaire, Magnesian, Alps Aficionado, Stanislav Ovsiannikov, Alex, Joseph William Delisle, Nikolai Manek, Michael Davis, Junyu Yang, K, J, Spencer Kim, Stefan Sabev, Olusegun Samson, transmissions 11, Michael Levine, Cory Kujawski, Rainer Wilmers, zynix, Kalila, Luke @flexchar, Ajan Kanaga, Mandus, vamX, Ai Maven, Mano Prime, Matthew Berman, subjectnull, Vitor Caleffi, Clay Pascal, biorpg, alfie_i, 阿明, Jeffrey Morgan, ya boyyy, Raymond Fosdick, knownsqashed, Olakabola, Leonard Tan, ReadyPlayerEmma, Enrico Ros, Dave, Talal Aujan, Illia Dulskyi, Sean Connelly, senxiiz, Artur Olbinski, Elle, Raven Klaugh, Fen Risland, Deep Realms, Imad Khwaja, Fred von Graf, Will Dee, usrbinkat, SuperWojo, Alexandros Triantafyllidis, Swaroop Kallakuri, Dan Guido, John Detwiler, Pedro Madruga, Iucharbius, Viktor Bowallius, Asp the Wyvern, Edmond Seymore, Trenton Dambrowitz, Space Cruiser, Spiking Neurons AB, Pyrater, LangChain4j, Tony Hughes, Kacper Wikieł, Rishabh Srivastava, David Ziegler, Luke Pendergrass, Andrey, Gabriel Puliatti, Lone Striker, Sebastain Graf, Pierre Kircher, Randy H, NimbleBox.ai, Vadim, danny, Deo Leter
+**Patreon special mentions**: Alicia Loh, Stephen Murray, K, Ajan Kanaga, RoA, Magnesian, Deo Leter, Olakabola, Eugene Pentland, zynix, Deep Realms, Raymond Fosdick, Elijah Stavena, Iucharbius, Erik Bjäreholt, Luis Javier Navarrete Lozano, Nicholas, theTransient, John Detwiler, alfie_i, knownsqashed, Mano Prime, Willem Michiel, Enrico Ros, LangChain4j, OG, Michael Dempsey, Pierre Kircher, Pedro Madruga, James Bentley, Thomas Belote, Luke @flexchar, Leonard Tan, Johann-Peter Hartmann, Illia Dulskyi, Fen Risland, Chadd, S_X, Jeff Scroggin, Ken Nordquist, Sean Connelly, Artur Olbinski, Swaroop Kallakuri, Jack West, Ai Maven, David Ziegler, Russ Johnson, transmissions 11, John Villwock, Alps Aficionado, Clay Pascal, Viktor Bowallius, Subspace Studios, Rainer Wilmers, Trenton Dambrowitz, vamX, Michael Levine, 준교 김, Brandon Frisco, Kalila, Trailburnt, Randy H, Talal Aujan, Nathan Dryer, Vadim, 阿明, ReadyPlayerEmma, Tiffany J. Kim, George Stoitzev, Spencer Kim, Jerry Meng, Gabriel Tamborski, Cory Kujawski, Jeffrey Morgan, Spiking Neurons AB, Edmond Seymore, Alexandros Triantafyllidis, Lone Striker, Cap'n Zoog, Nikolai Manek, danny, ya boyyy, Derek Yates, usrbinkat, Mandus, TL, Nathan LeClaire, subjectnull, Imad Khwaja, webtim, Raven Klaugh, Asp the Wyvern, Gabriel Puliatti, Caitlyn Gatomon, Joseph William Delisle, Jonathan Leane, Luke Pendergrass, SuperWojo, Sebastain Graf, Will Dee, Fred von Graf, Andrey, Dan Guido, Daniel P. Andersen, Nitin Borwankar, Elle, Vitor Caleffi, biorpg, jjj, NimbleBox.ai, Pieter, Matthew Berman, terasurfer, Michael Davis, Alex, Stanislav Ovsiannikov
 
 
 Thank you to all my generous patrons and donaters!
@@ -115,16 +252,34 @@ And thank you again to a16z for their generous grant.
 
 # Original model card: FPHam's Karen The Editor 13B
 
-## Karen is an editor for your fiction.
+<!-- header start -->
+<div style="width: 100%;">
+    <img src="https://media.tenor.com/frGCmLDFbkMAAAAC/karen-ok.gif" alt="FPHam's Karen" style="width: 30%; min-width: 200px; display: block; margin: auto;">
+</div>
+<div style="display: flex; flex-direction: column; align-items: center;">
+        <p><a href="https://ko-fi.com/Q5Q5MOB4M">Buy Karen Ko-fi</a></p>
+    </div>
+<!-- header end -->
+
+## Karen is an editor for your fiction. (v.0.2)
+
+Ah, Karen, a true peach among grammatical cucumbers! She yearns to rectify the missteps and linguistic tangles that infest your horribly written fiction.  
+Yet, unlike those ChatGPT kaboodles that morph into self-absorbed, constipated gurus of self-help style, Karen remains steadfastly grounded in wit and wisdom but respectfull of your style.
 
-She fixes grammar and wording issues, but doesn't necessary start rewording everything like ChatGPT into a corporate talk. So it should keep the style intact.
+She is also absolute joy to chat with, although she may correct grammar in your chats too from time to time 
+(As certain well known LLM said, "She is a radiant beacon of amusement")
 
-Based on LLAMA 13b and Wizard-Vucna-uncensored finetune, then finetuned with about 20k grammar examples (bad grammar/good grammar).
+She also has a particular soft spot for Llamas.
+
+## Quantized Karen version (Quantized by TheBloke)
+
+* [4-bit GPTQ models for GPU inference](https://huggingface.co/FPHam/Karen_theEditor-13B-4bit-128g-GPTQ)
+* [4-bit, 5-bit and 8-bit GGML models for CPU(+GPU) inference](https://huggingface.co/TheBloke/Karen_theEditor_13B-GGML)
 
 Karen gets triggered by this prompt (pun intended):
 
 ```
-USER: Edit the following for spelling and grammar mistakes:
+USER: Edit the following for spelling and grammar mistakes: 
 ASSISTANT:
 ```
 
@@ -141,4 +296,40 @@ context: "Assistant is a meticulous senior editor with a specialization in editi
 
 I am not sure to what extend the context part has any effect. Doesn't hurt though.
 
-This is a version 0.2 and finetuned just so it retains the underlaying Vicuna qualities.
+This is a version 0.2 and finetuned just so it retains the underlaying Vicuna qualities. 
+
+## Example:
+
+Input
+```
+USER: Edit the following for spelling and grammar mistakes:
+unce upon time lived name John who have pet monkey Jackie.
+one day while walkin down the street he saw his friend Tom coming to him.
+"Hey Tom" said John "hows it going?"
+
+Tom replyied "Not too bad how 'bout yourself?". as they was talk Jackie sudden jump onto Tom shoulder and started play with his hair.
+Tom look at John and ask "Is that yours?"
+
+John reply "Yeah, this crazy lil guy follow me everywhere" just then Jackie grab hold of Tom glasses and try to take thmm off.
+Tom struggle to keep his balance as he laugh hystericaly.
+```
+Output
+```
+ASSISTANT: Once upon a time there lived a man named John who had a pet monkey called Jackie.
+One day while walking down the street he saw his friend Tom approaching him.
+"Hey Tom," said John. "How's it going?"
+
+Tom replied, "Not too bad, how about yourself?" As they were talking, Jackie suddenly jumped onto Tom's shoulder and began playing with his hair.
+Tom looked at John and asked, "Is that yours?"
+
+John replied, "Yeah, this crazy little guy follows me everywhere." Just then Jackie grabbed hold of Tom's glasses and tried to take them off.
+Tom struggled to keep his balance as he laughed hysterically.
+```
+
+## Goal: to create the best grammar checker you have ever seen
+
+## To do:
+- train on larger dataset, big, enormous, gargantuan 
+- see if finetuning on just plain LLAMA without Vicuna would work better or worse (the theory is that it will be very focused on editing and nothing else)
+- explore what different settings (temperature, top_p, top_k do for this type of finetune)
+- create Rachel, the paraphrasing editor