---
language:
- hbb
license: other
tags:
- automatic-speech-recognition
- sil-ai/bloom-speech
- generated_from_trainer
datasets:
- bloom_speech
model-index:
- name: wav2vec2-bloom-speech-hbb
  results:
  - task: 
      name: Speech Recognition
      type: automatic-speech-recognition
    dataset:
      name: Bloom Speech hbb
      type: sil-ai/bloom-speech
      args: hbb
    metrics:
       - name: Test WER
         type: wer
         value: 27.49
       - name: Test CER
         type: cer
         value: 6.20
extra_gated_prompt: |-
  One more step before getting this model.
  
  This model is open access and available only for non-commercial use, with an SIL International AI & NLP RAIL-M license further specifying rights and usage.
  
  The SIL RAIL-M License specifies: 

  1. You can't use the model to deliberately produce nor share illegal or harmful outputs or content. Particularly, you cannot use the model use with the intent or effect of harming or enabling discrimination against Indigenous People.
  2. SIL claims no rights on outputs you generate for non-commercial use, you are free to use them and are accountable for their use, which must not go against the provisions set in the license
  3. You may re-distribute the weights and use the model non-commercially including as a service. If you do, please be aware you have to include the same use restrictions as the ones in the license and share a copy of the SIL International AI & NLP RAIL-M to all your users (please read the license entirely and carefully). Please read the full license here: https://huggingface.co/spaces/sil-ai/model-license
  
  By clicking on "Access repository" below, you accept that your *contact information* (email address and username) can be shared with the model authors as well.

  If you would like to ask about commercial uses of this model, please [email us](mailto:sj@derivation.co).
    
extra_gated_fields:
 I have read the License and agree with its terms: checkbox
---

# wav2vec2-bloom-speech-hbb

![logo for Bloom Library](https://bloom-vist.s3.amazonaws.com/bloom_logo.png) ![sil-ai logo](https://s3.amazonaws.com/moonup/production/uploads/1661440873726-6108057a823007eaf0c7bd10.png) 

## Model description

- **Homepage:** [SIL AI](https://ai.sil.org/)
- **Point of Contact:** [SIL AI email](mailto:idx_aqua@sil.org)
- **Source Data:** [Bloom Library](https://bloomlibrary.org/)

This model is a fine-tuned version of [facebook/wav2vec2-xls-r-300m](https://huggingface.co/facebook/wav2vec2-xls-r-300m) on the [SIL-AI/bloom-speech](https://huggingface.co/datasets/sil-ai/bloom-speech) - HBB (Nya Huba) dataset.
It achieves the following results on the evaluation set:
- Loss: 0.5336
- Wer: 0.2749
- Cer: 0.0620

Users should refer to the original model for tutorials on using a trained model for inference.

## Intended uses & limitations

Users of this model must abide by the [SIL RAIL-M License](https://huggingface.co/spaces/sil-ai/model-license).

This model is created as a proof of concept and no guarantees are made regarding the performance of the model is specific situations.

## Training and evaluation data

Training, Validation, and Test datasets were generated from the same corpus, ensuring that no duplicate files were used.

## Training procedure

Standard finetuning of XLS-R was used based on the examples in the [Hugging Face Transformers Github](https://github.com/huggingface/transformers/tree/main/examples/pytorch/speech-recognition)

### Training hyperparameters

The following hyperparameters were used during training:
- learning_rate: 0.0003
- train_batch_size: 16
- eval_batch_size: 8
- seed: 42
- gradient_accumulation_steps: 2
- total_train_batch_size: 32
- optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
- lr_scheduler_type: linear
- lr_scheduler_warmup_steps: 250
- num_epochs: 1000.0
- mixed_precision_training: Native AMP

### Training results

| Training Loss | Epoch  | Step | Validation Loss | Wer    | Cer    |
|:-------------:|:------:|:----:|:---------------:|:------:|:------:|
| No log        | 14.69  | 250  | 0.5759          | 0.6270 | 0.1577 |
| 1.9895        | 29.4   | 500  | 0.4064          | 0.3713 | 0.0784 |
| 1.9895        | 44.11  | 750  | 0.4197          | 0.3755 | 0.0800 |
| 0.1048        | 58.8   | 1000 | 0.4609          | 0.3638 | 0.0824 |
| 0.1048        | 73.51  | 1250 | 0.4703          | 0.3747 | 0.0840 |
| 0.0554        | 88.23  | 1500 | 0.5218          | 0.3361 | 0.0798 |
| 0.0554        | 102.91 | 1750 | 0.5258          | 0.3328 | 0.0723 |
| 0.0399        | 117.63 | 2000 | 0.5095          | 0.3227 | 0.0728 |
| 0.0399        | 132.34 | 2250 | 0.4456          | 0.3621 | 0.0859 |
| 0.0335        | 147.06 | 2500 | 0.5449          | 0.3663 | 0.0824 |
| 0.0335        | 161.74 | 2750 | 0.4750          | 0.3127 | 0.0662 |
| 0.0275        | 176.46 | 3000 | 0.5114          | 0.3202 | 0.0679 |
| 0.0275        | 191.17 | 3250 | 0.5342          | 0.2892 | 0.0618 |
| 0.0208        | 205.86 | 3500 | 0.5613          | 0.3286 | 0.0681 |
| 0.0208        | 220.57 | 3750 | 0.5267          | 0.3051 | 0.0677 |
| 0.0174        | 235.29 | 4000 | 0.5336          | 0.2749 | 0.0620 |
| 0.0174        | 249.97 | 4250 | 0.5204          | 0.2867 | 0.0606 |
| 0.0192        | 264.69 | 4500 | 0.5137          | 0.2758 | 0.0613 |
| 0.0192        | 279.4  | 4750 | 0.4783          | 0.3060 | 0.0691 |


### Framework versions

- Transformers 4.21.0.dev0
- Pytorch 1.9.0+cu111
- Datasets 2.2.2
- Tokenizers 0.12.1