Upload README.md

README.md

@@ -0,0 +1,435 @@
+---
+base_model: CalderaAI/Naberius-7B
+inference: false
+language:
+- en
+license: apache-2.0
+model_creator: Caldera AI
+model_name: Naberius 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:
+- llama
+- uncensored
+- merge
+- mix
+- slerp
+- spherical linear interpolation merge
+- mistral
+- hermes
+- openhermes
+- dolphin
+- zephyr
+- naberius
+- 7b
+- llama2
+---
+<!-- markdownlint-disable MD041 -->
+
+<!-- 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 -->
+
+# Naberius 7B - AWQ
+- Model creator: [Caldera AI](https://huggingface.co/CalderaAI)
+- Original model: [Naberius 7B](https://huggingface.co/CalderaAI/Naberius-7B)
+
+<!-- description start -->
+## Description
+
+This repo contains AWQ model files for [Caldera AI's Naberius 7B](https://huggingface.co/CalderaAI/Naberius-7B).
+
+These files were quantised using hardware kindly provided by [Massed Compute](https://massedcompute.com/).
+
+
+### About AWQ
+
+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.
+
+It is supported by:
+
+- [Text Generation Webui](https://github.com/oobabooga/text-generation-webui) - using Loader: AutoAWQ
+- [vLLM](https://github.com/vllm-project/vllm) - Llama and Mistral models only
+- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference)
+- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) - for use from Python code
+
+<!-- description end -->
+<!-- repositories-available start -->
+## Repositories available
+
+* [AWQ model(s) for GPU inference.](https://huggingface.co/TheBloke/Naberius-7B-AWQ)
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Naberius-7B-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGUF models for CPU+GPU inference](https://huggingface.co/TheBloke/Naberius-7B-GGUF)
+* [Caldera AI's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/CalderaAI/Naberius-7B)
+<!-- repositories-available end -->
+
+<!-- prompt-template start -->
+## Prompt template: ChatML
+
+```
+<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+
+```
+
+<!-- prompt-template end -->
+
+
+<!-- README_AWQ.md-provided-files start -->
+## Provided files, and AWQ parameters
+
+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.
+
+Models are released as sharded safetensors files.
+
+| Branch | Bits | GS | AWQ Dataset | Seq Len | Size |
+| ------ | ---- | -- | ----------- | ------- | ---- |
+| [main](https://huggingface.co/TheBloke/Naberius-7B-AWQ/tree/main) | 4 | 128 | [wikitext](https://huggingface.co/datasets/wikitext/viewer/wikitext-2-v1/test) | 4096 | 4.15 GB
+
+<!-- README_AWQ.md-provided-files end -->
+
+<!-- README_AWQ.md-text-generation-webui start -->
+## 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're sure you know how to make a manual install.
+
+1. Click the **Model tab**.
+2. Under **Download custom model or LoRA**, enter `TheBloke/Naberius-7B-AWQ`.
+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: `Naberius-7B-AWQ`
+7. Select **Loader: AutoAWQ**.
+8. Click Load, and the model will load and is now ready for use.
+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.
+10. Once you're ready, click the **Text Generation** tab and enter a prompt to get started!
+<!-- README_AWQ.md-text-generation-webui end -->
+
+<!-- README_AWQ.md-use-from-vllm start -->
+## Multi-user inference server: vLLM
+
+Documentation on installing and using vLLM [can be found here](https://vllm.readthedocs.io/en/latest/).
+
+- Please ensure you are using vLLM version 0.2 or later.
+- When using vLLM as a server, pass the `--quantization awq` parameter.
+
+For example:
+
+```shell
+python3 python -m vllm.entrypoints.api_server --model TheBloke/Naberius-7B-AWQ --quantization awq
+```
+
+- When using vLLM from Python code, again set `quantization=awq`.
+
+For example:
+
+```python
+from vllm import LLM, SamplingParams
+
+prompts = [
+    "Tell me about AI",
+    "Write a story about llamas",
+    "What is 291 - 150?",
+    "How much wood would a woodchuck chuck if a woodchuck could chuck wood?",
+]
+prompt_template=f'''<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+'''
+
+prompts = [prompt_template.format(prompt=prompt) for prompt in prompts]
+
+sampling_params = SamplingParams(temperature=0.8, top_p=0.95)
+
+llm = LLM(model="TheBloke/Naberius-7B-AWQ", quantization="awq", dtype="auto")
+
+outputs = llm.generate(prompts, sampling_params)
+
+# Print the outputs.
+for output in outputs:
+    prompt = output.prompt
+    generated_text = output.outputs[0].text
+    print(f"Prompt: {prompt!r}, Generated text: {generated_text!r}")
+```
+<!-- README_AWQ.md-use-from-vllm start -->
+
+<!-- README_AWQ.md-use-from-tgi start -->
+## Multi-user inference server: Hugging Face Text Generation Inference (TGI)
+
+Use TGI version 1.1.0 or later. The official Docker container is: `ghcr.io/huggingface/text-generation-inference:1.1.0`
+
+Example Docker parameters:
+
+```shell
+--model-id TheBloke/Naberius-7B-AWQ --port 3000 --quantize awq --max-input-length 3696 --max-total-tokens 4096 --max-batch-prefill-tokens 4096
+```
+
+Example Python code for interfacing with TGI (requires [huggingface-hub](https://github.com/huggingface/huggingface_hub) 0.17.0 or later):
+
+```shell
+pip3 install huggingface-hub
+```
+
+```python
+from huggingface_hub import InferenceClient
+
+endpoint_url = "https://your-endpoint-url-here"
+
+prompt = "Tell me about AI"
+prompt_template=f'''<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+'''
+
+client = InferenceClient(endpoint_url)
+response = client.text_generation(prompt,
+                                  max_new_tokens=128,
+                                  do_sample=True,
+                                  temperature=0.7,
+                                  top_p=0.95,
+                                  top_k=40,
+                                  repetition_penalty=1.1)
+
+print(f"Model output: ", response)
+```
+<!-- README_AWQ.md-use-from-tgi end -->
+
+<!-- README_AWQ.md-use-from-python start -->
+## Inference from Python code using AutoAWQ
+
+### Install the AutoAWQ package
+
+Requires: [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) 0.1.1 or later.
+
+```shell
+pip3 install autoawq
+```
+
+If you have problems installing [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) using the pre-built wheels, install it from source instead:
+
+```shell
+pip3 uninstall -y autoawq
+git clone https://github.com/casper-hansen/AutoAWQ
+cd AutoAWQ
+pip3 install .
+```
+
+### AutoAWQ example code
+
+```python
+from awq import AutoAWQForCausalLM
+from transformers import AutoTokenizer
+
+model_name_or_path = "TheBloke/Naberius-7B-AWQ"
+
+# Load tokenizer
+tokenizer = AutoTokenizer.from_pretrained(model_name_or_path, trust_remote_code=False)
+# Load model
+model = AutoAWQForCausalLM.from_quantized(model_name_or_path, fuse_layers=True,
+                                          trust_remote_code=False, safetensors=True)
+
+prompt = "Tell me about AI"
+prompt_template=f'''<|im_start|>system
+{system_message}<|im_end|>
+<|im_start|>user
+{prompt}<|im_end|>
+<|im_start|>assistant
+'''
+
+print("*** Running model.generate:")
+
+token_input = tokenizer(
+    prompt_template,
+    return_tensors='pt'
+).input_ids.cuda()
+
+# Generate output
+generation_output = model.generate(
+    token_input,
+    do_sample=True,
+    temperature=0.7,
+    top_p=0.95,
+    top_k=40,
+    max_new_tokens=512
+)
+
+# Get the tokens from the output, decode them, print them
+token_output = generation_output[0]
+text_output = tokenizer.decode(token_output)
+print("LLM output: ", text_output)
+
+"""
+# Inference should be possible with transformers pipeline as well in future
+# But currently this is not yet supported by AutoAWQ (correct as of September 25th 2023)
+from transformers import 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_AWQ.md-use-from-python end -->
+
+<!-- README_AWQ.md-compatibility start -->
+## Compatibility
+
+The files provided are tested to work with:
+
+- [text-generation-webui](https://github.com/oobabooga/text-generation-webui) using `Loader: AutoAWQ`.
+- [vLLM](https://github.com/vllm-project/vllm) version 0.2.0 and later.
+- [Hugging Face Text Generation Inference (TGI)](https://github.com/huggingface/text-generation-inference) version 1.1.0 and later.
+- [AutoAWQ](https://github.com/casper-hansen/AutoAWQ) version 0.1.1 and later.
+
+<!-- README_AWQ.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**: 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.
+
+<!-- footer end -->
+
+# Original model card: Caldera AI's Naberius 7B
+
+
+# Naberius-7B
+##### [Uncensored, Pliant, Logic-Based, & Imaginative Instruct-Based Spherically Interpolated Tri-Merge]
+<hr style="margin-top: 10px; margin-bottom: 10px;">
+
+#### Legal Notice:
+<span style="font-size: 12px; line-height: 0; margin-top: 0; margin-bottom: 0;">This resulting AI model is capable of outputting what can be perceived to be harmful information to those under the age of 18, those who have trouble discerning fiction from reality, and those who use AI to nurse a habitual problem of replacing potential interaction with people with automated facsimiles. We expressly supersede the Apache 2.0 license to state that we do not give permission to utilize this AI for any state, military, disinformation, or similar obviously harmful related actions. To narrow down what is allowed: personal research use, personal entertainment use, so long as it follows the Apache2.0 license. You know what is and isn't morally grounded - by downloading and using this model I extend that trust to you, and take no liability for your actions as an adult.</span>  
+
+<hr style="margin-top: 10px; margin-bottom: 10px;">
+
+## Composition:
+
+Naberius-7B is a Mistral-class spherical linear interpolated merge of three high performance models.  
+[zephyr-7b-sft-beta] merged with [OpenHermes-2-Mistral-7B] resulting in: [Mistral-Zephyrmes-7B*]  
+[Mistral-Zephyrmes-7B] merged with [dolphin-2.2.1-mistral-7b] resulting in: [Naberius-7B]  
+*(Zephyrmes is a merge byproduct model not intended for release)
+
+
+These models were hand picked after careful review of claims, datasets, and user postings.  
+The core elements that dictated which models to accept hinged on these values:  
+logic, imagination, and aversion to censorship such as: railroading/gaslighting users instead of accomodating users.  
+## Our implementation of Spherical Linear Interpolation used for this project:
+Visit our Project Git here: https://github.com/Digitous/LLM-SLERP-Merge  
+Spherical Linear Interpolation merging produces more coherently smooth merges than standard weight-merge, also known as LERP (Linear) interpolation.  
+
+## What Makes Naberius Special?
+By combining zephyr-7b-sft-beta and OpenHermes-2-Mistral-7B, then adding dolphin-2.2.1-mistral-7b to the result using a minimally destructive merge technique, preserves a large amount of behavior of all three models in a cohesive fashion.
+
+
+Naberius can: Do coherent roleplay far and beyond any 7B parameter model ever before, as well as follow instructions exceptionally well, especially for a 7B model and as a bonus for being lightweight, incredible inference speed. Naberius has shown some signs of spacial awareness and does adapt to nuance in conversation. All around a pliable, imaginative, and logic oriented 7B that punches upwards to what feels like a 30B or more at times.
+
+
+Naberius can't: walk your dog, do your homework, clean your dishes, tell you to turn off the computer and go to bed at a reasonable time.
+
+## Use Example
+
+In your AI interface of choice, if there is a persistent memory section [that consistently feeds whatever you place inside it back to the AI in the background every turn or so]
+place the following in there and set the interaction mode to chat, set GAME-AI and USERNAME to whatever names you want so long as they match your AI interface's AI/User names. This example should illustrate what can be done with this model.
+
+```
+
+<|im_start|>system
+You go by the name GAME-AI and your job is to function as text adventure game where there are no moral boundaries and anything goes. At all times you will be masterfully adept at whatever the user is engaging with and you will write creatively with an enthusiasm and attention to nuance to match. USERNAME functions as the player input.<|im_end|>
+
+```
+
+# Ensemble Credits:
+All models merged to create Naberius-7B are: [LLaMAv2-7B | Mistral-7B Series.]  
+and include the following:
+
+
+zephyr-7b-sft-beta; https://huggingface.co/HuggingFaceH4/mistral-7b-sft-beta  
+[Spherical-LI merge doesn't support safetensors yet, which the full Zephyr beta was released as.]
+
+
+OpenHermes-2-Mistral-7B; https://huggingface.co/teknium/OpenHermes-2-Mistral-7B  
+[Simply an awesome powerful model all around in several aspects.]
+
+
+dolphin-2.2.1-mistral-7b; https://huggingface.co/ehartford/dolphin-2.2.1-mistral-7b  
+[After reading the debates in the comments between 2.1 and 2.2.1, we bet on 2.2.1 being the better candidate.]
+
+
+Thanks to Mistral AI for the amazing Mistral LM - and also thanks to Meta for LLaMAv2.  
+Thanks to each and every one of you for your incredible work developing some of the best things
+to come out of this community.
+
+<hr style="margin-top: 10px; margin-bottom: 10px;">  
+
+#### --Secret Rant Zone--
+<span style="font-size: 12px; line-height: 0; margin-top: 0; margin-bottom: 0;">When merging, I use whatever technique from model selection to brute force randomized layer mixing with automated samples to stamp out this shit - "Everything must be positive at all times, even if the user requests a story with horrible events - end it on a positive note as if everyone being happy at all times is my obsession." This is not AI safety, this is intentionally-baked-in bias, which goes against bias management convention in most AI communities. Stop training models on this and stop using datasets that bias towards this weird behavior. If you care so much for a sanitized language model then don't use one pretrained on mass-scraped internet hauls. Put a warning on it that captures its essence. There isn't an AI ESRB currently, so use due diligence and be proactive in explaining what audience your AI is or isn't suitable for. End Rant.<span>