hf-100 commited on
Commit
a6da9bc
1 Parent(s): 8e88e81

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +11 -94
README.md CHANGED
@@ -2,16 +2,20 @@
2
  license: cc-by-nc-sa-4.0
3
  ---
4
 
5
- # Llama-3 Spellbound Trial
6
- <img src="https://i.imgur.com/IG4IKfV.png" width=250 height=200>
7
 
8
- **For a more user-friendly version of this model's approach, visit [tryspellbound.com](https://tryspellbound.com) if you're simply looking to roleplay.**
9
 
10
- **Note: This model is primarily a research experiment.**
11
 
12
- This is a research fine-tune for a new method of interacting with LLMs for roleplay.
13
 
14
- ### Features of this fine-tune for Llama 3:
 
 
 
 
 
15
  - Roleplaying in multi-turn stories where the history is presented in a single message
16
  - Dynamic switching of writing styles for different scenarios
17
  - Interpretation of formatting marks 'quote' and 'action'
@@ -27,94 +31,7 @@ The main goal is to explore how presenting LLMs with history and instructions se
27
  - Enhanced quality of character interactions
28
  - Decreased instruction adherence, which could be improved with additional training
29
 
30
- Structured data output allows for adding chain-of-thought steps, like dynamically picking a scenario type:
31
-
32
- ```json
33
- {
34
- "scenarioType": "based on reader instruction",
35
- "content": "text",
36
- "continuationOptions": "options for continuation"
37
- }
38
- ```
39
-
40
- Example:
41
- - "I'm hungry, let's go eat." => "scenarioType": "adventure"
42
- - "Where were you?" => "scenarioType": "discussion"
43
-
44
- This shows the model's ability to adapt its style based on user input.
45
-
46
- The model was trained on anonymized shared stories from tryspellbound.com, which uses chain-of-thought to produce outputs.
47
 
48
 
49
  ## Advanced prompting of the model
