a6188466 commited on
Commit
57ee616
Β·
verified Β·
1 Parent(s): 7ef6eb5

docs(README): rewrite dataset READMEs for clarity and alignment

Browse files
Files changed (1) hide show
  1. README.md +28 -43
README.md CHANGED
@@ -46,37 +46,22 @@ size_categories:
46
  - n<1K
47
  ---
48
 
49
-
50
  # dia-intent-sequencer-robot-arm-dataset
51
 
52
- This dataset provides natural language instructions paired with structured DSL function call trees using the **DIA intent sequencer** format. It is designed to train and evaluate models that control a robotic arm managing an inventory of screws.
53
 
54
  Unlike synthetic datasets, this one was **authored by hand** to reflect real-world, grounded use cases. It illustrates:
55
 
56
- - πŸ›  Mapping user intent to tool calls
57
- - πŸ”„ Dynamically resolving missing parameters using runtime-accessible resources
58
- - πŸ€– Interactively clarifying ambiguous input and handling runtime errors through dialogue
59
-
60
- The primary goal of this dataset is to serve as a **demonstration and testbed**, showcasing a model's ability to engage with users to resolve incomplete or ambiguous inputs and to recover from runtime errors during task execution.
61
-
62
- ---
63
 
64
- ## 🧩 Related Datasets
65
 
66
  This dataset is part of a broader collection of **`DIA`** datasets, each demonstrating different capabilities of intent sequencing and tool-based reasoning:
67
 
