Wav2vec2 Xls R 300m Khmer

🚀 xls-r-300m-km

This is a fine - tuned model based on facebook/wav2vec2-xls-r-300m for automatic speech recognition, achieving good results on the openslr dataset.

🚀 Quick Start

This model is a fine - tuned version of facebook/wav2vec2-xls-r-300m on the openslr dataset. It achieves the following results on the evaluation set:

• Loss: 0.3281
• Wer: 0.3462

Evaluation results on OpenSLR "test" (self - split 10%) (Running ./eval.py)

• WER: 0.3216977389924633
• CER: 0.08653361193169537

Evaluation results with language model on OpenSLR "test" (self - split 10%) (Running ./eval.py)

• WER: 0.257040856802856
• CER: 0.07025001801282513

✨ Features

• Fine - tuned Model: Based on facebook/wav2vec2-xls-r-300m, fine - tuned on the openslr dataset.
• Good Performance: Achieves relatively good WER and CER results on the evaluation set.

📦 Installation

Install the following libraries on top of HuggingFace Transformers for the supports of language model.

pip install pyctcdecode
pip install https://github.com/kpu/kenlm/archive/master.zip

💻 Usage Examples

Basic Usage

Using HuggingFace's pipeline, this will cover everything end - to - end from raw audio input to text output.

from transformers import pipeline

# Load the model
pipe = pipeline(model="vitouphy/wav2vec2-xls-r-300m-khmer")

# Process raw audio
output = pipe("sound_file.wav", chunk_length_s=10, stride_length_s=(4, 2))

Advanced Usage

More custom way to predict phonemes.

from transformers import Wav2Vec2Processor, Wav2Vec2ForCTC 
import librosa
import torch

# load model and processor
processor = Wav2Vec2Processor.from_pretrained("vitouphy/wav2vec2-xls-r-300m-khmer")
model = Wav2Vec2ForCTC.from_pretrained("vitouphy/wav2vec2-xls-r-300m-khmer")

# Read and process the input
speech_array, sampling_rate = librosa.load("sound_file.wav", sr=16_000)
inputs = processor(speech_array, sampling_rate=16_000, return_tensors="pt", padding=True)

with torch.no_grad():
    logits = model(inputs.input_values, attention_mask=inputs.attention_mask).logits

predicted_ids = torch.argmax(logits, axis=-1)      
predicted_sentences = processor.batch_decode(predicted_ids)
print(predicted_sentences)

📚 Documentation

Intended uses & limitations

The data used for this model is only around 4 hours of recordings.

• We split into 80/10/10. Hence, the training hour is 3.2 hours, which is very very small.
• Yet, its performance is not too bad. Quite interesting for such small dataset, actually. You can try it out.
• Its limitation is:
  • Rare characters, e.g. ឬស្សី ឪឡឹក
  • Speech needs to be clear and articulate.
• More data to cover more vocabulary and character may help improve this system.

Training procedure

Training hyperparameters

The following hyperparameters were used during training:

• learning_rate: 5e - 05
• train_batch_size: 8
• eval_batch_size: 8
• seed: 42
• gradient_accumulation_steps: 4
• 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: 1000
• num_epochs: 100
• mixed_precision_training: Native AMP

Training results

Framework versions

• Transformers 4.17.0.dev0
• Pytorch 1.10.2+cu102
• Datasets 1.18.2.dev0
• Tokenizers 0.11.0

📄 License

This model is released under the Apache - 2.0 license.