doc(README): finalize model card with clarified scope, evaluation details, and usage framing
Browse files
README.md
CHANGED
|
@@ -28,7 +28,7 @@ This adapter is designed as a **demonstration and testbed** for structured recur
|
|
| 28 |
|
| 29 |
## 🚀 Uses
|
| 30 |
|
| 31 |
-
This adapter
|
| 32 |
|
| 33 |
Example prompt:
|
| 34 |
|
|
@@ -42,32 +42,16 @@ It is a useful starting point for prototyping DSL-based schedulers, assistants,
|
|
| 42 |
|
| 43 |
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).
|
| 44 |
|
| 45 |
-
It provides:
|
| 46 |
-
|
| 47 |
-
- 🧠 A symbolic DSL to represent natural language recurrence patterns
|
| 48 |
-
- 📅 A Python engine to evaluate the DSL into structured recurrence rules
|
| 49 |
-
- 🤖 An integration with LLMs to translate text into DSL code
|
| 50 |
-
- 🔒 A safe alternative to arbitrary code execution — only predefined DSL functions are supported, so untrusted model output **cannot execute arbitrary code**
|
| 51 |
-
|
| 52 |
-
Example:
|
| 53 |
-
|
| 54 |
-
```python
|
| 55 |
-
from fifo_dev_dsl.domain_specific.mini_recurrence_converter_dsl import MiniRecurrenceConverterDSL
|
| 56 |
-
dsl = "WEEKLY(1, [MO, WE], TIME(10, 0))"
|
| 57 |
-
parsed = MiniRecurrenceConverterDSL().parse(dsl)
|
| 58 |
-
print(parsed)
|
| 59 |
-
# Output: structured recurrence rule object
|
| 60 |
-
```
|
| 61 |
|
| 62 |
## ⚠️ Out-of-Scope Use
|
| 63 |
|
| 64 |
-
This model
|
| 65 |
|
| 66 |
## 🏗️ Training Details
|
| 67 |
|
| 68 |
-
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)
|
| 69 |
|
| 70 |
-
- **Dataset:**
|
| 71 |
- **Epochs:** 15
|
| 72 |
- **Batch size:** 1
|
| 73 |
- **Precision:** bf16
|
|
@@ -106,7 +90,7 @@ Trained on [a6188466/mini-recurrence-converter-dsl-dataset](https://huggingface.
|
|
| 106 |
- **Eval set:** Natural language queries similar in structure and intent to the training examples
|
| 107 |
- **Metric:** Functional equivalence — two DSL expressions are considered correct when they evaluate to the same result
|
| 108 |
- **Results:**
|
| 109 |
-
- **97.79%** on held-out [test set](https://huggingface.co/datasets/a6188466/mini-recurrence-converter-dsl-dataset) (**221/226** passed)
|
| 110 |
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.
|
| 111 |
|
| 112 |
These results demonstrate strong accuracy on tested queries, but performance should be carefully evaluated in each individual use case.
|
|
|
|
| 28 |
|
| 29 |
## 🚀 Uses
|
| 30 |
|
| 31 |
+
This adapter fine-tunes Phi-4-mini-instruct for parsing natural recurrence expressions into DSL format.
|
| 32 |
|
| 33 |
Example prompt:
|
| 34 |
|
|
|
|
| 42 |
|
| 43 |
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).
|
| 44 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 45 |
|
| 46 |
## ⚠️ Out-of-Scope Use
|
| 47 |
|
| 48 |
+
This model has been fine-tuned specifically for recurrence conversion DSL as a demonstration and testbed. It is not intended for general-purpose dialogue or unrelated tasks.
|
| 49 |
|
| 50 |
## 🏗️ Training Details
|
| 51 |
|
| 52 |
+
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).
|
| 53 |
|
| 54 |
+
- **Dataset:** 279 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
|
| 55 |
- **Epochs:** 15
|
| 56 |
- **Batch size:** 1
|
| 57 |
- **Precision:** bf16
|
|
|
|
| 90 |
- **Eval set:** Natural language queries similar in structure and intent to the training examples
|
| 91 |
- **Metric:** Functional equivalence — two DSL expressions are considered correct when they evaluate to the same result
|
| 92 |
- **Results:**
|
| 93 |
+
- **97.79%** on a held-out [test set](https://huggingface.co/datasets/a6188466/mini-recurrence-converter-dsl-dataset) (**221/226** passed), containing queries similar in structure and intent to the training examples, using the functional equivalence metric defined above.
|
| 94 |
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.
|
| 95 |
|
| 96 |
These results demonstrate strong accuracy on tested queries, but performance should be carefully evaluated in each individual use case.
|