--- base_model: FPHam/Karen_TheEditor_V2_CREATIVE_Mistral_7B inference: false license: llama2 model_creator: FPHam model_name: Karen TheEditor V2 Creative Mistral 7B model_type: mistral prompt_template: '<|im_start|>system {system_message}<|im_end|> <|im_start|>user {prompt}<|im_end|> <|im_start|>assistant ' quantized_by: TheBloke tags: - llm - llama - spellcheck - grammar ---
TheBlokeAI

Chat & support: TheBloke's Discord server

Want to contribute? TheBloke's Patreon page

TheBloke's LLM work is generously supported by a grant from andreessen horowitz (a16z)

# Karen TheEditor V2 Creative Mistral 7B - GGUF - Model creator: [FPHam](https://huggingface.co/FPHam) - Original model: [Karen TheEditor V2 Creative Mistral 7B](https://huggingface.co/FPHam/Karen_TheEditor_V2_CREATIVE_Mistral_7B) ## Description This repo contains GGUF format model files for [FPHam's Karen TheEditor V2 Creative Mistral 7B](https://huggingface.co/FPHam/Karen_TheEditor_V2_CREATIVE_Mistral_7B). These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/). ### About GGUF GGUF is a new format introduced by the llama.cpp team on August 21st 2023. It is a replacement for GGML, which is no longer supported by llama.cpp. Here is an incomplete list of clients and libraries that are known to support GGUF: * [llama.cpp](https://github.com/ggerganov/llama.cpp). The source project for GGUF. Offers a CLI and a server option. * [text-generation-webui](https://github.com/oobabooga/text-generation-webui), the most widely used web UI, with many features and powerful extensions. Supports GPU acceleration. * [KoboldCpp](https://github.com/LostRuins/koboldcpp), a fully featured web UI, with GPU accel across all platforms and GPU architectures. Especially good for story telling. * [LM Studio](https://lmstudio.ai/), an easy-to-use and powerful local GUI for Windows and macOS (Silicon), with GPU acceleration. * [LoLLMS Web UI](https://github.com/ParisNeo/lollms-webui), a great web UI with many interesting and unique features, including a full model library for easy model selection. * [Faraday.dev](https://faraday.dev/), an attractive and easy to use character-based chat GUI for Windows and macOS (both Silicon and Intel), with GPU acceleration. * [ctransformers](https://github.com/marella/ctransformers), a Python library with GPU accel, LangChain support, and OpenAI-compatible AI server. * [llama-cpp-python](https://github.com/abetlen/llama-cpp-python), a Python library with GPU accel, LangChain support, and OpenAI-compatible API server. * [candle](https://github.com/huggingface/candle), a Rust ML framework with a focus on performance, including GPU support, and ease of use. ## Repositories available * [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-AWQ) * [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GPTQ) * [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF) * [FPHam's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/FPHam/Karen_TheEditor_V2_CREATIVE_Mistral_7B) ## Prompt template: ChatML ``` <|im_start|>system {system_message}<|im_end|> <|im_start|>user {prompt}<|im_end|> <|im_start|>assistant ``` ## Compatibility These quantised GGUFv2 files are compatible with llama.cpp from August 27th onwards, as of commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) They are also compatible with many third party UIs and libraries - please see the list at the top of this README. ## Explanation of quantisation methods
Click to see details The new methods available are: * GGML_TYPE_Q2_K - "type-1" 2-bit quantization in super-blocks containing 16 blocks, each block having 16 weight. Block scales and mins are quantized with 4 bits. This ends up effectively using 2.5625 bits per weight (bpw) * GGML_TYPE_Q3_K - "type-0" 3-bit quantization in super-blocks containing 16 blocks, each block having 16 weights. Scales are quantized with 6 bits. This end up using 3.4375 bpw. * GGML_TYPE_Q4_K - "type-1" 4-bit quantization in super-blocks containing 8 blocks, each block having 32 weights. Scales and mins are quantized with 6 bits. This ends up using 4.5 bpw. * GGML_TYPE_Q5_K - "type-1" 5-bit quantization. Same super-block structure as GGML_TYPE_Q4_K resulting in 5.5 bpw * GGML_TYPE_Q6_K - "type-0" 6-bit quantization. Super-blocks with 16 blocks, each block having 16 weights. Scales are quantized with 8 bits. This ends up using 6.5625 bpw Refer to the Provided Files table below to see what files use which methods, and how.
## Provided files | Name | Quant method | Bits | Size | Max RAM required | Use case | | ---- | ---- | ---- | ---- | ---- | ----- | | [karen_theeditor_v2_creative_mistral_7b.Q2_K.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q2_K.gguf) | Q2_K | 2 | 3.08 GB| 5.58 GB | smallest, significant quality loss - not recommended for most purposes | | [karen_theeditor_v2_creative_mistral_7b.Q3_K_S.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q3_K_S.gguf) | Q3_K_S | 3 | 3.16 GB| 5.66 GB | very small, high quality loss | | [karen_theeditor_v2_creative_mistral_7b.Q3_K_M.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q3_K_M.gguf) | Q3_K_M | 3 | 3.52 GB| 6.02 GB | very small, high quality loss | | [karen_theeditor_v2_creative_mistral_7b.Q3_K_L.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q3_K_L.gguf) | Q3_K_L | 3 | 3.82 GB| 6.32 GB | small, substantial quality loss | | [karen_theeditor_v2_creative_mistral_7b.Q4_0.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q4_0.gguf) | Q4_0 | 4 | 4.11 GB| 6.61 GB | legacy; small, very high quality loss - prefer using Q3_K_M | | [karen_theeditor_v2_creative_mistral_7b.Q4_K_S.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q4_K_S.gguf) | Q4_K_S | 4 | 4.14 GB| 6.64 GB | small, greater quality loss | | [karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf) | Q4_K_M | 4 | 4.37 GB| 6.87 GB | medium, balanced quality - recommended | | [karen_theeditor_v2_creative_mistral_7b.Q5_0.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q5_0.gguf) | Q5_0 | 5 | 5.00 GB| 7.50 GB | legacy; medium, balanced quality - prefer using Q4_K_M | | [karen_theeditor_v2_creative_mistral_7b.Q5_K_S.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q5_K_S.gguf) | Q5_K_S | 5 | 5.00 GB| 7.50 GB | large, low quality loss - recommended | | [karen_theeditor_v2_creative_mistral_7b.Q5_K_M.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q5_K_M.gguf) | Q5_K_M | 5 | 5.13 GB| 7.63 GB | large, very low quality loss - recommended | | [karen_theeditor_v2_creative_mistral_7b.Q6_K.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q6_K.gguf) | Q6_K | 6 | 5.94 GB| 8.44 GB | very large, extremely low quality loss | | [karen_theeditor_v2_creative_mistral_7b.Q8_0.gguf](https://huggingface.co/TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF/blob/main/karen_theeditor_v2_creative_mistral_7b.Q8_0.gguf) | Q8_0 | 8 | 7.70 GB| 10.20 GB | very large, extremely low quality loss - not recommended | **Note**: the above RAM figures assume no GPU offloading. If layers are offloaded to the GPU, this will reduce RAM usage and use VRAM instead. ## How to download GGUF files **Note for manual downloaders:** You almost never want to clone the entire repo! Multiple different quantisation formats are provided, and most users only want to pick and download a single file. The following clients/libraries will automatically download models for you, providing a list of available models to choose from: * LM Studio * LoLLMS Web UI * Faraday.dev ### In `text-generation-webui` Under Download Model, you can enter the model repo: TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF and below it, a specific filename to download, such as: karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf. Then click Download. ### On the command line, including multiple files at once I recommend using the `huggingface-hub` Python library: ```shell pip3 install huggingface-hub ``` Then you can download any individual model file to the current directory, at high speed, with a command like this: ```shell huggingface-cli download TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf --local-dir . --local-dir-use-symlinks False ```
More advanced huggingface-cli download usage You can also download multiple files at once with a pattern: ```shell huggingface-cli download TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF --local-dir . --local-dir-use-symlinks False --include='*Q4_K*gguf' ``` 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 HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf --local-dir . --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.
## Example `llama.cpp` command Make sure you are using `llama.cpp` from commit [d0cee0d](https://github.com/ggerganov/llama.cpp/commit/d0cee0d36d5be95a0d9088b674dbb27354107221) or later. ```shell ./main -ngl 32 -m karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf --color -c 2048 --temp 0.7 --repeat_penalty 1.1 -n -1 -p "<|im_start|>system\n{system_message}<|im_end|>\n<|im_start|>user\n{prompt}<|im_end|>\n<|im_start|>assistant" ``` Change `-ngl 32` to the number of layers to offload to GPU. Remove it if you don't have GPU acceleration. Change `-c 2048` to the desired sequence length. For extended sequence models - eg 8K, 16K, 32K - the necessary RoPE scaling parameters are read from the GGUF file and set by llama.cpp automatically. If you want to have a chat-style conversation, replace the `-p ` argument with `-i -ins` For other parameters and how to use them, please refer to [the llama.cpp documentation](https://github.com/ggerganov/llama.cpp/blob/master/examples/main/README.md) ## How to run in `text-generation-webui` Further instructions can be found in the text-generation-webui documentation, here: [text-generation-webui/docs/04 ‐ Model Tab.md](https://github.com/oobabooga/text-generation-webui/blob/main/docs/04%20%E2%80%90%20Model%20Tab.md#llamacpp). ## How to run from Python code You can use GGUF models from Python using the [llama-cpp-python](https://github.com/abetlen/llama-cpp-python) or [ctransformers](https://github.com/marella/ctransformers) libraries. ### How to load this model in Python code, using ctransformers #### First install the package Run one of the following commands, according to your system: ```shell # Base ctransformers with no GPU acceleration pip install ctransformers # Or with CUDA GPU acceleration pip install ctransformers[cuda] # Or with AMD ROCm GPU acceleration (Linux only) CT_HIPBLAS=1 pip install ctransformers --no-binary ctransformers # Or with Metal GPU acceleration for macOS systems only CT_METAL=1 pip install ctransformers --no-binary ctransformers ``` #### Simple ctransformers example code ```python from ctransformers import AutoModelForCausalLM # Set gpu_layers to the number of layers to offload to GPU. Set to 0 if no GPU acceleration is available on your system. llm = AutoModelForCausalLM.from_pretrained("TheBloke/Karen_TheEditor_V2_CREATIVE_Mistral_7B-GGUF", model_file="karen_theeditor_v2_creative_mistral_7b.Q4_K_M.gguf", model_type="mistral", gpu_layers=50) print(llm("AI is going to")) ``` ## How to use with LangChain Here are guides on using llama-cpp-python and ctransformers with LangChain: * [LangChain + llama-cpp-python](https://python.langchain.com/docs/integrations/llms/llamacpp) * [LangChain + ctransformers](https://python.langchain.com/docs/integrations/providers/ctransformers) ## 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**: 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 Thank you to all my generous patrons and donaters! And thank you again to a16z for their generous grant. # Original model card: FPHam's Karen TheEditor V2 Creative Mistral 7B
FPHam's Karen v2

