Adding information to the model card

README.md

@@ -1,3 +1,220 @@
----
-license: apache-2.0
----
+---
+language: ca
+datasets:
+- langtech-veu/catalan-verification-model-pkt-b
+tags:
+- audio
+- automatic-speech-recognition
+- spanish
+- parakeet-rnnt-1.1b
+- NeMo
+- Projecte-AINA
+- Barcelona-Supercomputing-Center
+- BSC
+- EuroHPC
+license: apache-2.0
+model-index:
+- name: catalan-verification-model-pkt-b
+  results:
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: Common Voice 17.0 Catalan (Test)
+      type: mozilla-foundation/common_voice_17_0
+      split: test
+      args:
+        language: ca
+    metrics:
+    - name: WER
+      type: wer
+      value: 3.735
+  - task:
+      name: Automatic Speech Recognition
+      type: automatic-speech-recognition
+    dataset:
+      name: Common Voice 17.0 Catalan (Dev)
+      type: mozilla-foundation/common_voice_17_0
+      split: dev
+      args:
+        language: ca
+    metrics:
+    - name: WER
+      type: wer
+      value: 3.409
+library_name: nemo
+---
+# catalan-verification-model-pkt-b
+
+## Table of Contents
+<details>
+<summary>Click to expand</summary>
+
+- [Paper](#paper)
+- [Model Summary](#model-summary)
+- [Intended Uses and Limitations](#intended-uses-and-limitations)
+- [How to Get Started with the Model](#how-to-get-started-with-the-model)
+- [Training Details](#training-details)
+- [Citation](#citation)
+- [Additional Information](#additional-information)
+
+</details>
+
+<!--
+## Paper
+
+**PDF:** [Automatic Validation of the Non-Validated Spanish Speech Data of Common Voice 17.0](https://dspace.ut.ee/server/api/core/bitstreams/918ec35c-a079-4258-b20d-07275ea28ae4/content)
+-->
+
+## Model Summary
+
+We define verification models as ASR models specifically designed to assess the reliability of transcriptions. These models are particularly useful when no reference transcription is available, as they can generate hypotheses with a certain degree of confidence.
+
+The core idea behind verification models is to train or fine-tune two or more ASR models on different datasets. If these models produce identical transcriptions for the same audio input, the result is likely to be accurate. Furthermore, if a verification model agrees with an existing reference transcription, this agreement can also be interpreted as a signal of reliability.
+
+In this model card, we present Verification Model B for Catalan, available as ["catalan-verification-model-pkt-b"](https://huggingface.co/langtech-veu/catalan-verification-model-pkt-b). This acoustic model is based on ["nvidia/parakeet-rnnt-1.1b"]((https://huggingface.co/nvidia/parakeet-rnnt-1.1b)) and is designed for Automatic Speech Recognition in Catalan. It is intended to be used in tandem with Verification Model A, ["catalan-verification-model-pkt-a"](https://huggingface.co/langtech-veu/catalan-verification-model-pkt-a), to enable cross-verification and boost transcription confidence in unannotated or weakly supervised scenarios.
+
+The datasets used to train models A and B were partitioned between the two models using the following pseudocode:
+
+```bash
+01: dataset_A = list
+02: dataset_B = list
+03: for index, recording in training_corpus:
+04: {
+05:   if index is an even number:
+06:   {
+07:     dataset_A=dataset_A+recording[index]
+08:   }
+09:   else:
+10:   {
+11:     dataset_B=dataset_B+recording[index]
+12:   }
+13: }
+```
+
+## Intended Uses and Limitations
+
+This model is designed for the following scenarios:
+
+* Verification of transcriptions: When two or more verification models produce the same output for a given audio segment, the transcription can be considered highly reliable. This is particularly useful in low-resource or weakly supervised settings.
+
+* Transcription without references: In situations where no reference transcription exists, this model can still produce a hypothesis that -when corroborated by a second verification model- may be considered trustworthy.
+
+* Data filtering and quality control: It can be used to automatically detect and retain high-confidence segments in large-scale speech datasets (e.g., for training or evaluation purposes).
+
+* Human-in-the-loop workflows: These models can assist human annotators by flagging reliable transcriptions, helping reduce manual verification time.
+
+As limitations, we identify the following:
+
+* No ground-truth guarantee: Agreement between models does not guarantee correctness; it only increases the likelihood of reliability.
+
+* Domain sensitivity: The accuracy and agreement rate may drop if used on speech data that differs significantly from the training domain (e.g., different accents, topics, or recording conditions).
+
+* Designed for pairwise comparison: This model is intended to work in conjunction with at least one other verification model. Using it in isolation does not provide verification benefits.
+
+* Language and model-specific: This particular model is optimized for Catalan and based on the Parakeet RNNT architecture. Performance in other languages or under different acoustic models may vary significantly.
+
+## How to Get Started with the Model
+
+To see an updated and functional version of this code, please see the NVIDIA's official [repository](https://huggingface.co/nvidia/parakeet-rnnt-1.1b)
+
+### Installation
+
+In order to use this model, you may install the [NVIDIA NeMo Framework](https://github.com/NVIDIA/NeMo):
+
+Create a virtual environment:
+```bash
+python -m venv /path/to/venv
+```
+Activate the environment:
+```bash
+source /path/to/venv/bin/activate
+```
+Install the modules:
+```bash
+BRANCH = 'main'
+python -m pip install git+https://github.com/NVIDIA/NeMo.git@$BRANCH#egg=nemo_toolkit[all]
+```
+
+### For Inference
+In order to transcribe audio in Spanish using this model, you can follow this example:
+
+```python
+import nemo.collections.asr as nemo_asr
+
+asr_model = nemo_asr.models.EncDecRNNTBPEModel.from_pretrained(model_name="projecte-aina/parakeet-rnnt-1.1b_cv17_es_ep18_1270h")
+
+output = asr_model.transcribe(['YOUR_WAV_FILE.wav'])
+print(output[0].text)
+
+```
+
+## Training Details
+
+### Training data
+
+The specific datasets used to create the model are:
+
+* [Mozilla Common Voice 17.0 (Catalan)](https://huggingface.co/datasets/mozilla-foundation/common_voice_17_0)
+* [3CatParla](https://huggingface.co/datasets/projecte-aina/3catparla_asr) (Soon to be published).
+* [Corts Valencianes](https://huggingface.co/datasets/projecte-aina/corts_valencianes_asr_a)
+
+### Training procedure
+
+This model is the result of finetuning the model ["parakeet-rnnt-1.1b"](https://huggingface.co/nvidia/parakeet-rnnt-1.1b) by following this [tutorial](https://github.com/NVIDIA/NeMo/blob/main/tutorials/asr/Transducers_with_HF_Datasets.ipynb)
+
+### Training Hyperparameters
+
+* language: catalan
+* hours of training audio: 1799
+* learning rate: 2e-4
+* devices=4
+* num_nodes=8
+* batch_size=8
+* accelerator=accelerator
+* strategy="ddp"
+* max_epochs=20
+* enable_checkpointing=True
+* logger=False
+* log_every_n_steps=100
+* check_val_every_n_epoch=1
+* precision='bf16-mixed'
+* callbacks=[checkpoint_callback]
+
+## Citation
+If this model contributes to your research, please cite the work:
+
+```bibtex
+@inproceedings{bsc-catvermodel-pkt-a-2025,
+  title={Catalan Verification Model Parakeet B},
+  author={Hernandez Mena, Carlos Daniel; Messaoudi, Abir; España i Bonet, Cristina;},
+  organization={Barcelona Supercomputing Center},
+  url={https://huggingface.co/langtech-veu/catalan-verification-model-pkt-b},
+  year={2025}
+}
+```
+
+## Additional Information
+
+### Author
+
+The fine-tuning process was perform during June (2025) in the [Language Technologies Laboratory](https://huggingface.co/BSC-LT) of the [Barcelona Supercomputing Center](https://www.bsc.es/) by [Carlos Daniel Hernández Mena](https://huggingface.co/carlosdanielhernandezmena) supervised by [Cristina España i Bonet](https://huggingface.co/cristinae). The validation of the model was performed by [Abir Messaoudi](https://huggingface.co/AbirMessaoudi).
+
+### Contact
+For further information, please send an email to <langtech@bsc.es>.
+
+### Copyright
+Copyright(c) 2025 by Language Technologies Laboratory, Barcelona Supercomputing Center.
+
+### License
+
+[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
+
+
+### Funding
+This work is funded by the Ministerio para la Transformación Digital y de la Función Pública - Funded by EU – NextGenerationEU within the framework of the project ILENIA with reference 2022/TL22/00215337.
+
+The training of the model was possible thanks to the computing time provided by [Barcelona Supercomputing Center](https://www.bsc.es/) through MareNostrum 5.
+
+We acknowledge EuroHPC Joint Undertaking for awarding us access to MareNostrum5 as BSC, Spain.
+