update README

README.md

@@ -10,11 +10,11 @@ datasets:
 model-index:
 - name: speecht5_tts-finetuned-nst-da
   results: []
+metrics:
+- mse
+pipeline_tag: text-to-speech
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
-
 # speecht5_tts-finetuned-nst-da
 
 This model is a fine-tuned version of [microsoft/speecht5_tts](https://huggingface.co/microsoft/speecht5_tts) on the NST Danish ASR Database dataset.
@@ -23,18 +23,30 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+Given that danish is a low-resource language, not many open-source implementations of a danish text-to-speech synthesizer are available online. As of writing, the only other existing implementations available on 🤗 are [facebook/seamless-streaming](https://huggingface.co/facebook/seamless-streaming) and [audo/seamless-m4t-v2-large](https://huggingface.co/audo/seamless-m4t-v2-large). This model has been developed to provide a simpler alternative that still performs reasonable well, both in terms of output quality and inference time. Additionally, contrary to the aforementioned models, this model also has an associated Space on 🤗 at [JackismyShephard/danish-speech-synthesis](https://huggingface.co/spaces/JackismyShephard/danish-speech-synthesis) which provides an easy interface for danish text-to-speech synthesis, as well as optional speech enhancement.
 
 ## Intended uses & limitations
 
-More information needed
+The model is intended for danish text-to-speech synthesis. 
+
+The model does not recognize special symbols such as "æ", "ø" and "å", as it uses the default tokenizer of [microsoft/speecht5_tts](https://huggingface.co/microsoft/speecht5_tts). The model performs best for short to medium length input text and expects input text to contain no more than 600 vocabulary tokens. Additionally, for best performance the model should be given a danish speaker embedding, ideally generated from an audio clip from the training split of [alexandrainst/nst-da](https://huggingface.co/datasets/alexandrainst/nst-da) using [speechbrain/spkrec-xvect-voxceleb](https://huggingface.co/speechbrain/spkrec-xvect-voxceleb).
+
+The output of the model is a log-mel spectogram, which should be converted to a waveform using [microsoft/speecht5_hifigan](https://huggingface.co/microsoft/speecht5_hifigan). For better quality output the resulting waveform can be enhanced using [ResembleAI/resemble-enhance](https://huggingface.co/ResembleAI/resemble-enhance).
+
+An example script showing how to use the model for inference can be found [here](https://github.com/JackismyShephard/hugging-face-audio-course/blob/main/finetuned_nst-da-inference.ipynb).
 
 ## Training and evaluation data
 
-More information needed
+The model was trained and evaluated on [alexandrainst/nst-da](https://huggingface.co/datasets/alexandrainst/nst-da) using MSE as both loss and metric. The dataset was pre-processed as follows:
+* special characters, such as "æ", "ø" and "å" were translated to their latin equivalents and examples with text containing digits were removed, as neiher are in the vocabulary of the tokenizer of [microsoft/speecht5_tts](https://huggingface.co/microsoft/speecht5_tts).
+* training split balancing was done by excluding speakers with less than 280 examples or more than 327 examples.
+* audio was enhanced using [speechbrain/metricgan-plus-voicebank](https://huggingface.co/speechbrain/metricgan-plus-voicebank) in an attempt to remove unwanted noise.
+
 
 ## Training procedure
 
+The script used for training the model (and pre-processing its data) can be found [here](https://github.com/JackismyShephard/hugging-face-audio-course/blob/main/finetuned-nst-da-training.ipynb).
+
 ### Training hyperparameters
 
 The following hyperparameters were used during training: