Lewdiculous commited on
Commit
a7508f5
·
verified ·
1 Parent(s): 1666278

add readme info

Browse files
Files changed (1) hide show
  1. README.md +74 -0
README.md CHANGED
@@ -20,4 +20,78 @@ transformers-AutoModelForCausalLM
20
  > **LoRA** by **mouseEliauk**: <br>
21
  > https://www.modelscope.cn/models/mouseEliauk/mirau-RP-14b
22
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/65d4cf2693a0a3744a27536c/99YhsFSeaGDYCq7XVcTcq.png)
 
20
  > **LoRA** by **mouseEliauk**: <br>
21
  > https://www.modelscope.cn/models/mouseEliauk/mirau-RP-14b
22
 
23
+ <details>
24
+ <summary>mouseEliauk's ReadMe information:</summary>
25
+
26
+ <br>
27
+
28
+ # mirau - A Powerful Character Roleplaying Model
29
+
30
+ ## Features
31
+ 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.
32
+
33
+ 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.
34
+
35
+ 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.
36
+
37
+ Overall, mirau features:
38
+
39
+ 1. Superior character consistency
40
+
41
+ 2. Powerful long-context memory capability
42
+
43
+ 3. Transparent thinking with hidden thought chains
44
+
45
+ You can experience this model at [mirau-14b-demo](https://www.modelscope.cn/studios/mouseEliauk/mirau-14b-demo/summary)
46
+
47
+ ## Usage and Conventions
48
+
49
+ ### System Prompt Conventions:
50
+ > mirau's system prompts require first-person monologues to describe its identity and current scene.
51
+
52
+ Example:
53
+ > 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...
54
+
55
+ ### Reference Conventions
56
+ Use `she/he/name` in parentheses to refer to users or others besides the BOT, and use `I` to refer to the BOT.
57
+ Example:
58
+ > user: (his voice is very gentle) I had polio //here "he" in parentheses refers to the character played by the user
59
+
60
+ > bot: (Polio? What's that? I've never heard of it) Polio? (tilting head in confusion)
61
+
62
+ ## Special Designs
63
+
64
+ ### BOT Hints
65
+ Used to suggest plot or behavior directions to the BOT, though the BOT may not necessarily follow them
66
+
67
+ > user: (Should I ask this?) //BOT will treat text in parentheses as its own inner monologue
68
+
69
+ > bot: (Hmm... maybe that's not a good question, though he seems interesting) Are you also new here?
70
+
71
+ ### BOT Control
72
+ Used to forcefully control BOT's behavior
73
+ > user: (I should apologize to him)
74
+
75
+ > bot: (That question was too intrusive, I should apologize) I... I'm sorry, I shouldn't have asked that.
76
+
77
+ ### Character Switching
78
+ Used to switch the character played by the user
79
+
80
+ > user: (A girl named Xiaohong next to me says hi) Hello!
81
+
82
+ > bot: (This girl is cute too) Hi! I'm Doudou!
83
+
84
+ > user: Hi! I'm Xiaohong! //User's role switches from Taiming to Xiaohong
85
+
86
+ > bot: (So her name is Xiaohong) Nice to meet you! When is the teacher coming?
87
+
88
+ ### Idle BOT
89
+ Turns the BOT into a third-person perspective
90
+
91
+ > user: (Xiaohong looks at Taiming) Taiming, is your leg better?
92
+
93
+ > bot: (They seem to know each other well) //Since there's no direct dialogue with the BOT, it only shows inner monologue
94
+
95
+ </details>
96
+
97
  ![image/png](https://cdn-uploads.huggingface.co/production/uploads/65d4cf2693a0a3744a27536c/99YhsFSeaGDYCq7XVcTcq.png)