Update README.md

README.md

@@ -21,7 +21,7 @@ size_categories:
 
 ![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Dataset-orange)
 
-Kaamel-Dict is the largest publicly available Persian grapheme-to-phoneme (G2P) dictionary, containing over 120,000 entries.
+Kaamel-Dict is the largest publicly available Persian grapheme-to-phoneme (G2P) dictionary, containing over 116,600 entries.
 It was developed by unifying multiple phonetic representation systems from existing G2P tools
 [[1](https://github.com/mohamad-hasan-sohan-ajini/G2P)]
 [[2](https://github.com/AzamRabiee/Persian\_G2P)]
@@ -38,6 +38,20 @@ and an additional online glossary
 , called Jame` Dictionary, . This dictionary is released under the GNU license, allowing it to be used for 
  developing G2P models, Persian text-to-speech (TTS) systems, or linguistic research.
 
+---
+
+## Column Descriptions
+
+The dataset contains the following columns:
+
+- **grapheme**: Persian written form of the word.
+- **phoneme**: List of pronunciations of the word. Each item in the list is a tuple of phonemes corresponding to a specific pronunciation.
+- **nodiff**: For some words with multiple pronunciations, this column is marked as `True` if all pronunciations are equivalent and can be used interchangeably. For example, `/AsemAn/` and `/AsmAn/` are both valid pronunciations for the word `آسمان`.
+- **POS**: For some words with multiple pronunciations, each pronunciation is labeled with the part of speech (POS) it takes in a sentence. For example, for the word `مرد`, the pronunciation `/mard/` is always a **NOUN**, while `/mord/` is always a **VERB**. The following POS values are used in this dictionary:
+  - **ADP**: Adposition (preposition or postposition), **ADV**: Adverb, **DET**: Determiner, **NUM**: Numeral, **N,EZ**: Noun with Ezafe (e.g., خانه‌ی من), **PRON**: Pronoun, **VERB**: Verb, **SCONJ**: Subordinating conjunction, **NOUN**: Noun, **ADJ**: Adjective
+- **prob**: For some words with multiple pronunciations, this column provides a relative probability (based on native speaker intuition) for each pronunciation. For example, the word `در` is pronounced as `/dorr/` very rarely (in old literature) and as `/dar/` much more commonly (as a preposition). This column indicates the relative likelihood of each pronunciation.
+---
+
 ## Phoneme Representation
 
 The phonetic symbols used in this dataset correspond to Persian phonemes. Below is a reference table for the specific symbols and their IPA equivalents:
@@ -61,11 +75,14 @@ The phonetic symbols used in this dataset correspond to Persian phonemes. Below
 | v      | و (consonant)        | v             | ورم: varam           |
 | ?      | ع، ء، ئ (consonant)  | ʔ             | عمر: ?omr, آینده: ?Ayande |
 
+---
 
 ## License
 
 Kaamel-Dict is distributed under the GNU General Public License, making it freely available for redistribution and modification under the same terms as its source materials. All source dictionaries are licensed for redistribution.
 
+---
+
 ## How to Use
 
 You can download the dataset from [Here](https://huggingface.co/datasets/MahtaFetrat/KaamelDict/resolve/main/KaamelDict.csv) or clone the repository:
@@ -74,6 +91,7 @@ You can download the dataset from [Here](https://huggingface.co/datasets/MahtaFe
 git clone https://huggingface.co/datasets/MahtaFetrat/KaamelDict
 ```
 
+---
 
 ## References
 
@@ -172,9 +190,13 @@ The following datasets and resources were used to create Kaamel-Dict:
 }
 ```
 
+---
+
 ## Contact
 For any questions or inquiries, feel free to open an issue or contact the author at [[email protected]].
 
+---
+
 ## Citation
 If you use KaamelDict in your research or projects, please cite the following paper: