Update README.md

README.md

@@ -12,6 +12,22 @@ widget:
 # Typo Detector
 
 
+## Dataset Information
+
+For this specific task, I used [NeuSpell](https://github.com/neuspell/neuspell) corpus as my raw data.
+
+## Evaluation
+
+The following tables summarize the scores obtained by model overall and per each class.
+
+|       #      | precision |  recall  | f1-score |  support |
+|:------------:|:---------:|:--------:|:--------:|:--------:|
+|     TYPO     |  0.992332 | 0.985997 | 0.989154 | 416054.0 |
+|   micro avg  |  0.992332 | 0.985997 | 0.989154 | 416054.0 |
+|   macro avg  |  0.992332 | 0.985997 | 0.989154 | 416054.0 |
+| weighted avg |  0.992332 | 0.985997 | 0.989154 | 416054.0 |
+
+
 ## How to use
 
 You use this model with Transformers pipeline for NER (token-classification).
@@ -76,3 +92,6 @@ Output:
 [Detected]:  It is left to the directors to figure out <i>hpw</i> to bring the <i>stry</i> across to <i>tye</i> audience .
 ----------------------------------------------------------------------------------------------------------------------------------
 ```
+
+## Questions?
+Post a Github issue on the [TypoDetector Issues](https://github.com/m3hrdadfi/typo-detector/issues) repo.