Update README.md

README.md

@@ -1,3 +1,264 @@
----
-license: llama3.2
----
+---
+license: llama3.2
+language:
+- en
+base_model:
+- meta-llama/Llama-3.2-1B-Instruct
+---
+
+<div align="center">
+  <b style="font-size: 40px;">Nano_Imp_1B</b>
+
+
+</div>
+
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B/resolve/main/Images/Nano_Imp_1B.png" alt="Nano_Imp_1B" style="width: 50%; min-width: 500px; display: block; margin: auto;">
+
+
+---
+
+<a href="https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B#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 **10th of May, 2025**—lots of progress is being made in the world of AI (DeepSeek, Qwen, etc...)—but still, there has yet to be a fully coherent **1B RP model**. Why?
+
+Well, at **1B size**, the mere fact a model is even coherent is some kind of a marvel—and getting it to roleplay feels like you're asking too much from 1B parameters. Making very small yet smart models is quite hard, making one that does RP is exceedingly hard. I should know.
+
+I've made the world's first **3B roleplay** model—[Impish_LLAMA_3B](https://huggingface.co/SicariusSicariiStuff/Impish_LLAMA_3B)—and I thought that this was the absolute minimum size for coherency and RP capabilities. I was **wrong.**
+
+One of my stated goals was to make AI accessible and available for everyone—but not everyone could run **13B** or even **8B** models. Some people only have mid-tier phones, should they be left behind?
+
+A growing sentiment often says something along the lines of:
+> If your waifu runs on someone else's hardware—then she's not your waifu.
+
+I'm not an expert in waifu culture, but I do agree that people should be able to run models locally, without their data (knowingly or unknowingly) being used for X or Y.
+
+I thought my goal of making a roleplay model that everyone could run would only be realized sometime in the future—when mid-tier phones got the equivalent of a high-end Snapdragon chipset. Again I was wrong, as this changes **today.**
+
+---
+
+Today, the 10th of May 2025, I proudly present to you—**Nano_Imp_1B**, the world's first and **only** fully coherent **1B-parameter roleplay model**.
+
+---
+
+## Example dialogue (3-shot):
+
+<img src="https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B/resolve/main/Images/Example.png" alt="Nano_Imp_1B_Example" style="width: 100%; min-width: 700px; display: block; margin: auto;">
+
+---
+
+# Included Character cards in this repo:
+
+- [Nano_Imp](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B/resolve/main/Character_Cards/Nano_Imp.png) (A shrunken palm-sized hellspawn who wants your soul)
+
+---
+
+# Other character cards:
+
+- [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**)
+- [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.)
+- [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**)
+
+---
+
+### TL;DR
+- **The first and only 1B RP model in the world**.
+- Runs on anything. Don't have a GPU, and got an old CPU from 10 years ago instead? **It can run Nano_Imp_1B**.
+- **Short length** response (1-2 paragraphs, usually 1), CAI style.
+- Surprisngly coherent, the need of swipes is **inveitable** though.
+- **quite good** at following the **character card**, this assumes sane generation settings, and once it **picked up the formatting**- this is **important**. Try the included characters if you're having sub-optimal results.
+
+### Important: Make sure to use the correct settings!
+[Assistant settings](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B#recommended-settings-for-assistant-mode)
+
+[Roleplay settings](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B#recommended-settings-for-roleplay-mode)
+
+
+---
+
+## Nano_Imp_1B is available at the following quantizations:
+
+- Original: [FP16](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B)
+- GGUF: [GGUF](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B_GGUF)
+- GPTQ: [4-Bit-32](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B_GPTQ-4-bit-32)
+- Specialized: [FP8](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B_FP8)
+- Mobile (ARM): [Q4_0](https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B_ARM)
+---
+
+## Model Details
+
+- Intended use: **Role-Play**, **Basic** Creative Writing, **Basic** General Tasks.
+
+- Censorship level: <b>Medium</b>
+
+- **4.5 / 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.
+
+<b>(Open the image in a new window to better see the full details)</b>
+<img src="https://huggingface.co/SicariusSicariiStuff/Oni_Mitsubishi_12B/resolve/main/Presets/Oni_Mitsubishi_12B_RP.png" alt="Oni_Mitsubishi_12B_Settings" style="width: 100%; min-width: 600px; display: block; margin: auto;">
+
+
+```
+temperature:  0.8
+top_p:  0.95
+top_k:  25
+typical_p:  1
+min_p:  0
+repetition_penalty: 1.12
+repetition_penalty_range: 1024
+```
+
+</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: Llama-3-Instruct
+
+```
+<|begin_of_text|><|start_header_id|>system<|end_header_id|>
+
+{system_prompt}<|eot_id|><|start_header_id|>user<|end_header_id|>
+
+{input}<|eot_id|><|start_header_id|>assistant<|end_header_id|>
+
+{output}<|eot_id|>
+```
+
+---
+
+**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{Nano_Imp_1B,
+  author = {SicariusSicariiStuff},
+  title = {Nano_Imp_1B},
+  year = {2025},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/SicariusSicariiStuff/Nano_Imp_1B}
+}
+```
+
+---
+
+## 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.