Update README.md

README.md

@@ -1,3 +1,89 @@
----
-license: cc-by-nc-4.0
----
+---
+license: cc-by-nc-4.0
+language:
+- az
+base_model:
+- google/mt5-small
+pipeline_tag: text2text-generation
+tags:
+- spell
+- correction
+- azerbaijani
+---
+
+# Azerbaijani Spell Correction Model
+
+This repository contains an Azerbaijani spell correction model based on `google/mt5-small`. The model is fine-tuned to correct orthographic and typographical errors in Azerbaijani text, closely mimicking real-world spelling mistakes. It leverages the characteristics of the Azerbaijani language and keyboard layouts to provide accurate corrections.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Dataset](#dataset)
+  - [Imitating Real Spelling Errors](#imitating-real-spelling-errors)
+  - [Keyboard Layout Considerations](#keyboard-layout-considerations)
+  - [Typical Substitutions](#typical-substitutions)
+- [Model Training](#model-training)
+- [Usage](#usage)
+- [Examples](#examples)
+- [License](#license)
+
+## Overview
+
+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.
+
+## Dataset
+
+### Imitating Real Spelling Errors
+
+The dataset was meticulously constructed to imitate real orthographic and typographical errors commonly found in Azerbaijani text. This was achieved by:
+
+- **Collecting a corpus of correct Azerbaijani sentences** from various sources such as news articles, books, and online content.
+- **Introducing errors into the sentences** based on common spelling mistakes, character substitutions, and keyboard mishits.
+- **Ensuring a balance between different types of errors** to train the model to handle a wide variety of mistakes.
+
+### Keyboard Layout Considerations
+
+The Azerbaijani keyboard layout and neighboring letters were taken into account to simulate realistic typing errors. Since many spelling mistakes occur due to pressing adjacent keys, the dataset includes errors resulting from:
+
+- **Mishits of neighboring keys** on the Azerbaijani keyboard.
+- **Omission or duplication of characters** that are close to each other.
+- **Transposition of adjacent characters** due to fast typing.
+
+The consideration of the keyboard layout enhances the model's ability to correct errors that are likely to occur during actual typing.
+
+### Typical Substitutions
+
+Several typical substitutions were included in the dataset to reflect common errors:
+
+- **Character Replacements:**
+  - `ə` replaced with `e`
+  - `ş` replaced with `s` or `w`
+  - `ç` replaced with `c`
+  - `ö` replaced with `o`
+  - `ğ` replaced with `g`
+  - `ı` replaced with `i`
+  - `ü` replaced with `u`
+  - `w` used instead of `v`
+  - `q` replaced with `k`
+  - `c` replaced with `j`
+
+- **Examples:**
+  - `gədər` written as `qeder`
+  - `güllə` written as `gulle`
+  - `maşın` written as `masin`
+  - `əlaqə` written as `elaqe`
+
+These substitutions represent phonetic similarities and common mistakes made by speakers when writing Azerbaijani text, especially when using Latin characters.
+
+## Model Training
+
+The model was fine-tuned using the Hugging Face Transformers library. Key points in the training process include:
+
+- **Model Architecture:** `google/mt5-small` was chosen for its multilingual support and capability to handle Azerbaijani characters.
+- **Training Objective:** The model was trained to map incorrect sentences to their correct versions.
+- **Evaluation:** The performance was evaluated using metrics like BLEU and ROUGE to ensure the quality of corrections.
+
+## Usage
+
+To use the model for spell correction:
+