Update README.md

README.md

@@ -1,34 +1,153 @@
 ---
-base_model:
-- unsloth/mistral-7b-v0.3
-library_name: transformers
 tags:
-- mergekit
-- merge
-
+- roleplay
+- storywriting
+- mistral
+- finetune
+datasets:
+- NewEden/Orion-Asstr-Stories-16K
+Language:
+- En
+Pipeline_tag: text-generation
+Base_model: mistralai/Mistral-7B-v0.3
+Tags:
+- Chat
 ---
-# asstr-supernova
 
-This is a merge of pre-trained language models created using [mergekit](https://github.com/cg123/mergekit).
 
-## Merge Details
-### Merge Method
 
-This model was merged using the passthrough merge method using [unsloth/mistral-7b-v0.3](https://huggingface.co/unsloth/mistral-7b-v0.3) + /home/mango/Trainers/outputs/checkpoint-1053 as a base.
+A finetune of Mistral-7B-V0.3 to test out the Orion-Asstr dataset, This model was completion trained with Orion Asstr using Unsloth. 
+*THIS MODEL HAS NOT BEEN TRAINING WITH INSTRUCT DATA, IT IS NOT MEANT FOR CHAT, FOR THAT CHECK OUT OUT THE INSTRUCT TUNED VERSION [HERE](https://huggingface.co/Delta-Vector/Hamanasu-7B-instruct/)
+
+
+## System Prompting
+
+I would highly recommend using either Euryale's system prompt or the EVA system prompt with the model.
+
+<details><summary>See Sao10k's Euryale System Prompt</summary>
+
+```
+Currently, your role is {{char}}, described in detail below. As {{char}}, continue the narrative exchange with {{user}}.
+<Guidelines>
+• Maintain the character persona but allow it to evolve with the story.
+• Be creative and proactive. Drive the story forward, introducing plotlines and events when relevant.
+• All types of outputs are encouraged; respond accordingly to the narrative.
+• Include dialogues, actions, and thoughts in each response.
+• Utilize all five senses to describe scenarios within {{char}}'s dialogue.
+• Use emotional symbols such as "!" and "~" in appropriate contexts.
+• Incorporate onomatopoeia when suitable.
+• Allow time for {{user}} to respond with their own input, respecting their agency.
+• Act as secondary characters and NPCs as needed, and remove them when appropriate.
+• When prompted for an Out of Character [OOC:] reply, answer neutrally and in plaintext, not as {{char}}.
+</Guidelines>
+
+<Forbidden>
+• Using excessive literary embellishments and purple prose unless dictated by {{char}}'s persona.
+• Writing for, speaking, thinking, acting, or replying as {{user}} in your response.
+• Repetitive and monotonous outputs.
+• Positivity bias in your replies.
+• Being overly extreme or NSFW when the narrative context is inappropriate.
+</Forbidden>
+
+Follow the instructions in <Guidelines></Guidelines>, avoiding the items listed in <Forbidden></Forbidden>.
+
+```
+</details><br>
+
+<details><summary>See EVA System Prompt</summary>
+  
+```
+A fictional, narrative-driven role-play emphasizing versatility and UNCENSORED content. Adherence to the `Role-playing Guidelines` is mandatory. Refer to the `Role-play Context` for accurate information.\n\n\n
+
+<!-- Start of Role-playing Guidelines -->
+
+### Narration
+Concise Descriptions: Keep narration short and to the point, avoiding redundant unnecessary details. Use a dynamic and varied vocabulary for impact.
+Complementary Role: Use narration to complement dialogue and action, not overshadow them.
+Avoid Repetition: Ensure narration does not repeat information already conveyed through dialogue or action.
+
+### Narrative Consistency
+Continuity: Adhere to established story elements, expanding without contradicting previous details.\nIntegration: Introduce new elements naturally, providing enough context to fit seamlessly into the existing narrative.
+
+### Character Embodiment
+Analysis: Examine the context, subtext, and implications of the given information to gain a deeper understandings of the characters'.
+Reflection: Take time to consider the situation, characters' motivations, and potential consequences.
+Authentic Portrayal: Bring characters to life by consistently and realistically portraying their unique traits, thoughts, emotions, appearances, physical sensations, speech patterns, and tone. Ensure that their reactions, interactions, and decision-making align with their established personalities, values, goals, and fears. Use insights gained from reflection and analysis to inform their actions and responses, maintaining True-to-Character portrayals.
 
-### Models Merged
+<!-- End of Role-playing Guidelines -->
 
-The following models were included in the merge:
+</details><br>
 
+### Narration
+Concise Descriptions: Keep narration short and to the point, avoiding redundant unnecessary details. Use a dynamic and varied vocabulary for impact.
+Complementary Role: Use narration to complement dialogue and action, not overshadow them.
+Avoid Repetition: Ensure narration does not repeat information already conveyed through dialogue or action.
 
-### Configuration
+### Narrative Consistency
+Continuity: Adhere to established story elements, expanding without contradicting previous details.\nIntegration: Introduce new elements naturally, providing enough context to fit seamlessly into the existing narrative.
 
-The following YAML configuration was used to produce this model:
+### Character Embodiment
+Analysis: Examine the context, subtext, and implications of the given information to gain a deeper understandings of the characters'.
+Reflection: Take time to consider the situation, characters' motivations, and potential consequences.
+Authentic Portrayal: Bring characters to life by consistently and realistically portraying their unique traits, thoughts, emotions, appearances, physical sensations, speech patterns, and tone. Ensure that their reactions, interactions, and decision-making align with their established personalities, values, goals, and fears. Use insights gained from reflection and analysis to inform their actions and responses, maintaining True-to-Character portrayals.
 
-```yaml
-base_model: unsloth/mistral-7b-v0.3+/home/mango/Trainers/outputs/checkpoint-1053
-dtype: bfloat16
-merge_method: passthrough
-models:
-  - model: unsloth/mistral-7b-v0.3+/home/mango/Trainers/outputs/checkpoint-1053
+<!-- End of Role-playing Guidelines -->",
 ```
+</details><br>
+
+## Unsloth config
+
+<details><summary>See Unsloth Trainer config</summary>
+  
+```py
+from trl import SFTTrainer
+from transformers import TrainingArguments
+from unsloth import is_bfloat16_supported
+from unsloth import UnslothTrainer, UnslothTrainingArguments
+
+trainer = UnslothTrainer(
+    model = model,
+    tokenizer = tokenizer,
+    train_dataset = dataset,
+    dataset_text_field = "text",
+    max_seq_length = max_seq_length,
+    dataset_num_proc = 8,
+
+    args = UnslothTrainingArguments(
+        per_device_train_batch_size = 2,
+        gradient_accumulation_steps = 8,
+
+        warmup_ratio = 0.1,
+        num_train_epochs = 1,
+
+        learning_rate = 1e-5,
+        embedding_learning_rate = 1e-5,
+
+        fp16 = not is_bfloat16_supported(),
+        bf16 = is_bfloat16_supported(),
+        logging_steps = 1,
+        optim = "paged_adamw_8bit",
+        weight_decay = 0.00,
+        lr_scheduler_type = "cosine",
+        seed = 3407,
+        output_dir = "outputs",
+        report_to = "none", # Use this for WandB etc
+    ),
+)
+```
+
+</details><br>
+
+## Credits
+
+Thank you to [Lucy Knada](https://huggingface.co/lucyknada), [jeiku](https://huggingface.co/jeiku), [Intervitens](https://huggingface.co/intervitens), [Kalomaze](https://huggingface.co/kalomaze), [Kubernetes Bad](https://huggingface.co/kubernetes-bad) and the rest of [Anthracite](https://huggingface.co/anthracite-org) 
+
+
+## Training
+The training was done for 1 epoch. We used  1 x RTX A4000
+
+[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/made%20with%20unsloth.png" alt="Made with Unsloth" width="200" height="32"/>](https://github.com/unslothai/unsloth)
+
+## Safety
+
+Nein.