Upload 3 files

Psyfighter2-13B-vore.Q4_K_M.gguf

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:4f953054dd6352bf107473e50ed33daa3392cd9ef2ffd62afc14bc016c00aa73
+oid sha256:906ee4c1fa60cd36949972bfc6d3b35302435b77afd7031b50ec61d38b0f1185
 size 7865956448

Psyfighter2-13B-vore.Q8_0.gguf

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:4709594e2f8430c25cb5a446e658ec777f3b116d43a08bbd7101927d250bdcee
+oid sha256:487f1febff821f9d5c03dac612edc3248af899aac1f4b122e8ed2385f87817de
 size 13831319648

README.md

@@ -12,15 +12,15 @@ tags:
 base_model: SnakyMcSnekFace/Psyfighter2-13B-vore
 model_type: llama
 prompt_template: >
+  ### Instruction: 
+
   Below is an instruction that describes a task. Write a response that
   appropriately completes the request.
 
-
-  ### Instruction:
+  ### Input:
 
   {prompt}
 
-
   ### Response:
 ---
 
@@ -30,7 +30,7 @@ This is a quantized version of [SnakyMcSnekFace/Psyfighter2-13B-vore](https://hu
 
 This model is a version of [KoboldAI/LLaMA2-13B-Psyfighter2](https://huggingface.co/KoboldAI/LLaMA2-13B-Psyfighter2) finetuned to better understand vore context. The primary purpose of this model is to be a storywriting assistant, a conversational model in a chat, and an interactive choose-your-own-adventure text game.
 
-The Adventure Mode is still work in progress, and will be added later.
+The model has preliminary support for Adventure Mode. It is still work in progress, and the model will be further trained to be better at storytelling and to not require complicated configuration. **(See instructions below for configuring Adventure Mode for optimal performance.)**
 
 ## Model Details
 
@@ -55,13 +55,63 @@ The easiest way to try out the model is [Koboldcpp Colab Notebook](https://colab
 - Open the notebook
 - Paste the model URL into the `Model`  field: `https://huggingface.co/SnakyMcSnekFace/Psyfighter2-13B-vore-GGUF/resolve/main/Psyfighter2-13B-vore.Q4_K_M.gguf`
 - Start the notebook, wait for the URL to CloudFlare tunnel to appear at the bottom and click it
-- Use the model as a writing assistant
-- You can try an adventure from [https://aetherroom.club/](https://aetherroom.club/), but keep in mind that it is still a work-in-progress. The adventure mode will be the focus of the future updates.
+- Select "Settings" and configure them as follows:
+  - In "Basic" tab:
+    - Temperature = 0.8
+    - Amount to Gen. = 512
+    - Top p Sampling = 0.9
+    - Repetition Pentalty = 1.1
+  - In "Advanced" tab:
+    - Min-P = 0.1
+    - EOS Token Ban = Unban
+    - Placeholder Tags = Checked
+- Select "Scenarios" -> "New Story" to use the model as a writing assistant
 
 #### To run `Q8_0` model in Colab notebook
 - Paste the model URL into the `Model` field: `https://huggingface.co/SnakyMcSnekFace/Psyfighter2-13B-vore-GGUF/resolve/main/Psyfighter2-13B-vore.Q8_0.gguf`
 - Set `Layers` field to `30` (reduce this number if the model fails to start)
 
+#### Adventure Mode
+
+The model has **preliminary** support for the adventure mode. Select "Scenarios" -> "New Adventure" to start an adventure.
+
+**IMPORTANT - The context must be configured exactly as described below or the model will not perform well.**
+
+- Select "Context"
+- Paste this text into "Memory" verbatim:
+```
+### Instruction: 
+
+Text transcript of a never-ending adventure story, written by the AI assistant. AI assistant uses vivid and evocative language to create a well-written novel. Characters are proactive and take initiative. Think about what goals the characters of the story have and write what they do to achieve those goals. 
+
+### Input: 
+```
+- Ensure that "Newline After Memory" is checked
+- Paste this text into "Author's note" verbatim **(IMPORTANT: the Author's Note must end with two empty lines)**:
+```
+Write a few paragraphs that advance the plot of the story. 
+
+### Response: 
+
+
+```
+- Set "A/N Strength" to "Immediate"
+- Set "Author's Note Template" to `<|>`
+
+#### Adventure - creating premise and taking turns
+
+Select "Story" in the bottom left corner to generate premise of the story, and "Action" to take actions with your character. In the adventure mode, the model expects all player actions to be written in second person. For example:
+
+```
+As you venture deeper into the damp cave, you come across a lone goblin. The vile creature mumbles something to itself as it stares at the glowing text on a cave wall. It doesn't notice your approach.
+
+> You sneak behind the goblin and hit it with the sword.
+
+```
+
+Check "Allow Editing" to make edits to the story to overwrite and re-generate parts of the model's response. This is useful if the model makes a mistake or the story doesn't go in the direction that you like.
+
+
 ### Backyard AI 
 
 Another convenient way to use the model is [Backyard AI](https://backyard.ai/) application, which allows you to run the model locally on your computer. You'll need a graphics card with at least 8GB VRAM to use the model comfortably.
@@ -78,6 +128,7 @@ Download [Psyfighter2-13B-vore.Q4_K_M.gguf](https://huggingface.co/SnakyMcSnekFa
 
 ## Model updates
 
+- 09/02/2024 - fine-tuned the model to follow Kobold AI Adventure Mode format
 - 06/02/2024 - fixed errors in training and merging, significantly improving the overall prose quality
 - 05/25/2024 - updated training process, making the model more coherent and improving the writing quality
 - 04/13/2024 - uploaded the first version of the model