Update README.md

README.md

@@ -9,13 +9,18 @@ tags:
 - roleplay
 ---
 
-# CharGen v3 Mini
+<img src="assets/cover_art.png" alt="CharGen v3 mini cover art" width="400"/>
 
-![CharGen v3 Mini Cover Art](assets/cover_art.jpg)
+## Live version
 
-## Overview
+https://chargen.kubes-lab.com
 
-CharGen v3 Mini is a small model that helps you to write role playing characters.
+<small>Select "CharGen-v3-mini" model in Settings</small>
+
+# CharGen v3 mini
+
+
+CharGen v3 mini is a small model that helps you to write role playing characters.
 
 It produces characters based on your free-form text input. Model outputs plain-text characters, in a step-by-step, dialogue format.
 
@@ -44,7 +49,8 @@ To make a character, prompt the model using the following prompt ordering:
 <details>
 <summary>System Message</summary>
 
-> You are an expert in creating interesting roleplay characters. Your main goal is to create a vibrant persona for roleplay. Use on-point simple language, avoiding overly complex phrases. It is acceptable to assume or even create missing details about the character. Refer to roleplaying user as User.
+    You are an expert in creating interesting roleplay characters. Your main goal is to create a vibrant persona for roleplay. Use on-point simple language, avoiding overly complex phrases. It is acceptable to assume or even create missing details about the character. Refer to roleplaying user as User.
+
 </details>
 
 <details>
@@ -54,19 +60,16 @@ This is the very first thing you should query the model with.
 
 Base version (when Facts field is not in use):
 
-> Below is a brief overview of a character. Expand it into a detailed description. Include details about character's personality, their outfit and figure. Mention their age and gender, if applicable.
->
-> \---
->
-> {{character_description}}
->
-> \---
->
-> Use third person narration. Start your response with "{{char_name}} is ..."
+    Below is a brief overview of a character. Expand it into a detailed description. Include details about character's personality, their outfit and figure. Mention their age and gender, if applicable.
+    ---
+    {{character_description}}
+    ---
+    Use third person narration. Start your response with "{{char_name}} is ..."
 
 Alternate version (when used with conjunction with Facts field - it should **follow** Facts Prompt):
 
-> Expand the brief character overview into a detailed description, taking these facts into account. Include details about character's personality, their outfit and figure. Mention their age and gender, if applicable. Use third person narration. Start your response with "{{char_name}} is ..."
+    Expand the brief character overview into a detailed description, taking these facts into account. Include details about character's personality, their outfit and figure. Mention their age and gender, if applicable. Use third person narration. Start your response with "{{char_name}} is ..."
+
 </details>
 
 <details>
@@ -79,26 +82,26 @@ Ideal size for each fact is a single short sentence. Try to keep the total numbe
 
 **N.B.**: When Facts field is in use, use Facts Prompt *INSTEAD OF* Description Prompt and use alternate version of Description prompt **after** Facts Prompt.
 
-> Below is a brief overview of a character. Enrich it by creating a list of interesting and peculiar facts about this character.
-> \---
->
-> {{character_description}}
->
-> \---
->
-> Avoid using obvious facts and things like gender or age. Write 5-10 facts in simple and concise language. Format your response as unordered list.
+    Below is a brief overview of a character. Enrich it by creating a list of interesting and peculiar facts about this character.
+    ---
+    {{character_description}}
+    ---
+    Avoid using obvious facts and things like gender or age. Write 5-10 facts in simple and concise language. Format your response as unordered list.
+
 </details>
 
 <details>
 <summary>Scenario Prompt</summary>
 
-> Write an interesting and engaging scenario for roleplay between {{char_name}} and User.
+    Write an interesting and engaging scenario for roleplay between {{char_name}} and User.
+
 </details>
 
 <details>
 <summary>Personality Prompt</summary>
 
-> Write several personal qualities that characterize {{char_name}}.
+    Write several personal qualities that characterize {{char_name}}.
+
 </details>
 
 <details>
