Duplicate from MahtaFetrat/KaamelDict

Co-authored-by: Mahta Fetrat <MahtaFetrat@users.noreply.huggingface.co>

.gitattributes

@@ -0,0 +1,58 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text
+# Video files - compressed
+*.mp4 filter=lfs diff=lfs merge=lfs -text
+*.webm filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,214 @@
+---
+license: gpl
+task_categories:
+- translation
+language:
+- fa
+tags:
+- grapheme-to-phoneme
+- g2p
+- phoneme-translation
+- persian
+- farsi
+- dictionary
+- glossary
+- kaamel-dict
+- kaameldict
+- llm-powered
+pretty_name: Kaamel Dict
+size_categories:
+- 100K<n<1M
+---
+# Kaamel-Dict: A Comprehensive Persian G2P Dictionary
+
+![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 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)]
+[[3](https://github.com/PasaOpasen/PersianG2P)]
+[[4](https://arxiv.org/abs/2204.03067)]
+and datasets
+[[5](https://github.com/open-dict-data/ipa-dict)]
+[[6](https://github.com/tihu-nlp/tihudict)]
+[[7](https://github.com/lotusfa/IPA-Translator)]
+[[8](https://www.wiktionary.org/)]
+[[9](https://www.peykaregan.ir/dataset/)]
+and an additional online glossary
+[[10](http://farhang.apll.ir/)]
+, 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)      | uː            | دوست: dust           |
+| i      | ای (long vowel)      | iː            | میز: 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)        | dʒ            | نجات: 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](https://huggingface.co/datasets/MahtaFetrat/KaamelDict/resolve/main/KaamelDict.csv) or clone the repository:
+
+```bash
+git clone https://huggingface.co/datasets/MahtaFetrat/KaamelDict
+```
+
+---
+
+## References
+
+The following datasets and resources were used to create Kaamel-Dict:
+
+```bash
+@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}},
+}
+```
+
+```bash
+@misc{tihu-dict,
+  title = {Tihu Persia Dictionary},
+  year = {2019},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/tihu-nlp/tihudict}},
+}
+```
+
+```bash
+@misc{IPA-Translator,
+  title = {IPA-Translator},
+  year = {2022},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/lotusfa/IPA-Translator}},
+}
+```
+
+```bash
+@misc{wiktionary,
+  title        = {Wiktionary free dataset},
+  howpublished = {\url{https://www.wiktionary.org/}},
+  note         = {Accessed: 2024-09-05}
+}
+```
+
+```bash
+@misc{zaya,
+  title        = {Persian Zaya Dictionary},
+  howpublished = {\url{https://www.peykaregan.ir/dataset/}},
+  note         = {Accessed: 2024-09-05}
+}
+```
+
+```bash
+@misc{jame,
+  title        = {Persian Jame Glossary},
+  howpublished = {\url{http://farhang.apll.ir/}},
+  note         = {Accessed: 2024-09-05}
+}
+```
+
+```bash
+@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}
+}
+```
+
+```bash
+@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}
+}
+```
+
+```bash
+@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}
+}
+```
+
+```bash
+@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 [m.fetrat@sharif.edu].
+
+---
+
+## Citation
+If you use KaamelDict in your research or projects, please cite the following paper:
+
+```bash
+@inproceedings{qharabagh2025llm,
+  title={LLM-Powered Grapheme-to-Phoneme Conversion: Benchmark and Case Study},
+  author={Qharabagh, Mahta Fetrat and Dehghanian, Zahra and Rabiee, Hamid R},
+  booktitle={ICASSP 2025-2025 IEEE International Conference on Acoustics, Speech and Signal Processing (ICASSP)},
+  pages={1--5},
+  year={2025},
+  organization={IEEE}
+}
+```