Update README.md

README.md

@@ -1,3 +1,116 @@
 ---
-license: cc-by-sa-4.0
+license: cc-by-nc-sa-4.0
+tags:
+- automatic-speech-recognition
+- NbAiLab/NPSC
+- no
+- nb
+- nb-NO
+datasets:
+- NbAiLab/NPSC
+language:
+- nb-NO
+model-index:
+- name: nb-wav2vec2-300m-bokmaal
+  results:
+  - task:
+      name: Automatic Speech Recognition 
+      type: automatic-speech-recognition
+    dataset:
+      name: NPSC
+      type: NbAiLab/NPSC
+      args: 16K_mp3_bokmaal
+    metrics:
+       - name: Test (Bokmål) WER
+         type: wer
+         value: 0.0703
+       - name: Test (Bokmål) CER
+         type: cer
+         value: 0.0269
 ---
+
+# Norwegian Wav2Vec2 Model - 300M - VoxRex - Bokmål
+This model is finetuned on top of feature extractor [VoxRex-model](https://huggingface.co/KBLab/wav2vec2-large-voxrex) from the National Library of Sweeden. The finefinetuned model achieves the following results on the test set with a 5-gram KenLM. Numbers in parenthesis is without the language model:
+- **WER: 0.0703** (0.0979)
+- **CER: 0.0269** (0.0311)
+
+## Model description
+This is one of several Wav2Vec-models created during the 🤗 hosted [Robust Speech Event](https://discuss.huggingface.co/t/open-to-the-community-robust-speech-recognition-challenge/13614?s=09). This is the complete list of models and their final scores:
+
+| Model         | Final WER   | |
+|:--------------|:------------|:------------:|
+| [NbAiLab/nb-wav2vec2-1b-bokmaal](https://huggingface.co/NbAiLab/nb-wav2vec2-1b-bokmaal) |  6.33 |                                          |
+| [NbAiLab/nb-wav2vec2-300m-bokmaal](https://huggingface.co/NbAiLab/nb-wav2vec2-300m-bokmaal) |  7.03 |                                      |
+| NbAiLab/nb-wav2vec2-300m-nynorsk (this model) | 12.22  |                                                |
+## Dataset
+In parallell with the event, the team also converted the [Norwegian Parliamentary Speech Corpus (NPSC)](https://huggingface.co/datasets/NbAiLab/NPSC) to the 🤗 Dataset format and used that as the main source for training.
+
+## Code
+We do release all code developed during the event so that the Norwegian NLP community can build upon this to develop even better Norwegian ASR models. The finetuning of these models are not very compute demanding. You should after following the instructions here, be able to train your own automatic speech recognition system in less than a day with an average GPU.
+
+## Team
+The following people contributed to building this model: Rolv-Arild Braaten, Per Egil Kummervold, Andre Kåsen, Javier de la Rosa, Per Erik Solberg, and Freddy Wetjen. 
+
+## Training procedure
+To reproduce these results, we strongly recommend that you follow the [instructions from 🤗](https://github.com/huggingface/transformers/tree/master/examples/research_projects/robust-speech-event#talks) to train a simple Swedish model.
+
+When you have verified that you are able to do this, create a fresh new repo. You can then start by copying the files ```run.sh``` and ```run_speech_recognition_ctc.py``` from our repo. Running this will create all the other necessary files, and should let you reproduce our results. With some tweaks to the hyperparameters, you might even be able to build an even better ASR. Good luck!
+
+### Language Model
+As you see from the results above, adding even a simple 5-gram language will improve the results.  🤗 has provided another [very nice blog](https://huggingface.co/blog/wav2vec2-with-ngram) about how to add a 5-gram language model to improve the ASR model. You can build this from your own corpus, for instance by extracting some suitable text from the [Norwegian Colossal Corpus](https://huggingface.co/datasets/NbAiLab/NCC). You can also skip some of the steps in the guide, and copy the [5-gram model from this repo](https://huggingface.co/NbAiLab/XLSR-300M-bokmaal/tree/main/language_model).
+
+
+### Parameters
+The final model was run using these parameters:
+```
+--dataset_name="NbAiLab/NPSC"
+--model_name_or_path="facebook/wav2vec2-xls-r-1b"
+--dataset_config_name="16K_mp3_bokmaal"
+--output_dir="./"
+--overwrite_output_dir
+--num_train_epochs="40"
+--per_device_train_batch_size="12"
+--per_device_eval_batch_size="12" 
+--gradient_accumulation_steps="2" 
+--learning_rate="2e-5" 
+--warmup_steps="2000" 
+--length_column_name="input_length" 
+--evaluation_strategy="steps" 
+--text_column_name="text" 
+--save_steps="500" 
+--eval_steps="500" 
+--logging_steps="100" 
+--layerdrop="0.041" 
+--attention_dropout="0.094" 
+--activation_dropout="0.055" 
+--hidden_dropout="0.047" 
+--save_total_limit="3"
+--freeze_feature_encoder 
+--feat_proj_dropout="0.04" 
+--mask_time_prob="0.082" 
+--mask_time_length="10" 
+--mask_feature_prob="0.25" 
+--mask_feature_length="64" 
+--gradient_checkpointing
+--min_duration_in_seconds="0.5" 
+--max_duration_in_seconds="30.0" 
+	--ctc_zero_infinity=True 
+--use_auth_token 
+--seed="42" 
+--fp16 
+--group_by_length 
+--do_train --do_eval 
+--push_to_hub 
+--preprocessing_num_workers="16"
+```
+
+Following this settings, the training might take 3-4 days on an average GPU. You should however get a decent model and faster results by tweaking these parameters
+
+| Parameter| Comment | 
+|:-------------|:-----|
+| per_device_train_batch_size       | Adjust this to the maximum of available memory. 16 or 24 might be good settings depending on your system  |
+|gradient_accumulation_steps |Can be adjusted even further up to increase batch size and speed up training without running into memory issues |
+| learning_rate|Can be increased, maybe as high as 1e-4. Speeds up training but might add instability |
+| epochs| Can be decreased significantly. This is a huge dataset and you might get a decent result already after a couple of epochs|
+
+