NbAiLab
/

nb-whisper-small-beta

@@ -1,84 +1,260 @@
 ---
 language:
 - 'no'
-license: apache-2.0
 tags:
 - audio
 - asr
 - automatic-speech-recognition
 - hf-asr-leaderboard
-model-index:
-- name: nb-whisper-small-publicbeta-25k
-  results: []
 ---
-<!-- This model card has been generated automatically according to the information Keras had access to. You should
-probably proofread and complete it, then remove this comment. -->
-# nb-whisper-small-publicbeta-25k
-This model is a fine-tuned version of [openai/whisper-small](https://huggingface.co/openai/whisper-small) on the NbAiLab/ncc_speech2 dataset.
-## Model description
-More information needed
-## Intended uses & limitations
-More information needed
-## Training and evaluation data
-More information needed
-## Training procedure
-### Training hyperparameters
-The following hyperparameters were used during training:
-- learning_rate: 5e-05
-- lr_scheduler_type: linear
-- per_device_train_batch_size: 32
-- total_train_batch_size_per_node: 128
-- total_train_batch_size: 1024
-- total_optimization_steps: 25,000
-- starting_optimization_step: None
-- finishing_optimization_step: 25,000
-- num_train_dataset_workers: 32
-- num_hosts: 8
-- total_num_training_examples: 25,600,000
-- steps_per_epoch: 7313
-- num_beams: 5
-- weight_decay: 0.01
-- adam_beta1: 0.9
-- adam_beta2: 0.98
-- adam_epsilon: 1e-06
-- dropout: True
-- bpe_dropout_probability: 0.1
-- activation_dropout_probability: 0.1
-### Training results
-| step  | validation_fleurs_loss | train_loss | validation_fleurs_wer | validation_fleurs_cer | validation_fleurs_exact_wer | validation_fleurs_exact_cer | validation_stortinget_loss | validation_stortinget_wer | validation_stortinget_cer | validation_stortinget_exact_wer | validation_stortinget_exact_cer |
-|:-----:|:----------------------:|:----------:|:---------------------:|:---------------------:|:---------------------------:|:---------------------------:|:--------------------------:|:-------------------------:|:-------------------------:|:-------------------------------:|:-------------------------------:|
-| 0     | 1.2013                 | 3.1115     | 218.8876              | 174.4279              | 388.7694                    | 278.9901                    | 1.4191                     | 71.3727                   | 46.4810                   | 76.7531                         | 49.0057                         |
-| 1000  | 0.5627                 | 1.1938     | 16.3593               | 6.2586                | 20.0717                     | 7.2820                      | 0.4640                     | 20.7725                   | 11.8840                   | 24.4401                         | 12.5992                         |
-| 2000  | 0.3961                 | 0.9944     | 11.7192               | 4.0146                | 15.4719                     | 4.9384                      | 0.3737                     | 16.5674                   | 10.1748                   | 20.0976                         | 10.8109                         |
-| 3000  | 0.3696                 | 0.9185     | 10.8269               | 4.1576                | 14.7551                     | 5.1220                      | 0.3426                     | 14.9167                   | 9.5103                    | 18.3471                         | 10.1061                         |
-| 4000  | 0.3467                 | 0.8298     | 9.7858                | 4.2513                | 13.6201                     | 5.1558                      | 0.3251                     | 14.3438                   | 9.2267                    | 17.7666                         | 9.8219                          |
-| 5000  | 0.3266                 | 0.8400     | 10.0833               | 4.2711                | 13.8889                     | 5.2138                      | 0.3110                     | 13.9022                   | 9.1039                    | 17.2299                         | 9.6697                          |
-| 6000  | 0.3280                 | 0.7875     | 8.7745                | 3.3636                | 12.6344                     | 4.3295                      | 0.3058                     | 13.5598                   | 8.8853                    | 16.9561                         | 9.4543                          |
-| 7000  | 0.3177                 | 0.7937     | 8.5961                | 3.7581                | 12.7539                     | 4.6775                      | 0.2991                     | 13.1425                   | 8.6226                    | 16.4905                         | 9.1878                          |
-| 8000  | 0.3383                 | 0.7872     | 8.8935                | 3.8666                | 12.9630                     | 4.7934                      | 0.2917                     | 13.0831                   | 8.6552                    | 16.4486                         | 9.2255                          |
-| 9000  | 0.3320                 | 0.7526     | 9.1612                | 4.0738                | 13.0526                     | 5.0495                      | 0.2899                     | 12.8380                   | 8.4996                    | 16.1350                         | 9.0495                          |
-| 10000 | 0.3267                 | 0.7547     | 9.5181                | 4.1280                | 13.3513                     | 5.1462                      | 0.2894                     | 12.7106                   | 8.4593                    | 16.0502                         | 9.0189                          |
-| 11000 | 0.3358                 | 0.7120     | 9.0125                | 4.1379                | 13.4409                     | 5.1703                      | 0.2889                     | 12.8828                   | 8.5885                    | 16.1915                         | 9.1459                          |
-| 12000 | 0.3179                 | 0.7387     | 9.1910                | 4.2563                | 13.5006                     | 5.2331                      | 0.2825                     | 12.6795                   | 8.4383                    | 16.0152                         | 8.9950                          |
-| 13000 | 0.3152                 | 0.7295     | 8.7448                | 4.0541                | 12.7539                     | 4.9529                      | 0.2832                     | 12.5267                   | 8.4567                    | 15.8700                         | 9.0105                          |
-### Framework versions
-- Transformers 4.31.0.dev0
-- Datasets 2.13.0
-- Tokenizers 0.13.3

 ---
+license: cc-by-4.0
 language:
 - 'no'
+- nb
+- nn
+- en
+datasets:
+- NbAiLab/ncc_speech
+- NbAiLab/NST
+- NbAiLab/NPSC
 tags:
 - audio
 - asr
 - automatic-speech-recognition
 - hf-asr-leaderboard
+metrics:
+- wer
+- cer
+library_name: transformers
+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.
+<center>
+  <figure>
+    <video controls>
+      <source src="https://huggingface.co/NbAiLab/nb-whisper-small-beta/resolve/main/king.mp4" type="video/mp4">
+    Your browser does not support the video tag.
+    </video>
+  <figcaption><a href="https://www.royalcourt.no/tale.html?tid=137662&sek=28409&scope=27248" target="_blank">Speech given by His Majesty The King of Norway at the garden party hosted by Their Majesties The King and Queen at the Palace Park on 1 September 2016.</a></figcaption>
+</figure>
+</center>
+## Model Details
+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       | 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_ |
+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:** [NB AI-Lab](https://ai.nb.no/)
+- **Shared by:** [NB AI-Lab](https://ai.nb.no/)
+- **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
+<!-- Provide the basic links for the model. -->
+- **Repository:** https://github.com/NbAiLab/nb-whisper/
+- **Paper:** _Coming soon_
+- **Demo:** _Coming soon_
+## Uses
+### Direct Use
+This is a **_public beta_** release. The models published in this repository are intended for a generalist purpose and are available to third parties.
+### 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.
+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
+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.
+### 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
+Use the code below to get started with the model.
+```python
+from transformers import pipeline
+asr = pipeline(
+    "automatic-speech-recognition",
+    "NbAiLab/nb-whisper-small-beta"
+)
+asr(
+    "audio.mp3",
+    generate_kwargs={'task': 'transcribe', 'language': 'no'}
+)
+# {'text': ' Så mange anga kører seg i så viktig sak, så vi får du kører det tilbake med. Om kabaret gudam i at vi skal hjælge. Kør seg vi gjør en uda? Nei noe skal å abelistera sonvorne skrifer. Det er sak, så kjent det bare handling i samtatsen til bargører. Trudet første lask. På den å først så å køre og en gange samme, og så får vi gjør å vorte vorte vorte når vi kjent dit.'}
+```
+Timestamps can also be retrieved by passing in the right parameter.
+```python
+asr(
+    "audio.mp3",
+    generate_kwargs={'task': 'transcribe', 'language': 'no'},
+    return_timestamps=True,
+)
+# {'text': ' at så mange angar til seg så viktig sak, så vi får jo kjølget klare tilbakemeldingen om hva valget dem gjør at vi skal gjøre. Hva skjer vi gjøre nå da? Nei, nå skal jo administrationen vår skrivferdige sak, så kjem til behandling i samfærdshetshøyvalget, tror det første
+#  r. 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.',
+#  'chunks': [{'timestamp': (0.0, 5.34),
+#    'text': ' at så mange angar til seg så viktig sak, så vi får jo kjølget klare tilbakemeldingen om'},
+#   {'timestamp': (5.34, 8.64),
+#    'text': ' hva valget dem gjør at vi skal gjøre.'},
+#   {'timestamp': (8.64, 10.64), 'text': ' Hva skjer vi gjøre nå da?'},
+#   {'timestamp': (10.64, 17.44),
+#    'text': ' Nei, nå skal jo administrationen vår skrivferdige sak, så kjem til behandling i samfærdshetshøyvalget,'},
+#   {'timestamp': (17.44, 19.44), 'text': ' tror det første år.'},
+#   {'timestamp': (19.44, 23.94),
+#    '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 -->
+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:** TPUv4
+- **Hours used:** 1,536
+- **Cloud Provider:** Google Cloud
+- **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]
+## Citation
+_A paper is coming soon!_
+<!-- **BibTeX:**
+[More Information Needed]
+**APA:**
+[More Information Needed] -->
+## 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.
+## Contact
+<a rel="noopener nofollow" href="mailto:ailab@nb.no">ailab@nb.no</a>