Update README.md
Browse files
README.md
CHANGED
|
@@ -29,21 +29,12 @@ This model predicts the reading grade level of text using ModernBERT, trained on
|
|
| 29 |
- **Task:** Text Readability Assessment (Regression)
|
| 30 |
- **Framework:** PyTorch
|
| 31 |
- **Base Model:** `answerdotai/ModernBERT-base`
|
| 32 |
-
- **Training Data:**
|
| 33 |
- **Performance:**
|
| 34 |
- RMSE: 1.4143198236928092
|
| 35 |
- R²: 0.8125544567620288
|
| 36 |
- **Output:** Predicted grade level (0-12)
|
| 37 |
|
| 38 |
-
## Intended Use
|
| 39 |
-
|
| 40 |
-
This model is designed to help educators, content creators, and publishers assess the reading level difficulty of texts. It can be used for:
|
| 41 |
-
|
| 42 |
-
- Determining appropriate content for different age groups and reading abilities
|
| 43 |
-
- Ensuring instructional materials match student proficiency levels
|
| 44 |
-
- Simplifying complex text to increase accessibility
|
| 45 |
-
- Creating a consistent measurement of text complexity across materials
|
| 46 |
-
|
| 47 |
## Usage
|
| 48 |
|
| 49 |
```python
|
|
@@ -115,17 +106,3 @@ This model was fine-tuned on a custom dataset created by augmenting texts from v
|
|
| 115 |
3. Averaging grade level metrics for a more reliable target
|
| 116 |
4. Fine-tuning ModernBERT with a regression head
|
| 117 |
5. Optimizing for minimum RMSE and maximum R²
|
| 118 |
-
|
| 119 |
-
## Citation
|
| 120 |
-
|
| 121 |
-
If you use this model in your research, please cite:
|
| 122 |
-
|
| 123 |
-
```
|
| 124 |
-
@misc{modernbert-grade-predictor,
|
| 125 |
-
author = {Kiddom},
|
| 126 |
-
title = {Text Readability Grade Predictor},
|
| 127 |
-
year = {2023},
|
| 128 |
-
publisher = {Hugging Face},
|
| 129 |
-
howpublished = {\url{https://huggingface.co/{repo_id}}}
|
| 130 |
-
}
|
| 131 |
-
```
|
|
|
|
| 29 |
- **Task:** Text Readability Assessment (Regression)
|
| 30 |
- **Framework:** PyTorch
|
| 31 |
- **Base Model:** `answerdotai/ModernBERT-base`
|
| 32 |
+
- **Training Data:** [CLEAR dataset](https://github.com/scrosseye/CLEAR-Corpus)
|
| 33 |
- **Performance:**
|
| 34 |
- RMSE: 1.4143198236928092
|
| 35 |
- R²: 0.8125544567620288
|
| 36 |
- **Output:** Predicted grade level (0-12)
|
| 37 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 38 |
## Usage
|
| 39 |
|
| 40 |
```python
|
|
|
|
| 106 |
3. Averaging grade level metrics for a more reliable target
|
| 107 |
4. Fine-tuning ModernBERT with a regression head
|
| 108 |
5. Optimizing for minimum RMSE and maximum R²
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|