Update README.md

README.md

@@ -138,9 +138,17 @@ Baselines were evaluated using their respective chat-template and system prompts
 
 ### Usage
 
+**IMPORTANT NOTICE for using the model**
+
+* `<bos>` must be at start of prompt, ff your code's tokenizer does not prepend `<bos>` by default, you MUST prepend <bos> into the prompt yourself, otherwise, it would not work!
+* Repitition penalty (e.g: in llama.cpp, ollama, LM-studio) must be set to **1** , otherwise will lead to degeneration!
+
 #### Instruction format
 
 ```python
+# ! WARNING, if your code's tokenizer does not prepend <bos> by default,
+# You MUST prepend <bos> into the prompt yourself, otherwise, it would not work!
+
 prompt = """<|im_start|>system
 You are a helpful assistant.<eos>
 <|im_start|>user
@@ -151,7 +159,7 @@ Hi there, how can I help?<eos>"""
 # <|im_start|> is not a special token.
 # Transformers chat_template should be consistent with vLLM format below.
 
-# ! ENSURE 1 and only 1 bos `<s>` at the beginning of sequence
+# ! ENSURE 1 and only 1 bos `<bos>` at the beginning of sequence
 print(tokenizer.convert_ids_to_tokens(tokenizer.encode(prompt)))
 
 """