doc(README): clarify usage to better reflect intended use of the model as a prototyping tool
Browse files
README.md
CHANGED
@@ -40,7 +40,7 @@ $ You are a precise parser of recurring schedule expressions. Your only job is t
|
|
40 |
|
41 |
### Downstream Use
|
42 |
|
43 |
-
|
44 |
|
45 |
The DSL produced by this model is defined and executed by the [Mini Recurrence Converter DSL module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl).
|
46 |
|
@@ -69,7 +69,7 @@ This model is specialized for recurrence conversion DSL. It is not intended for
|
|
69 |
|
70 |
Trained on [a6188466/mini-recurrence-converter-dsl-dataset](https://huggingface.co/datasets/a6188466/mini-recurrence-converter-dsl-dataset) using the `dsl` adapter from [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets) and [`fine_tune.py`](https://github.com/gh9869827/fifo-tool-airlock-model-env/blob/main/fifo_tool_airlock_model_env/fine_tuning/phi_4/fine_tune.py) in a fully local, air-gapped Docker container.
|
71 |
|
72 |
-
- **Dataset:** 226 examples mapping natural language to DSL commands, including hand-curated and [synthetic](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl/generate_synthetic_data.py) samples
|
73 |
- **Epochs:** 15
|
74 |
- **Batch size:** 1
|
75 |
- **Precision:** bf16
|
@@ -111,6 +111,8 @@ Trained on [a6188466/mini-recurrence-converter-dsl-dataset](https://huggingface.
|
|
111 |
- **97.79%** on held-out [test set](https://huggingface.co/datasets/a6188466/mini-recurrence-converter-dsl-dataset) (**221/226** passed)
|
112 |
The test set includes 26 hand-curated and 200 [synthetic](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl/generate_synthetic_data.py) examples.
|
113 |
|
|
|
|
|
114 |
Evaluation script: [`evaluate_mini_recurrence_converter_dsl_model.py`](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl/evaluate_mini_recurrence_converter_dsl_model.py)
|
115 |
|
116 |
## 🪪 License
|
|
|
40 |
|
41 |
### Downstream Use
|
42 |
|
43 |
+
Useful for prototyping DSL-based schedulers, assistants, or natural language interfaces requiring structured recurrence interpretation.
|
44 |
|
45 |
The DSL produced by this model is defined and executed by the [Mini Recurrence Converter DSL module](https://github.com/gh9869827/fifo-dev-dsl/tree/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl).
|
46 |
|
|
|
69 |
|
70 |
Trained on [a6188466/mini-recurrence-converter-dsl-dataset](https://huggingface.co/datasets/a6188466/mini-recurrence-converter-dsl-dataset) using the `dsl` adapter from [`fifo-tool-datasets`](https://github.com/gh9869827/fifo-tool-datasets) and [`fine_tune.py`](https://github.com/gh9869827/fifo-tool-airlock-model-env/blob/main/fifo_tool_airlock_model_env/fine_tuning/phi_4/fine_tune.py) in a fully local, air-gapped Docker container.
|
71 |
|
72 |
+
- **Dataset:** 226 examples mapping natural language to DSL commands, including hand-curated and [synthetic](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl/generate_synthetic_data.py) samples
|
73 |
- **Epochs:** 15
|
74 |
- **Batch size:** 1
|
75 |
- **Precision:** bf16
|
|
|
111 |
- **97.79%** on held-out [test set](https://huggingface.co/datasets/a6188466/mini-recurrence-converter-dsl-dataset) (**221/226** passed)
|
112 |
The test set includes 26 hand-curated and 200 [synthetic](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl/generate_synthetic_data.py) examples.
|
113 |
|
114 |
+
These results demonstrate strong accuracy on tested queries, though the model may still produce incorrect outputs on novel or ambiguous phrasing.
|
115 |
+
|
116 |
Evaluation script: [`evaluate_mini_recurrence_converter_dsl_model.py`](https://github.com/gh9869827/fifo-dev-dsl/blob/main/fifo_dev_dsl/domain_specific/mini_recurrence_converter_dsl/evaluate_mini_recurrence_converter_dsl_model.py)
|
117 |
|
118 |
## 🪪 License
|