Upload README.md with huggingface_hub

README.md

@@ -1,28 +1,37 @@
-# KazakhTTS: An Open-Source Kazakh Text-to-Speech Model
+## KazakhTTS: An Open-Source Kazakh Text-to-Speech Dataset
 
-<!-- **Repository:** [This section would contain the link to the Hugging Face repository if one existed.  Since this is a recipe and not a dataset hosted on Hugging Face,  a link cannot be provided here.  A link to the original GitHub repo *could* be added here if desired.] -->
+This Hugging Face dataset card describes the KazakhTTS project, which provides a recipe for training a Kazakh text-to-speech (TTS) model.  The project utilizes the KazakhTTS and KazakhTTS2 corpora and builds upon the ESPnet framework.  Pretrained models and vocoders are available.
 
 **Summary:**
 
-This recipe details the creation of a Kazakh text-to-speech (TTS) model using the KazakhTTS and KazakhTTS2 corpora. 
+The KazakhTTS project offers a recipe for training high-quality Kazakh TTS models using the ESPnet framework.  It provides access to pretrained models and vocoders, along with instructions for synthesis.  The project emphasizes ethical use and requires attribution.
 
-**Repository:** https://github.com/IS2AI/ISSAI_SAIDA_Kazakh_ASR
+**Dataset Information:**
 
-<!-- **Model Information:**
+The dataset itself is not directly accessible through this repository; information about the dataset is available in the original project documentation (the actual dataset download requires access through a form).  The project utilizes the KazakhTTS and KazakhTTS2 corpora.
 
-The recipe supports training various models (Tacotron2, Fastspeech, Transformer) with the provided configuration files.  Pre-trained models are available for download, but specific details on their performance metrics are not given.
- -->
-<!-- **Pretrained Models:**
+**Model Information:**
 
-The following pre-trained models and their corresponding vocoders are mentioned:
+The project uses ESPnet for model training.  The recipe supports training various models such as Tacotron2 and FastSpeech.  Pretrained models and vocoders are offered.
 
-| Model Name                     | Vocoder Name                 | Download Link                                                                        |
-|---------------------------------|------------------------------|------------------------------------------------------------------------------------|
-| `kaztts_female1_tacotron2`    | `parallelwavegan_female1`     | [Link omitted - See original document]                                              |
-| `kaztts_female2_tacotron2`    | `parallelwavegan_female2`     | [Link omitted - See original document]                                              |
-| `kaztts_female3_tacotron2`    | `parallelwavegan_female3`     | [Link omitted - See original document]                                              |
-| `kaztts_male1_tacotron2`      | `parallelwavegan_male1`       | [Link omitted - See original document]                                              |
-| `kaztts_male2_tacotron2`      | `parallelwavegan_male2`       | [Link omitted - See original document]                                              | -->
+
+**Pretrained Models and Vocoders:**
+
+The following pretrained models and vocoders are available (links removed as requested):
+
+
+| Model/Vocoder Name                      | Description                                      |
+|------------------------------------------|--------------------------------------------------|
+| `kaztts_female1_tacotron2_train.loss.ave` | Tacotron2 training loss for female speaker 1    |
+| `kaztts_female2_tacotron2_train.loss.ave` | Tacotron2 training loss for female speaker 2    |
+| `kaztts_female3_tacotron2_train.loss.ave` | Tacotron2 training loss for female speaker 3    |
+| `kaztts_male1_tacotron2_train.loss.ave`  | Tacotron2 training loss for male speaker 1     |
+| `kaztts_male2_tacotron2_train.loss.ave`  | Tacotron2 training loss for male speaker 2     |
+| `parallelwavegan_female1_checkpoint`     | Parallel WaveGAN checkpoint for female speaker 1 |
+| `parallelwavegan_female2_checkpoint`     | Parallel WaveGAN checkpoint for female speaker 2 |
+| `parallelwavegan_female3_checkpoint`     | Parallel WaveGAN checkpoint for female speaker 3 |
+| `parallelwavegan_male1_checkpoint`      | Parallel WaveGAN checkpoint for male speaker 1  |
+| `parallelwavegan_male2_checkpoint`      | Parallel WaveGAN checkpoint for male speaker 2  |
 
 
 **Citation:**
@@ -37,3 +46,6 @@ The following pre-trained models and their corresponding vocoders are mentioned:
   doi={10.21437/Interspeech.2021-2124}
 }
 ```
+
+**GitHub Repository:** [https://github.com/IS2AI/Kazakh_TTS](https://github.com/IS2AI/Kazakh_TTS)
+