Add tool use template (#18)

- Add tool use template (44ba1a220a7c4dde080b07625c52ca9a5f27e1c1)


Co-authored-by: Matthew Carrigan <[email protected]>

README.md

@@ -1,5 +1,7 @@
 ---
-base_model: mistralai/Mistral-7B-v0.1
+language:
+- en
+license: apache-2.0
 tags:
 - Mistral
 - instruct
@@ -12,21 +14,21 @@ tags:
 - distillation
 - function calling
 - json mode
-model-index:
-- name: Hermes-2-Pro-Mistral-7B
-  results: []
-license: apache-2.0
-language:
-- en
+base_model: mistralai/Mistral-7B-v0.1
 datasets:
 - teknium/OpenHermes-2.5
 widget:
 - example_title: Hermes 2 Pro
   messages:
   - role: system
-    content: You are a sentient, superintelligent artificial general intelligence, here to teach and assist me.
+    content: You are a sentient, superintelligent artificial general intelligence,
+      here to teach and assist me.
   - role: user
-    content: Write a short story about Goku discovering kirby has teamed up with Majin Buu to destroy the world.
+    content: Write a short story about Goku discovering kirby has teamed up with Majin
+      Buu to destroy the world.
+model-index:
+- name: Hermes-2-Pro-Mistral-7B
+  results: []
 ---
 
 # Hermes 2 Pro - Mistral 7B

added_tokens.json

@@ -1,14 +1,4 @@
 {
-  "<|im_end|>": 32000,
-  "<|im_start|>": 32001,
-  "<pad2>": 32002,
-  "<pad3>": 32003,
-  "<pad4>": 32004,
-  "<pad5>": 32005,
-  "<pad6>": 32006,
-  "<pad7>": 32007,
-  "<pad8>": 32008,
-  "<pad9>": 32009,
   "<pad10>": 32010,
   "<pad11>": 32011,
   "<pad12>": 32012,
@@ -29,6 +19,16 @@
   "<pad27>": 32027,
   "<pad28>": 32028,
   "<pad29>": 32029,
+  "<pad2>": 32002,
   "<pad30>": 32030,
-  "<pad31>": 32031
+  "<pad31>": 32031,
+  "<pad3>": 32003,
+  "<pad4>": 32004,
+  "<pad5>": 32005,
+  "<pad6>": 32006,
+  "<pad7>": 32007,
+  "<pad8>": 32008,
+  "<pad9>": 32009,
+  "<|im_end|>": 32000,
+  "<|im_start|>": 32001
 }

tokenizer_config.json

@@ -286,7 +286,16 @@
   },
   "additional_special_tokens": [],
   "bos_token": "<s>",