68
  - [`a6188466/dia-intent-sequencer-calculator-dataset`](https://huggingface.co/datasets/a6188466/dia-intent-sequencer-calculator-dataset)
69
- Designed for training a model to translate symbolic math instructions into structured function call trees. It illustrates:
70
- - Structural reasoning over nested, composable intent calls
71
- - Generalization across randomized function and parameter names
72
- - Pure function execution with no runtime queries or clarification steps
73
-
74
  - [`a6188466/dia-intent-sequencer-calendar-dataset`](https://huggingface.co/datasets/a6188466/dia-intent-sequencer-calendar-dataset)
75
- Designed for training a task/reminder scheduling agent. It illustrates:
76
- - Mapping of user intent to tool calling
77
- - Nesting of intents
78
- - Dynamic resolution of missing information from runtime-accessible resources
79
- - Interactive clarification of missing or conflicting information via user interaction
80
 
81
  ---
82
 
@@ -84,11 +69,11 @@ This dataset is part of a broader collection of **`DIA`** datasets, each demonst
84
 
85
  The dataset uses a **wide format** with the following columns:
86
 
87
- - `system` β€” the system prompt defining the model's task
88
- - `in` β€” a natural language instruction related to managing or retrieving screws (e.g. `"retrieve 3 screws that are 10mm long"`)
89
- - `out` β€” a structured DSL expression that encodes tool calls with function/argument mapping (e.g. `"retrieve_screw(count=3, length=10)`)
90
 
91
- Each entry is structured as:
92
 
93
  ```
94
  system β†’ in β†’ out
@@ -98,32 +83,25 @@ system β†’ in β†’ out
98
 
99
  ## πŸ“‹ System Prompt Format
100
 
101
- The `system` prompt is a structured instruction that tells the model to translate the user input into one or more **atomic DIA DSL function calls** based on a list of available functions (tools) that the robotic arm can perform, such as `retrieve_screw`, `initialize`, and others.
102
-
103
- The [DIA LLM invocation strategy](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/dia#-llm-invocation-strategy) documents the various prompts used by the LoRA adapter trained with this dataset. This dataset includes examples of the following system prompts:
104
 
105
- - `system_prompt_intent_sequencer`
106
- - `system_prompt_slot_resolver`
107
- - `system_prompt_error_resolver`
108
 
109
- Because the robotic arm operates in a real-world environment, the model is expected to handle missing or incomplete information using `QUERY_FILL`, `QUERY_USER`, and other runtime-aware operations. These enable the model to:
110
 
111
  - Query the inventory for relevant values
112
  - Propagate values through chained tool calls
113
- - Interactively clarify incomplete or conflicting user input
114
 
115
- > πŸ’‘ Example: A user might say "Give me one of the longest screws." The model should use `QUERY_FILL(...)` to retrieve the appropriate length at runtime.
116
 
117
- ## 🧠 DIA DSL Project
118
 
119
- The DSL used in this dataset is defined in the [DIA module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/dia). It is a DSL for interactive agents that translates user intent into tool calls, resolving missing information and runtime errors through user interaction or by querying contextual information available at runtime.
120
 
121
- - 🧠 **Structured intent-to-action mapping** for precise and secure execution
122
- - 🧩 **Composable function calls** with nesting and multi-step workflows
123
- - πŸ”„ **Interactive resolution** of missing parameters via queries or user input
124
- - πŸ€– **Built-in runtime recovery mechanisms** for handling runtime errors
125
 
126
- For a complete example of how this model can be used in a robotic arm context, see [`robot_arm.py`](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/dia/demo/robot_arm.py).
127
 
128
  ---
129
 
@@ -138,17 +116,24 @@ print(dataset_dict["train"])
138
  print(dataset_dict["validation"])
139
  ```
140
 
141
- This dataset is ideal for training `DIA` models that interact with both the user and the runtime environment. It supports use cases involving clarification, error handling, and dynamic value resolution.
142
-
143
  ---
144
 
145
  ## πŸ”§ Upload & Editing Tools
146
 
147
- Uploaded via [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets) using the `dsl` adapter.
 
148
  You can edit or extend the dataset using its `.dat` format and CLI tools.
149
 
150
  ---
151
 
 
 
 
 
 
 
 
 
152
  ## πŸͺͺ License
153
 
154
  This dataset is licensed under **CC BY 4.0**. See [LICENSE](LICENSE) for details.
 
46
  - n<1K
47
  ---
48
 
 
49
  # dia-intent-sequencer-robot-arm-dataset
50
 
51
+ This dataset provides natural language instructions paired with structured DSL function call trees using the **DIA intent sequencer** format. It is used to train and evaluate a demo model that controls a custom robotic arm managing an inventory of screws.
52
 
53
  Unlike synthetic datasets, this one was **authored by hand** to reflect real-world, grounded use cases. It illustrates:
54
 
55
+ - πŸ›  Mapping user intent to tool calls
56
+ - πŸ”„ Attempting to resolve missing parameters using runtime-accessible resources
57
+ - πŸ€– Attempting to clarify ambiguous input and to handle runtime errors through dialogue
 
 
 
 
58
 
59
+ The goal of this dataset is to serve as a **demonstration and testbed**, showcasing a model's ability to engage with users in an attempt to resolve incomplete or ambiguous inputs, and to recover from runtime errors during task execution when possible.
60
 
61
  This dataset is part of a broader collection of **`DIA`** datasets, each demonstrating different capabilities of intent sequencing and tool-based reasoning:
62
 
63
  - [`a6188466/dia-intent-sequencer-calculator-dataset`](https://huggingface.co/datasets/a6188466/dia-intent-sequencer-calculator-dataset)
 
 
 
 
 
64
  - [`a6188466/dia-intent-sequencer-calendar-dataset`](https://huggingface.co/datasets/a6188466/dia-intent-sequencer-calendar-dataset)
 
 
 
 
 
65
 
66
  ---
67
 
 
69
 
70
  The dataset uses a **wide format** with the following columns:
71
 
72
+ - `system` β€” the system prompt that defines the model's task
73
+ - `in` β€” a natural language instruction related to managing or retrieving screws (e.g., `"retrieve 3 screws that are 10mm long"`)
74
+ - `out` β€” a structured DSL expression encoding tool calls with function and argument mappings (e.g., `retrieve_screw(count=3, length=10)`)
75
 
76
+ Each entry follows the structure:
77
 
78
  ```
79
  system β†’ in β†’ out
 
83
 
84
  ## πŸ“‹ System Prompt Format
85
 
86
+ The `system` prompt is a structured instruction that tells the model to translate the user input into one or more **atomic DIA DSL function calls** based on a list of available functions (tools) that the demo robotic arm can perform, such as `retrieve_screw`, `initialize`, and others.
 
 
87
 
88
+ The [DIA LLM invocation strategy](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/dia#-llm-invocation-strategy) documents the various prompts used by the demo LoRA adapter trained with this demo dataset.
 
 
89
 
90
+ Because the demo robotic arm operates in a real-world environment, the model is expected to handle missing or incomplete information using `QUERY_FILL`, `QUERY_USER`, and other runtime-aware operations, for example, to:
91
 
92
  - Query the inventory for relevant values
93
  - Propagate values through chained tool calls
94
+ - Attempt to clarify incomplete or conflicting user input through interaction
95
 
96
+ > πŸ’‘ Example: A user might say, "Give me one of the longest screws." The model will attempt to use `QUERY_FILL(...)` to retrieve the appropriate length at runtime.
97
 
98
+ ---
99
 
100
+ ## 🧠 DIA DSL Project
101
 
102
+ The DSL used in this dataset is defined in the [DIA module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/dia).
 
 
 
103
 
104
+ For an example of a demo model built with this **demo dataset**, see [`robot_arm.py`](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/dia/demo/robot_arm.py).
105
 
106
  ---
107
 
 
116
  print(dataset_dict["validation"])
117
  ```
118
 
 
 
119
  ---
120
 
121
  ## πŸ”§ Upload & Editing Tools
122
 
123
+ Uploaded via [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets) using the `dsl` adapter.
124
+
125
  You can edit or extend the dataset using its `.dat` format and CLI tools.
126
 
127
  ---
128
 
129
+ ## ⚠️ Limitations
130
+
131
+ This dataset was created to test intent sequencing using the DIA DSL with a custom robotic arm I built for experimentation. It focuses on a limited set of custom functions specific to that setup and serves as a simple, controlled example. It's not meant to cover the full range of possible user inputs, tasks, or edge cases.
132
+
133
+ This dataset is provided as-is, without any warranties, express or implied. The authors and contributors assume no responsibility for its accuracy or suitability for any purpose.
134
+
135
+ ---
136
+
137
  ## πŸͺͺ License
138
 
139
  This dataset is licensed under **CC BY 4.0**. See [LICENSE](LICENSE) for details.