Update README.md
Browse files
README.md
CHANGED
|
@@ -18,19 +18,23 @@ This repository contains an Azerbaijani spell correction model based on `google/
|
|
| 18 |
## Table of Contents
|
| 19 |
|
| 20 |
- [Overview](#overview)
|
|
|
|
| 21 |
- [Dataset](#dataset)
|
| 22 |
- [Imitating Real Spelling Errors](#imitating-real-spelling-errors)
|
| 23 |
- [Keyboard Layout Considerations](#keyboard-layout-considerations)
|
| 24 |
- [Typical Substitutions](#typical-substitutions)
|
| 25 |
- [Model Training](#model-training)
|
| 26 |
- [Usage](#usage)
|
| 27 |
-
- [Examples](#examples)
|
| 28 |
- [License](#license)
|
| 29 |
-
|
|
|
|
| 30 |
## Overview
|
| 31 |
|
| 32 |
The spell correction model is designed to automatically correct spelling errors in Azerbaijani text. It is built upon the multilingual T5 model (`google/mt5-small`), which supports Azerbaijani language characters and has been fine-tuned on a custom dataset that reflects common spelling mistakes made by native speakers.
|
| 33 |
|
|
|
|
|
|
|
|
|
|
| 34 |
**Input**
|
| 35 |
`Gozel arasdirlma apariril. bizde kassirlerden sikayetci ola bilmirsen umumilikde goturende bezi yerlerden sikayetci olmaq mumkun deyil`
|
| 36 |
|
|
@@ -94,3 +98,19 @@ The model was fine-tuned using the Hugging Face Transformers library. Key points
|
|
| 94 |
|
| 95 |
To use the model for spell correction:
|
| 96 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
## Table of Contents
|
| 19 |
|
| 20 |
- [Overview](#overview)
|
| 21 |
+
- [Examples](#examples)
|
| 22 |
- [Dataset](#dataset)
|
| 23 |
- [Imitating Real Spelling Errors](#imitating-real-spelling-errors)
|
| 24 |
- [Keyboard Layout Considerations](#keyboard-layout-considerations)
|
| 25 |
- [Typical Substitutions](#typical-substitutions)
|
| 26 |
- [Model Training](#model-training)
|
| 27 |
- [Usage](#usage)
|
|
|
|
| 28 |
- [License](#license)
|
| 29 |
+
- [Contact](#сontact)
|
| 30 |
+
-
|
| 31 |
## Overview
|
| 32 |
|
| 33 |
The spell correction model is designed to automatically correct spelling errors in Azerbaijani text. It is built upon the multilingual T5 model (`google/mt5-small`), which supports Azerbaijani language characters and has been fine-tuned on a custom dataset that reflects common spelling mistakes made by native speakers.
|
| 34 |
|
| 35 |
+
|
| 36 |
+
## Examples
|
| 37 |
+
|
| 38 |
**Input**
|
| 39 |
`Gozel arasdirlma apariril. bizde kassirlerden sikayetci ola bilmirsen umumilikde goturende bezi yerlerden sikayetci olmaq mumkun deyil`
|
| 40 |
|
|
|
|
| 98 |
|
| 99 |
To use the model for spell correction:
|
| 100 |
|
| 101 |
+
|
| 102 |
+
## License
|
| 103 |
+
|
| 104 |
+
This model licensed under the CC BY-NC-ND 4.0 license.
|
| 105 |
+
What does this license allow?
|
| 106 |
+
|
| 107 |
+
Attribution: You must give appropriate credit, provide a link to the license, and indicate if changes were made.
|
| 108 |
+
Non-Commercial: You may not use the material for commercial purposes.
|
| 109 |
+
No Derivatives: If you remix, transform, or build upon the material, you may not distribute the modified material.
|
| 110 |
+
|
| 111 |
+
For more information, please refer to the <a target="_blank" href="https://creativecommons.org/licenses/by-nc-nd/4.0/">CC BY-NC-ND 4.0 license</a>.
|
| 112 |
+
|
| 113 |
+
|
| 114 |
+
## Contact
|
| 115 |
+
|
| 116 |
+
For more information, questions, or issues, please contact LocalDoc at [v.resad.89@gmail.com].
|