DreamGenX commited on
Commit
69dca2a
·
verified ·
1 Parent(s): 340144a

Upload /README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +15 -4
README.md CHANGED
@@ -40,8 +40,9 @@ Lucid is a family of AI language models developed and used by DreamGen with a **
40
  - [Suggesting New Characters](#suggesting-new-characters)
41
  - [Sampling Params](#sampling-params)
42
  - [SillyTavern](#sillytavern)
43
- - [Role-Play](#role-play)
44
- - [Story-Writing](#story-writing)
 
45
  - [API: Local](#using-local-api)
46
  - [API: DreamGen (free)](#using-dreamgen-api-free)
47
  - [DreamGen Web App (free)](#dreamgen-web-app-free)
@@ -1002,12 +1003,14 @@ The examples in this README used:
1002
 
1003
  SillyTavern is a great local front end. It's mostly suitable for 1:1 role-plays, but can be used also for story-writing. Below you will find basic presets for both, together with some examples.
1004
 
 
 
1005
  <details>
1006
  <summary><strong>How To Import Master Presets</strong></summary>
1007
  <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_preset_import.webp" />
1008
  </details>
1009
 
1010
- ### Role-Play
1011
 
1012
  Start with [this master preset](/dreamgen/lucid-v1-nemo/resolve/main/resources/sillytavern/presets/role_play_basic.json).
1013
 
@@ -1023,7 +1026,7 @@ Start with [this master preset](/dreamgen/lucid-v1-nemo/resolve/main/resources/s
1023
 
1024
  <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_role_play_eliza_chat.webp" />
1025
 
1026
- ### Story-Writing
1027
 
1028
  **WARNING:** This is for advanced users who are comfortable with non-traditional SillyTavern experience and who are willing to make or edit their own cards.
1029
 
@@ -1057,6 +1060,14 @@ In this example you can see the use of `/sys` to provide instructions for the ne
1057
 
1058
  <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_writing_mountains_hunger_chat.webp" />
1059
 
 
 
 
 
 
 
 
 
1060
  ### Using Local API
1061
 
1062
  You have several options to run the model locally. Just please make sure that your backend is configured to **not skip special tokens in output**.
 
40
  - [Suggesting New Characters](#suggesting-new-characters)
41
  - [Sampling Params](#sampling-params)
42
  - [SillyTavern](#sillytavern)
43
+ - [Role-Play](#role-play-preset)
44
+ - [Story-Writing](#story-writing-preset)
45
+ - [Assistant](#assistant-preset)
46
  - [API: Local](#using-local-api)
47
  - [API: DreamGen (free)](#using-dreamgen-api-free)
48
  - [DreamGen Web App (free)](#dreamgen-web-app-free)
 
1003
 
1004
  SillyTavern is a great local front end. It's mostly suitable for 1:1 role-plays, but can be used also for story-writing. Below you will find basic presets for both, together with some examples.
1005
 
1006
+ **WARNING:** All of the presets below require that you enable "Instruct Mode".
1007
+
1008
  <details>
1009
  <summary><strong>How To Import Master Presets</strong></summary>
1010
  <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_preset_import.webp" />
1011
  </details>
1012
 
1013
+ ### Role-Play Preset
1014
 
1015
  Start with [this master preset](/dreamgen/lucid-v1-nemo/resolve/main/resources/sillytavern/presets/role_play_basic.json).
1016
 
 
1026
 
1027
  <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_role_play_eliza_chat.webp" />
1028
 
1029
+ ### Story-Writing Preset
1030
 
1031
  **WARNING:** This is for advanced users who are comfortable with non-traditional SillyTavern experience and who are willing to make or edit their own cards.
1032
 
 
1060
 
1061
  <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_writing_mountains_hunger_chat.webp" />
1062
 
1063
+ ### Assistant Preset
1064
+
1065
+ Start with [this master preset](/dreamgen/lucid-v1-nemo/resolve/main/resources/sillytavern/presets/assistant.json) and this [Assistant character card](/dreamgen/lucid-v1-nemo/resolve/main/resources/sillytavern/cards/assistant.json). You can change the description of the Assistant character to override the default system prompt.
1066
+
1067
+ Here is what it will look like:
1068
+
1069
+ <img src="/dreamgen/lucid-v1-nemo/resolve/main/images/sillytavern_assistant_think.webp" />
1070
+
1071
  ### Using Local API
1072
 
1073
  You have several options to run the model locally. Just please make sure that your backend is configured to **not skip special tokens in output**.