Update README.md

README.md

@@ -1,3 +1,113 @@
----
-license: gpl
----
+---
+license: gpl
+task_categories:
+- translation
+language:
+- fa
+tags:
+- grapheme-to-phoneme
+- g2p
+- persian
+- farsi
+- phoneme-translation
+- polyphone
+- mana-tts
+- commonvoice
+- sentence-bench
+pretty_name: SentenceBench
+size_categories:
+- n<1K
+---
+
+# Sentence-Bench: A Sentence-Level Benchmarking Dataset for Persian Grapheme-to-Phoneme (G2P) Tasks
+
+![Hugging Face](https://img.shields.io/badge/Hugging%20Face-Dataset-orange)
+
+## Introduction
+
+**Sentence-Bench** is the first sentence-level benchmarking dataset for evaluating grapheme-to-phoneme (G2P) models in Persian. To the best of our knowledge, no other dataset exists with phoneme-annotated sentences in Persian, designed specifically to address two significant challenges in sentence-level G2P tasks:
+
+1. **Polyphone Word Pronunciation**: Predicting the correct pronunciation of polyphone words within a sentence.
+2. **Context-Sensitive Phonemes**: Predicting context-sensitive phonemes, such as Ezafe, which requires consideration of sentence context.
+
+This dataset allows comprehensive sentence-level evaluation of G2P tools using three metrics:
+- **Phoneme Error Rate (PER)**: The conventional evaluation metric for phoneme-level tasks.
+- **Polyphone Word Accuracy**: Accuracy in predicting the correct pronunciation of polyphone words.
+  
+The dataset comprises 400 sentences, split into three parts:
+- 200 sentences manually constructed using approximately 100 polyphone words selected from the **Kaamel** [[1](https://huggingface.co/datasets/MahtaFetrat/KaamelDict)] dictionary, each word appearing in various contexts to showcase multiple pronunciations.
+- 100 randomly selected sentences from the unpublished **ManaTTS** [[2](https://huggingface.co/datasets/MahtaFetrat/Mana-TTS)] dataset.
+- 100 of the most upvoted sentences from **CommonVoice** [[3](https://commonvoice.mozilla.org/en)].
+
+Each sentence in the first part is annotated with its corresponding phoneme sequence, and sentences containing polyphone words include an additional annotation for the correct pronunciation of the polyphone within that sentence.
+
+## Dataset Structure
+
+The dataset is provided as a CSV file with the following columns:
+
+- **dataset**: The source of the sentence, which is one of `mana-tts`, `commonvoice`, or `polyphone`.
+- **grapheme**: The sentence in Persian script.
+- **phoneme**: The phonetic transcription of the sentence.
+- **polyphone word**: The Persian word with ambiguous pronunciation (only for sentences with polyphones).
+- **pronunciation**: The correct pronunciation of the polyphone word within the sentence (only for sentences with polyphones).
+
+## 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 |
+
+The Ezafe phones are annotated by `-e` or `-ye` according to the context.
+
+## License
+
+This dataset is released under a GNU license, in accordance with the licenses of its components.
+
+## References
+The source datasets can be cited as follows:
+
+```bash
+@article{ardila2019common,
+  title={Common voice: A massively-multilingual speech corpus},
+  author={Ardila, Rosana and Branson, Megan and Davis, Kelly and Henretty, Michael and Kohler, Michael and Meyer, Josh and Morais, Reuben and Saunders, Lindsay and Tyers, Francis M and Weber, Gregor},
+  journal={arXiv preprint arXiv:1912.06670},
+  year={2019}
+}
+```
+
+```bash
+@unpublished{manatts,
+  author       = {Fetrat, Mahta and Dehghanian, Zahra and Rabiee, Hamid R},
+  title        = {ManaTTS: A Large-Scale Persian Speech Dataset and Data Collection Framework},
+  note         = {Unpublished manuscript, submitted to NeurIPS},
+  year         = {2024}
+}
+```
+
+
+## Citation
+
+Please cite the following papers if you use this dataset:
+
+```bash
+TO BE UPDATED
+```
+
+