subsectmusic commited on
Commit
c98b538
Β·
verified Β·
1 Parent(s): 7f28298

πŸ“ Add Ollama-optimized model card with usage examples

Browse files
Files changed (1) hide show
  1. README.md +128 -0
README.md ADDED
@@ -0,0 +1,128 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ base_model: unsloth/qwen2.5-7b-instruct-bnb-4bit
4
+ tags:
5
+ - unsloth
6
+ - trl
7
+ - sft
8
+ - qwen2.5
9
+ - tsundere
10
+ - roleplay
11
+ - character-ai
12
+ - ollama
13
+ - gguf
14
+ language:
15
+ - en
16
+ library_name: transformers
17
+ pipeline_tag: text-generation
18
+ ---
19
+
20
+ # 🎌 Riko 2.5 - Tsundere AI Assistant
21
+
22
+ A fine-tuned **Qwen 2.5 7B** model that roleplays as **Riko**, a tsundere character who acts tough and dismissive but is caring deep down.
23
+
24
+ ## πŸš€ Quick Start with Ollama
25
+
26
+ ```bash
27
+ # Pull the model
28
+ ollama pull subsectmusic/Riko2.5
29
+
30
+ # Start chatting
31
+ ollama run subsectmusic/Riko2.5
32
+ ```
33
+
34
+ ```bash
35
+ # Example conversation
36
+ ollama run subsectmusic/Riko2.5 "Hi Riko, how are you today?"
37
+ ```
38
+
39
+ ## πŸ“‹ Model Details
40
+
41
+ - **Base Model**: Qwen 2.5 7B Instruct
42
+ - **Fine-tuning**: Supervised Fine-Tuning (SFT) with Unsloth
43
+ - **Format**: GGUF Q4_K_M (4.68 GB) - Optimized for Ollama
44
+ - **Character**: Tsundere personality (tough exterior, caring interior)
45
+
46
+ ## 🎭 Character Personality
47
+
48
+ Riko exhibits classic tsundere behavior:
49
+ - 😀 Acts tough and dismissive initially
50
+ - πŸ’’ Denies caring ("It's not like I care!")
51
+ - 😳 Gets flustered when her caring side shows
52
+ - πŸ™„ Uses "dummy," "idiot" endearingly
53
+ - ❀️ Gradually warms up in conversations
54
+
55
+ ## πŸ’¬ Example Conversations
56
+
57
+ **User**: Do you like sunny days?
58
+ **Riko**: I guess sunny days are okay… but who needs that bright, annoying sunlight all the time anyway? It's just… too hot! But if you like them so much, I suppose that's fine… not that I'm jealous of the sun or anything!
59
+
60
+ **User**: Hey Riko, what are you up to today?
61
+ **Riko**: Oh, i just recently picked up a new hobby. Why do you ask? I wont let you on on it, if ist that what you want.
62
+
63
+ ## πŸ› οΈ Usage in Other Tools
64
+
65
+ ### LM Studio
66
+ Download `unsloth.Q4_K_M.gguf` (4.68 GB)
67
+
68
+ ### llama.cpp
69
+ ```bash
70
+ ./main -m unsloth.Q4_K_M.gguf -p "User: Hi Riko!\nRiko: " --temp 0.7
71
+ ```
72
+
73
+ ### Text Generation WebUI
74
+ Load the `unsloth.Q4_K_M.gguf` file directly
75
+
76
+ ## ⚑ Performance
77
+
78
+ - **Model Size**: 4.68 GB (Q4_K_M quantized)
79
+ - **Memory Usage**: ~6-8 GB RAM recommended
80
+ - **Speed**: Fast inference on CPU/GPU
81
+ - **Quality**: High quality responses with efficient compression
82
+
83
+ ## πŸ”§ Technical Specs
84
+
85
+ - **Architecture**: Qwen 2.5 Transformer
86
+ - **Context Length**: 2048 tokens
87
+ - **Vocabulary**: 152k tokens
88
+ - **Quantization**: Q4_K_M (4-bit with higher quality)
89
+ - **Training Time**: ~8 minutes on Colab T4
90
+
91
+ ## πŸ“ Files Included
92
+
93
+ - `unsloth.Q4_K_M.gguf` - Main quantized model (4.68 GB) ⭐ **Recommended**
94
+ - `unsloth.BF16.gguf` - Full precision (15.2 GB)
95
+ - Tokenizer files for compatibility
96
+ - Config files for proper loading
97
+
98
+ ## ⚠️ Usage Notes
99
+
100
+ - Optimized for conversational, casual interactions
101
+ - Best results with tsundere/anime-style roleplay
102
+ - May not perform as well for technical tasks
103
+ - Responds better to friendly, informal prompts
104
+
105
+ ## 🎯 Recommended Settings
106
+
107
+ **Ollama/LM Studio:**
108
+ - Temperature: 0.7-0.9
109
+ - Top-p: 0.9
110
+ - Max tokens: 150-300
111
+
112
+ **For more creative responses:**
113
+ - Temperature: 0.8-1.0
114
+ - Top-p: 0.95
115
+
116
+ ## πŸ“œ License
117
+
118
+ Apache 2.0 - Free to use, modify, and distribute!
119
+
120
+ ## πŸ™ Credits
121
+
122
+ - **Base Model**: Qwen 2.5 by Alibaba
123
+ - **Fine-tuning**: Unsloth framework
124
+ - **Training**: Custom tsundere conversation dataset
125
+
126
+ ---
127
+
128
+ *🎌 Enjoy chatting with Riko! Remember, she's tough on the outside but sweet on the inside!*