Create README.md

README.md

@@ -0,0 +1,273 @@
+---
+language:
+- en
+pipeline_tag: text-generation
+tags:
+- unsloth
+- axolotl
+license: cc-by-nc-nd-4.0
+---
+
+```
+  e88 88e                               d8     
+ d888 888b  8888 8888  ,"Y88b 888 8e   d88     
+C8888 8888D 8888 8888 "8" 888 888 88b d88888   
+ Y888 888P  Y888 888P ,ee 888 888 888  888     
+  "88 88"    "88 88"  "88 888 888 888  888     
+      b                                        
+      8b,                                      
+ 
+  e88'Y88                  d8           888    
+ d888  'Y  ,"Y88b 888,8,  d88    ,e e,  888    
+C8888     "8" 888 888 "  d88888 d88 88b 888    
+ Y888  ,d ,ee 888 888     888   888   , 888    
+  "88,d88 "88 888 888     888    "YeeP" 888    
+                                               
+PROUDLY PRESENTS         
+```
+# dreamgen-opus-v1.2-70b-exl2-rpcal
+Quantized using 200 samples of 8192 tokens from an RP-oriented [PIPPA](https://huggingface.co/datasets/royallab/PIPPA-cleaned) dataset.
+
+Branches:
+- `main` -- `measurement.json`
+- `4.65b6h` -- 4.65bpw, 6bit lm_head
+
+Original model link: [dreamgen/opus-v1.2-70b](https://huggingface.co/dreamgen/opus-v1.2-70b)
+
+Original model README below.
+
+-----
+
+# DreamGen Opus V1
+
+<div style="display: flex; flex-direction: row; align-items: center;">
+<img src="https://huggingface.co/dreamgen/opus-v1.2-70b/resolve/main/images/logo-1024.png" alt="model logo" style="
+    border-radius: 12px;
+    margin-right: 12px;
+    margin-top: 0px;
+    margin-bottom: 0px;
+    max-width: 100px;
+    height: auto;
+"/>
+
+Models for **(steerable) story-writing and role-playing**.
+<br/>[All Opus V1 models, including quants](https://huggingface.co/collections/dreamgen/opus-v1-65d092a6f8ab7fc669111b31).
+
+</div>
+
+## Resources
+
+- [**Opus V1 prompting guide**](https://dreamgen.com/docs/models/opus/v1) with many (interactive) examples and prompts that you can copy.
+- [**Google Colab**](https://colab.research.google.com/drive/1J178fH6IdQOXNi-Njgdacf5QgAxsdT20?usp=sharing) for interactive role-play using `opus-v1.2-7b`.
+- [Python code](example/prompt/format.py) to format the prompt correctly.
+- Join the community on [**Discord**](https://dreamgen.com/discord) to get early access to new models.
+
+<img src="https://huggingface.co/dreamgen/opus-v1.2-70b/resolve/main/images/story_writing.webp" alt="story writing on dreamgen.com" style="
+    padding: 12px;
+    border-radius: 12px;
+    border: 2px solid #f9a8d4;
+    background: rgb(9, 9, 11);
+"/>
+
+## Prompting
+
+<details>
+<summary>The models use an extended version of ChatML.</summary>
+
+```
+<|im_start|>system
+(Story description in the right format here)
+(Typically consists of plot description, style description and characters)<|im_end|>
+<|im_start|>user
+(Your instruction on how the story should continue)<|im_end|>
+<|im_start|>text names= Alice
+(Continuation of the story from the Alice character)<|im_end|>
+<|im_start|>text
+(Continuation of the story from no character in particular (pure narration))<|im_end|>
+<|im_start|>user
+(Your instruction on how the story should continue)<|im_end|>
+<|im_start|>text names= Bob
+(Continuation of the story from the Bob character)<|im_end|>
+```
+
+The Opus V1 extension is the addition of the `text` role, and the addition / modification of role names.
+
+Pay attention to the following:
+
+- The `text` messages can (but don't have to have) `names`, names are used to indicate the "active" character during role-play.
+- There can be multiple subsequent message with a `text` role, especially if names are involved.
+- There can be multiple names attached to a message.
+- The format for names is `names= {{name[0]}}; {{name[1]}}`, beware of the spaces after `names=` and after the `;`. This spacing leads to most natural tokenization for the names.
+</details>
+
+While the main goal for the models is great story-writing and role-playing performance, the models are also capable of several writing related tasks as well as general assistance.
+
+Here's how you can prompt the model for the following tasks
+
+### Steerable Story-writing and Role-playing:
+
+- [Story-writing prompt guide](https://dreamgen.com/docs/models/opus/v1#task-story-writing)
+- [Role-playing prompt guide](https://dreamgen.com/docs/models/opus/v1#task-role-playing)
+- Input:
+  - System prompt: You provide story / role-play description, which consists of:
+    - Plot description
+    - Style description
+    - Characters and their descriptions
+  - Conversation turns:
+    - Text / message turn: This represents part of the story or role play
+    - Instruction: This tells the model what should happen next
+- Output: Continuation of the story / role-play.
+
+### Story plot summarization
+
+- [Prompt guide](https://dreamgen.com/docs/models/opus/v1#task-plot-description)
+- Input: A story, or a few chapters of a story.
+- Output: A description of the story or chapters.
+
+#### Examples:
+
+<details>
+  <summary>Summary of <a href="https://www.libraryofshortstories.com/onlinereader/the-last-incantation">short fiction story</a> in 50 words</summary>
+  <blockquote>
+  Malygris, a powerful magician, summons his long-dead lover Nylissa from the grave using necromancy. However, upon seeing her, he realizes that she is not the same person he once knew, leading him to question the nature of love, memory, and the power of magic.
+  </blockquote>
+</details>
+<details>
+  <summary>Summary of <a href="https://www.libraryofshortstories.com/onlinereader/the-last-incantation">short fiction story</a> in 200 words</summary>
+  <blockquote>
+The story is a dark fantasy set in the city of Susran, where an ancient and powerful magician named Malygris dwells in a tower atop a conical hill. Malygris, who has mastered all forms of sorcery and necromancy, is plagued by a deep sense of ennui and melancholy. He seeks solace in the memory of Nylissa, a girl he once loved in his youth.
+
+One day, Malygris decides to summon Nylissa's spirit from the grave using his necromantic powers. He performs the necessary rituals and incantations, and Nylissa appears before him as a ghostly apparition. However, as Malygris gazes upon her, he becomes increasingly disillusioned. He notices subtle changes in her appearance and behavior that do not match his memories of her. He begins to question whether this is truly the same Nylissa he once knew, or if it is just another illusion conjured by his magic.
+
+As Malygris grapples with this uncertainty, he becomes increasingly despondent and disillusioned with life itself. He realizes that even his magic cannot bring back the past or make him truly happy. In the end, he dismisses Nylissa's spirit and returns to his lonely tower, resigned to his fate as an old and weary sorcerer.
+  </blockquote>
+
+</details>
+<details>
+  <summary>Summary of <a href="https://edition.cnn.com/2024/02/29/health/pets-diseases-viruses-bacteria-wellness/index.html">CNN News article</a> in 150 words</summary>
+  <blockquote>
+The article discusses the recent human deaths from diseases transmitted by animals, specifically Alaskapox and bubonic plague. Dr. Leana Wen, an emergency physician and former Baltimore health commissioner, explains the various ways household pets can transmit diseases to humans. These include fecal-oral transmission, scratches and bites, and vector-borne diseases like ticks, fleas, and mosquitoes. Wen emphasizes the importance of vaccinating pets, maintaining cleanliness, and taking commonsense precautions to reduce disease transmission. She also advises that individuals who are immunocompromised, babies, and pregnant women should take additional care when interacting with animals.
+  </blockquote>
+</details>
+<details>
+  <summary>Summary of <a href="https://edition.cnn.com/2024/02/29/health/pets-diseases-viruses-bacteria-wellness/index.html">CNN News article</a> in 50 words</summary>
+  <blockquote>
+A doctor discusses the risks of diseases transmitted from animals to humans, focusing on household pets like cats and dogs. They emphasize the importance of vaccination, hygiene, and regular veterinary care to prevent these illnesses.
+  </blockquote>
+</details>
+
+### Story character description
+
+- [Prompt guide](https://dreamgen.com/docs/models/opus/v1#task-char-description)
+- Input: A story, or a few chapters of a story, set of characters.
+- Output: A description of the characters.
+
+#### Examples:
+
+<details>
+  <summary>Description of the Malygris character from <a href="https://www.libraryofshortstories.com/onlinereader/the-last-incantation">this story</a> in 50 words</summary>
+  <blockquote>
+Malygris is an ancient and powerful magician, characterized by his long white beard, cold green eyes, and a violet robe. He is a master of necromancy and possesses a vast knowledge of forbidden magic. Despite his immense power, he is plagued by a deep sense of melancholy and ennui.
+  </blockquote>
+</details>
+
+<details>
+  <summary>Description of the prince character from <a href="https://www.libraryofshortstories.com/onlinereader/the-pearl-of-love">this story</a> in 50 words</summary>
+  <blockquote>
+The prince is a devoted and determined individual, driven by his love for his late queen. He is described as a graceful youth in the beginning, but as he grows older, his dedication to the Pearl of Love transforms him into a grave and intent man. His sense of color and design evolves over time, reflecting his growing maturity and artistic vision.
+  </blockquote>
+</details>
+
+### Story style description
+
+- [Prompt guide](https://dreamgen.com/docs/models/opus/v1#task-style-description)
+- Input: A story, or a few chapters of a story.
+- Output: A description the style of the story.
+
+<details>
+  <summary>Style description of <a href="https://www.libraryofshortstories.com/onlinereader/the-last-incantation">this story</a></summary>
+  <blockquote>
+The story is written in a descriptive and evocative style, with a focus on the atmosphere and setting. The author uses vivid and detailed language to create a sense of place and time, and employs a variety of literary devices such as similes, metaphors, and allusions to enhance the mood and tone of the narrative. The sentence structure is varied, with a mix of short and long sentences that create a rhythmic flow to the prose.
+  </blockquote>
+</details>
+
+<details>
+  <summary>Style description of <a href="https://www.libraryofshortstories.com/onlinereader/the-pearl-of-love">this story</a></summary>
+  <blockquote>
+The writing style is descriptive and evocative, with a focus on the beauty and grandeur of the Pearl of Love. The author uses vivid imagery and sensory details to create a rich and immersive atmosphere. The tone is reverential and contemplative, reflecting the prince's deep love for his queen and his dedication to creating a lasting monument to her memory.
+  </blockquote>
+</details>
+
+### Story description to chapters
+
+- [Prompt guide](https://dreamgen.com/docs/models/opus/v1#task-story-description-to-chapter-descriptions)
+- Input: A brief plot description and the desired number of chapters.
+- Output: A description for each chapter.
+
+### And more...
+
+## Sampling params
+
+For story-writing and role-play, I recommend "Min P" based sampling with `min_p` in the range `[0.01, 0.1]` and with `temperature` in the range `[0.5, 1.5]`, depending on your preferences. A good starting point would be `min_p=0.1; temperature=0.8`.
+
+You may also benefit from setting presence, frequency and repetition penalties, especially at lower temperatures.
+
+## Dataset
+
+The fine-tuning dataset consisted of ~100M tokens of steerable story-writing, role-playing, writing-assistant and general-assistant examples. Each example was up to 31000 tokens long.
+
+All story-writing and role-playing examples were based on human-written text.
+
+![token count distribution](images/token_count_cum__token_bucket.png)
+
+## Running the model
+
+The model is should be compatible with any software that supports the base model, but beware of prompting and tokenization.
+
+I recommend using these model versions:
+
+- 7B: [no quant (opus-v1.2-7b)](https://huggingface.co/dreamgen/opus-v1.2-7b)
+- 34B: [no quant (opus-v1-34b)](https://huggingface.co/dreamgen/opus-v1-34b) or [awq (opus-v1-34b-awq)](https://huggingface.co/dreamgen/opus-v1-34b-awq)
+- 70B: [no quant (opus-v1.2-70b)](https://huggingface.co/dreamgen/opus-v1.2-70b) or [awq (opus-v1.2-70b-awq)](https://huggingface.co/dreamgen/opus-v1.2-70b-awq)
+
+### Running on DreamGen.com (free)
+
+You can run the models on [dreamgen.com](https://dreamgen.com) for free — you can use the built-in UI for story-writing & role-playing, or use [the API](https://dreamgen.com/docs/api).
+
+### Running Locally
+
+- **Make sure your prompt is as close as possible to the Opus V1**
+  - Regardless of which backend you use, it's important that you format your prompt well and that the tokenization works correctly.
+  - [Read the prompt guide](https://dreamgen.com/docs/models/opus/v1)
+  - [Read the prompt formatting code](example/prompt/format.py)
+  - Make sure `<|im_start|>` and `<|im_end|>` are tokenized correctly
+- **vLLM**
+  - [**Google Colab**](https://colab.research.google.com/drive/1J178fH6IdQOXNi-Njgdacf5QgAxsdT20?usp=sharing): This is a simple interactive Google Colab to do role-play with the 7B model, it should fit on the T4 GPU.
+  - [Code](example/prompt/interactive.py): This is simple script for interactive chat for one hard-coded scenario.
+- **SillyTavern**
+  - [Official SillyTavern documentation for DreamGen](https://docs.sillytavern.app/usage/api-connections/dreamgen/) -- applies to both the API an local models
+  - SillyTavern (staging) comes with built-in DreamGen preset for RP
+    - Other presets can be found [here](https://huggingface.co/dreamgen/opus-v1.2-70b/tree/main/configs/silly_tavern), v2 kindly provided by @MarinaraSpaghetti
+    - Make sure to unselect `Skip special tokens`, otherwise it won't work
+    - This is just an attempt at approximating the Opus V1 prompt, it won't be perfect
+  - Character cards specifically rewritten for the built-in DreamGen preset:
+    - [Seraphina](configs/silly_tavern/cards/Seraphina.png) (based on the default Seraphina card)
+    - [Lara Lightland](configs/silly_tavern/cards/LaraLightland.png) (based on the card by Deffcolony)
+- **LM Studio**
+  - [Config](configs/lmstudio/preset.json)
+  - Just like ChatML, just changed "assistant" to "text" role.
+  - **There's a bug** in LM Studio if you delete a message or click "Continue", [see here for details](https://discord.com/channels/1110598183144399058/1212665261128417280/1212665261128417280).
+- **HuggingFace**
+  - [Chat template](tokenizer_config.json#L51)
+  - Just like ChatML, just changed "assistant" to "text" role.
+
+## Known Issues
+
+- **34B repetition**:
+  - The 34B sometimes gets stuck repeating the same word, or synonyms. This seems to be a common problem across various Yi 34B fine-tunes.
+- **GGUF**:
+  - The tokenization might be messed up. Some users reported that `<|im_start|>` and `<|im_end|>` are tokenized as multiple tokens. Also llama.cpp may not tokenize correctly (the Yi tokenizer is subtly different from the Llama 2 tokenizer).
+
+## License
+
+- This model is intended for personal use only, other use is not permitted.