Buy Karen Ko-fi

# Karen is an editor for your text. (v.2) CREATIVE edition 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 grammatical wisdom but respectfull of your style. # Info Karen, Version 2, uses a completely different data set and base model than the previous Karen. # There are two versions of Karen V2 1. Strict ((here)[https://huggingface.co/FPHam/Karen_TheEditor_V2_STRICT_Mistral_7B]), in which Karen will try not to make too many changes to your original text, mostly fixing grammar and spelling, assuming that you know what you are doing. 2. Creative (this one), in which Karen may suggest slight contextual improvements or rephrasing where necessary. It's Karen, after a glass of wine. # Goals Karen's primary goal is to rectify grammatical and spelling errors in US English without altering the style of the text. She is adept at identifying and correcting common ESL errors. Verb Tense Errors: Incorrect use of verb tenses, such as using present tense when past tense is required and vice versa. Confusion between continuous and simple tenses. Subject-Verb Agreement: Lack of agreement between the subject and verb in number, e.g., using a singular verb with a plural subject or vice versa. Articles (a, an, the): Incorrect use or omission of articles, such as using "a" instead of "an" or vice versa. Overuse or omission of the definite article "the." Prepositions: Misuse of prepositions, such as using "in" instead of "on" or "at," or omitting prepositions where they are needed. Word Order: Incorrect word order in sentences, especially in questions and negative sentences. Misplacement of adverbs or adjectives. Pluralization: Incorrect plural forms of nouns, such as failing to add "-s" or "-es" when necessary. Pronoun Errors: Confusion between subject and object pronouns. Incorrect use of possessive pronouns. Double Negatives: Using double negatives, which is grammatically incorrect in standard English. Modal Verbs: Misuse of modal verbs like can, could, will, would, should, etc. Confusing Similar Words: Confusing words that sound similar but have different meanings and spellings (e.g., "their," "there," and "they're"). Lack of Plural/Singular Agreement: Mistakes in matching singular and plural nouns and verbs in a sentence. # Future Goals Use bigger model, add grammar cases that the model misses. Better datasets. Use larger datasets. # Training It was reversely trained on fict/non-fiction US text where errors were intentionally inserted by another Llama model (Darth Karen) and Python script. # Usage It should be used by submitting a paragraph or block of text at a time. # Model uses ChatML ``` <|im_start|>system <|im_end|> <|im_start|>user Edit the following text for spelling and grammar mistakes: {paragraph of text} <|im_end|> <|im_start|>assistant ``` Note the pretext: *Edit the following text for spelling and grammar mistakes:* before the actual text. This way Karen wouldn't start talking ABOUT the text. # Recomended settings - Temperature: 0.7 - top_p: 0.1 - top_k: 40 - repetition penalty: 1.18 Karen could also be used in chatting. But if Karen is involved in a conversation where the text is lengthy, she might interpret your message as needing proofreading assistance rather than simply acknowledging that you are using her in casual chat. Example: >Edit the following text for spelling and grammar mistakes: I see future writing more about you writing the story any way you can and LLM editing it and making it into a proper fiction. That seems to be more satisfying way where you could feel you actually had done something creATIVE. So human is the creative, LLM is the burger flipping intern. >The opposite is what many people are trying rn. Make LLM to invent story (from premise, to creating outline to writing actual chapters) and the human to somehow assemble it from those pieces. So LLM is the creative man, and human is the floor polisher. >I can't believe a normal person would find it satisfying long term. >So in my view, the job of editor would be replaced by Ai, not the job of author. (Grammarly Score: 48) Output STRICT: >I see the future of writing being more about you writing the story any way you can and having an AI like LLM edit it and make it into a proper fiction. That seems to be a more satisfying way where you could feel you actually did something creative. So humans are the creative ones, while LLMs are the burger-flipping interns. > >On the other hand, many people are currently trying to do the exact opposite. They want to make LLMs create stories (from premises, to outlining, to writing entire chapters). And then they want humans to somehow piece them together from these parts. In this scenario, LLMs become the creative individuals, and humans become the floor polishers. > >I can't imagine a regular person finding that satisfying over the long run. > >In my opinion, the role of an editor will eventually be taken over by AI, not the role of an author. (Grammarly Score: 93) Output CREATIVE: >I see the future of writing being more focused on you writing the story any way you can and having an AI like GPT-3 edit it and turn it into a proper piece of fiction. This seems to be a more satisfying approach where you can truly feel that you have done something creative. In this scenario, humans remain the creative force, while the AI acts as the burger flipping intern. > >On the other hand, there are those who argue that we should let the AI generate stories from scratch - from coming up with a premise, to outlining the plot, to writing individual chapters. They believe that the role of the human should then become one of assembling these pieces together. In this case, the AI becomes the creative mind, and the human takes on the role of a floor polisher. > >I cannot imagine how someone could find this satisfying over the long term. Therefore, in my opinion, the job of the editor will eventually be taken over by AI, not the job of the author. (Grammarly Score: 83) # Conclusion After probably 10 different versions with subsequent changes, I can now say that the current model works reasonably well, with occasional (but often debatable) grammar misses. The limitations seem to be related to the 7B parameters. It appears that the size isn't sufficient to have a fine-grained understanding of various nuances of the input. This correlates with my other findings - the Mistral model performs quite well when generating its own text, but its comprehension is less than perfect, again related to only 7B parameters. The goal was to create a model that wouldn't change the style of the text. Often, LLM models, when asked to edit text, will attempt to rewrite the text even if the text is already fine. This proved to be quite challenging for such a small model where the main task was to determine the right balance between fixing the text (and not changing its style) and copying it verbatim. The strict model assumes that you're already a good writer that doesn't need hand-holding and that every word you've written you've meant.