Latest update about.md

about.md

@@ -1,16 +1,18 @@
 ## 📄 About
 Natural and efficient TTS in Catalan: using Matcha-TTS with the Catalan language.
 
-Here you'll be able to find all the information regarding our model, which has been trained with the use of deep learning. If you want specific information on how to train the model you can find it [here](https://huggingface.co/BSC-LT/matcha-tts-cat-multispeaker). The code we've used is also on Github [here](https://github.com/langtech-bsc/Matcha-TTS/tree/dev-cat).
+Here you'll be able to find all the information regarding our models Matxa 🍵 and alVoCat 🥑 , which have been trained with the use of deep learning. If you want specific information on how to train these model you can find it [here](https://huggingface.co/BSC-LT/matcha-tts-cat-multispeaker) and [here](https://huggingface.co/BSC-LT/vocos-mel-22khz-cat) respectively. The code we've used is also on Github [here](https://github.com/langtech-bsc/Matcha-TTS/tree/dev-cat).
 
 ## Table of Contents
 <details>
 <summary>Click to expand</summary>
 
 - [General Model Description](#general-model-description)
-- [Adaptation to Catalan](#adaptation-to-catalan)
 - [Intended Uses and Limitations](#intended-uses-and-limitations)
 - [Samples](#samples)
+- [Main components](#main-components)
+- [The model in detail](#the-model-in-detail)
+- [Adaptation to Catalan](#adaptation-to-catalan)
 - [Citation](#citation)  
 - [Additional Information](#additional-information)
 
@@ -18,6 +20,194 @@ Here you'll be able to find all the information regarding our model, which has b
 
 ## General Model Description
 
+The significance of open-source text-to-speech (TTS) technologies for minority languages cannot be overstated. These technologies democratize access to TTS solutions by providing a framework for communities to develop and adapt models according to their linguistic needs. This is why we have developed different open-source TTS solutions in Catalan, using an ensemble of technologies.
+
+Firstly, we created a [TTS model for central Catalan](https://huggingface.co/BSC-LT/matcha-tts-cat-multispeaker) by fine-tuning the Matcha-TTS English model. Matcha-TTS is a state-of-the-art model that employs deep learning, a form of AI, to train models that replicate human speech patterns, allowing it to generate lifelike synthetic voices from written text. After that, we fine-tuned this Catalan central model for three other Catalan dialects:
+
+* Balear
+* North-Occidental
+* Valencian
+
+
+## Intended Uses and Limitations
+
+This model is intended to serve as an acoustic feature generator for multispeaker text-to-speech systems for the Catalan language. 
+It has been finetuned using a Catalan phonemizer, therefore if the model is used for other languages it may will not produce intelligible samples after mapping 
+its output into a speech waveform. 
+
+The quality of the samples can vary depending on the speaker. 
+This may be due to the sensitivity of the model in learning specific frequencies and also due to the quality of samples for each speaker.
+
+## Samples
+* Female samples 
+
+<table style="font-size:16px">
+  <col width="205">
+  <col width="205">
+  <td>Valencian</td>
+  <td>Occidental</td>
+  <td>Balear</td>
+<tbody
+<table>
+  <tbody>
+    <tr>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk1/0.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk1/0.wav" type="audio/wav"">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk1/0.wav" type="audio/wav">
+        </audio>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk1/1.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk1/1.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk1/1.wav" type="audio/wav">
+        </audio>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk1/2.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk1/2.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk1/2.wav" type="audio/wav">
+        </audio>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+* Male samples:
+
+<table style="font-size:16px">
+  <col width="205">
+  <col width="205">
+<thead>
+<tr>
+  <td>Valencian</td>
+  <td>Occidental</td>
+  <td>Balear</td>
+</tr>
+</thead>
+<tbody
+<table>
+  <tbody>
+    <tr>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk0/0.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk0/0.wav" type="audio/wav"">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk0/0.wav" type="audio/wav">
+        </audio>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk0/1.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk0/1.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk0/1.wav" type="audio/wav">
+        </audio>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk0/2.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk0/2.wav" type="audio/wav">
+        </audio>
+      </td>
+      <td>
+        <audio controls="" preload="none" style="width: 200px">
+          audio not supported
+          <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk0/2.wav" type="audio/wav">
+        </audio>
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+## Main components
+
+Our text-to-speech model tailored for Catalan employs a multi-step process to convert written text into spoken words with accurate pronunciation. These are the steps:
+
+1- Initially, the model analyzes the input text, breaking it down into smaller linguistic units such as words and sentences while identifying any special characters. It then utilizes our version of eSpeak, a speech phonemizer, to generate phonemes based on the Catalan language's phonetic rules. For each Catalan accent, certain specifically adapted eSpeak rules apply.
+
+2- The matcha-TTS model converts these phonemes into a mel spectrogram, a visual representation of the spectrum of frequencies of a sound over time. 
+
+3- This spectrogram is then fed into [our adaptation of the Vocos vocoder](https://huggingface.co/BSC-LT/vocos-mel-22khz-cat), which synthesizes the speech waveform.
+
+By employing this series of steps, the TTS model ensures accurate pronunciation and natural-sounding Catalan speech output adapted to the nuances of the language. The computing of these steps was performed by Marenostrum 5 from the Barcelona Supercomputing Center, and Finisterrae III from CESGA.
+
+Together, these technologies form a comprehensive TTS solution tailored to the needs of Catalan speakers, exemplifying the power of open-source initiatives in advancing linguistic diversity and inclusivity.
+
+
+## The model in detail
+
 **Matcha-TTS** is an encoder-decoder architecture designed for fast acoustic modelling in TTS. 
 On the one hand, the encoder part is based on a text encoder and a phoneme duration prediction. Together, they predict averaged acoustic features.
 On the other hand, the decoder has essentially a U-Net backbone inspired by [Grad-TTS](https://arxiv.org/pdf/2105.06337.pdf), which is based on the Transformer architecture. 
@@ -34,6 +224,8 @@ The original Matcha-TTS model excels in English, but to bring its capabilities t
  
  * A studio-recorded dataset of central catalan, which will soon be published.
  
+ * [Our version of the Festcat dataset.](https://huggingface.co/datasets/projecte-aina/festcat_trimmed_denoised)
+ 
  This soon to be published dataset also included recordings of three different dialects:
  
  * Valencian
@@ -46,180 +238,23 @@ With a male and a female speaker for each dialect.
 
 Then, through fine-tuning for these specific Catalan dialects, the model adapted to regional variations in pronunciation and cadence. This meticulous approach ensures that the model reflects the linguistic richness and cultural diversity within the Catalan-speaking community, offering seamless communication in previously underserved dialects.
  
-In addition to training the Matcha-TTS model for Catalan, integrating the eSpeak phonemizer played a crucial role in enhancing the naturalness and accuracy of generated speech. A TTS (Text-to-Speech) system comprises several components, each contributing to the overall quality of synthesized speech. The first component involves text preprocessing, where the input text undergoes normalization and linguistic analysis to identify words, punctuation, and linguistic features. Next, the text is converted into phonemes, the smallest units of sound in a language, through a process called phonemization. This step is where the eSpeak phonemizer shines, as it accurately converts Catalan text into phonetic representations, capturing the subtle nuances of pronunciation specific to Catalan. You can find the espeak version we used [here](https://github.com/projecte-aina/espeak-ng/tree/dev-ca).
+In addition to training the Matcha-TTS model for Catalan, integrating the eSpeak phonemizer played a crucial role in enhancing the naturalness and accuracy of generated speech. A TTS (Text-to-Speech) system comprises several components, each contributing to the overall quality of synthesized speech. The first component involves text preprocessing, where the input text undergoes normalization and linguistic analysis to identify words, punctuation, and linguistic features. Next, the text is converted into phonemes, the smallest units of sound in a language, through a process called phonemization. This step is where the eSpeak phonemizer shines, as it accurately converts Catalan text into phonetic representations, capturing the subtle nuances of pronunciation specific to Catalan. You can find the eSpeak version we used [here](https://github.com/projecte-aina/espeak-ng/tree/dev-ca).
 
 After phonemization, the phonemes are passed to the synthesis component, where they are transformed into audible speech. Here, the Matcha-TTS model takes center stage, generating high-quality speech output based on the phonetic input. The model's training, fine-tuning, and adaptation to Catalan ensure that the synthesized speech retains the natural rhythm, intonation, and pronunciation patterns of the language, thereby enhancing the overall user experience.
 
 Finally, the synthesized speech undergoes post-processing, where prosodic features such as pitch, duration, and emphasis are applied to further refine the output and make it sound more natural and expressive. By integrating the eSpeak phonemizer into the TTS pipeline and adapting it for Catalan, alongside training the Matcha-TTS model for the language, we have created a comprehensive and effective system for generating high-quality Catalan speech. This combination of advanced techniques and meticulous attention to linguistic detail is instrumental in bridging language barriers and facilitating communication for Catalan speakers worldwide.
 
-## Intended Uses and Limitations
-
-This model is intended to serve as an acoustic feature generator for multispeaker text-to-speech systems for the Catalan language. 
-It has been finetuned using a Catalan phonemizer, therefore if the model is used for other languages it may will not produce intelligible samples after mapping 
-its output into a speech waveform. 
-
-The quality of the samples can vary depending on the speaker. 
-This may be due to the sensitivity of the model in learning specific frequencies and also due to the quality of samples for each speaker.
-
-
-
-
-## Samples
-* Female samples 
-<div class="table-wrapper">
-  <table class="tg">
-    <thead>
-      <tr>
-        <th class="tg-0pky">Valencian</td>
-        <th class="tg-0pky">Occidental</td>
-        <th class="tg-0pky">Balear</td>
-      <tr>
-    <thead>
-    <tbody>
-      <tr>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk1/0.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk1/0.wav" type="audio/wav"">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk1/0.wav" type="audio/wav">
-          </audio>
-        </td>
-      </tr>
-      <tr>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk1/1.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk1/1.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk1/1.wav" type="audio/wav">
-          </audio>
-        </td>
-      </tr>
-      <tr>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk1/2.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk1/2.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk1/2.wav" type="audio/wav">
-          </audio>
-        </td>
-      </tr>
-    </tbody>
-  </table>
-</div>
-
-* Male samples:
-
-<div class="table-wrapper">
-  <table class="tg">
-    <thead>
-      <tr>
-        <th class="tg-0pky">Valencian</td>
-        <th class="tg-0pky">Occidental</td>
-        <th class="tg-0pky">Balear</td>
-      <tr>
-    <thead>
-    <tbody>
-      <tr>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk0/0.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk0/0.wav" type="audio/wav"">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk0/0.wav" type="audio/wav">
-          </audio>
-        </td>
-      </tr>
-      <tr>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk0/1.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk0/1.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk0/1.wav" type="audio/wav">
-          </audio>
-        </td>
-      </tr>
-      <tr>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/valencia/spk0/2.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/occidental/spk0/2.wav" type="audio/wav">
-          </audio>
-        </td>
-        <td>
-          <audio controls="" preload="none" style="width: 200px">
-            audio not supported
-            <source src="https://github.com/mllopartbsc/assets/raw/c6a393237e712851dd7cc7d10c70dde29d3412ac/matcha_tts_catalan/balear/spk0/2.wav" type="audio/wav">
-          </audio>
-        </td>
-      </tr>
-    </tbody>
-  </table>
-</div>
-
 ## Citation
 
 If this code contributes to your research, please cite the work:
 
+```
+@misc{LTU2024,
+  title={Natural and efficient TTS in Catalan: using Matcha-TTS with the Catalan language},
+  author={The Language Technologies Unit from Barcelona Supercomputing Center},
+  year={2024},
+}
+```
 ```
 @misc{mehta2024matchatts,
       title={Matcha-TTS: A fast TTS architecture with conditional flow matching}, 
@@ -246,4 +281,4 @@ Copyright(c) 2023 by Language Technologies Unit, Barcelona Supercomputing Center
 [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 
 ### Funding
-This work has been promoted and financed by the Generalitat de Catalunya through the [Aina project](https://projecteaina.cat/).
+This work has been promoted and financed by the Generalitat de Catalunya through the [Aina project](https://projecteaina.cat/).