Wav2vec2 Luganda

🚀 卢干达语自动语音识别模型

本模型专为Mozilla卢干达语自动语音识别竞赛而构建。它是在卢干达语Common Voice数据集 7.0版本上对facebook/wav2vec2-large-xlsr-53模型进行微调得到的。

我们还提供了一个实时演示来测试该模型。使用此模型时，请确保您的语音输入采样率为16kHz。

✨ 主要特性

• 基于微调的facebook/wav2vec2-large-xlsr-53模型，适用于卢干达语自动语音识别。
• 提供实时演示，方便测试模型效果。
• 支持直接使用（无需语言模型）。

📦 安装指南

文档未提及具体安装步骤，故跳过此章节。

💻 使用示例

基础用法

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"])

高级用法

文档未提及高级用法相关代码，故跳过此部分。

📚 详细文档

评估

该模型可以在Common Voice的印尼测试数据上进行如下评估：

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时的词错误率（WER）： 测试结果：7.53 %

训练

Common Voice的train、validation等数据集用于训练。训练脚本可在此处找到。

🔧 技术细节

文档中关于训练部分描述简略，未达到技术细节最低要求（具体的技术说明>50字），故跳过此章节。

📄 许可证

本项目采用Apache-2.0许可证。