Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,82 @@
+
+---
+
+license: apache-2.0
+language:
+- en
+base_model:
+- mistralai/Mistral-Nemo-Base-2407
+tags:
+- text adventure
+- roleplay
+
+---
+
+[![QuantFactory Banner](https://lh7-rt.googleusercontent.com/docsz/AD_4nXeiuCm7c8lEwEJuRey9kiVZsRn2W-b4pWlu3-X534V3YmVuVc2ZL-NXg2RkzSOOS2JXGHutDuyyNAUtdJI65jGTo8jT9Y99tMi4H4MqL44Uc5QKG77B0d6-JfIkZHFaUA71-RtjyYZWVIhqsNZcx8-OMaA?key=xt3VSDoCbmTY7o-cwwOFwQ)](https://hf.co/QuantFactory)
+
+
+# QuantFactory/Wayfarer-12B-GGUF
+This is quantized version of [LatitudeGames/Wayfarer-12B](https://huggingface.co/LatitudeGames/Wayfarer-12B) created using llama.cpp
+
+# Original Model Card
+
+
+![image/jpeg](wayfarer.jpg)
+
+# Wayfarer-12B
+We’ve heard over and over from AI Dungeon players that modern AI models are too nice, never letting them fail or die. While it may be good for a chatbot to be nice and helpful, great stories and games aren’t all rainbows and unicorns. They have conflict, tension, and even death. These create real stakes and consequences for characters and the journeys they go on.
+
+Similarly, great games need opposition. You must be able to fail, die, and may even have to start over. This makes games more fun! 
+
+However, the vast majority of AI models, through alignment RLHF, have been trained away from darkness, violence, or conflict, preventing them from fulfilling this role. To give our players better options, we decided to train our own model to fix these issues.
+
+Wayfarer is an adventure role-play model specifically trained to give players a challenging and dangerous experience. We thought they would like it, but since releasing it on AI Dungeon, players have reacted even more positively than we expected.
+
+Because they loved it so much, we’ve decided to open-source the model so anyone can experience unforgivingly brutal AI adventures! Anyone can download the model to run locally.
+
+Or if you want to easily try this model for free, you can do so at [https://aidungeon.com](https://aidungeon.com/).
+
+We plan to continue improving and open-sourcing similar models, so please share any and all feedback on how we can improve model behavior. Below we share more details on how Wayfarer was created.
+
+[Quantized GGUF weights can be downloaded here.](https://huggingface.co/LatitudeGames/Wayfarer-12B-GGUF)
+
+## Model details
+Wayfarer 12B was trained on top of the Nemo base model using a two-stage SFT approach, with the first stage containing 180K chat-formatted instruct data instances and the second stage consisting of a 50/50 mixture of synthetic 8k context text adventures and roleplay experiences.
+
+## How It Was Made
+Wayfarer’s text adventure data was generated by simulating playthroughs of published character creator scenarios from AI Dungeon. Five distinct user archetypes played through each scenario, whose character starts all varied in faction, location, etc. to generate five unique samples.
+
+One language model played the role of narrator, with the other playing the user. They were blind to each other’s underlying logic, so the user was actually capable of surprising the narrator with their choices. Each simulation was allowed to run for 8k tokens or until the main character died.
+
+Wayfarer’s general emotional sentiment is one of pessimism, where failure is frequent and plot armor does not exist. This serves to counter the positivity bias so inherent in our language models nowadays.
+
+## Inference
+The Nemo architecture is known for being sensitive to higher temperatures, so the following settings are recommended as a baseline. Nothing stops you from experimenting with these, of course.
+
+```
+"temperature": 0.8,
+"repetition_penalty": 1.05,
+"min_p": 0.025
+```
+
+## Limitations
+Wayfarer was trained exclusively on second-person present tense data (using “you”) in a narrative style. Other styles will work as well but may produce suboptimal results.
+
+Additionally, Wayfarer was trained exclusively on single-turn chat data.
+
+## Prompt Format
+ChatML was used for both finetuning stages.
+
+```
+<|im_start|>system
+You're a masterful storyteller and gamemaster. Write in second person present tense (You are), crafting vivid, engaging narratives with authority and confidence.<|im_end|>
+<|im_start|>user
+> You peer into the darkness.
+<|im_start|>assistant
+You have been eaten by a grue.
+
+GAME OVER
+```
+
+## Credits
+Thanks to [Gryphe Padar](https://huggingface.co/Gryphe) for collaborating on this finetune with us!