ShinchanAI-small / README.md
Aakash098's picture
Update README.md
2c925b5 verified
---
language:
- en
- hi
license: apache-2.0
tags:
- 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.
---
## ๐Ÿš€ 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)
```python
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?"}
]
)
print(response["choices"][0]["message"]["content"])
```
## ๐Ÿ’– Acknowledgements
This model was trained with the incredible tools provided by Unsloth.
<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>
```