Update README.md

README.md

@@ -111,6 +111,83 @@ model-index:
 This model was converted to GGUF format from [`invisietch/MiS-Firefly-v0.2-22B`](https://huggingface.co/invisietch/MiS-Firefly-v0.2-22B) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
 Refer to the [original model card](https://huggingface.co/invisietch/MiS-Firefly-v0.2-22B) for more details on the model.
 
+---
+Model details:
+-
+This is a fix for the quantization issue in Firefly v0.1.
+
+Firefly is a Mistral Small 22B finetune designed for creative writing and roleplay. The model is largely uncensored and should support context up to 32,768 tokens.
+
+The model has been tested in various roleplay scenarios up to 16k context, as well as in a role as an assistant. It shows a broad competency & coherence across various scenarios.
+
+Special thanks to SicariusSicariiStuff for bouncing ideas back & forth on training, and SytanSD for quants.
+
+Feedback
+-
+I appreciate all feedback on any of my models, you can use:
+
+    My Discord server - requires Discord.
+    The Community tab - requires HF login.
+    Discord DMs to invisietch.
+
+Your feedback is how I improve these models for future versions.
+
+Disclaimer
+-
+This model is extensively uncensored. It can generate explicit, disturbing or offensive responses. Use responsibly. I am not responsible for your use of this model.
+
+This model is a finetune of Mistral Small 22B (2409) and usage must follow the terms of Mistral's license. By downloading this model, you agree not to use it for commercial purposes unless you have a valid Mistral commercial license. See the base model card for more details.
+
+Prompting Format
+-
+I'd recommend Mistral v2 & v3 prompting format:
+
+<s>[INST] User message here.[/INST] Bot response here</s>[INST] User message 2 here.[/INST]
+
+If you're using SillyTavern, make sure the story string is set correctly to Mistral v2 & v3 (not v3 Tekken):
+
+[INST] {{#if system}}{{system}}
+{{/if}}{{#if wiBefore}}{{wiBefore}}
+{{/if}}{{#if description}}{{description}}
+{{/if}}{{#if personality}}{{personality}}
+{{/if}}{{#if scenario}}{{scenario}}
+{{/if}}{{#if wiAfter}}{{wiAfter}}
+{{/if}}{{#if persona}}{{persona}}
+{{/if}}{{trim}}[/INST] Understood.</s>
+
+The model seems very sensitive to wrong prompting formats.
+
+Sampler Settings
+-
+I'm running the following sampler settings but this is an RC and they may not be optimal.
+
+    Temperature: 1
+    Min-P: 0.1
+    Rep Pen: 1.08
+    Rep Pen Range: 1536
+    XTC: 0.1/0.15
+
+If you get completely incoherent responses, feel free to use these as a starting point.
+
+High temperature settings (above 1) tend to create less coherent responses.
+
+Training Strategy
+-
+I started with a finetune of Mistral Small 22B which had been trained on the Gutenberg dataset: nbeerbower/Mistral-Small-Gutenberg-Doppel-22B.
+
+The first stage of my training was a single epoch at low LR over a 474 million token text completion dataset.
+
+I followed this up with a coherence, decensorship & roleplay finetune over a 172 million token instruct dataset over two epochs.
+
+I did a slerp merge of epoch 1 into epoch 2 at a light weight which resolved the name-spelling issues on quantized versions of Firefly v0.1.
+
+Total training time was about 32hrs on 4x Nvidia A100 80GB.
+
+Built with Axolotl 
+
+# [Open LLM Leaderboard Evaluation Results](https://huggingface.co/spaces/open-llm-leaderboard/open_llm_leaderboard) Detailed results can be found [here](https://huggingface.co/datasets/open-llm-leaderboard/details_invisietch__MiS-Firefly-v0.2-22B) 
+
+---
 ## Use with llama.cpp
 Install llama.cpp through brew (works on Mac and Linux)