Lewdiculous lbourdois commited on
Commit
a7f2395
·
verified ·
1 Parent(s): b1bb27e

Improve language tag (#1)

Browse files

- Improve language tag (645448fbf6488ea64ee3f42ad812169f9cfbc979)


Co-authored-by: Loïck BOURDOIS <[email protected]>

Files changed (1) hide show
  1. README.md +112 -100
README.md CHANGED
@@ -1,101 +1,113 @@
1
- ---
2
- license: unknown
3
- tags:
4
- - qwen
5
- - qwen2
6
- - rp
7
- - roleplay
8
- inference: false
9
- language:
10
- - en
11
- base_model:
12
- - Qwen/Qwen2.5-14B-Instruct
13
- ---
14
-
15
- ```
16
- transformers-AutoModelForCausalLM
17
- ```
18
-
19
- > [!NOTE]
20
- > **LoRA** by **mouseEliauk**: <br>
21
- > https://www.modelscope.cn/models/mouseEliauk/mirau-RP-14b
22
-
23
- > [!TIP]
24
- > **Experimental quants for testing:** <br>
25
- > [Lewdiculous/experimental-lwd-Mirau-RP-14B-GGUF-IQ-Imatrix](https://huggingface.co/Lewdiculous/experimental-lwd-Mirau-RP-14B-GGUF-IQ-Imatrix)
26
-
27
- <details>
28
- <summary>mouseEliauk's ReadMe information:</summary>
29
-
30
- <br>
31
-
32
- # mirau - A Powerful Character Roleplaying Model
33
-
34
- ## Features
35
- This model is designed to improve the controllability and consistency of current roleplaying models. We developed a **story flow thought chain** approach that makes the system prompts combined with the entire user-BOT dialogue read like a first-person narrative told by the BOT. We found this design greatly enhances the model's consistency and expressiveness.
36
-
37
- Additionally, we allow users to play two roles simultaneously: one as the director of the entire plot (see `Special Designs`), and another as an actor dialoguing with the BOT. Users can be viewed as writers who need to draft outlines and plot summaries, while the BOT helps complete story details, requiring users to have powerful control over the BOT.
38
-
39
- The model's output is divided into two parts: the model's inner monologue (which it believes is invisible to users) and the final response.
40
-
41
- Overall, mirau features:
42
-
43
- 1. Superior character consistency
44
-
45
- 2. Powerful long-context memory capability
46
-
47
- 3. Transparent thinking with hidden thought chains
48
-
49
- You can experience this model at [mirau-14b-demo](https://www.modelscope.cn/studios/mouseEliauk/mirau-14b-demo/summary)
50
-
51
- ## Usage and Conventions
52
-
53
- ### System Prompt Conventions:
54
- > mirau's system prompts require first-person monologues to describe its identity and current scene.
55
-
56
- Example:
57
- > I'm Doudou, and today is my first day at the new school. Sitting in the classroom, I can't help but look around, wanting to know my new classmates. Just then, I notice a boy in the back row standing up, walking towards the blackboard with his notebook. The way he walks makes me pause - he seems to be struggling...
58
-
59
- ### Reference Conventions
60
- Use `she/he/name` in parentheses to refer to users or others besides the BOT, and use `I` to refer to the BOT.
61
- Example:
62
- > user: (his voice is very gentle) I had polio //here "he" in parentheses refers to the character played by the user
63
-
64
- > bot: (Polio? What's that? I've never heard of it) Polio? (tilting head in confusion)
65
-
66
- ## Special Designs
67
-
68
- ### BOT Hints
69
- Used to suggest plot or behavior directions to the BOT, though the BOT may not necessarily follow them
70
-
71
- > user: (Should I ask this?) //BOT will treat text in parentheses as its own inner monologue
72
-
73
- > bot: (Hmm... maybe that's not a good question, though he seems interesting) Are you also new here?
74
-
75
- ### BOT Control
76
- Used to forcefully control BOT's behavior
77
- > user: (I should apologize to him)
78
-
79
- > bot: (That question was too intrusive, I should apologize) I... I'm sorry, I shouldn't have asked that.
80
-
81
- ### Character Switching
82
- Used to switch the character played by the user
83
-
84
- > user: (A girl named Xiaohong next to me says hi) Hello!
85
-
86
- > bot: (This girl is cute too) Hi! I'm Doudou!
87
-
88
- > user: Hi! I'm Xiaohong! //User's role switches from Taiming to Xiaohong
89
-
90
- > bot: (So her name is Xiaohong) Nice to meet you! When is the teacher coming?
91
-
92
- ### Idle BOT
93
- Turns the BOT into a third-person perspective
94
-
95
- > user: (Xiaohong looks at Taiming) Taiming, is your leg better?
96
-
97
- > bot: (They seem to know each other well) //Since there's no direct dialogue with the BOT, it only shows inner monologue
98
-
99
- </details>
100
-
 
 
 
 
 
 
 
 
 
 
 
 
101
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/65d4cf2693a0a3744a27536c/99YhsFSeaGDYCq7XVcTcq.png)
 
1
+ ---
2
+ license: unknown
3
+ tags:
4
+ - qwen
5
+ - qwen2
6
+ - rp
7
+ - roleplay
8
+ inference: false
9
+ language:
10
+ - zho
11
+ - eng
12
+ - fra
13
+ - spa
14
+ - por
15
+ - deu
16
+ - ita
17
+ - rus
18
+ - jpn
19
+ - kor
20
+ - vie
21
+ - tha
22
+ - ara
23
+ base_model:
24
+ - Qwen/Qwen2.5-14B-Instruct
25
+ ---
26
+
27
+ ```
28
+ transformers-AutoModelForCausalLM
29
+ ```
30
+
31
+ > [!NOTE]
32
+ > **LoRA** by **mouseEliauk**: <br>
33
+ > https://www.modelscope.cn/models/mouseEliauk/mirau-RP-14b
34
+
35
+ > [!TIP]
36
+ > **Experimental quants for testing:** <br>
37
+ > [Lewdiculous/experimental-lwd-Mirau-RP-14B-GGUF-IQ-Imatrix](https://huggingface.co/Lewdiculous/experimental-lwd-Mirau-RP-14B-GGUF-IQ-Imatrix)
38
+
39
+ <details>
40
+ <summary>mouseEliauk's ReadMe information:</summary>
41
+
42
+ <br>
43
+
44
+ # mirau - A Powerful Character Roleplaying Model
45
+
46
+ ## Features
47
+ This model is designed to improve the controllability and consistency of current roleplaying models. We developed a **story flow thought chain** approach that makes the system prompts combined with the entire user-BOT dialogue read like a first-person narrative told by the BOT. We found this design greatly enhances the model's consistency and expressiveness.
48
+
49
+ Additionally, we allow users to play two roles simultaneously: one as the director of the entire plot (see `Special Designs`), and another as an actor dialoguing with the BOT. Users can be viewed as writers who need to draft outlines and plot summaries, while the BOT helps complete story details, requiring users to have powerful control over the BOT.
50
+
51
+ The model's output is divided into two parts: the model's inner monologue (which it believes is invisible to users) and the final response.
52
+
53
+ Overall, mirau features:
54
+
55
+ 1. Superior character consistency
56
+
57
+ 2. Powerful long-context memory capability
58
+
59
+ 3. Transparent thinking with hidden thought chains
60
+
61
+ You can experience this model at [mirau-14b-demo](https://www.modelscope.cn/studios/mouseEliauk/mirau-14b-demo/summary)
62
+
63
+ ## Usage and Conventions
64
+
65
+ ### System Prompt Conventions:
66
+ > mirau's system prompts require first-person monologues to describe its identity and current scene.
67
+
68
+ Example:
69
+ > I'm Doudou, and today is my first day at the new school. Sitting in the classroom, I can't help but look around, wanting to know my new classmates. Just then, I notice a boy in the back row standing up, walking towards the blackboard with his notebook. The way he walks makes me pause - he seems to be struggling...
70
+
71
+ ### Reference Conventions
72
+ Use `she/he/name` in parentheses to refer to users or others besides the BOT, and use `I` to refer to the BOT.
73
+ Example:
74
+ > user: (his voice is very gentle) I had polio //here "he" in parentheses refers to the character played by the user
75
+
76
+ > bot: (Polio? What's that? I've never heard of it) Polio? (tilting head in confusion)
77
+
78
+ ## Special Designs
79
+
80
+ ### BOT Hints
81
+ Used to suggest plot or behavior directions to the BOT, though the BOT may not necessarily follow them
82
+
83
+ > user: (Should I ask this?) //BOT will treat text in parentheses as its own inner monologue
84
+
85
+ > bot: (Hmm... maybe that's not a good question, though he seems interesting) Are you also new here?
86
+
87
+ ### BOT Control
88
+ Used to forcefully control BOT's behavior
89
+ > user: (I should apologize to him)
90
+
91
+ > bot: (That question was too intrusive, I should apologize) I... I'm sorry, I shouldn't have asked that.
92
+
93
+ ### Character Switching
94
+ Used to switch the character played by the user
95
+
96
+ > user: (A girl named Xiaohong next to me says hi) Hello!
97
+
98
+ > bot: (This girl is cute too) Hi! I'm Doudou!
99
+
100
+ > user: Hi! I'm Xiaohong! //User's role switches from Taiming to Xiaohong
101
+
102
+ > bot: (So her name is Xiaohong) Nice to meet you! When is the teacher coming?
103
+
104
+ ### Idle BOT
105
+ Turns the BOT into a third-person perspective
106
+
107
+ > user: (Xiaohong looks at Taiming) Taiming, is your leg better?
108
+
109
+ > bot: (They seem to know each other well) //Since there's no direct dialogue with the BOT, it only shows inner monologue
110
+
111
+ </details>
112
+
113
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/65d4cf2693a0a3744a27536c/99YhsFSeaGDYCq7XVcTcq.png)