clarify prompt syntax

README.md

@@ -18,6 +18,7 @@ tags:
 - The model responds with a structured json argument with the function name and arguments.
 
 **Recent Updates**
+- November 6th 2023 -> added Deepseek Coder 6.7B and 33B
 - October 11th 2023 -> added Mistral 7B with function calling
 - October 11th 2023 -> new models pushed, trained on an improved underlying dataset
 
@@ -60,6 +61,8 @@ The dataset used for training this model can be found at [Trelis Function Callin
 
 ## Inference
 
+!!! Make sure to check the prompt format below and adjust inference accordingly !!!
+
 **Quick Start in Google Colab**
 Try out this notebook [fLlama_Inference notebook](https://colab.research.google.com/drive/1Ow5cQ0JNv-vXsT-apCceH6Na3b4L7JyW?usp=sharing)
 
@@ -81,8 +84,9 @@ import requests
 import json
 
 # Define the roles and markers
-B_INST, E_INST = "[INST]", "[/INST]"
 B_FUNC, E_FUNC = "<FUNCTIONS>", "</FUNCTIONS>\n\n"
+B_INST, E_INST = "[INST] ", " [/INST]" #Llama style
+# B_INST, E_INST = "\n### Instruction:\n", "\n### Response:\n" #DeepSeek Coder Style
 
 # Define the function metadata
 function_metadata = {
@@ -102,7 +106,7 @@ user_prompt = 'Search for the latest news on AI.'
 
 # Format the function list and prompt
 function_list = json.dumps(function_metadata, indent=4)
-prompt = f"{B_FUNC}{function_list.strip()}{E_FUNC}{B_INST} {user_prompt.strip()} {E_INST}\n\n"
+prompt = f"{B_FUNC}{function_list.strip()}{E_FUNC}{B_INST}{user_prompt.strip()}{E_INST}\n\n"
 
 # Define the API endpoint
 url = "http:/localhost:8080/completion"
@@ -123,21 +127,23 @@ The function descriptions must be wrapped within a function block. You can put t
 Example without a system message:
 ```
   # Define the roles and markers
-  B_INST, E_INST = "[INST]", "[/INST]"
   B_FUNC, E_FUNC = "<FUNCTIONS>", "</FUNCTIONS>\n\n"
+  B_INST, E_INST = "[INST] ", " [/INST]" #Llama style
+  # B_INST, E_INST = "\n### Instruction:\n", "\n### Response:\n" #DeepSeek Coder Style
 
   functionList = {function_1_metadata}{function_2_metadata}...
   user_prompt = '...'
 
   # Format your prompt template
-  prompt = f"{B_FUNC}{functionList.strip()}{E_FUNC}{B_INST} {user_prompt.strip()} {E_INST}\n\n"
+  prompt = f"{B_FUNC}{functionList.strip()}{E_FUNC}{B_INST}{user_prompt.strip()}{E_INST}\n\n"
 ```
 
 Example with a system message:
 ```
   # Define the roles and markers
-  B_INST, E_INST = "[INST]", "[/INST]"
   B_FUNC, E_FUNC = "<FUNCTIONS>", "</FUNCTIONS>\n\n"
+  B_INST, E_INST = "[INST] ", " [/INST]" #Llama style
+  # B_INST, E_INST = "\n### Instruction:\n", "\n### Response:\n" #DeepSeek Coder Style
   B_SYS, E_SYS = "<<SYS>>\n", "\n<</SYS>>\n\n"
 
   # assuming functionList is defined as above
@@ -145,7 +151,7 @@ Example with a system message:
   user_prompt = '...'
 
   # Format your prompt template
-  prompt = f"{B_FUNC}{functionList.strip()}{E_FUNC}{B_INST} {B_SYS}{system_prompt.strip()}{E_SYS}{user_prompt.strip()} {E_INST}\n\n"
+  prompt = f"{B_FUNC}{functionList.strip()}{E_FUNC}{B_INST}{B_SYS}{system_prompt.strip()}{E_SYS}{user_prompt.strip()}{E_INST}\n\n"
 
 ```
 Notice that the function block is placed at the very start of the sequence, before 'B_INST'.