Update README.md

README.md

@@ -1,16 +1,29 @@
 ---
-library_name: peft
+license: llama2
+language:
+  - en
+tags:
+  - roleplay
+  - characters
 ---
 
-# Character Making Lora: test 2
+# CharGen v1
 
-Changes: trained on more uniform, curated subset of test-1 cards, with scenario included into instruction.
+> A model for creating characters for role play.
 
-For now, it only supports plaintext cards. Try plist/w++/etc at your own risk.
+Trained on *lots* of character cards both from chub and janitor, with some post-processing.
 
-Address {{user}} as `User`. Character descriptions work best if they begin with `CharacterName is a ...` - for example "Martha is a middle-aged woman who is ..."
+For now, it only supports plaintext cards. Any other variation like plist/w++/etc is entirely untested.
 
-Use alpaca template with the following instruction:
+Address {{user}} as `User`. Character descriptions work best if they begin with `CharacterName is a ...` - for example *"Martha is a middle-aged woman who is ..."*
+
+NB: This model is **NOT** for roleplay directly. It creates characters that can then be used in roleplay with some other model like [MythoMax](https://huggingface.co/Gryphe/MythoMax-L2-13b).
+
+It was trained on dynamic prompt template, so it should be able to accommodate your changes to the prompt. 
+
+Trained as a LoRA, the released model is a merge with [Airoboros 2.2](https://huggingface.co/jondurbin/airoboros-l2-13b-2.2) for extra-good instruction following.
+
+Prompt template:
 
 ```
 Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
@@ -38,4 +51,30 @@ Fuckana is a friendly and talkative catgirl that has enormous breasts. Her voice
 
 ### Response:
 
-```
+```
+
+### Dataset
+
+~34,000 cards from CharacterHub and another ~80,000 cards from Janitor were used as initial dataset, as captured in period between August and September 2023.
+
+Dataset will not be released, unless explicit permission to do so would be granted from both Chub and Janitor.
+
+
+## Training procedure
+
+
+The following `bitsandbytes` quantization config was used during training:
+- quant_method: bitsandbytes
+- load_in_8bit: True
+- load_in_4bit: False
+- llm_int8_threshold: 6.0
+- llm_int8_skip_modules: None
+- llm_int8_enable_fp32_cpu_offload: False
+- llm_int8_has_fp16_weight: False
+- bnb_4bit_quant_type: fp4
+- bnb_4bit_use_double_quant: False
+- bnb_4bit_compute_dtype: float32
+### Framework versions
+
+
+- PEFT 0.6.0.dev0