Update README.md

README.md

@@ -23,7 +23,7 @@ pipeline_tag: automatic-speech-recognition
 
 # NB-Whisper small (beta)
 
-This is a **_public beta_** of the Norwegian NB-Whisper. NB-Whisper is a 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.
+This is a **_public beta_** of the Norwegian NB-Whisper model released by the National Library of Norway. NB-Whisper is a 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.
 
 <center>
   <figure>
@@ -38,12 +38,12 @@ This is a **_public beta_** of the Norwegian NB-Whisper. NB-Whisper is a series
 
 ## Model Details
 
-NB-Whisper models are available in five different sizes (the table has links to the other sizes with semi-identical model cards):
+NB-Whisper models will be available in five different sizes:
 
 | 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_ |
+| tiny       | 39M        | _Will be released in public beta shortly_ |
+| base       | 74M        | _Will be released in public beta shortly_ |
 | small      | 244M       | This model, 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_ |
@@ -67,7 +67,7 @@ Please refer to the OpenAI Whisper model card for more details about the backbon
 
 - **Repository:** https://github.com/NbAiLab/nb-whisper/
 - **Paper:** _Coming soon_
-- **Demo:** _Coming soon_
+- **Demo:** http://ai.nb.no/demo/nb-whisper
 
 ## Uses
 
@@ -78,24 +78,17 @@ This is a **_public beta_** release. The models published in this repository are
 
 ### Downstream Use
 
-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.
+For Norwegian transcriptions we are confident that this public beta will give you State-of-the-Art results compared to currently available Norwegian ASR models of the same size. 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.
 
-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.
+A significant part of the training material comes from TV subtitles. Subtitles often shorten the content to make it easier to read. 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
 
-Production use without adequate assessment of risks and mitigation; any use cases which may be considered irresponsible or harmful.
 
 ## Bias, Risks, and 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.
+This is a public beta that is not intended for production. Production use without adequate assessment of risks and mitigation may be considered irresponsible or harmful. 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.
 
 
-### Recommendations
-
-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.
 
 ## How to Get Started with the Model
 
@@ -137,78 +130,6 @@ asr(
 #    'text': ' Først så kan vi ta og henge dem kjemme, og så får vi gjøre vårt valget når vi kommer dit.'}]}
 ```
 
-
-## Training Details
-
-### Training Data
-
-<!-- This should link to a Data 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. -->
-
-Trained data comes from Språkbanken and the digital collection at the National Library of Norway. Training data includes:
-
-- [NST Norwegian ASR Database (16 kHz)](https://www.nb.no/sprakbanken/en/resource-catalogue/oai-nb-no-sbr-54/), and its corresponding [dataset](https://huggingface.co/datasets/NbAiLab/NST)
-- Transcribed speeches from the Norwegian Parliament produced by Språkbanken
-- TV broadcast (NRK) subtitles (NLN digital collection)
-- Audiobooks (NLN digital collection)
-
-
-### 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:** bf16 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 Data 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 -->
@@ -221,40 +142,22 @@ Carbon emissions estimated using the [Machine Learning Impact calculator](https:
 - **Compute Region:** `us-central1`
 - **Carbon Emitted:** Total emissions are estimated to be 247.77 kgCO₂ of which 100 percents were directly offset by the cloud provider.
 
-## Technical Specifications [optional]
-
-### Model Architecture and Objective
-
-[More Information Needed]
-
-### Compute Infrastructure
-
-[More Information Needed]
-
-#### Hardware
-
-[More Information Needed]
 
 #### Software
 
-[More Information Needed]
+The model is trained using Jax/Flax. The final model is converted to Pytorch, whisper.cpp and ONXX. Please tell us if you would like future models to be converted to other format. 
 
-## Citation
+## Citation & Authors
+This model was developed within the scope of the _NoSTram_ project, led by _Per Egil Kummervold_. The Jax code and training scripts were crafted by _Javier de la Rosa_, _Freddy Wetjen_, _Rolv-Arild Braaten_, and _Per Egil Kummervold_. Dataset curation was carried out by _Freddy Wetjen_, _Rolv-Arild Braaten_, and _Per Egil Kummervold_. Documentation was composed by _Javier de la Rosa_ and _Per Egil Kummervold_. The AiLab is under the direction of _Svein Arne Brygfjeld_. Each author contributed to the development and deliberations on the optimal way to train a Norwegian ASR model using Whisper. The work on this model was conducted as part of their professional roles at the National Library of Norway.
 
 _A paper is coming soon!_
 
-<!-- **BibTeX:**
-
-[More Information Needed]
-
-**APA:**
-
-[More Information Needed] -->
+If you plan on using this model in your research, we st
 
 ## Acknowledgements
 
-Thanks to [Google TPU Research Cloud](https://sites.research.google/trc/about/) for supporting this project with extensive training resources. Thanks to Google Cloud for supporting us with credits for translating large parts of the corpus. A special thanks to [Sanchit Ghandi](https://huggingface.co/sanchit-gandhi) for providing thorough technical advice in debugging and with the work of getting this to train on Google TPUs.
+Thanks to [Google TPU Research Cloud](https://sites.research.google/trc/about/) for supporting this project with extensive training resources. Thanks to Google Cloud for supporting us with credits for translating large parts of the corpus. A special thanks to [Sanchit Ghandi](https://huggingface.co/sanchit-gandhi) for providing thorough technical advice in debugging and with the work of getting this to train on Google TPUs. A special thanks to Per Erik Solberg at Språkbanken for the collaboration with regard to the Stortinget corpus.
 
 ## Contact
-
+We are releasing this ASR Whisper model as a public beta to garner constructive feedback on its performance. Please do not hesitate to contact us with any experiences, insights, or suggestions that you may have. Your input is invaluable in helping us to improve the model and ensure that it effectively serves the needs of users. Whether you have technical concerns, usability suggestions, or ideas for future enhancements, we welcome your input. Thank you for participating in this critical stage of our model's development.
 <a rel="noopener nofollow" href="mailto:ailab@nb.no">ailab@nb.no</a>