-  "chat_template": "{{bos_token}}{% for message in messages %}{{'<|im_start|>' + message['role'] + '\n' + message['content'] + '<|im_end|>' + '\n'}}{% endfor %}{% if add_generation_prompt %}{{ '<|im_start|>assistant\n' }}{% endif %}",
+  "chat_template": [
+    {
+      "name": "default",
+      "template": "{{bos_token}}{% for message in messages %}{{'<|im_start|>' + message['role'] + '\n' + message['content'] + '<|im_end|>' + '\n'}}{% endfor %}{% if add_generation_prompt %}{{ '<|im_start|>assistant\n' }}{% endif %}"
+    },
+    {
+      "name": "tool_use",
+      "template": "{%- macro json_to_python_type(json_spec) %}\n{%- set basic_type_map = {\n    \"string\": \"str\",\n    \"number\": \"float\",\n    \"integer\": \"int\",\n    \"boolean\": \"bool\"\n} %}\n\n{%- if basic_type_map[json_spec.type] is defined %}\n    {{- basic_type_map[json_spec.type] }}\n{%- elif json_spec.type == \"array\" %}\n    {{- \"list[\" +  json_to_python_type(json_spec|items) + \"]\"}}\n{%- elif json_spec.type == \"object\" %}\n    {%- if json_spec.additionalProperties is defined %}\n        {{- \"dict[str, \" + json_to_python_type(json_spec.additionalProperties) + ']'}}\n    {%- else %}\n        {{- \"dict\" }}\n    {%- endif %}\n{%- elif json_spec.type is iterable %}\n    {{- \"Union[\" }}\n    {%- for t in json_spec.type %}\n      {{- json_to_python_type({\"type\": t}) }}\n      {%- if not loop.last %}\n        {{- \",\" }} \n    {%- endif %}\n    {%- endfor %}\n    {{- \"]\" }}\n{%- else %}\n    {{- \"Any\" }}\n{%- endif %}\n{%- endmacro %}\n\n\n{{- bos_token }}\n{{- \"You are a function calling AI model. You are provided with function signatures within <tools></tools> XML tags. You may call one or more functions to assist with the user query. Don't make assumptions about what values to plug into functions. Here are the available tools: <tools> \" }}\n{%- for tool in tools %}\n    {%- if tool.function is defined %}\n        {%- set tool = tool.function %}\n    {%- endif %}\n    {{- '{\"type\": \"function\", \"function\": ' }}\n    {{- '{\"name\": ' + tool.name + '\", ' }}\n    {{- '\"description\": \"' + tool.name + '(' }}\n    {%- for param_name, param_fields in tool.parameters.properties|items %}\n        {{- param_name + \": \" + json_to_python_type(param_fields) }}\n        {%- if not loop.last %}\n            {{- \", \" }}\n        {%- endif %}\n    {%- endfor %}\n    {{- \")\" }}\n    {%- if tool.return is defined %}\n        {{- \" -> \" + json_to_python_type(tool.return) }}\n    {%- endif %}\n    {{- \" - \" + tool.description + \"\\n\\n\" }}\n    {%- for param_name, param_fields in tool.parameters.properties|items %}\n        {%- if loop.first %}\n            {{- \"    Args:\\n\" }}\n        {%- endif %}\n        {{- \"        \" + param_name + \"(\" + json_to_python_type(param_fields) + \"): \" + param_fields.description|trim }}\n    {%- endfor %}\n    {%- if tool.return is defined and tool.return.description is defined %}\n        {{- \"\\n    Returns:\\n        \" + tool.return.description }}\n    {%- endif %}\n    {{- '\"' }}\n    {{- ', \"parameters\": ' }}\n    {%- if tool.parameters.properties | length == 0 %}\n        {{- \"{}\" }}\n    {%- else %}\n        {{- tool.parameters|tojson }}\n    {%- endif %}\n    {{- \"}\" }}\n    {%- if not loop.last %}\n        {{- \"\\n\" }}\n    {%- endif %}\n{%- endfor %}\n{{- \" </tools>\" }}\n{{- 'Use the following pydantic model json schema for each tool call you will make: {\"properties\": {\"arguments\": {\"title\": \"Arguments\", \"type\": \"object\"}, \"name\": {\"title\": \"Name\", \"type\": \"string\"}}, \"required\": [\"arguments\", \"name\"], \"title\": \"FunctionCall\", \"type\": \"object\"}\n' }}\n{{- \"For each function call return a json object with function name and arguments within <tool_call></tool_call> XML tags as follows:\n\" }}\n{{- \"<tool_call>\n\" }}\n{{- '{\"arguments\": <args-dict>, \"name\": <function-name>}\n' }}\n{{- '</tool_call><|im_end|>' }}\n{%- for message in messages %}\n    {%- if message.role == \"user\" or message.role == \"system\" or (message.role == \"assistant\" and message.tool_calls is not defined) %}\n        {{- '<|im_start|>' + message.role + '\\n' + message.content + '<|im_end|>' + '\\n' }}\n    {%- elif message.role == \"assistant\" %}\n        {{- '<|im_start|>' + message.role + '\\n<tool_call>\\n' }}\n        {%- for tool_call in message.tool_calls %}\n            {%- if tool_call.function is defined %}\n                {%- set tool_call = tool_call.function %}\n            {%- endif %}\n            {{- '{ ' }}\n            {%- if tool_call.arguments is defined %}\n                {{- '\"arguments\": ' }}\n                {{- tool_call.arguments|tojson }}\n                {{- ', '}}\n            {%- endif %}\n            {{- '\"name\": \"' }}\n            {{- tool_call.name }}\n            {{- '\"}' }}\n            {{- '\\n</tool_call> ' }}\n        {%- endfor %}\n        {{- '<|im_end|>\\n' }}\n    {%- elif message.role == \"tool\" %}\n        {%- if not message.name is defined %}\n            {{- raise_exception(\"Tool response dicts require a 'name' key indicating the name of the called function!\") }}\n        {%- endif %}\n        {{- '<|im_start|>' + message.role + '\\n<tool_response>\\n' }}\n        {{- '{\"name\": \"' }}\n        {{- message.name }}\n        {{- '\", \"content\": ' }}\n        {{- message.content|tojson + '}' }}\n        {{- '\\n</tool_response> <|im_end|>\\n' }} \n    {%- endif %}\n{%- endfor %}\n{%- if add_generation_prompt %}\n    {{- '<|im_start|>assistant\\n' }}\n{%- endif %}\n"
+    }
+  ],
   "clean_up_tokenization_spaces": true,
   "eos_token": "<|im_end|>",
   "legacy": true,