Update README.md
Browse files
README.md
CHANGED
|
@@ -8,13 +8,14 @@ each scored for overall holistic language proficiency as well as analytic scores
|
|
| 8 |
phraseology, grammar, and conventions. The scores were obtained through assessments by a number of professional English teachers
|
| 9 |
adhering to rigorous procedures. The training dataset guarantees that our model acuqires high practicality and accuracy, closely emulating professional grading standards.
|
| 10 |
|
| 11 |
-
The model's performance on the test dataset, which includes around 980 English essays,
|
|
|
|
| 12 |
|
| 13 |
Upon inputting an essay, the model outputs six scores corresponding to cohesion, syntax, vocabulary, phraseology, grammar, and conventions. Each score ranges from 1 to 5, with higher scores indicating greater proficiency within the essay. These dimensions collectively assess the quality of the input essay from multiple perspectives. The model serves as a valuable tool for EFL teachers and researchers, and it is also beneficial for English L2 learners and parents for self-evaluating their composition skills.
|
| 14 |
|
| 15 |
To test the model, run the following code or paste your essay into the API interface:
|
| 16 |
|
| 17 |
-
1) Please use the following Python code if you want to get the ouput values ranging from 1 to 5.
|
| 18 |
|
| 19 |
```
|
| 20 |
from transformers import AutoModelForSequenceClassification, AutoTokenizer
|
|
@@ -63,7 +64,7 @@ for item, score in zip(item_names, rounded_scores):
|
|
| 63 |
|
| 64 |
```
|
| 65 |
|
| 66 |
-
2) However, implement the following code if you expect to obtain the output values between 1 to 10.
|
| 67 |
|
| 68 |
```
|
| 69 |
from transformers import AutoModelForSequenceClassification, AutoTokenizer
|
|
@@ -101,7 +102,7 @@ for item, score in zip(item_names, rounded_scores):
|
|
| 101 |
```
|
| 102 |
|
| 103 |
|
| 104 |
-
Examples:
|
| 105 |
```
|
| 106 |
# the first example (A1 level)
|
| 107 |
|
|
@@ -129,8 +130,8 @@ conventions: 8.5
|
|
| 129 |
|
| 130 |
```
|
| 131 |
|
| 132 |
-
Please cite the following paper if you use this model:
|
| 133 |
-
|
| 134 |
@article{sun2024automatic,
|
| 135 |
title={Automatic Essay Multi-dimensional Scoring with Fine-tuning and Multiple Regression},
|
| 136 |
author={Kun Sun and Rong Wang},
|
|
@@ -138,4 +139,4 @@ Please cite the following paper if you use this model:
|
|
| 138 |
journal={ArXiv},
|
| 139 |
url={https://arxiv.org/abs/5634515}
|
| 140 |
}
|
| 141 |
-
|
|
|
|
| 8 |
phraseology, grammar, and conventions. The scores were obtained through assessments by a number of professional English teachers
|
| 9 |
adhering to rigorous procedures. The training dataset guarantees that our model acuqires high practicality and accuracy, closely emulating professional grading standards.
|
| 10 |
|
| 11 |
+
The model's performance on the test dataset, which includes around 980 English essays,
|
| 12 |
+
is summarized by the following metrics: 'mean accuracy'= 0.91 and 'mean f1 score' = 0.9, mean Quadratic Weighted Kappa (QWK) =0.85.
|
| 13 |
|
| 14 |
Upon inputting an essay, the model outputs six scores corresponding to cohesion, syntax, vocabulary, phraseology, grammar, and conventions. Each score ranges from 1 to 5, with higher scores indicating greater proficiency within the essay. These dimensions collectively assess the quality of the input essay from multiple perspectives. The model serves as a valuable tool for EFL teachers and researchers, and it is also beneficial for English L2 learners and parents for self-evaluating their composition skills.
|
| 15 |
|
| 16 |
To test the model, run the following code or paste your essay into the API interface:
|
| 17 |
|
| 18 |
+
1) Please use the following Python code if you want to get the ouput values ranging from **1 to 5**.
|
| 19 |
|
| 20 |
```
|
| 21 |
from transformers import AutoModelForSequenceClassification, AutoTokenizer
|
|
|
|
| 64 |
|
| 65 |
```
|
| 66 |
|
| 67 |
+
2) However, implement the following code if you expect to obtain the output values between **1 to 10**.
|
| 68 |
|
| 69 |
```
|
| 70 |
from transformers import AutoModelForSequenceClassification, AutoTokenizer
|
|
|
|
| 102 |
```
|
| 103 |
|
| 104 |
|
| 105 |
+
**Examples**:
|
| 106 |
```
|
| 107 |
# the first example (A1 level)
|
| 108 |
|
|
|
|
| 130 |
|
| 131 |
```
|
| 132 |
|
| 133 |
+
Please **cite** the following paper if you use this model:
|
| 134 |
+
```
|
| 135 |
@article{sun2024automatic,
|
| 136 |
title={Automatic Essay Multi-dimensional Scoring with Fine-tuning and Multiple Regression},
|
| 137 |
author={Kun Sun and Rong Wang},
|
|
|
|
| 139 |
journal={ArXiv},
|
| 140 |
url={https://arxiv.org/abs/5634515}
|
| 141 |
}
|
| 142 |
+
'''
|