CoRal-project
/

roest-whisper-large-v1

@@ -24,203 +24,53 @@ model-index:
       args: read_aloud
     metrics:
     - type: cer
-      value: 4.5% ± 0.2%
       name: CER
     - type: wer
-      value: 11.1% ± 0.4%
       name: WER
 ---
-# Model Card for Model ID
-<!--This is a Danish state-of-the-art speech recognition model, trained by [Alvenir](https://www.alvenir.ai/).-->
-## 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]

       args: read_aloud
     metrics:
     - type: cer
+      value: 4.3% ± X.X%
       name: CER
     - type: wer
+      value: 10.4% ± X.X%
       name: WER
 ---
+# Whisper-Large v.3 trained on CoRaL release 1
+This is a Danish state-of-the-art speech recognition model, trained by [Alvenir](https://www.alvenir.ai/).
+## Evaluation Results
+| Model | Number of parameters | [CoRal](https://huggingface.co/datasets/alexandrainst/coral/viewer/read_aloud/test) CER | [CoRal](https://huggingface.co/datasets/alexandrainst/coral/viewer/read_aloud/test) WER |
+|:---|---:|---:|---:|
+| [Alvenir/coral-1-whisper-large](https://huggingface.co/Alvenir/coral-1-whisper-large) | 1540M | **4.3% ± X.X%** | **10.4% ± X.X%** |
+| [alexandrainst/roest-315m](https://huggingface.co/alexandrainst/roest-315m) | 315M | 6.6% ± 0.2% | 17.0% ± 0.4% |
+| [mhenrichsen/hviske-v2](https://huggingface.co/syvai/hviske-v2) | 1540M | 4.7% ± 0.07% | 11.8% ± 0.3% |
+| [openai/whisper-large-v3](https://hf.co/openai/whisper-large-v3) | 1540M | 11.4% ± 0.3% | 28.3% ± 0.6% |
+Results of more models and more datasets can be seen in the [model card for Røst-315m](https://huggingface.co/alexandrainst/roest-315m).
+## Model details
+This is simply the [Whisper Large v.3 model](https://hf.co/openai/whisper-large-v3) trained on the first release of [CoRaL data](https://huggingface.co/datasets/alexandrainst/coral).
+The model was trained for 30K steps using the configuration from the [CoRaL repository](https://github.com/alexandrainst/coral) by running:
+```py
+python src/scripts/finetune_asr_model.py model=whisper-large max_steps=30000 model.learning_rate=1e-5
+```
+## License
+Note that the dataset used is licensed under a custom license, adapted from OpenRAIL-M, which allows
+commercial use with a few restrictions (speech synthesis and biometric identification).
+See
+[license](https://huggingface.co/alexandrainst/roest-315m/blob/main/LICENSE).
+## Creators and Funders
+The CoRal project is funded by the [Danish Innovation
+Fund](https://innovationsfonden.dk/) and consists of the following partners:
+- [Alexandra Institute](https://alexandra.dk/)
+- [University of Copenhagen](https://www.ku.dk/)
+- [Agency for Digital Government](https://digst.dk/)
+- [Alvenir](https://www.alvenir.ai/)
+- [Corti](https://www.corti.ai/)