Wav2vec2 Luganda

🚀 盧幹達語自動語音識別模型

本模型專為Mozilla盧幹達語自動語音識別競賽而構建。它是在盧幹達語Common Voice數據集7.0版本上對facebook/wav2vec2-large-xlsr-53模型進行微調得到的。

我們還提供了一個在線演示來測試該模型。使用此模型時，請確保語音輸入的採樣率為16kHz。

🚀 快速開始

本模型可直接用於盧幹達語的自動語音識別任務，為相關語音處理項目提供了高效的解決方案。

✨ 主要特性

• 針對性訓練：針對盧幹達語進行了專門的微調，能更好地適應盧幹達語的語音特點。
• 便捷測試：提供在線演示，方便用戶快速測試模型效果。
• 明確輸入要求：明確指出語音輸入的採樣率要求，確保使用的準確性。

📦 安裝指南

暫未提及具體安裝步驟，可參考相關依賴庫（如torch、torchaudio、datasets、transformers等）的官方安裝說明進行安裝。

💻 使用示例

基礎用法

import torch
import torchaudio
from datasets import load_dataset
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor

test_dataset = load_dataset("common_voice", "lg", split="test[:2%]")

processor = Wav2Vec2Processor.from_pretrained("indonesian-nlp/wav2vec2-luganda")
model = Wav2Vec2ForCTC.from_pretrained("indonesian-nlp/wav2vec2-luganda")

resampler = torchaudio.transforms.Resample(48_000, 16_000)

# Preprocessing the datasets.
# We need to read the aduio files as arrays
def speech_file_to_array_fn(batch):
    if "audio" in batch:
        speech_array = torch.tensor(batch["audio"]["array"])
    else:
        speech_array, sampling_rate = torchaudio.load(batch["path"])
    batch["speech"] = resampler(speech_array).squeeze().numpy()
    return batch

test_dataset = test_dataset.map(speech_file_to_array_fn)
inputs = processor(test_dataset[:2]["speech"], 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, dim=-1)

print("Prediction:", processor.batch_decode(predicted_ids))
print("Reference:", test_dataset[:2]["sentence"])

高級用法

import torch
import torchaudio
from datasets import load_dataset, load_metric
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
import re

test_dataset = load_dataset("common_voice", "lg", split="test")
wer = load_metric("wer")

processor = Wav2Vec2Processor.from_pretrained("indonesian-nlp/wav2vec2-luganda")
model = Wav2Vec2ForCTC.from_pretrained("indonesian-nlp/wav2vec2-luganda") 
model.to("cuda")

chars_to_ignore = [",", "?", ".", "!", "-", ";", ":", '""', "%", "'", '"', "�", "‘", "’", "’"]
chars_to_ignore_regex = f'[{"".join(chars_to_ignore)}]'

resampler = torchaudio.transforms.Resample(48_000, 16_000)

# Preprocessing the datasets.
# We need to read the audio files as arrays
def speech_file_to_array_fn(batch):
    batch["sentence"] = re.sub(chars_to_ignore_regex, '', batch["sentence"]).lower()
    if "audio" in batch:
        speech_array = torch.tensor(batch["audio"]["array"])
    else:
        speech_array, sampling_rate = torchaudio.load(batch["path"])
    batch["speech"] = resampler(speech_array).squeeze().numpy()
    return batch

test_dataset = test_dataset.map(speech_file_to_array_fn)

# Preprocessing the datasets.
# We need to read the audio files as arrays
def evaluate(batch):
    inputs = processor(batch["speech"], sampling_rate=16_000, return_tensors="pt", padding=True)

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

    pred_ids = torch.argmax(logits, dim=-1)
    batch["pred_strings"] = processor.batch_decode(pred_ids)
    return batch

result = test_dataset.map(evaluate, batched=True, batch_size=8)

print("WER: {:2f}".format(100 * wer.compute(predictions=result["pred_strings"], references=result["sentence"])))

📚 詳細文檔

評估結果

• 無KenLM時的字錯率（WER）：15.38 %
• 有KenLM時的測試結果：7.53 %

訓練信息

使用了Common Voice的train、validation等數據集進行訓練。訓練腳本可在此處找到。

📄 許可證

本項目採用Apache 2.0許可證。

📋 模型信息