doc(README): clarify dataset scope, structure, and limitations
Browse files
README.md
CHANGED
|
@@ -47,7 +47,9 @@ size_categories:
|
|
| 47 |
|
| 48 |
# mini-recurrence-converter-dsl-dataset
|
| 49 |
|
| 50 |
-
This dataset
|
|
|
|
|
|
|
| 51 |
|
| 52 |
---
|
| 53 |
|
|
@@ -56,7 +58,7 @@ This dataset contains natural language recurrence expressions paired with symbol
|
|
| 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
|
| 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.
|
|
@@ -104,6 +106,7 @@ from fifo_tool_datasets.sdk.hf_dataset_adapters.dsl import DSLAdapter
|
|
| 104 |
dataset_dict = DSLAdapter().from_hub_to_dataset_dict("a6188466/mini-recurrence-converter-dsl-dataset")
|
| 105 |
print(dataset_dict["train"])
|
| 106 |
print(dataset_dict["validation"])
|
|
|
|
| 107 |
```
|
| 108 |
|
| 109 |
---
|
|
@@ -118,9 +121,12 @@ You can edit or extend the dataset using its `.dat` format and CLI tools.
|
|
| 118 |
|
| 119 |
## ⚠️ Limitations
|
| 120 |
|
| 121 |
-
This dataset
|
|
|
|
|
|
|
|
|
|
| 122 |
|
| 123 |
-
This dataset is provided as
|
| 124 |
|
| 125 |
---
|
| 126 |
|
|
|
|
| 47 |
|
| 48 |
# mini-recurrence-converter-dsl-dataset
|
| 49 |
|
| 50 |
+
This dataset is used to prototype models for the [Mini Recurrence Converter DSL module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl).
|
| 51 |
+
|
| 52 |
+
It pairs English **recurrence expressions** (e.g., `"every Tuesday at 8am"`) with symbolic DSL function calls (e.g., `WEEKLY(1, [TU], TIME(8, 0))`) compatible with the module.
|
| 53 |
|
| 54 |
---
|
| 55 |
|
|
|
|
| 58 |
The dataset uses a **wide format** with the following three columns:
|
| 59 |
|
| 60 |
- `system` — the system prompt that defines the model's task
|
| 61 |
+
- `in` — the natural language **recurrence expressions** (e.g. `"every Tuesday at 8am"`)
|
| 62 |
- `out` — the corresponding DSL expression (e.g. `WEEKLY(1, [TU], TIME(8, 0))`)
|
| 63 |
|
| 64 |
Each entry consists of a `system`, `in`, and `out` field, forming a structured input-output example.
|
|
|
|
| 106 |
dataset_dict = DSLAdapter().from_hub_to_dataset_dict("a6188466/mini-recurrence-converter-dsl-dataset")
|
| 107 |
print(dataset_dict["train"])
|
| 108 |
print(dataset_dict["validation"])
|
| 109 |
+
print(dataset_dict["test"])
|
| 110 |
```
|
| 111 |
|
| 112 |
---
|
|
|
|
| 121 |
|
| 122 |
## ⚠️ Limitations
|
| 123 |
|
| 124 |
+
This dataset is intended solely for prototyping models for the [Mini Recurrence Converter DSL module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl).
|
| 125 |
+
|
| 126 |
+
It does not cover all phrasings or edge cases of English **recurrence expressions**. Instead, it focuses on illustrative examples supported by [the module's DSL functions](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl#-dsl-syntax-and-examples). The dataset should be independently evaluated and extended to meet the specific requirements of any use case.
|
| 127 |
+
|
| 128 |
|
| 129 |
+
This dataset is provided *as is*, without any warranties, express or implied. The authors and contributors assume no responsibility for its accuracy, completeness, or suitability for any purpose.
|
| 130 |
|
| 131 |
---
|
| 132 |
|