add README.md

README.md

@@ -0,0 +1,26 @@
+# ToolACE (tool-calling conversations)
+
+A cleaned-up mirror of the ToolACE function-calling corpus. Every line of
+`data/train.jsonl` is one JSON object describing a full conversation.
+
+## Entry format
+
+- `messages`: list of turns.
+  - The first message is always a `system` message with boilerplate about how
+    to use tools (the tool definitions themselves are NOT embedded there).
+  - Assistant messages that invoke tools carry `tool_calls`: a list of
+    `{id, type: "function", function: {name, arguments}}` objects, where
+    `arguments` is already a JSON object (not a string).
+  - Tool results come back as `{role: "tool", tool_call_id, content}` messages,
+    where `tool_call_id` references the originating call.
+- `tools`: list of tool definitions, each with `name`, `description` and
+  `parameters`. `parameters` is an object with `type` (`dict` for object
+  containers), `properties` (parameter name -> `{type, description}` plus an
+  optional `default`) and `required`. Parameter types use the short spellings
+  `str`, `int`, `float`, `bool`, `list`, `dict`.
+
+## Files
+
+- `data/train.jsonl` - all examples.
+
+Total examples: 30