Upload README.md

README.md

@@ -0,0 +1,146 @@
+---
+datasets:
+- Fredithefish/openassistant-guanaco-unfiltered
+inference: false
+language:
+- en
+library_name: transformers
+license: apache-2.0
+model_creator: Fredithefish
+model_link: https://huggingface.co/Fredithefish/Guanaco-3B-Uncensored-v2
+model_name: Guanaco 3B Uncensored v2
+model_type: gpt-neox
+pipeline_tag: conversational
+quantized_by: TheBloke
+---
+
+<!-- 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 -->
+
+# Guanaco 3B Uncensored v2 - GGML
+- Model creator: [Fredithefish](https://huggingface.co/Fredithefish)
+- Original model: [Guanaco 3B Uncensored v2](https://huggingface.co/Fredithefish/Guanaco-3B-Uncensored-v2)
+
+## Description
+
+This repo contains GPT-NeoX GGML format model files for [Fredithefish's Guanaco 3B Uncensored v2](https://huggingface.co/Fredithefish/Guanaco-3B-Uncensored-v2).
+
+Please note that these GGMLs are **not compatible with llama.cpp, text-generation-webui or llama-cpp-python**. Please see below for a list of tools that work with this GGML model.
+
+## Repositories available
+
+* [GPTQ models for GPU inference, with multiple quantisation parameter options.](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GPTQ)
+* [2, 3, 4, 5, 6 and 8-bit GGML models for CPU+GPU inference (deprecated)](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GGML)
+* [Fredithefish's original unquantised fp16 model in pytorch format, for GPU inference and for further conversions](https://huggingface.co/Fredithefish/Guanaco-3B-Uncensored-v2)
+
+## Prompt template: Guanaco
+
+```
+### Human: {prompt}
+### Assistant:
+
+```
+
+<!-- compatibility_ggml start -->
+## Compatibilty
+
+These files are **not** compatible with llama.cpp, text-generation-webui or llama-cpp-python.
+
+They can be used with:
+* [KoboldCpp](https://github.com/LostRuins/koboldcpp), a powerful inference engine based on llama.cpp with full GPU acceleration and good UI.
+* [LM Studio](https://lmstudio.ai/), a fully featured local GUI for GGML inference on Windows and macOS.
+* [LoLLMs-WebUI](https://github.com/ParisNeo/LoLLMs-WebUI) a web UI which supports nearly every backend out there. Use ctransformers backend for support for this model.
+* [ctransformers](https://github.com/marella/ctransformers): for use in Python code, including LangChain support.
+* [rustformers' llm](https://github.com/rustformers/llm)
+* The example `gpt-neox` binary provided with [ggml](https://github.com/ggerganov/ggml)
+
+As other options become available I will endeavour to update them here (do let me know in the Community tab if I've missed something!)
+
+## Tutorial for using LoLLMs-WebUI:
+
+* [Video tutorial, by LoLLMs-WebUI's author **ParisNeo**](https://youtu.be/vBU1b5n0GMU)
+<!-- compatibility_ggml end -->
+
+## Provided files
+| Name | Quant method | Bits | Size | Max RAM required | Use case |
+| ---- | ---- | ---- | ---- | ---- | ----- |
+| [guanaco-3b-uncensored-v2.ggmlv1.q4_0.bin](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GGML/blob/main/guanaco-3b-uncensored-v2.ggmlv1.q4_0.bin) | q4_0 | 4 | 1.57 GB| 4.07 GB | 4-bit. |
+| [guanaco-3b-uncensored-v2.ggmlv1.q4_1.bin](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GGML/blob/main/guanaco-3b-uncensored-v2.ggmlv1.q4_1.bin) | q4_1 | 4 | 1.74 GB| 4.24 GB | 4-bit. Higher accuracy than q4_0 but not as high as q5_0. However has quicker inference than q5 models. |
+| [guanaco-3b-uncensored-v2.ggmlv1.q5_0.bin](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GGML/blob/main/guanaco-3b-uncensored-v2.ggmlv1.q5_0.bin) | q5_0 | 5 | 1.91 GB| 4.41 GB | 5-bit. Higher accuracy, higher resource usage and slower inference. |
+| [guanaco-3b-uncensored-v2.ggmlv1.q5_1.bin](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GGML/blob/main/guanaco-3b-uncensored-v2.ggmlv1.q5_1.bin) | q5_1 | 5 | 2.09 GB| 4.59 GB | 5-bit. Even higher accuracy, resource usage and slower inference. |
+| [guanaco-3b-uncensored-v2.ggmlv1.q8_0.bin](https://huggingface.co/TheBloke/Guanaco-3B-Uncensored-v2-GGML/blob/main/guanaco-3b-uncensored-v2.ggmlv1.q8_0.bin) | q8_0 | 8 | 2.95 GB| 5.45 GB | 8-bit. Almost indistinguishable from float16. High resource use and slow. Not recommended for most users. |
+
+**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.
+
+<!-- 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**: Russ Johnson, J, alfie_i, Alex, NimbleBox.ai, Chadd, Mandus, Nikolai Manek, Ken Nordquist, ya boyyy, Illia Dulskyi, Viktor Bowallius, vamX, Iucharbius, zynix, Magnesian, Clay Pascal, Pierre Kircher, Enrico Ros, Tony Hughes, Elle, Andrey, knownsqashed, Deep Realms, Jerry Meng, Lone Striker, Derek Yates, Pyrater, Mesiah Bishop, James Bentley, Femi Adebogun, Brandon Frisco, SuperWojo, Alps Aficionado, Michael Dempsey, Vitor Caleffi, Will Dee, Edmond Seymore, usrbinkat, LangChain4j, Kacper Wikieł, Luke Pendergrass, John Detwiler, theTransient, Nathan LeClaire, Tiffany J. Kim, biorpg, Eugene Pentland, Stanislav Ovsiannikov, Fred von Graf, terasurfer, Kalila, Dan Guido, Nitin Borwankar, 阿明, Ai Maven, John Villwock, Gabriel Puliatti, Stephen Murray, Asp the Wyvern, danny, Chris Smitley, ReadyPlayerEmma, S_X, Daniel P. Andersen, Olakabola, Jeffrey Morgan, Imad Khwaja, Caitlyn Gatomon, webtim, Alicia Loh, Trenton Dambrowitz, Swaroop Kallakuri, Erik Bjäreholt, Leonard Tan, Spiking Neurons AB, Luke @flexchar, Ajan Kanaga, Thomas Belote, Deo Leter, RoA, Willem Michiel, transmissions 11, subjectnull, Matthew Berman, Joseph William Delisle, David Ziegler, Michael Davis, Johann-Peter Hartmann, Talal Aujan, senxiiz, Artur Olbinski, Rainer Wilmers, Spencer Kim, Fen Risland, Cap'n Zoog, Rishabh Srivastava, Michael Levine, Geoffrey Montalvo, Sean Connelly, Alexandros Triantafyllidis, Pieter, Gabriel Tamborski, Sam, Subspace Studios, Junyu Yang, Pedro Madruga, Vadim, Cory Kujawski, K, Raven Klaugh, Randy H, Mano Prime, Sebastain Graf, Space Cruiser
+
+
+Thank you to all my generous patrons and donaters!
+
+And thank you again to a16z for their generous grant.
+
+<!-- footer end -->
+
+# Original model card: Fredithefish's Guanaco 3B Uncensored v2
+
+
+<img src="https://huggingface.co/Fredithefish/Guanaco-3B-Uncensored/resolve/main/Guanaco-Uncensored.jpg" alt="Alt Text" width="295"/>
+
+# ✨ Guanaco - 3B - Uncensored ✨
+
+
+Guanaco-3B-Uncensored has been fine-tuned for 6 epochs on the [Unfiltered Guanaco Dataset.](https://huggingface.co/datasets/Fredithefish/openassistant-guanaco-unfiltered) using [RedPajama-INCITE-Base-3B-v1](https://huggingface.co/togethercomputer/RedPajama-INCITE-Base-3B-v1) as the base model.
+<br>The model does not perform well with languages other than English.
+<br>Please note: This model is designed to provide responses without content filtering or censorship. It generates answers without denials.
+
+## Special thanks
+I would like to thank AutoMeta for providing me with the computing power necessary to train this model.
+
+
+### Prompt Template
+```
+### Human: {prompt} ### Assistant:
+```
+
+### Changes
+This is the second version of the 3B parameter Guanaco uncensored model.
+The model has been fine-tuned on the V2 of the Guanaco unfiltered dataset.