Kimang18
/

mms-tts-khm-finetuned

@@ -1,199 +1,107 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-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]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **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. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-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 -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
 library_name: transformers
+license: cc-by-nc-4.0
+tags:
+- mms
+- Khmer
+- vits
+pipeline_tag: text-to-speech
+datasets:
+- seanghay/khmer_mpwt_speech
+language:
+- km
+base_model:
+- facebook/mms-tts-khm
 ---
+# Massively Multilingual Speech (MMS): Khmer Text-to-Speech
+This repository contains the **Khmer (khm)** language text-to-speech (TTS) model checkpoint.
+This model is part of Facebook's [Massively Multilingual Speech](https://arxiv.org/abs/2305.13516) project, aiming to
+provide speech technology across a diverse range of languages. You can find more details about the supported languages
+and their ISO 639-3 codes in the [MMS Language Coverage Overview](https://dl.fbaipublicfiles.com/mms/misc/language_coverage_mms.html),
+and see all MMS-TTS checkpoints on the Hugging Face Hub: [facebook/mms-tts](https://huggingface.co/models?sort=trending&search=facebook%2Fmms-tts).
+MMS-TTS is available in the 🤗 Transformers library from version 4.33 onwards.
+## License
+The model is licensed as **CC-BY-NC 4.0**.
+## Model Details
+VITS (**V**ariational **I**nference with adversarial learning for end-to-end **T**ext-to-**S**peech) is an end-to-end
+speech synthesis model that predicts a speech waveform conditional on an input text sequence. It is a conditional variational
+autoencoder (VAE) comprised of a posterior encoder, decoder, and conditional prior.
+A set of spectrogram-based acoustic features are predicted by the flow-based module, which is formed of a Transformer-based
+text encoder and multiple coupling layers. The spectrogram is decoded using a stack of transposed convolutional layers,
+much in the same style as the HiFi-GAN vocoder. Motivated by the one-to-many nature of the TTS problem, where the same text
+input can be spoken in multiple ways, the model also includes a stochastic duration predictor, which allows the model to
+synthesise speech with different rhythms from the same input text.
+The model is trained end-to-end with a combination of losses derived from variational lower bound and adversarial training.
+To improve the expressiveness of the model, normalizing flows are applied to the conditional prior distribution. During
+inference, the text encodings are up-sampled based on the duration prediction module, and then mapped into the
+waveform using a cascade of the flow module and HiFi-GAN decoder. Due to the stochastic nature of the duration predictor,
+the model is non-deterministic, and thus requires a fixed seed to generate the same speech waveform.
+For the MMS project, a separate VITS checkpoint is trained on each langauge.
+## Usage
+MMS-TTS is available in the 🤗 Transformers library from version 4.33 onwards. To use this checkpoint,
+first install the latest version of the library:
+```
+pip install --upgrade transformers accelerate
+```
+Then, run inference with the following code-snippet:
+```python
+from transformers import VitsModel, AutoTokenizer
+import torch
+model = VitsModel.from_pretrained("Kimang18/mms-tts-khm-finetuned")
+tokenizer = AutoTokenizer.from_pretrained("Kimang18/mms-tts-khm-finetuned")
+text = "some example text in the Khmer language"
+inputs = tokenizer(text, return_tensors="pt")
+with torch.no_grad():
+    output = model(**inputs).waveform
+```
+The resulting waveform can be saved as a `.wav` file:
+```python
+import scipy
+scipy.io.wavfile.write("techno.wav", rate=model.config.sampling_rate, data=output)
+```
+Or displayed in a Jupyter Notebook / Google Colab:
+```python
+from IPython.display import Audio
+Audio(output, rate=model.config.sampling_rate)
+```
+## BibTex citation
+This model was developed by Vineel Pratap et al. from Meta AI. If you use the model, consider citing the MMS paper:
+```
+@article{pratap2023mms,
+    title={Scaling Speech Technology to 1,000+ Languages},
+    author={Vineel Pratap and Andros Tjandra and Bowen Shi and Paden Tomasello and Arun Babu and Sayani Kundu and Ali Elkahky and Zhaoheng Ni and Apoorv Vyas and Maryam Fazel-Zarandi and Alexei Baevski and Yossi Adi and Xiaohui Zhang and Wei-Ning Hsu and Alexis Conneau and Michael Auli},
+    journal={arXiv},
+    year={2023}
+}
+```