Update README.md

README.md

@@ -6,6 +6,8 @@ language:
 - nn
 datasets:
 - NbAiLab/ncc_speech
+- NbAiLab/NST
+- NbAiLab/NPSC
 metrics:
 - wer
 - cer
@@ -14,64 +16,66 @@ pipeline_tag: automatic-speech-recognition
 ---
 # NB-Whisper small (beta)
 
-<!-- Provide a quick summary of what the model is/does. -->
-
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
+This is a **_public beta_** of the Norwegian NB-Whisper. NB-Whisper is an series of models for automatic speech recognition (ASR) and speech translation, building upon the foundation laid by [OpenAI's Whisper](https://arxiv.org/abs/2212.04356). All models are trained on 20,000 hours of labeled data.
 
 ## Model Details
 
-### Model Description
+NB-Whisper models are available in five different sizes (the table has links to the other sizes with semi-identical model cards):
+
+| Model Size | Parameters | Availability |
+|------------|------------|--------------|
+| tiny       | 39M        | Will be released in public beta later this summer |
+| base       | 74M        | Will be released in public beta later this summer |
+| small      | 244M       | Available in public beta |
+| medium     | 769M       | Will be released in public beta later this summer |
+| large      | 1550M      | Will be released in public beta later this summer |
 
-<!-- Provide a longer summary of what this model is. -->
+An official release of NB-Whisper models is planned for the Fall 2023.
 
+Please refer to the OpenAI Whisper model card for more details about the backbone model.
 
+### Model Description
 
-- **Developed by:** [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]
+- **Developed by:** NB AI-Lab
+- **Shared by:** NB AI-Lab
+- **Model type:** `whisper`
+- **Language(s) (NLP):** Norwegian, Norwegian Bokmål, Norwegian Nynorsk, English
+- **License:** [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/)
+- **Finetuned from model:** [openai/whisper-small](https://huggingface.co/openai/whisper-small)
 
-### Model Sources [optional]
+### Model Sources
 
 <!-- Provide the basic links for the model. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** https://github.com/NbAiLab/nb-whisper/
+- **Paper:** _Coming_
+- **Demo:** _Coming_
 
 ## 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. -->
+This is a Beta release. The models published in this repository are intended for a generalist purpose and are available to third parties.
 
-[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 -->
+We are confident that NB-Whisper will give better results than the multilingual OpenAI Whisper if the target is Norwegian. However, it is still known to show some hallucinations, as well as a tendency to drop part of the transcript from time to time. Please also note that the transcripts are typically not word by word. Spoken language and written language are often very different, and the model aims to "translate" spoken utterances into grammatically correct written sentences. We strongly believe that the best way to understand these models is to try them yourself.
 
-[More Information Needed]
+A significant part of the training material comes from TV subtitles. Subtitles often shorten sentences to make them more readable. Typically, non-essential parts of the utterance can be also dropped. In some cases, this is a desired ability, in other cases, this is undesired. The final release of these model will provida a mechanism to control for this beaviour.
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
+Production use without adequate assessment of risks and mitigation; any use cases which may be considered irresponsible or harmful.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+These models may have bias and/or any other undesirable distortions. When third parties, deploy or provide systems and/or services to other parties using any of these models (or using systems based on these models) or become users of the models, they should note that it is their responsibility to mitigate the risks arising from their use and, in any event, to comply with applicable regulations, including regulations regarding the use of artificial intelligence. In no event shall the owner of the models (The National Library of Norway) be liable for any results arising from the use made by third parties of these models.
 
-[More Information Needed]
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+We recommend users of NB-Whisper models to consider finetuning them for the specific set of tasks of interest, and for guardrails and appropriate precautions to be taken for any production use.
 
 Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
@@ -100,7 +104,7 @@ Use the code below to get started with the model.
 
 #### 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:** bf16 mixed precision
 
 #### Speeds, Sizes, Times [optional]
 
@@ -150,13 +154,13 @@ Use the code below to get started with the model.
 
 <!-- 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).
+Carbon emissions 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]
+- **Hardware Type:** TPUv4
+- **Hours used:** 1,536
+- **Cloud Provider:** Google Cloud
+- **Compute Region:** `us-central1`
+- **Carbon Emitted:** Total emissions are estimated to be 247.77 kgCO$_2$eq of which 100 percents were directly offset by the cloud provider.
 
 ## Technical Specifications [optional]
 
@@ -176,34 +180,18 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Citation [optional]
+## Citation
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+_A paper is coming soon!_
 
-**BibTeX:**
+<!-- **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]
+[More Information Needed] -->
 
+## Contact
 
+<a rel="noopener nofollow" href="mailto:ailab@nb.no">ailab@nb.no</a>