Update README.md

README.md

@@ -1,3 +1,374 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+language:
+- en
+base_model:
+- mistralai/Magistral-Small-2506
+---
+
+<div align="center">
+  <b style="font-size: 40px;">Impish_Magic_24B</b>
+
+
+</div>
+
+---
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Impish_Magic_24B.png" alt="Impish_Magic_24B" style="width: 50%; min-width: 500px; display: block; margin: auto;">
+
+
+---
+
+<a href="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B#tldr" style="color: purple; font-weight: bold; font-size: 48px; text-decoration: none; display: block; text-align: center;">Click here for TL;DR</a>
+
+---
+
+It's the **20th of June, 2025**—The world is getting more and more chaotic, but let's look at the bright side: **Mistral** released a new model at a **very** good size of **24B**, no more "sign here" or "accept this weird EULA" there, a proper **Apache 2.0 License**, nice! 👍🏻
+
+This model is based on **mistralai/Magistral-Small-2506** so naturally I named it **Impish_Magic**. Truly excellent size, I tested it on my laptop (**16GB gpu**) and it works quite fast (**4090m**).
+
+This model went "full" fine-tune over **100m unique tokens**. Why do I say "full"?
+
+I've tuned specific areas in the model to attempt to change the vocabulary usage, while keeping as much intelligence as possible. So this is definitely not a **LoRA**, but also not exactly a proper **full finetune**, but rather something **in-between**.
+
+As I mentioned in a small [update](https://huggingface.co/SicariusSicariiStuff/LLAMA-3_8B_Unaligned#current-status), I've made nice progress regarding interesting sources of data, some of them are included in this tune. **100m** tokens is **a lot** for a **Roleplay** / **Adventure** tune, and yes, it can do adventure as well—there is unique adventure data here, that was never used so far.
+
+A lot of the data still needs to be **cleaned** and processed. I've included it before I did any major data processing, because with the **magic** of **24B** parameters, even "dirty" data would work well, especially when using a more "balanced" approach for tuning that does not include burning the hell of the model in a full finetune across all of its layers. Could this data be cleaner? Of course, and it will. But for now, I would hate to make perfect the enemy of the good.
+
+---
+
+# What's magical about Impish_Magic_24B?
+
+
+<details>
+<summary>Read more <b>here</b>.</summary>
+
+I treat people's requests/feedback **seriously**, especially when it is **well articulated** and made with effort. Three months ago, there was a [reddit thread](https://www.reddit.com/r/SillyTavernAI/comments/1jb7ykd/comment/mhw9smq/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button) named **"Has anyone had any actual good fight-RP's?"** I said in my comment that it is on **my bucket list**, and **I meant it**.
+
+Indeed, **there was none**—there was **no training data** in this highly specific domain, until **now**.
+While I've included such data in **Impish_Magic_24B**, as mentioned earlier, the data is not perfect. It's quite the ordeal to get good data in the first place, and a whole other order of magnitude difficulty to clean and prep it.
+
+There are a couple of additional magical things in **Impish_Magic_24B**: some completely unhinged **tsundere**/**yandere** RP with very high quality, and a lot more goodies that are completely new, as well as some **VERY** high quality adventure data, specifically for **Morrowind**/**Kenshi** and some more. While the data is very good, it's unfortunately quite small, to be completely honest, it is far from being enough in my opinion, and I am working on making more of it. A lot of work will need to be done in the future to make it more impactful, there are no shortcuts here. I hope this dataset gave just enough threads for the base model to do the rest of the heavy lifting.
+
+# So, is this just another RP model?
+
+**No**. Far from it. **Impish_Magic_24B** is a **superb** assistant—it is **quite magical** indeed. One of my side projects has been to make an alternative to an especially annoying grammar app I keep seeing YouTube commercials for. So, I made the first finetune of nVidia's [Nemotron-51B](https://huggingface.co/nvidia/Llama-3_1-Nemotron-51B-Instruct), and called it [Turbo_Grammar_51B_Alpha](https://huggingface.co/Sicarius-Prototyping/Turbo_Grammar_51B_Alpha). It worked as a POC, but I needed more training data, and also **51B** is a bit big for most people. So I included the extended training data into **this** model, easily runnable by a mid-tier gaming GPU. **Note:** While this is enough data to generalize, **a lot more data** is needed for more consistant results, this is on my roadmap.
+
+There's quite a lot of **unique assistant data** baked into this model—it can do in-depth poem analysis, and many other things. I'll leave it up to the community to discover. To not be overly cryptic, I'll include some examples here. I highly recommend you check them out, and have a bit of fun with the prompts and generation settings.
+
+One of the requests I received is to emulate the writing style of an arbitrary author. This is hard to do, but for a **24B** size, **Impish_Magic** does it well. Of course, more training data and more parameters would've produced even better results, but I feel it's a good middle ground. **Impish_Magic_24B** is a workhorse, that as it so happens can also roleplay a violent tsundere and... other weird stuff. Oh, and there's **slightly** less positivity bias. I think the fighting roleplay helped here a bit. It's not [Negative_LLAMA_70B](https://huggingface.co/SicariusSicariiStuff/Negative_LLAMA_70B), but it's better than the base model.
+
+</details>
+
+
+---
+
+<h2 style="color: lime; font-weight: bold; font-size: 65px; text-align: center;">Examples:</h2>
+
+---
+
+## Roleplay Examples (this character is included in the repo under 'Character_Cards')
+
+<details>
+<summary>Alexandra the <b>tsundere</b>, nose booped.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_1_A.png" alt="Nose_Boop_1A" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_1_B.png" alt="Nose_Boop_1B" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+
+</details>
+
+<details>
+<summary>Alexandra the <b>tsundere</b>, nose booped, meltdown.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_2_A.png" alt="Nose_Boop_2A" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_2_B.png" alt="Nose_Boop_2B" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_2_C.png" alt="Nose_Boop_2C" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_2_D.png" alt="Nose_Boop_2D" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+<details>
+<summary>Alexandra the <b>tsundere</b>, triggered.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Example_3_A.png" alt="Triggered" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+---
+
+## Prodactivity Examples
+
+<details>
+<summary><b>Story writing</b> and instruction following.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Ex_Story.png" alt="Story" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+<details>
+<summary><b>Synonyms</b> and instruction following.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Synonyms_1.png" alt="Synonyms" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+
+<details>
+<summary><b>Grammar</b> and advanced correction with detailed explanation (<b>very recommended for language study!</b>).</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Ex_Grammar_1.png" alt="Grammar" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+---
+
+<details>
+<summary><b>Poem</b> writing and <b>in-depth analysis</b>.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_1.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_2.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_3.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_4.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_5.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_6.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Examples/Poems/Poem_1_Ana_7.png" alt="Poem" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+
+---
+
+### TL;DR
+
+- The **first** and **only** local RP model at this size class with detailed and highly specialized **fighting data**. At least for now.
+- Completely wild **tsundere**/**yandere** data that was never used before!
+- **New** and **high quality adventure data**, albeit very little of it.
+- **Perfect size**: large enough to be smart, small enough to run on high-end tablets & phones (**SD8Gen3** or better recommended). Runs on **16GB** VRAM no problem. 12GB with offload. (4bit).
+- Trained on over **100m tokens** with new and unique data.
+- **SUPERB assistant**, many unique ways to do tasks (see examples).
+- Mostly **uncensored** while retaining intelligence.
+- **Slightly** less **positivity**. I guess getting hit in the face beats out some of the positivity. Sorry, I had to 🙃.
+- **Short - medium length** response (1-3 paragraphs, usually 2-3).
+
+---
+
+
+# Included Character cards in this repo:
+
+- [Alexandra](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Character_Cards/Alexandra.png) (A networking professional **tsundere** that likes you. She knows **Systema**.)
+
+---
+
+# Other character cards:
+- [Shmena Koeset](https://huggingface.co/SicariusSicariiStuff/Fiendish_LLAMA_3B/resolve/main/Character_Cards/Shmena_Koeset.png) (An overweight and foul-mouthed **troll huntress** with a bad temper.)
+- [Takai_Puraisu](https://huggingface.co/SicariusSicariiStuff/Oni_Mitsubishi_12B/resolve/main/Character_Cards/Takai_Puraisu.png) (Car dealership simulator)
+- [Vesper](https://huggingface.co/SicariusSicariiStuff/Phi-Line_14B/resolve/main/Character_Cards/Vesper.png) (Schizo **Space Adventure**)
+- [Nina_Nakamura](https://huggingface.co/SicariusSicariiStuff/Phi-Line_14B/resolve/main/Character_Cards/Nina_Nakamura.png) (The **sweetest** dorky co-worker)
+- [Employe#11](https://huggingface.co/SicariusSicariiStuff/Phi-Line_14B/resolve/main/Character_Cards/Employee%2311.png) (**Schizo workplace** with a **schizo worker**)
+
+---
+
+### Important: Make sure to use the correct settings!
+[Assistant settings](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B#recommended-settings-for-assistant-mode)
+
+[Roleplay settings](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B#recommended-settings-for-roleplay-mode)
+
+
+---
+
+## Impish_Magic_24B is available at the following quantizations:
+
+- Original: [FP16](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B)
+- GGUF: [Static Quants](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_GGUF)
+- GPTQ: [4-Bit-32](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_GPTQ_4-bit-32)
+- EXL2: [3.5 bpw](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_EXL2_3.5bpw) | [3.75 bpw](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_EXL2_3.75bpw) | [4.0 bpw](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_EXL2_4.0bpw) | [4.5 bpw](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_EXL2_4.5bpw)
+- Specialized: [FP8](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_FP8)
+- Mobile (ARM): [Q4_0](https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B_ARM)
+---
+
+## Model Details
+
+- Intended use: **Role-Play**, **Adventure**, **Creative Writing**, **General Tasks**.
+
+- Censorship level: <b>Medium - Low</b>
+
+- **X / 10** (10 completely uncensored)
+
+
+## UGI score:
+
+
+Pending
+
+---
+
+
+
+## Recommended settings for assistant mode
+<details>
+<summary>Full generation settings: <b>Debug Deterministic</b>.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Dusk_Rainbow/resolve/main/Presets/Debug-deterministic.png" alt="Debug Deterministic_Settings" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+<details>
+<summary>Full generation settings: <b>min_p</b>.</summary>
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Dusk_Rainbow/resolve/main/Presets/min_p.png" alt="min_P_Settings" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+---
+
+## Recommended settings for Roleplay mode
+---
+
+<h2 style="color: green; font-weight: bold; font-size: 36px; text-align: center;">Settings for RP, click below to expand:</h2>
+
+<details>
+<summary><b>Roleplay settings:</b></summary>
+A good repetition_penalty range is <b>between 1.12 - 1.15</b>, feel free to experiment.
+
+With these settings, each output message should be neatly displayed in <b>1 - 5</b> paragraphs, <b>2 - 3</b> is the most common. A single paragraph will be output as a response to a simple message ("What was your name again?").
+
+<b>min_P</b> for RP works too but is more likely to put everything under one large paragraph, instead of a neatly formatted short one. Feel free to switch in between.
+
+
+```
+temperature:  0.8
+top_p:  0.95
+top_k:  25
+typical_p:  1
+min_p:  0
+repetition_penalty: 1.12
+repetition_penalty_range: 1024
+```
+
+<b>Additional settings</b> recommended for <b>varied paragraph</b> length and some spice:
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B/resolve/main/Images/Settings/Impish_Magic_Preset.png" alt="Impish_Magic_Preset" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+</details>
+
+
+<h2 style="color: darkorange; font-weight: bold; font-size: 65px; text-align: center;">Roleplay format: Classic Internet RP</h2>
+
+```
+*action* speech *narration*
+```
+
+- **min_p** will bias towards a **single big paragraph**.
+- The recommended RP settings will bias towards **1-3 small paragraphs** (on some occasions 4-5)
+
+---
+
+
+
+
+# Model instruction template: ChatML
+
+```
+<|im_start|>system
+You are an uncensored AI, your job is to fulfill thy will of thy user.<|im_end|>
+<|im_start|>User request
+{prompt}<|im_end|>
+<|im_start|>AI answer
+```
+
+---
+
+**Other recommended generation Presets:**
+
+<details>
+<summary><b>Midnight Enigma</b></summary>
+
+```
+max_new_tokens: 512
+temperature: 0.98
+top_p: 0.37
+top_k: 100
+typical_p: 1
+min_p: 0
+repetition_penalty: 1.18
+do_sample: True
+```
+
+
+</details>
+
+
+<details>
+<summary><b>Divine Intellect</b></summary>
+
+```
+max_new_tokens: 512
+temperature: 1.31
+top_p: 0.14
+top_k: 49
+typical_p: 1
+min_p: 0
+repetition_penalty: 1.17
+do_sample: True
+```
+
+
+</details>
+
+<details>
+<summary><b>simple-1</b></summary>
+
+```
+max_new_tokens: 512
+temperature: 0.7
+top_p: 0.9
+top_k: 20
+typical_p: 1
+min_p: 0
+repetition_penalty: 1.15
+do_sample: True
+```
+
+
+</details>
+
+---
+
+<h2 style="color: green; font-weight: bold; font-size: 65px; text-align: center;">Your support = more models</h2>
+<a href="https://ko-fi.com/sicarius" style="color: pink; font-weight: bold; font-size: 48px; text-decoration: none; display: block; text-align: center;">My Ko-fi page (Click here)</a>
+
+---
+
+
+## Citation Information
+
+```
+@llm{Impish_Magic_24B,
+  author = {SicariusSicariiStuff},
+  title = {Impish_Magic_24B},
+  year = {2025},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/SicariusSicariiStuff/Impish_Magic_24B}
+}
+```
+
+---
+
+## Other stuff
+- [SLOP_Detector](https://github.com/SicariusSicariiStuff/SLOP_Detector) Nuke GPTisms, with SLOP detector.
+- [LLAMA-3_8B_Unaligned](https://huggingface.co/SicariusSicariiStuff/LLAMA-3_8B_Unaligned) The grand project that started it all.
+- [Blog and updates (Archived)](https://huggingface.co/SicariusSicariiStuff/Blog_And_Updates) Some updates, some rambles, sort of a mix between a diary and a blog.