Update README.md

README.md

@@ -1,32 +1,36 @@
----
-tags:
-- generated_from_trainer
-model-index:
-- name: home/suika/bin/axolotl/OUT-perscengen/
-  results: []
----
+# LimaRP Persona-Scenario Generator (v5, Alpaca)
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+A previously unpublished LoRA adapter for [Yarn-Llama-2-7B-64k](https://huggingface.co/NousResearch/Yarn-Llama-2-7b-64k) made
+for internal use. Its primary purpose is generating Persona and Scenario (summary) from LimaRP `yaml` source data.
+To some extent it can work with different text types, however.
 
-[<img src="https://raw.githubusercontent.com/OpenAccess-AI-Collective/axolotl/main/image/axolotl-badge-web.png" alt="Built with Axolotl" width="200" height="32"/>](https://github.com/OpenAccess-AI-Collective/axolotl)
-# home/suika/bin/axolotl/OUT-perscengen/
+## Prompt format
+```
+### Input:
+{Your text here}
 
-This model was trained from scratch on the None dataset.
-It achieves the following results on the evaluation set:
-- Loss: 1.8290
+### Response:
+Charactername's Persona: {output goes here}
+```
 
-## Model description
+Replace `Charactername` with the name of the character you want to infer a Persona for.
+By default this LoRA looks for the placeholder names `<FIRST>` and `<SECOND>` (in this
+respective order) but it can work with proper names as well.
 
-More information needed
+## Example
+This image shows what would happen (red box) after adding data in the format shown in the left pane.
 
-## Intended uses & limitations
+![img](https://files.catbox.moe/rfwlpp.png)
 
-More information needed
+In practice the results would be double-checked and manually tweaked to diversify the
+outputs and adding character quirks, peculiarities or traits that the model couldn't catch.
 
-## Training and evaluation data
-
-More information needed
+## Known issues
+- While the scenario/summary is often remarkably accurate, personas don't show a very high accuracy and can be repetitive.
+- Persona and Scenario may exhibit `gpt`-isms.
+- Peculiar character quirks may not be observed by the model.
+- The LoRA hasn't been extensively tested with different input formats.
+- This LoRA hasn't been updated in a good while.
 
 ## Training procedure