a6188466 commited on
Commit
049826b
Β·
verified Β·
1 Parent(s): 8461940

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

Browse files
Files changed (1) hide show
  1. README.md +16 -21
README.md CHANGED
@@ -47,9 +47,7 @@ size_categories:
47
 
48
  # mini-recurrence-converter-dsl-dataset
49
 
50
- This dataset contains natural language recurrence expressions paired with symbolic DSL function calls, formatted in a structured `system β†’ in β†’ out` format. It is designed for training models to convert everyday recurrence descriptions (e.g. "every Tuesday at 8am") into structured, executable DSL representations.
51
-
52
- It was uploaded using the [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets) utility with the `dsl` adapter, which supports structured `system β†’ in β†’ out` triplets.
53
 
54
  ---
55
 
@@ -57,10 +55,12 @@ It was uploaded using the [`fifo-tool-datasets`](https://github.com/gh9869827/fi
57
 
58
  The dataset uses a **wide format** with the following three columns:
59
 
60
- - `system` β€” the system prompt defining the role of the model
61
  - `in` β€” the natural language recurrence string (e.g. `"every Tuesday at 8am"`)
62
  - `out` β€” the corresponding DSL expression (e.g. `WEEKLY(1, [TU], TIME(8, 0))`)
63
 
 
 
64
  For all examples, the system prompt is set to:
65
 
66
  ```plaintext
@@ -81,28 +81,23 @@ $ You are a precise parser of recurring schedule expressions. Your only job is t
81
 
82
  The DSL used in this dataset is implemented in the [Mini Recurrence Converter DSL module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl).
83
 
84
- It provides:
85
-
86
- - 🧠 A symbolic DSL to represent natural language recurrence patterns
87
- - πŸ“… A Python engine to evaluate the DSL into structured recurrence rules
88
- - πŸ€– Integration with LLMs to convert natural language into DSL code
89
- - πŸ”’ A safe alternative to arbitrary code execution β€” only predefined DSL functions are supported, so untrusted model output **cannot execute arbitrary code**
90
-
91
  Example:
92
 
93
  ```python
94
- from fifo_dev_dsl.domain_specific.mini_recurrence_converter_dsl import MiniRecurrenceConverterDSL
 
95
  dsl = "WEEKLY(1, [MO, WE], TIME(10, 0))"
96
  parsed = MiniRecurrenceConverterDSL().parse(dsl)
 
97
  print(parsed)
98
- # Output: structured recurrence rule object
99
  ```
100
 
101
  ---
102
 
103
  ## πŸš€ Using the Dataset
104
 
105
- To load the dataset in your training or fine-tuning pipeline:
106
 
107
  ```python
108
  from fifo_tool_datasets.sdk.hf_dataset_adapters.dsl import DSLAdapter
@@ -111,21 +106,21 @@ print(dataset_dict["train"])
111
  print(dataset_dict["validation"])
112
  ```
113
 
114
- The test split enables functional evaluation by comparing model-generated DSL outputs against expected outcomes.
115
-
116
  ---
117
 
118
- ## ⚠️ Limitations
119
 
120
- This dataset does not cover all natural language recurrence phrasings or edge cases. It focuses on representative examples of common recurring schedule expressions. Users should evaluate and extend it as needed for their specific use case.
 
 
121
 
122
  ---
123
 
124
- ## πŸ”§ Upload & Editing Tools
125
 
126
- This dataset was uploaded using [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets), which supports conversion between `.dat` files and Hugging Face-compatible `datasets.Dataset` objects.
127
 
128
- To re-import the dataset as a `.dat` file or update it, you can use the CLI or Python SDK included in that tool.
129
 
130
  ---
131
 
 
47
 
48
  # mini-recurrence-converter-dsl-dataset
49
 
50
+ This dataset contains natural language recurrence expressions paired with symbolic DSL function calls, formatted in a structured `system β†’ in β†’ out` format. It is used for prototyping models that convert English recurrence descriptions (e.g., "every Tuesday at 8am") into structured, executable DSL representations.
 
 
51
 
52
  ---
53
 
 
55
 
56
  The dataset uses a **wide format** with the following three columns:
57
 
58
+ - `system` β€” the system prompt that defines the model's task
59
  - `in` β€” the natural language recurrence string (e.g. `"every Tuesday at 8am"`)
60
  - `out` β€” the corresponding DSL expression (e.g. `WEEKLY(1, [TU], TIME(8, 0))`)
61
 
62
+ Each entry consists of a `system`, `in`, and `out` field, forming a structured input-output example.
63
+
64
  For all examples, the system prompt is set to:
65
 
66
  ```plaintext
 
81
 
82
  The DSL used in this dataset is implemented in the [Mini Recurrence Converter DSL module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl).
83
 
 
 
 
 
 
 
 
84
  Example:
85
 
86
  ```python
87
+ from fifo_dev_dsl.domain_specific.mini_recurrence_converter_dsl.core import MiniRecurrenceConverterDSL
88
+
89
  dsl = "WEEKLY(1, [MO, WE], TIME(10, 0))"
90
  parsed = MiniRecurrenceConverterDSL().parse(dsl)
91
+
92
  print(parsed)
93
+ # RecurrenceRule(unit=<RecurrenceUnit.WEEKLY>, frequency=1, days=[0, 2], day_of_month=None, month=None, occurrence=None, hour=10, minute=0)
94
  ```
95
 
96
  ---
97
 
98
  ## πŸš€ Using the Dataset
99
 
100
+ To load the dataset:
101
 
102
  ```python
103
  from fifo_tool_datasets.sdk.hf_dataset_adapters.dsl import DSLAdapter
 
106
  print(dataset_dict["validation"])
107
  ```
108
 
 
 
109
  ---
110
 
111
+ ## πŸ”§ Upload & Editing Tools
112
 
113
+ Uploaded via [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets) using the `dsl` adapter.
114
+
115
+ You can edit or extend the dataset using its `.dat` format and CLI tools.
116
 
117
  ---
118
 
119
+ ## ⚠️ Limitations
120
 
121
+ This dataset does not cover all natural language recurrence phrasings or edge cases. It focuses on illustrative examples of common recurring schedule expressions. Users should evaluate and extend it as needed for their specific use case.
122
 
123
+ 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.
124
 
125
  ---
126