Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,7 +1,57 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
-
|
| 3 |
-
|
| 4 |
-
library_name: mlx
|
| 5 |
-
tags:
|
| 6 |
-
- mlx
|
| 7 |
-
---
|
|
|
|
| 1 |
+
# Regex-Helper (Powered by ML-Forge)
|
| 2 |
+
|
| 3 |
+
**Precision Regular Expression Assistant** built using a specialized fine-tuning pipeline.
|
| 4 |
+
|
| 5 |
+
## 🏗 ML-Forge Workflow
|
| 6 |
+
|
| 7 |
+
This model is generated using the **ML-Forge** engine, a parameterized automation stack for rapid LLM development.
|
| 8 |
+
|
| 9 |
+
### 🚀 Rapid Start
|
| 10 |
+
|
| 11 |
+
Follow these steps to go from zero to a published model:
|
| 12 |
+
|
| 13 |
+
#### 1. Initialize
|
| 14 |
+
|
| 15 |
+
Sets up the base Llama 3.2 weight.
|
| 16 |
+
|
| 17 |
+
```bash
|
| 18 |
+
./scripts/setup.sh
|
| 19 |
+
```
|
| 20 |
+
|
| 21 |
+
#### 2. Prepare Data
|
| 22 |
+
|
| 23 |
+
Pulls `bndis/regex_instructions` from Hugging Face and cleans it.
|
| 24 |
+
|
| 25 |
+
```bash
|
| 26 |
+
source config.sh
|
| 27 |
+
uv run python scripts/data_prep.py
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
#### 3. Train
|
| 31 |
+
|
| 32 |
+
Starts the LoRA training session (1000 iterations, Rank 16).
|
| 33 |
+
|
| 34 |
+
```bash
|
| 35 |
+
./scripts/train.sh
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
#### 4. Publish
|
| 39 |
+
|
| 40 |
+
Fuses weights, creates GGUFs, and pushes to HF, Ollama, and Kaggle.
|
| 41 |
+
|
| 42 |
+
```bash
|
| 43 |
+
./scripts/publish.sh
|
| 44 |
+
```
|
| 45 |
+
|
| 46 |
+
## 📊 Technical Configuration
|
| 47 |
+
|
| 48 |
+
Parameters are managed in `config.sh`:
|
| 49 |
+
|
| 50 |
+
- **Base**: Llama 3.2 3B Instruct
|
| 51 |
+
- **Rank**: 16
|
| 52 |
+
- **Context**: 2048 tokens
|
| 53 |
+
- **Precision**: Q4_K_M (Ollama) / BF16 (HF)
|
| 54 |
+
|
| 55 |
---
|
| 56 |
+
|
| 57 |
+
_Created by the ML-Forge Pipeline._
|
|
|
|
|
|
|
|
|
|
|
|