Update README.md

README.md

@@ -1,12 +1,20 @@
 ---
 library_name: transformers
-tags: []
+datasets:
+- Sigurdur/talromur-rosa
+language:
+- is
+base_model:
+- facebook/mms-tts
+pipeline_tag: text-to-speech
 ---
 
 # Model Card for Model ID
 
 <!-- Provide a quick summary of what the model is/does. -->
 
+This is a text-to-speach model for Icelandic, it is finetuned from ``facebook/mms-tts-isl`` with the dataset Talrómur (see https://repository.clarin.is/repository/xmlui/handle/20.500.12537/330)
+
 
 
 ## Model Details
@@ -17,43 +25,59 @@ tags: []
 
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Developed by:** Sigurdur Haukur Birgisson
+- **Model type:** [VITS](https://huggingface.co/docs/transformers/model_doc/vits)
+- **Language(s) (NLP):** Icelandic, isl
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
+- **Finetuned from model:** [facebook/mms-tts-isl](https://huggingface.co/facebook/mms-tts-isl)
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
 
+This model should be used for text-to-speach applications for Icelandic.
+
 ### Direct Use
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+```py
+from transformers import VitsModel, AutoTokenizer
+import scipy.io.wavfile as wav
+import torch
 
-### Downstream Use [optional]
+model = VitsModel.from_pretrained("Sigurdur/vits_icelandic_rosa_female_monospeaker")
+tokenizer = AutoTokenizer.from_pretrained("Sigurdur/vits_icelandic_rosa_female_monospeaker")
 
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+text = "Góðan daginn! Ég heiti Rósa, ég er talgervill"
 
-[More Information Needed]
+inputs = tokenizer(text, return_tensors="pt")
+with torch.no_grad():
+  output = model(**inputs).waveform
 
-### Out-of-Scope Use
+sampling_rate = getattr(sampling_rate, "sampling_rate", 16000)  # Default to 16kHz if not set
+if not (0 <= sampling_rate <= 65535):
+    raise ValueError(f"Invalid sampling rate: {sampling_rate}")
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+waveform = output.squeeze().cpu().numpy()  # Remove batch dimension if present
+```
 
-[More Information Needed]
+To save output to file
+
+```py
+
+wav.write("output.wav", rate=sampling_rate, data=waveform)
+```
+
+To view in jupyter notebook
+
+```py
+from IPython.display import Audio
+
+# show audio player for "output.wav"
+Audio(output, rate=sampling_rate)
+```
 
 ## Bias, Risks, and Limitations
 
@@ -67,32 +91,17 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 
 Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
-## How to Get Started with the Model
-
-Use the code below to get started with the model.
-
-[More Information Needed]
-
-## Training Details
-
 ### Training Data
 
 <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
 
 [More Information Needed]
 
-### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
-#### Preprocessing [optional]
-
-[More Information Needed]
 
 
 #### Training Hyperparameters
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+- **Training regime:** fp16 <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
 #### Speeds, Sizes, Times [optional]
 
@@ -190,10 +199,10 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Model Card Authors [optional]
+## Model Card Authors
 
-[More Information Needed]
+Sigurdur Haukur Birgisson
 
 ## Model Card Contact
 
-[More Information Needed]
+Feel free to contact me through Linkedin: [Sigurdur Haukur Birgisson](https://www.linkedin.com/in/sigurdur-haukur-birgisson/)