KaamelDict / README.md
MahtaFetrat's picture
Update README.md
8ddbf02 verified
metadata
license: gpl
task_categories:
  - translation
language:
  - fa
tags:
  - grapheme-to-phoneme
  - g2p
  - phoneme-translation
  - persian
  - farsi
  - dictionary
  - glossary
  - kaamel-dict
pretty_name: Kaamel Dict
size_categories:
  - 100K<n<1M

Kaamel-Dict: A Comprehensive Persian G2P Dictionary

Hugging Face

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] [2] [3] [4] and datasets [5] [6] [7] [8] [9] and an additional online glossary [10] , 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:

Symbol Persian Sound IPA Equivalent Example
A آ, ا (long vowel) æ ماه: mAh
a َ (short vowel) ɒː درد: dard
u او (long vowel) دوست: dust
i ای (long vowel) میز: miz
o ُ (short vowel) o ظهر: zohr
e ِ (short vowel) e ذهن: zehn
S ش (consonant) ʃ شهر: Sahr
C چ (consonant) tʃʰ چتر: Catr
Z ژ (consonant) ʒ ژاله: ZAle
q غ، ق (consonant) ɣ, q غذا: qazA, قند: qand
x خ (consonant) x خاک: xAk
r ر (consonant) ɾ روح: ruh
y ی (consonant) j یار: yAr
j ج (consonant) نجات: nejAt
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 or clone the repository:

git clone https://huggingface.co/datasets/MahtaFetrat/KaamelDict

References

The following datasets and resources were used to create Kaamel-Dict:

@misc{ipa-dict,
  title = {IPA-dict: Monolingual wordlists with pronunciation information in IPA},
  year = {2023},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/open-dict-data/ipa-dict}},
}
@misc{tihu-dict,
  title = {Tihu Persia Dictionary},
  year = {2019},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/tihu-nlp/tihudict}},
}
@misc{IPA-Translator,
  title = {IPA-Translator},
  year = {2022},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/lotusfa/IPA-Translator}},
}
@misc{wiktionary,
  title        = {Wiktionary free dataset},
  howpublished = {\url{https://www.wiktionary.org/}},
  note         = {Accessed: 2024-09-05}
}
@misc{zaya,
  title        = {Persian Zaya Dictionary},
  howpublished = {\url{https://www.peykaregan.ir/dataset/}},
  note         = {Accessed: 2024-09-05}
}
@misc{jame,
  title        = {Persian Jame Glossary},
  howpublished = {\url{http://farhang.apll.ir/}},
  note         = {Accessed: 2024-09-05}
}
@misc{mohammadhasan,
  author       = {Mohammad Hasan Sohan Ajini},
  title        = {Attention Based Grapheme To Phoneme},
  howpublished = {\url{https://github.com/mohamad-hasan-sohan-ajini/G2P}},
  year         = {2022},
  note         = {Accessed: 2024-09-05}
}
@misc{azamrabiee,
  author = {Rabiee, Azam},
  title = {Persian g2p},
  year = {2019},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/AzamRabiee/Persian\_G2P}},
  note         = {Accessed: 2024-09-05}
}
@misc{PasaOpasen,
  author       = {Demetry Pasсal},
  title        = {Simple persian (farsi) grapheme-to-phoneme converter},
  howpublished = {\url{https://github.com/PasaOpasen/PersianG2P}},
  year         = {2020},
  note         = {Accessed: 2024-09-05}
}
@article{zhu2022charsiu-g2p,
  title={ByT5 model for massively multilingual grapheme-to-phoneme conversion},
  author={Zhu, Jian and Zhang, Cong and Jurgens, David},
  url = {https://arxiv.org/abs/2204.03067},
  doi = {10.48550/ARXIV.2204.03067},
  year={2022}
}

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:

@misc{fetrat2024llmpoweredg2p,
      title={LLM-Powered Grapheme-to-Phoneme Conversion: Benchmark and Case Study}, 
      author={Mahta Fetrat Qharabagh and Zahra Dehghanian and Hamid R. Rabiee},
      year={2024},
      eprint={2409.08554},
      archivePrefix={arXiv},
      primaryClass={cs.CL},
      url={https://arxiv.org/abs/2409.08554}, 
}