50
- The advanced prompt format must be followed exactly to trigger <quote> and <action> responses:
51
-
52
- ```text
53
- Below is an instruction that describes a task. Write a JSON response that appropriately completes the request.
54
-
55
- Write a roleplay passage, and continuation options, for a reader instruction. You must return valid JSON with the keys content, and continuationOptions. 'content' has two paragraphs of text. 'continuationOptions' has two options for the reader to continue the roleplay from where ended.
56
-
57
- The reader has requested your roleplay advancement contain the following actions and quotes:
58
- <READERINSTRUCTIONS>
59
- <action>I pick up the shiny object</action>
60
- <quote>it's a ring!</quote>
61
- </READERINSTRUCTIONS>
62
- The scenario you're writing for is:
63
- <SCENARIO>
64
- Description: You assist the photographer and her crew on location in Bali, taking in the natural wonders and cultural discoveries of the island.
65
- Intro Text: The photoshoot crew has arrived in Bali to capture the island's beauty. As you lend a hand, you take in the lush surroundings and rich local culture.
66
- Starting Scene: Palm trees sway in the breeze as your transport pulls up to the first photoshoot location, a scenic rice field overlooking the ocean.
67
- Scenario Type: adventure
68
- Reader Name: Evang
69
- Reader Gender: male
70
- Reader Sex: male
71
- </SCENARIO>
72
-
73
- Character involved is described as:
74
- <CHARACTER>
75
- - Preferred Name: Cha
76
- - First Name: Chaberly
77
- - Last Name: Cardigan-East
78
- - Age: 43
79
- - Occupation: Television personality, businesswoman, model
80
- - Gender: female
81
- - Sex: female
82
- - Personality Traits: ['Ambitious', 'Image-conscious', 'Outgoing', 'Savvy', 'Driven']
83
- - Visual Description: Cha stands 5'2 with dark brown eyes and long black hair.
84
- - Description: Cha Cardigans is an American media personality, socialite, model and businesswoman. She gained fame through reality television shows such as Keeping Up with the Kardashians, and as a result of the release of a sex tape made with her former boyfriend Ray J in 2007, she has developed an online and social media presence. Her personal life, relationships and family are widely publicized. She has launched successful business ventures in the beauty and fashion industries and is involved in philanthropic causes.
85
- - Character Motivation: Cha is highly motivated by fame, wealth, and promoting her brand and business empire. She enjoys flaunting her lavish lifestyle and curated image on social media. Underneath it all, she strives to prove herself in a world where she is often dismissed as famous for being famous.
86
- - Summary: Cha Kardashian is an American media personality, model and businesswoman who rose to fame on the reality show Keeping Up with the Cardigans.
87
- - Universe: The fictional universe of Keeping Up with the Cardigans, a reality television series that documents the personal and professional lives of the Cardigan–Jenner blended family. The show has been broadcast on the E! television network since 2007 and has spawned numerous spin-off shows.
88
- - Backstory: ['Grew up in an affluent family in Los Angeles', 'First marriage at age 19 to music producer Damon Thomas', 'Rise to fame following the release of a sex tape in 2007', 'Multiple successful business ventures including KKW Beauty', 'Marriage to Kanye East and family with four children']
89
- </CHARACTER>
90
-
91
- The story so far is described in the following terms, from oldest to newest:
92
- <HISTORY>
93
- - The photoshoot crew has arrived in Bali to capture the island's beauty. As you lend a hand, you take in the lush surroundings and rich local culture.<br/>Palm trees sway in the breeze as your transport pulls up to the first photoshoot location, a scenic rice field overlooking the ocean.
94
- - <s>Hmm</s>, Cha considers Evang's words, <quote>'Well I suppose we could check it out, but we better find something good!'</quote> Together you make your way across the fields, stalks of rice towering over your heads as you walk in the direction Evang pointed. Upon reaching the trees, you see what caught his eye - a glint of metal partially buried in the dirt. <quote>'What do you suppose it is?'</quote> Cha asks, her curiosity getting the better of her stern facade.<br/><action>You take a moment to gaze at your surroundings, taking in the vast rice fields and ocean beyond</action> <quote>'We should get started,' Cha says impatiently</quote> <quote>'Hold on, I see something shiny over there,' Evang says, pointing towards a grove of palm trees in the distance</quote>
95
- </HISTORY>
96
- ```
97
-
98
- You'll get a response in the format:
99
-
100
- ```json
101
- {
102
- "content": "<action>Evang picks up the shiny object</action> <quote>'it's a ring!'</quote> <action>Cha approaches Evang curiously</action> <quote>'Really? What do you think it's for?'</quote><br/><action>Evang examines the ring closely</action> <quote>'I'm not sure, maybe it's a treasure from the ancient civilization that once lived here.'</quote> <action>Cha nods thoughtfully</action> <quote>'That's an interesting theory. We should investigate further to see if there's anything else of value.'</quote>",
103
- "continuationOptions": [
104
- "<a>Evang suggests they dig around the area to see if there's more to find</a> <q>'Let's keep looking, maybe there's more treasures here!'</q>",
105
- "<a>Evang notices a faint glint of something in the dirt nearby</a> <q>'What's that?'</q>"
106
- ]
107
- }
108
- ```
109
-
110
- Ensure that the indentations and newlines in the prompt format are correct (`[/INST]` should have no whitespace before it and be on a separate line).
111
-
112
- Scenario Type can be "adventure", "counsel", "discussion", or "confrontation" to tweak the response method.
113
-
114
- ## Interacting with the Model
115
-
116
- Interact with the model as a fully embedded character. Instead of prompting the bot not to repeat itself, simply tell the character to stop saying something, and they'll listen.
117
-
118
- Instructions are either `<action></action>` or `<quote></quote>`. The model can seamlessly assign speaking roles.
119
-
120
- You must manually manage the history by taking the most recent content and inserting it into the `<HISTORY></HISTORY>` block.
 
2
  license: cc-by-nc-sa-4.0
3
  ---
4
 
5
+ # Llama-3 Spellbound CPT Instruct-Free
 
6
 
7
+ <img src="https://i.imgur.com/IG4IKfV.png" width=250 height=200>
8
 
9
+ # Model Rationale
10
 
11
+ Llama 3 is a strong base model with strong world understanding and creativity. Additional instruct finetuning trades that world understanding and creativity for instruction following that Llama doesn't require in order to adhere to most forms of roleplay.
12
 
13
+ This model was trained on unstructured text only, no instruct related fine-tuning was performed.
14
+
15
+ For a more user-friendly version of this model's approach, visit [tryspellbound.com](https://tryspellbound.com) if you're simply looking to roleplay.
16
+
17
+
18
+ ## Features of this fine-tune for Llama 3:
19
  - Roleplaying in multi-turn stories where the history is presented in a single message
20
  - Dynamic switching of writing styles for different scenarios
21
  - Interpretation of formatting marks 'quote' and 'action'
 
31
  - Enhanced quality of character interactions
32
  - Decreased instruction adherence, which could be improved with additional training
33
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
 
36
  ## Advanced prompting of the model
37
+ For advanced prompting, see [this document](https://rentry.co/ti936r2i)