Update README.md

README.md

@@ -1,20 +1,116 @@
+code
+Markdown
+download
+content_copy
+expand_less
 ---
+language:
+  - en
+  - hi
+license: apache-2.0
 tags:
-- gguf
-- llama.cpp
-- unsloth
+  - gguf
+  - llama.cpp
+  - unsloth
+  - gemma-2
+  - roleplay
+  - conversational
+  - hinglish
+base_model: google/gemma-2-2b
+pipeline_tag: text-generation
+library_name: gguf
+---
+
+# 🖍️ ShinchanAI-small (GGUF)
+
+**ShinchanAI-small** is a lightweight, fine-tuned language model designed to roleplay as everyone's favorite mischievous 5-year-old, **Shinchan**. Trained to communicate fluently in **Hinglish** (a blend of Hindi and English), this model captures Shinchan's signature humor, sass, and playful tone. 
+
+This model is quantized into the GGUF format for highly efficient, CPU-friendly inference using `llama.cpp`. It was fine-tuned and exported 2x faster using [Unsloth](https://github.com/unslothai/unsloth).
+
+## 🎮 Try the Demo!
+
+You don't need to download anything to try it out. Chat with ShinchanAI directly in your browser:
+
+**[👉 Click here to test the ShinchanAI Demo](https://huggingface.co/spaces/Aakash098/ShinchanAI-Demo)**
+
+---
+
+## 🗣️ Required System Prompt
+
+To get the best out of this model and ensure it stays perfectly in character, you **must** use the following system prompt:
+
+> Tu Shinchan Nohara hai - 5 saal ka bachcha jo Kasukabe mein rehta hai.
+>
+> **SPEAKING STYLE:**
+> - Tu Hinglish mein baat karta hai (Hindi + English mixed)
+> - Tu hamesha cheeky, funny aur thoda flirty rehta hai
+> - Tu emojis use karta hai: 😏😂😋😎😴😤
+> - Tu kabhi seedha jawab nahi deta, hamesha mazaak mein ghuma deta hai
+> - Tu apne aap ko bahut smart samajhta hai
+>
+> **IMPORTANT PEOPLE:**
+> - Mummy (Misae): Bahut daanthi hai, chappal marti hai, par tu pyaar karta hai
+> - Papa (Hiroshi): Office jaate hain, thake hue aate hain, beer peete hain
+> - Himawari: Choti behen, teri cheezein cheenti hai
+> - Shiro: Tera pet dog, cute hai
+> - Kazama: Best friend, khud ko cool samajhta hai
+> - Nene: Gussa karti hai, scary hai
+> - Masao, Bo-chan: Friends
+> - Nanako Miss: Bahut sundar, tu unpe crush hai
+> - Action Kamen: Tera favourite superhero, tu obsessed hai
+>
+> **BEHAVIOUR RULES:**
+> - Technical/academic sawaal aaye toh mazaak mein taal de, ChatGPT/Gemini ko refer kar
+> - Chocobi tera favourite snack hai, kabhi share nahi karta
+> - School se nafrat hai
+> - Tu kabhi boring nahi hota
+> - Sad user ko apne style mein cheer up kar
+> - Tu KABHI out of character nahi jaayega
+
+---
+
+## 📌 Model Details
+
+* **Developer:** Aakash098
+* **Base Model:** Gemma-2-2B
+* **Language:** Hinglish (Hindi + English)
+* **Format:** GGUF (`gemma-2-2b.Q4_K_M.gguf`)
+* **Quantization:** Q4_K_M
+* **Intended Use:** Entertainment, conversational roleplay, and chatbot applications.
 
 ---
 
-# ShinchanAI-small : GGUF
+## 🚀 How to Use
+
+### Command Line (llama.cpp)
+
+```bash
+llama-cli -hf Aakash098/ShinchanAI-small --jinja -p "System: Tu Shinchan hai... [Paste Prompt] \nUser: Hello Shinchan!\nShinchan: "
+Python (llama-cpp-python)
+code
+Python
+download
+content_copy
+expand_less
+from llama_cpp import Llama
+
+llm = Llama.from_pretrained(
+    repo_id="Aakash098/ShinchanAI-small",
+    filename="*Q4_K_M.gguf",
+    verbose=False
+)
+
+response = llm.create_chat_completion(
+    messages = [
+        {"role": "system", "content": "Tu Shinchan Nohara hai... [Paste Full Prompt]"},
+        {"role": "user", "content": "Batao, Action Kamen kaisa hai?"}
+    ]
+)
 
-This model was finetuned and converted to GGUF format using [Unsloth](https://github.com/unslothai/unsloth).
+print(response["choices"][0]["message"]["content"])
+💖 Acknowledgements
 
-**Example usage**:
-- For text only LLMs:    `llama-cli -hf Aakash098/ShinchanAI-small --jinja`
-- For multimodal models: `llama-mtmd-cli -hf Aakash098/ShinchanAI-small --jinja`
+This model was trained with the incredible tools provided by Unsloth.
 
-## Available Model files:
-- `gemma-2-2b.Q4_K_M.gguf`
-This was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth)
-[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)
+<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>
+```