Fix display of special tokens like <think> in readme

When using tags like `<think>` you have to escape them using `\<think>` otherwise HuggingFace's markdown renderer will try to interpret them, and since they are not valid markdown code they will just become invsible. Which is currently the case with the readme. This change properly escape the tokens used so that they display properly.

Files changed (1) hide show

README.md +4 -4

README.md CHANGED Viewed

@@ -61,9 +61,9 @@ QwQ-32B-ArliAI-RpR-v1 is the first release in the RpR series. It is a 32-billion
 For any reasoning models in general, you need to make sure to set:
-* Prefix is set to ONLY <think> and the suffix is set to ONLY </think> without any spaces or newlines (enter)
-* Reply starts with <think>
 * Always add character names is unchecked
@@ -71,13 +71,13 @@ For any reasoning models in general, you need to make sure to set:
 * As always the chat template should also conform to the model being used
-Note: Reasoning models work properly only if include names is set to never, since they always expect the eos token of the user turn followed by the <think> token in order to start reasoning before outputting their response. If you set include names to enabled, then it will always append the character name at the end like "Seraphina:<eos_token>" which confuses the model on whether it should respond or reason first.
 The rest of your sampler parameters can be set as you wish as usual.
 If you don't see the reasoning wrapped inside the thinking block, then either your settings is still wrong and doesn't follow my example or that your ST version is too old without reasoning block auto parsing.
-If you see the whole response is in the reasoning block, then your <think> and </think> reasoning token suffix and prefix might have an extra space or newline. Or the model just isn't a reasoning model that is smart enough to always put reasoning in between those tokens.
 ### If you set everything up correctly, it should look like this:

 For any reasoning models in general, you need to make sure to set:
+* Prefix is set to ONLY \<think> and the suffix is set to ONLY \</think> without any spaces or newlines (enter)
+* Reply starts with \<think>
 * Always add character names is unchecked
 * As always the chat template should also conform to the model being used
+Note: Reasoning models work properly only if include names is set to never, since they always expect the eos token of the user turn followed by the \<think> token in order to start reasoning before outputting their response. If you set include names to enabled, then it will always append the character name at the end like "Seraphina:\<eos_token>" which confuses the model on whether it should respond or reason first.
 The rest of your sampler parameters can be set as you wish as usual.
 If you don't see the reasoning wrapped inside the thinking block, then either your settings is still wrong and doesn't follow my example or that your ST version is too old without reasoning block auto parsing.
+If you see the whole response is in the reasoning block, then your \<think> and \</think> reasoning token suffix and prefix might have an extra space or newline. Or the model just isn't a reasoning model that is smart enough to always put reasoning in between those tokens.
 ### If you set everything up correctly, it should look like this: