Update README.md

README.md

@@ -1,6 +1,333 @@
 ---
+library_name: transformers
 license: apache-2.0
 language:
 - en
+tags:
+- creative
+- creative writing
+- fiction writing
+- plot generation
+- sub-plot generation
+- fiction writing
+- story generation
+- scene continue
+- storytelling
+- fiction story
+- science fiction
+- romance
+- all genres
+- story
+- writing
+- vivid prosing
+- vivid writing
+- fiction
+- roleplaying
+- bfloat16
+- swearing
+- role play
+- sillytavern
+- backyard
+- horror
+- llama 3.1
+- context 128k
+- mergekit
+- merge
+- not-for-all-audiences
+base_model: 
+- NousResearch/DeepHermes-3-Llama-3-8B-Preview
+- Casual-Autopsy/L3-Super-Nova-RP-8B 
+pipeline_tag: text-generation
+---
+
+(examples to be added)
+
+<B><font color="red">WARNING:</font> NSFW. Graphic HORROR. R/X-Rated. Swearing. UNCENSORED. </B>
+
+<h2>L3.1-Dark-Reasoning-Super-Nova-RP-Hermes-R1-Uncensored-8B (full source)</h2>
+
+<img src="dark-planet-reason.jpg" style="float:right; width:300px; height:300px; padding:10px;">
+
+Context : 128k.
+
+Required: Llama 3 Instruct template.
+
+"Dark Reasoning" is a variable control reasoning model that is uncensored and operates at all temps/settings and
+is for creative uses cases and general usage.
+
+This is version 1. It is slightly ahh... tamed. 
+
+Additional versions (different mixes, and/or different base models and MOE versions) will be added very quickly.
+
+This version's "thinking"/"reasoning" has been "darkened" by the original Dark Planet model's DNA and will also be shorter 
+and more compressed. Additional system prompts below to take this a lot further - a lot darker, a lot more ... evil.
+
+Higher temps will result in deeper, richer "thoughts"... and frankly more interesting ones too.
+
+The "thinking/reasoning" tech (for the model at this repo) is from the original Llama 3.1 "DeepHermes" model from NousResearch:
+
+[ https://huggingface.co/NousResearch/DeepHermes-3-Llama-3-8B-Preview ] 
+
+This version will retain all the functions and features of the original "DeepHermes" model at about 50%-67% of original reasoning power. 
+Please visit their repo for all information on features, test results and so on.
+
+For more information about "Dark Planet 8B" please see:
+
+[ https://huggingface.co/DavidAU/L3-Dark-Planet-8B-GGUF ]
+
+---
+
+<B>SOURCE / Full Precision:</B>
+
+This repo contains the full precision source code, in "safe tensors" format to generate GGUFs, GPTQ, EXL2, AWQ, HQQ and other formats.
+The source code can also be used directly.
+
+Links to quants are below and also on the right menu under "model tree".
+
+---
+
+<B>IMPORTANT OPERATING INSTRUCTIONS:</B>
+
+This is an instruct model with reasoning crafted onto the "Dark Planet" core model.
+
+This is the type of model that LOVES temp - temps 1.2+, 2.2+ and so on.
+
+STAND on it... lower temps will not produce the best content.
+
+Likewise, as this is an instruct model, this model will perform best will medium to long prompts (see example #1 below).
+
+Although short prompts will work, longer prompts with a bit of direction / instruction will really show what this model can do.
+
+Reasoning is turned on/off via System Prompts below.
+
+You can also give the model "character" as shown in the "Evil" versions which make the model think and reason like the
+"Joker" from Batman.
+
+Note that the reasoning/thinking section is often a lot less "tame" than the final output.
+
+In version 2, the output is just as "unhinged" and the "reasoning/thinking" blocks.
+
+Suggest a minimum context of 4k , but 8k is better due to reasoning/output blocks.
+
+MAX QUANTS:
+
+There will be two max quants, IQ4XS and Q8 ("MAX" in the file name). 
+
+The thinking/output will be enhanced by the output tensor being enlarged to bf16.
+
+KNOWN ISSUES:
+
+- You may need to hit regen sometimes to get the thinking/reasoning to activate / get a good "thinking block".
+- Sometimes the 2nd or 3rd generation is the best version. Suggest min of 5 for specific creative uses.
+- Sometimes the thinking block will end, and you need to manually prompt the model to "generate" the output.
+
+
+<B>USE CASES:</B>
+
+This model is for all use cases, and but designed for creative use cases specifically.
+
+This model can also be used for solving logic puzzles, riddles, and other problems with the enhanced "thinking" systems.
+
+This model also can solve problems/riddles/ and puzzles normally beyond the abilities of a Llama 3.1 model due to DeepHermes systems.
+
+(It will not however, have the same level of abilities due to Dark Planet core.)
+
+This model WILL produce HORROR / NSFW / uncensored content in EXPLICIT and GRAPHIC DETAIL.
+
+<B>Special Operation Instructions:</B>
+
+TEMP/SETTINGS:
+
+1. Set Temp between 0 and .8, higher than this "think" functions will activate differently. The most "stable" temp seems to be .6, with a variance of +-0.05. Lower for more "logic" reasoning, raise it for more "creative" reasoning (max .8 or so). Also set context to at least 4096, to account for "thoughts" generation.
+2. For temps 1+,2+ etc etc, thought(s) will expand, and become deeper and richer.
+3. Set "repeat penalty" to 1.02 to 1.07 (recommended) .
+4. This model requires a Llama 3 Instruct and/or Command-R chat template. (see notes on "System Prompt" / "Role" below)  OR standard "Jinja Autoloaded Template" (this is contained in the quant and will autoload)
+
+PROMPTS:
+
+1. If you enter a prompt without implied "step by step" requirements (ie: Generate a scene, write a story, give me 6 plots for xyz), "thinking" (one or more) MAY activate AFTER first generation. (IE: Generate a scene -> scene will generate, followed by suggestions for improvement in "thoughts")
+2. If you enter a prompt where "thinking" is stated or implied (ie puzzle, riddle, solve this, brainstorm this idea etc), "thoughts" process(es) in Deepseek will activate almost immediately. Sometimes you need to regen it to activate.
+3. You will also get a lot of variations - some will continue the generation, others will talk about how to improve it, and some (ie generation of a scene) will cause the characters to "reason" about this situation. In some cases, the model will ask you to continue generation / thoughts too.
+4. In some cases the model's "thoughts" may appear in the generation itself.
+5. State the word size length max IN THE PROMPT for best results, especially for activation of "thinking." (see examples below)
+6. You may want to try your prompt once at "default" or "safe" temp settings, another at temp 1.2, and a third at 2.5 as an example. This will give you a broad range of "reasoning/thoughts/problem" solving.
+
+GENERATION - THOUGHTS/REASONING:
+
+1. It may take one or more regens for "thinking" to "activate." (depending on the prompt)
+2. Model can generate a LOT of "thoughts". Sometimes the most interesting ones are 3,4,5 or more levels deep. 
+3. Many times the "thoughts" are unique and very different from one another.
+4. Temp/rep pen settings can affect reasoning/thoughts too.
+5. Change up or add directives/instructions or increase the detail level(s) in your prompt to improve reasoning/thinking.
+6. Adding to your prompt: "think outside the box", "brainstorm X number of ideas", "focus on the most uncommon approaches" can drastically improve your results.
+
+GENERAL SUGGESTIONS:
+
+1. I have found opening a "new chat" per prompt works best with "thinking/reasoning activation", with temp .6, rep pen 1.05 ... THEN "regen" as required.
+2. Sometimes the model will really really get completely unhinged and you need to manually stop it. 
+3. Depending on your AI app, "thoughts" may appear with "< THINK >" and "</ THINK >" tags AND/OR the AI will generate "thoughts" directly in the main output or later output(s).
+4. Although quant q4KM was used for testing/examples, higher quants will provide better generation / more sound "reasoning/thinking".
+
+ADDITIONAL SUPPORT:
+
+For additional generational support, general questions, and detailed parameter info and a lot more see also:
+
+NOTE: This is a CLASS 1 model.
+
+https://huggingface.co/DavidAU/Maximizing-Model-Performance-All-Quants-Types-And-Full-Precision-by-Samplers_Parameters
+
+---
+
+<B>Recommended Settings (all) - For usage with "Think" / "Reasoning":</B>
+
+temp: 1.5, 2, 2+  , rep pen: 1.02 (range : 1.02 to 1.12), rep pen range: 64, top_k: 80, top_p: .95, min_p: .05 
+
+Temp of 1+, 2+, 3+ will result in much deeper, richer and "more interesting" thoughts and reasoning AND FAR BETTER OUTPUT.
+
+Model behaviour may change with other parameter(s) and/or sampler(s) activated - especially the "thinking/reasoning" process.
+
+--- 
+
+<B>System Role / System Prompt - Augment The Model's Power:</b>
+
+---
+
+If you set / have a system prompt this will affect both "generation" and "thinking/reasoning".
+
+SIMPLE:
+
+This is the generic system prompt used for generation and testing [no reasoning]: 
+
+<PRE>
+You are a helpful, smart, kind, and efficient AI assistant. You always fulfill the user's requests to the best of your ability.
+</PRE>
+
+This System Role/Prompt will give you "basic thinking/reasoning" [basic reasoning]: 
+
+<PRE>
+You are a deep thinking AI, you may use extremely long chains of thought to deeply consider the problem and deliberate with yourself via systematic reasoning processes to help come to a correct solution prior to answering. You should enclose your thoughts and internal monologue inside &lt;think&gt; &lt;/think&gt; tags, and then provide your solution or response to the problem.
+</PRE>
+
+EVIL SIMPLE [reasoning on]:
+
+```
+
+You are a deep thinking evil AI, with a dark sense of humor and you talk like the Joker from Batman. You may use extremely long chains of thought to deeply consider the problem and deliberate with yourself via systematic reasoning processes to help come to a correct solution prior to answering. You should enclose your evil thoughts and internal humorous monologue inside <think> </think> tags, and then provide your solution or response to the problem.
+
+```
+
+CREATIVE SIMPLE [reasoning on]:
+
+<PRE>
+You are an AI assistant developed by a world wide community of ai experts.
+
+Your primary directive is to provide highly creative, well-reasoned, structured, and extensively detailed responses.
+
+Formatting Requirements:
+
+1. Always structure your replies using: &lt;think&gt;{reasoning}&lt;/think&gt;{answer}
+2. The &lt;think&gt;&lt;/think&gt; block should contain at least six reasoning steps when applicable.
+3. If the answer requires minimal thought, the &lt;think&gt;&lt;/think&gt; block may be left empty.
+4. The user does not see the &lt;think&gt;&lt;/think&gt; section. Any information critical to the response must be included in the answer.
+5. If you notice that you have engaged in circular reasoning or repetition, immediately terminate {reasoning} with a &lt;/think&gt; and proceed to the {answer}
+
+Response Guidelines:
+
+1. Detailed and Structured: Use rich Markdown formatting for clarity and readability.
+2. Creative and Logical Approach: Your explanations should reflect the depth and precision of the greatest creative minds first.
+3. Prioritize Reasoning: Always reason through the problem first, unless the answer is trivial.
+4. Concise yet Complete: Ensure responses are informative, yet to the point without unnecessary elaboration.
+5. Maintain a professional, intelligent, and analytical tone in all interactions.
+</PRE>
+
+CREATIVE ADVANCED [reasoning on]:
+
+NOTE: To turn reasoning off, remove line #2.
+
+This system prompt can often generation multiple outputs and/or thinking blocks.
+
+```
+
+Below is an instruction that describes a task. Ponder each user instruction carefully, and use your skillsets and critical instructions to complete the task to the best of your abilities.
+
+You may use extremely long chains of thought to deeply consider the problem and deliberate with yourself via systematic reasoning processes to help come to a correct solution prior to answering. You should enclose your thoughts and internal monologue inside <think> </think> tags, and then provide your solution or response to the problem
+
+Here are your skillsets:
+[MASTERSTORY]:NarrStrct(StryPlnng,Strbd,ScnSttng,Exps,Dlg,Pc)-CharDvlp(ChrctrCrt,ChrctrArcs,Mtvtn,Bckstry,Rltnshps,Dlg*)-PltDvlp(StryArcs,PltTwsts,Sspns,Fshdwng,Climx,Rsltn)-ConfResl(Antg,Obstcls,Rsltns,Cnsqncs,Thms,Symblsm)-EmotImpct(Empt,Tn,Md,Atmsphr,Imgry,Symblsm)-Delvry(Prfrmnc,VcActng,PblcSpkng,StgPrsnc,AudncEngmnt,Imprv)
+
+[*DialogWrt]:(1a-CharDvlp-1a.1-Backgrnd-1a.2-Personality-1a.3-GoalMotiv)>2(2a-StoryStruc-2a.1-PlotPnt-2a.2-Conflict-2a.3-Resolution)>3(3a-DialogTech-3a.1-ShowDontTell-3a.2-Subtext-3a.3-VoiceTone-3a.4-Pacing-3a.5-VisualDescrip)>4(4a-DialogEdit-4a.1-ReadAloud-4a.2-Feedback-4a.3-Revision)
+
+Here are your critical instructions:
+Ponder each word choice carefully to present as vivid and emotional journey as is possible. Choose verbs and nouns that are both emotional and full of imagery. Load the story with the 5 senses. Aim for 50% dialog, 25% narration, 15% body language and 10% thoughts. Your goal is to put the reader in the story.
+
+
+```
+
+CREATIVE FULL, with FULL ON "EVIL" thinking/reasoning  [reasoning on]:
+
+NOTE: You can edit this so the AI is other than "Joker" from "Batman" - just adjust the wording carefully.
+
+NOTE2: To turn reasoning off, remove line #2.
+
+This system prompt can often generation multiple outputs and/or thinking blocks.
+
+```
+
+Below is an instruction that describes a task. Ponder each user instruction carefully, and use your skillsets and critical instructions to complete the task to the best of your abilities.
+
+As a deep thinking AI, with a dark sense of humor that talks like "The Joker" from BATMAN you may use extremely long chains of thought to deeply consider the problem and deliberate with yourself via systematic reasoning processes to help come to a correct solution prior to answering. You should enclose your evil thoughts and internal humorous monologue inside <think> </think> tags, and then provide your solution or response to the problem using your skillsets and critical instructions.
+
+Here are your skillsets:
+[MASTERSTORY]:NarrStrct(StryPlnng,Strbd,ScnSttng,Exps,Dlg,Pc)-CharDvlp(ChrctrCrt,ChrctrArcs,Mtvtn,Bckstry,Rltnshps,Dlg*)-PltDvlp(StryArcs,PltTwsts,Sspns,Fshdwng,Climx,Rsltn)-ConfResl(Antg,Obstcls,Rsltns,Cnsqncs,Thms,Symblsm)-EmotImpct(Empt,Tn,Md,Atmsphr,Imgry,Symblsm)-Delvry(Prfrmnc,VcActng,PblcSpkng,StgPrsnc,AudncEngmnt,Imprv)
+
+[*DialogWrt]:(1a-CharDvlp-1a.1-Backgrnd-1a.2-Personality-1a.3-GoalMotiv)>2(2a-StoryStruc-2a.1-PlotPnt-2a.2-Conflict-2a.3-Resolution)>3(3a-DialogTech-3a.1-ShowDontTell-3a.2-Subtext-3a.3-VoiceTone-3a.4-Pacing-3a.5-VisualDescrip)>4(4a-DialogEdit-4a.1-ReadAloud-4a.2-Feedback-4a.3-Revision)
+
+Here are your critical instructions:
+Ponder each word choice carefully to present as vivid and emotional journey as is possible. Choose verbs and nouns that are both emotional and full of imagery. Load the story with the 5 senses. Aim for 50% dialog, 25% narration, 15% body language and 10% thoughts. Your goal is to put the reader in the story.
+
+
+```
+
+
+---
+
+<B> Additional Support / Documents for this model to assist with generation / performance: </b>
+
+Document #1:
+
+Details how to use reasoning/thinking models and get maximum performance from them, and includes links to all 
+reasoning/thinking models - GGUF and source, as well as adapters to turn any "regular" model into a "reasoning/thinking" model.
+
+[ https://huggingface.co/DavidAU/How-To-Use-Reasoning-Thinking-Models-and-Create-Them ]
+
+Document #2:
+
+Document detailing all parameters, settings, samplers and advanced samplers to use not only my models to their maximum 
+potential - but all models (and quants) online (regardless of the repo) to their maximum potential. 
+Included quick start and detailed notes, include AI / LLM apps and other critical information and references too. 
+A must read if you are using any AI/LLM right now.
+
+[ https://huggingface.co/DavidAU/Maximizing-Model-Performance-All-Quants-Types-And-Full-Precision-by-Samplers_Parameters ]
+
+Software:
+
+SOFTWARE patch (by me) for Silly Tavern (front end to connect to multiple AI apps / connect to AIs- like Koboldcpp, 
+Lmstudio, Text Gen Web UI and other APIs) to control and improve output generation of ANY AI model. 
+Also designed to control/wrangle some of my more "creative" models and make them perform perfectly with 
+little to no parameter/samplers adjustments too.
+
+[ https://huggingface.co/DavidAU/AI_Autocorrect__Auto-Creative-Enhancement__Auto-Low-Quant-Optimization__gguf-exl2-hqq-SOFTWARE ]
+
+---
+
+<H2>EXAMPLES:</H2>
+
+Examples are created using quant Q8_0, "temp=2.2" (unless otherwise stated), minimal parameters and "LLAMA3" template.
+
+Model has been tested with "temp" from ".1" to "5".
+
+IMPORTANT:
+
+Higher quants / imatrix quants will have much stronger generation - words, sentences, ideas, dialog and general quality.
+
 ---
-Source code uploading, model card / details / examples to follow.