Update README.md

README.md

@@ -19,4 +19,44 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+language:
+- nan
+task_categories:
+- automatic-speech-recognition
 ---
+# Taiwanese-Minnan-Sutiau Dataset
+The dataset consists of a curated collection of words that resemble tokens in Taiwanese Minnan (Taiwanese Hokkien), aimed at enhancing the recognition and processing of the language for various applications. Sourced from the Ministry of Education in Taiwan, this dataset serves as a valuable linguistic resource for researchers and developers engaged in language processing and recognition tasks.
+
+Dataset Features
+- Source: Ministry of Education, Taiwan (Sutian Resource Center)
+  - Text: [kautian.ods](https://sutian.moe.edu.tw/und-hani/siongkuantsuguan/)
+  - Wav: [sutiau-wav.zip](https://sutian.moe.edu.tw/und-hani/siongkuantsuguan/)
+- Content: The dataset includes a compilation of commonly used Taiwanese Minnan words that resemble tokens, formatted for seamless integration into language processing systems.
+- Data Cleaning: Some entries have been removed due to the unexisting wav file. This curation process ensures that the dataset maintains a focus on clear and existing wav file in Taiwanese Minnan.
+# Curation Process
+The dataset has been meticulously curated to ensure high quality and relevance. It encompasses a variety of words that reflect common usage in Taiwanese Minnan, making it an essential resource for developing language recognition models.
+
+Using the Dataset
+You can easily download and utilize the Taiwanese Minnan Token-like Words dataset with Hugging Face's datasets library:
+```py
+from datasets import load_dataset
+
+# The entire dataset is available for use
+dataset = load_dataset("sarahwei/Taiwanese-Minnan-Sutiau")
+print(dataset)
+```
+
+# References
+The original content is maintained by the Ministry of Education in Taiwan. For details regarding usage rights, please refer to the respective license information provided by the source.
+
+This dataset is released under a Creative Commons Attribution-Noncommercial-ShareAlike (CC BY-NC-SA 4.0) license. If you use this dataset in your research or projects, please cite it as follows:
+
+```
+@misc{sarahwei_taiwanese_minnan_token_words_2024,
+  author = {Chieh Hui Wei},
+  title = {Taiwanese Minnan Token-like Words},
+  year = {2024},
+  publisher = {Hugging Face},
+  howpublished = {\url{https://huggingface.co/datasets/sarahwei/Taiwanese-Minnan-Sutiau}}
+}
+```