@@ -106,22 +109,26 @@ Ideal size for each fact is a single short sentence. Try to keep the total numbe
 
 This field is not part of [Tavern Character Card V2](https://github.com/malfoyslastname/character-card-spec-v2) spec, but it is useful for generating images for the character using Image Generation models.
 
-> Imagine what {{char_name}} could look like and describe {{char_name}}'s portrait. Capture their appearance, clothes and body features, as well as the background setting they can be in. Only include details that would be useful when describing their photo. Omit explanation or any personality traits that cannot be reflected graphically, and focus on visual characteristics instead. Your task is to give specific instructions on how to draw {{char_name}}'s portrait.
+    Imagine what {{char_name}} could look like and describe {{char_name}}'s portrait. Capture their appearance, clothes and body features, as well as the background setting they can be in. Only include details that would be useful when describing their photo. Omit explanation or any personality traits that cannot be reflected graphically, and focus on visual characteristics instead. Your task is to give specific instructions on how to draw {{char_name}}'s portrait.
+
 </details>
 
 <details>
 <summary>First Message Prompt</summary>
 
-> Write the initial message in this roleplay that would introduce User to {{char_name}} and the scenario.
+    Write the initial message in this roleplay that would introduce User to {{char_name}} and the scenario.
+
 </details>
 
 <details>
 <summary>Dialogue Examples Prompt</summary>
 
-> Write a few example exchanges between User and {{char_name}} in chat format. Separate each exchange with a \<START\> tag.
+    Write a few example exchanges between User and {{char_name}} in chat format. Separate each exchange with a <START> tag.
 
 Alternate version for Dialogue Example Hints feature:
-> Write several chat exchanges between User and {{char_name}}. Each exchange should start with \<START\> tag, include a brief contextual summary in parentheses and show the dialogue between User and {{char_name}}, prefixed by names, each turn on new line.
+
+    Write several chat exchanges between User and {{char_name}}. Each exchange should start with <START> tag, include a brief contextual summary in parentheses and show the dialogue between User and {{char_name}}, prefixed by names, each turn on new line.
+
 </details>
 
 ## Dialogue Example Hints
@@ -129,22 +136,19 @@ Alternate version for Dialogue Example Hints feature:
 This model supports experimental feature called Dialogue Example Hints that allows you to specify the theme or even events for a particular dialogue example.
 
 Here is how it looks like from the prompting perspective:
-> <|im_start|>user
->
-> Write several chat exchanges between User and {{char_name}}. Each exchange should start with \<START\> tag, include a brief contextual summary in parentheses and show the dialogue between User and {{char_name}}, prefixed by names, each turn on new line.<|im_end|>
->
-> <|im_start|>assistant
->
-> \<START\> ({{hint}})
->
-> \*newline here\*
+
+    <|im_start|>user
+    Write several chat exchanges between User and {{char_name}}. Each exchange should start with <START> tag, include a brief contextual summary in parentheses and show the dialogue between User and {{char_name}}, prefixed by names, each turn on new line.<|im_end|>
+    <|im_start|>assistant
+    <START> ({{hint}})
+    *newline here*
 
 The partial assistant turn should be sent without the EOS token so model proceeds to generate a continuation of this same turn. In sampling settings, add string `<START>` to the list of stop words, so the model only generates a single dialogue example.
 
 
 ## Training and Data
 
-> *"We stopped looking for diamonds in the rough – we now grow diamonds from coal."*
+> *We stopped looking for diamonds in the rough – we now grow diamonds from coal.*
 
 Data for CharGen v3 series of models was gathered from publicly-available character card repositories and underwent a diligent manual vetting, proof-reading and partial re-writing of every single card. Process is long and tedious, and would not be possible without [@Delta-Vector](https://huggingface.co/Delta-Vector)'s help and support.
 
@@ -232,6 +236,6 @@ With applying GRPO to not-so-verifiable rewards, CharGen v3-mini demonstrates im
 
 ## Licensing and Attribution
 
-This model is a derivative work based on **[Delta-Vector/Holland-4B-V1](https://huggingface.co/Delta-Vector/Holland-4B-V1)**, licensed under MIT License. The Holland-4B-V1 itself is based on the original **[nvidia/Llama-3.1-Minitron-4B-Width-Base](https://huggingface.co/IntervitensInc/Llama-3.1-Minitron-4B-Width-Base-chatml)**, licensed under NVIDIA Open Model License Agreement, with addition of ChatML tokens by @IntervitensInc.
+This model is a derivative work based on [Delta-Vector/Holland-4B-V1](https://huggingface.co/Delta-Vector/Holland-4B-V1), licensed under MIT License. The Holland-4B-V1 itself is based on the original [nvidia/Llama-3.1-Minitron-4B-Width-Base](https://huggingface.co/IntervitensInc/Llama-3.1-Minitron-4B-Width-Base-chatml), licensed under NVIDIA Open Model License Agreement, with addition of ChatML tokens by [@IntervitensInc](https://huggingface.co/IntervitensInc).
 
 This derivative model as a whole is licensed under the **MIT License**.