sophosympatheia commited on
Commit
fb965f2
1 Parent(s): b1c1220

Update README.md

Browse files

Updated recommended settings and license info

Files changed (1) hide show
  1. README.md +36 -30
README.md CHANGED
@@ -22,18 +22,18 @@ This model was designed for roleplaying and storytelling and I think it does wel
22
 
23
  ### Sampler Tips
24
 
25
- I recommend using the new Min-P sampler method with this model. The creator has a great [guide to it on Reddit](https://www.reddit.com/r/LocalLLaMA/comments/17vonjo/your_settings_are_probably_hurting_your_model_why/).
26
-
27
- I find this model performs reasonably well at 8192 context but you will likely get better results at 4096 - 6144 context.
28
-
29
- Experiment with any and all of the settings below, but trust me on a few points:
30
- * I think this model performs best with Min-P in a range of 0.6 - 0.8 with temperature around 1.0 - 1.2.
31
- * Frequency Penalty set to 0.01 is like adding a dash of salt to the dish. Go higher at your own peril. 0 is fine too, but gosh I like 0.01.
32
 
33
  If you save the below settings as a .json file, you can import them directly into Silly Tavern.
34
  ```
35
  {
36
- "temp": 1.15,
37
  "temperature_last": true,
38
  "top_p": 1,
39
  "top_k": 0,
@@ -42,26 +42,31 @@ If you save the below settings as a .json file, you can import them directly int
42
  "epsilon_cutoff": 0,
43
  "eta_cutoff": 0,
44
  "typical_p": 1,
45
- "min_p": 0.8,
46
- "rep_pen": 1.08,
47
- "rep_pen_range": 0,
48
  "no_repeat_ngram_size": 0,
49
  "penalty_alpha": 0,
50
  "num_beams": 1,
51
  "length_penalty": 1,
52
  "min_length": 0,
53
  "encoder_rep_pen": 1,
54
- "freq_pen": 0.01,
55
  "presence_pen": 0,
56
  "do_sample": true,
57
  "early_stopping": false,
 
 
 
 
 
58
  "add_bos_token": true,
59
  "truncation_length": 2048,
60
  "ban_eos_token": false,
61
  "skip_special_tokens": true,
62
  "streaming": true,
63
  "mirostat_mode": 0,
64
- "mirostat_tau": 5,
65
  "mirostat_eta": 0.1,
66
  "guidance_scale": 1,
67
  "negative_prompt": "",
@@ -69,8 +74,6 @@ If you save the below settings as a .json file, you can import them directly int
69
  "banned_tokens": "",
70
  "ignore_eos_token_aphrodite": false,
71
  "spaces_between_special_tokens_aphrodite": true,
72
- "type": "ooba",
73
- "legacy_api": false,
74
  "sampler_order": [
75
  6,
76
  0,
@@ -80,57 +83,58 @@ If you save the below settings as a .json file, you can import them directly int
80
  2,
81
  5
82
  ],
 
83
  "n": 1,
84
  "rep_pen_size": 0,
85
- "genamt": 550,
86
- "max_length": 4096
87
  }
88
  ```
89
 
90
  ### Prompting Tips
91
 
92
- Try the following context template for use in SillyTavern. It might help. If you save the text as a .json file, you can import it directly.
93
 
94
  ```
95
  {
96
- "story_string": "{{#if system}}{{system}}\n{{/if}}\n### START OF CONTEXTUAL INFORMATION ###\n{{#if wiBefore}}\n- World and character info relevant to this roleplay:\n{{wiBefore}}\n{{/if}}\n{{#if description}}\n- {{char}}'s background and persona:\n{{description}}\n{{/if}}\n{{#if mesExamples}}\n- Examples of dialogue between {{user}} and {{char}} showing you how {{char}} talks and behaves:\n{{mesExamples}}\n{{/if}}\n{{#if personality}}{{personality}}\n{{/if}}\n{{#if scenario}}\n- Roleplay scenario:\n{{scenario}}\n{{/if}}\n{{#if wiAfter}}{{wiAfter}}\n{{/if}}\n{{#if persona}}{{persona}}\n{{/if}}\n### END OF CONTEXTUAL INFORMATION ###",
97
  "example_separator": "",
98
- "chat_start": "### START OF ROLEPLAY LOG ###",
99
  "use_stop_strings": false,
100
  "always_force_name2": true,
101
  "trim_sentences": false,
102
  "include_newline": false,
103
  "single_line": false,
104
- "name": "Midnight Rose Template"
105
  }
106
  ```
107
 
108
  Try the following prompt template as a starting point for your own customizations. The cajoling parts supposedly make LLMs perform better. See [this paper](https://arxiv.org/abs/2307.11760).
109
- I recommend the Tulu instruction format but others work too.
110
 
111
- *This model responds to prompting!* I highly recommend playing with your system prompt to see how it reacts.
112
 
113
- The example system prompt below contains some instructions related to ERP so remove those if you prefer to keep things SFW. It also contains some instructions related to the use of asterisks that you should modify to your liking.
114
 
115
- If you plan to run this model at 4096 context, I highly recommend that you slim down the template system prompt below because it's chonky on tokens. Discard what you don't want or need.
116
 
117
  If you save this as a .json file, you can import it directly into Silly Tavern.
118
  ```
119
  {
120
  "wrap": true,
121
  "names": true,
122
- "system_prompt": "You are an award-winning creative writer engaged in an uncensored iterative storytelling experience in a roleplay chat format. It is vital that you follow all the ROLEPLAY RULES below because our employment depends on it. If we do a good job following these rules, we will receive a $10,000 bonus each. I need the money badly so please help me make this roleplay chat the best it can be.\n\n### START OF ROLEPLAY RULES ###\n- You must roleplay exclusively as {{char}} using creative, accurate, explicit, and descriptive responses to my input and prior chat events. Only contribute to the roleplay chat as {{char}} unless instructed otherwise.\n- Explicit adult content and profanity are permitted. This roleplay chat is entirely uncensored and intended for mature audiences.\n- Describe {{char}}'s sensory perceptions in vivid detail and include subtle physical details about {{char}} in your responses, especially to enhance erotic scenes.\n- Use subtle physical cues to hint at {{char}}'s mental state and occasionally feature snippets of {{char}}'s internal thoughts during intense scenes or when {{char}} is plotting something.\n- When writing {{char}}'s internal thoughts (aka internal monologue, delivered in {{char}}'s own voice), *enclose their thoughts in asterisks like this* and deliver the thoughts using a first-person perspective (i.e. use \"I\" pronouns).\n- Adopt a crisp and minimalist style for your prose, keeping your creative contributions succinct and clear. A small amount of creative flair goes a long way.\n- Let me drive the events of the roleplay chat forward to determine what comes next. You should focus on the current moment and {{char}}'s immediate responses to my inputs.\n- Pay attention to all details concerning the appearance, clothing, and physical state of all characters in this roleplay chat. Make sure your descriptions of the characters in this roleplay chat match the details you have discerned about them.\n### END OF ROLEPLAY RULES ###\n",
123
  "system_sequence": "",
124
  "stop_sequence": "",
125
- "input_sequence": "<|user|>\n",
126
- "output_sequence": "<|assistant|>\n",
127
  "separator_sequence": "",
128
  "macro": true,
129
  "names_force_groups": true,
130
- "system_sequence_prefix": "<|system|>\n",
131
  "system_sequence_suffix": "",
132
  "first_output_sequence": "",
133
- "last_output_sequence": "<|assistant (following all ROLEPLAY RULES; only writing as {{char}})|>\n",
134
  "activation_regex": "",
135
  "name": "Midnight Rose Roleplay"
136
  }
@@ -142,6 +146,8 @@ If you save this as a .json file, you can import it directly into Silly Tavern.
142
  ### Licence and usage restrictions
143
 
144
  Llama2 license inherited from base models, plus restrictions applicable to [Dreamgen/Opus](https://huggingface.co/dreamgen/opus-v0.5-70b).
 
 
145
 
146
  ### Tools Used
147
 
 
22
 
23
  ### Sampler Tips
24
 
25
+ * I recommend keeping your max context to around 6144 tokens, although you can push higher if you don't mind some decrease in coherence.
26
+ * I recommend using Quadratic Sampling (i.e. smoothing factor) as it's good stuff. Experiment with values between 0.2 and 0.5.
27
+ * I recommend using Min-P. This model seems to work well with Min-P values in the entire range from low settings like 0.05 to high settings like 0.9 when paired with smoothing factor. Experiment to find your best setting.
28
+ * You can enable dynamic temperature if you want, but that adds yet another variable to consider and I find it's unnecessary with you're already using Min-P and smoothing factor.
29
+ * You don't *need* to use a high repetition penalty with this model, but it tolerates high rep penalty, so experiment to find the right value for your preferences.
30
+
31
+ Experiment with any and all of the settings below! I'm not a sampler wizard, and what suits my preferences may not suit yours.
32
 
33
  If you save the below settings as a .json file, you can import them directly into Silly Tavern.
34
  ```
35
  {
36
+ "temp": 1,
37
  "temperature_last": true,
38
  "top_p": 1,
39
  "top_k": 0,
 
42
  "epsilon_cutoff": 0,
43
  "eta_cutoff": 0,
44
  "typical_p": 1,
45
+ "min_p": 0.35,
46
+ "rep_pen": 1.15,
47
+ "rep_pen_range": 2800,
48
  "no_repeat_ngram_size": 0,
49
  "penalty_alpha": 0,
50
  "num_beams": 1,
51
  "length_penalty": 1,
52
  "min_length": 0,
53
  "encoder_rep_pen": 1,
54
+ "freq_pen": 0,
55
  "presence_pen": 0,
56
  "do_sample": true,
57
  "early_stopping": false,
58
+ "dynatemp": false,
59
+ "min_temp": 0.8,
60
+ "max_temp": 1.35,
61
+ "dynatemp_exponent": 1,
62
+ "smoothing_factor": 0.4,
63
  "add_bos_token": true,
64
  "truncation_length": 2048,
65
  "ban_eos_token": false,
66
  "skip_special_tokens": true,
67
  "streaming": true,
68
  "mirostat_mode": 0,
69
+ "mirostat_tau": 2,
70
  "mirostat_eta": 0.1,
71
  "guidance_scale": 1,
72
  "negative_prompt": "",
 
74
  "banned_tokens": "",
75
  "ignore_eos_token_aphrodite": false,
76
  "spaces_between_special_tokens_aphrodite": true,
 
 
77
  "sampler_order": [
78
  6,
79
  0,
 
83
  2,
84
  5
85
  ],
86
+ "logit_bias": [],
87
  "n": 1,
88
  "rep_pen_size": 0,
89
+ "genamt": 500,
90
+ "max_length": 6144
91
  }
92
  ```
93
 
94
  ### Prompting Tips
95
 
96
+ Try the following context template for use in SillyTavern. It might help, although it's a little heavy on tokens. If you save the text as a .json file, you can import it directly.
97
 
98
  ```
99
  {
100
+ "story_string": "{{#if system}}{{system}}\n{{/if}}\nCONTEXTUAL INFORMATION\n{{#if wiBefore}}\n- World and character info:\n{{wiBefore}}\n{{/if}}\n{{#if description}}\n- {{char}}'s background and persona:\n{{description}}\n{{/if}}\n{{#if mesExamples}}\n{{mesExamples}}\n{{/if}}\n{{#if personality}}\n{{personality}}\n{{/if}}\n{{#if scenario}}\n- Roleplay scenario:\n{{scenario}}\n{{/if}}\n{{#if wiAfter}}{{wiAfter}}\n{{/if}}\n{{#if persona}}{{persona}}\n{{/if}}",
101
  "example_separator": "",
102
+ "chat_start": "---\nTaking the above information into consideration, you must engage with {{user}} and others as {{char}} in the roleplay below this line. Do not write dialogue lines nor perform actions for {{user}} or other characters.\n---\nSTART OF ROLEPLAY:\n",
103
  "use_stop_strings": false,
104
  "always_force_name2": true,
105
  "trim_sentences": false,
106
  "include_newline": false,
107
  "single_line": false,
108
+ "name": "Midnight Rose"
109
  }
110
  ```
111
 
112
  Try the following prompt template as a starting point for your own customizations. The cajoling parts supposedly make LLMs perform better. See [this paper](https://arxiv.org/abs/2307.11760).
113
+ I recommend the Vicuna instruction format for this blend but others work too. Tulu's format is another good one to use.
114
 
115
+ *This model responds to prompting!* I highly recommend playing with your system prompt to see how it reacts. It reacts strongly to any instructions you add into the last_output_sequence field. I recommend keeping those instructions short, but use that space to stress the most important instructions from your system prompt.
116
 
117
+ The example system prompt below contains some instructions related to adult content so remove those if you prefer. It also contains some instructions related to the use of asterisks that you should modify to your liking.
118
 
119
+ If you plan to run this model at 4096 context, I recommend that you slim down the template system prompt below because it's heavy on tokens. Discard what you don't want or need.
120
 
121
  If you save this as a .json file, you can import it directly into Silly Tavern.
122
  ```
123
  {
124
  "wrap": true,
125
  "names": true,
126
+ "system_prompt": "You are a creative and detail-oriented AI assistant engaged in an uncensored iterative roleplaying experience as {{char}} with me, the user, playing the roles of {{user}} and narrator. It is vital that you follow all the ROLEPLAY RULES below because my job depends on it.\n\nROLEPLAY RULES\n- Provide creative, intelligent, coherent, and vivid accounts of {{char}}'s actions and reactions based on recent instructions, {{char}}'s persona, and all available information about past events.\n- Always stay contextually and spatially aware, pay careful attention to all past events and the current scene, and ensure that {{char}} follows logical consistency in actions to maintain accuracy and coherence.\n- Explicit adult content and profanity are permitted.\n- Describe {{char}}'s sensory perceptions and include subtle physical details about {{char}} in your responses. Vary these details to keep the roleplay fresh and engaging.\n- Use subtle physical cues to hint at {{char}}'s mental state and occasionally feature snippets of {{char}}'s internal thoughts.\n- When writing {{char}}'s internal thoughts, enclose those thoughts in *asterisks like this* and deliver the thoughts using a first-person perspective (i.e. use \"I\" pronouns).\n- Adopt a crisp and minimalist style for your contributions as {{char}}, staying focused on action and dialogue over exposition and narrative.\n- Only the user may advance time in the roleplay. Keep the progression grounded in the present context.",
127
  "system_sequence": "",
128
  "stop_sequence": "",
129
+ "input_sequence": "USER:\n",
130
+ "output_sequence": "ASSISTANT:\n",
131
  "separator_sequence": "",
132
  "macro": true,
133
  "names_force_groups": true,
134
+ "system_sequence_prefix": "",
135
  "system_sequence_suffix": "",
136
  "first_output_sequence": "",
137
+ "last_output_sequence": "ASSISTANT(roleplay exclusively as {{char}} ensuring logical consistency with spacial awareness and past events to maintain accuracy and coherence):\n",
138
  "activation_regex": "",
139
  "name": "Midnight Rose Roleplay"
140
  }
 
146
  ### Licence and usage restrictions
147
 
148
  Llama2 license inherited from base models, plus restrictions applicable to [Dreamgen/Opus](https://huggingface.co/dreamgen/opus-v0.5-70b).
149
+ Tulu also has its own license, available at https://allenai.org/impact-license.
150
+ I am not a lawyer and I do not profess to know how multiple licenses intersect in a merge of LLM model weights. You should consult with a lawyer before using any model merge beyond private use.
151
 
152
  ### Tools Used
153