Wav2vec2 Large Xlsr 53 Arabic

🚀 阿拉伯语大模型Wav2Vec2-Large-XLSR-53

本项目基于预训练模型 facebook/wav2vec2-large-xlsr-53，在阿拉伯语上进行了微调。使用了 Common Voice 和 Arabic Speech Corpus 的训练集数据。使用该模型时，请确保语音输入的采样率为 16kHz。

🚀 快速开始

本模型是基于预训练模型 facebook/wav2vec2-large-xlsr-53 在阿拉伯语语音数据上微调得到的。使用时需注意语音输入采样率为 16kHz。

✨ 主要特性

• 数据集丰富：使用了 Common Voice 和 Arabic Speech Corpus 两个数据集进行训练。
• 格式特殊：使用 Buckwalter 转写 格式表示阿拉伯语，仅包含 ASCII 字符。

📦 安装指南

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

💻 使用示例

基础用法

模型可以直接使用（无需语言模型），示例代码如下：

import torch
import torchaudio
from datasets import load_dataset
from lang_trans.arabic import buckwalter
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor

dataset = load_dataset("common_voice", "ar", split="test[:10]")
resamplers = {  # all three sampling rates exist in test split
    48000: torchaudio.transforms.Resample(48000, 16000),
    44100: torchaudio.transforms.Resample(44100, 16000),
    32000: torchaudio.transforms.Resample(32000, 16000),
}

def prepare_example(example):
    speech, sampling_rate = torchaudio.load(example["path"])
    example["speech"] = resamplers[sampling_rate](speech).squeeze().numpy()
    return example

dataset = dataset.map(prepare_example)
processor = Wav2Vec2Processor.from_pretrained("elgeish/wav2vec2-large-xlsr-53-arabic")
model = Wav2Vec2ForCTC.from_pretrained("elgeish/wav2vec2-large-xlsr-53-arabic").eval()

def predict(batch):
    inputs = processor(batch["speech"], sampling_rate=16000, return_tensors="pt", padding=True)
    with torch.no_grad():
        predicted = torch.argmax(model(inputs.input_values).logits, dim=-1)
    predicted[predicted == -100] = processor.tokenizer.pad_token_id  # see fine-tuning script
    batch["predicted"] = processor.tokenizer.batch_decode(predicted)
    return batch

dataset = dataset.map(predict, batched=True, batch_size=1, remove_columns=["speech"])

for reference, predicted in zip(dataset["sentence"], dataset["predicted"]):
    print("reference:", reference)
    print("predicted:", buckwalter.untrans(predicted))
    print("--")

以下是代码的输出示例：

reference: ألديك قلم ؟
predicted: هلديك قالر
--
reference: ليست هناك مسافة على هذه الأرض أبعد من يوم أمس.
predicted: ليست نالك مسافة على هذه الأرض أبعد من يوم أمس
--
reference: إنك تكبر المشكلة.
predicted: إنك تكبر المشكلة
--
reference: يرغب أن يلتقي بك.
predicted: يرغب أن يلتقي بك
--
reference: إنهم لا يعرفون لماذا حتى.
predicted: إنهم لا يعرفون لماذا حتى
--
reference: سيسعدني مساعدتك أي وقت تحب.
predicted: سيسئدني مساعد سكرأي وقت تحب
--
reference: أَحَبُّ نظريّة علمية إليّ هي أن حلقات زحل مكونة بالكامل من الأمتعة المفقودة.
predicted: أحب ناضريةً علمية إلي  هي أنحل قتزح المكونا بالكامل من الأمت عن المفقودة
--
reference: سأشتري له قلماً.
predicted: سأشتري له قلما
--
reference: أين المشكلة ؟
predicted: أين المشكل
--
reference: وَلِلَّهِ يَسْجُدُ مَا فِي السَّمَاوَاتِ وَمَا فِي الْأَرْضِ مِنْ دَابَّةٍ وَالْمَلَائِكَةُ وَهُمْ لَا يَسْتَكْبِرُونَ
predicted: ولله يسجد ما في السماوات وما في الأرض من دابة والملائكة وهم لا يستكبرون
--

📚 详细文档

评估

可以在 Common Voice 的阿拉伯语测试数据上对模型进行评估，示例代码如下：

import jiwer
import torch
import torchaudio
from datasets import load_dataset
from lang_trans.arabic import buckwalter
from transformers import set_seed, Wav2Vec2ForCTC, Wav2Vec2Processor

set_seed(42)
test_split = load_dataset("common_voice", "ar", split="test")
resamplers = {  # all three sampling rates exist in test split
    48000: torchaudio.transforms.Resample(48000, 16000),
    44100: torchaudio.transforms.Resample(44100, 16000),
    32000: torchaudio.transforms.Resample(32000, 16000),
}

def prepare_example(example):
    speech, sampling_rate = torchaudio.load(example["path"])
    example["speech"] = resamplers[sampling_rate](speech).squeeze().numpy()
    return example

test_split = test_split.map(prepare_example)
processor = Wav2Vec2Processor.from_pretrained("elgeish/wav2vec2-large-xlsr-53-arabic")
model = Wav2Vec2ForCTC.from_pretrained("elgeish/wav2vec2-large-xlsr-53-arabic").to("cuda").eval()

def predict(batch):
    inputs = processor(batch["speech"], sampling_rate=16000, return_tensors="pt", padding=True)
    with torch.no_grad():
        predicted = torch.argmax(model(inputs.input_values.to("cuda")).logits, dim=-1)
    predicted[predicted == -100] = processor.tokenizer.pad_token_id  # see fine-tuning script
    batch["predicted"] = processor.tokenizer.batch_decode(predicted)
    return batch

test_split = test_split.map(predict, batched=True, batch_size=16, remove_columns=["speech"])
transformation = jiwer.Compose([
    # normalize some diacritics, remove punctuation, and replace Persian letters with Arabic ones
    jiwer.SubstituteRegexes({
        r'[auiFNKo\~_،؟»\?;:\-,\.؛«!"]': "", "\u06D6": "",
        r"[\|\{]": "A", "p": "h", "ک": "k", "ی": "y"}),
    # default transformation below
    jiwer.RemoveMultipleSpaces(),
    jiwer.Strip(),
    jiwer.SentencesToListOfWords(),
    jiwer.RemoveEmptyStrings(),
])
metrics = jiwer.compute_measures(
    truth=[buckwalter.trans(s) for s in test_split["sentence"]],  # Buckwalter transliteration
    hypothesis=test_split["predicted"],
    truth_transform=transformation,
    hypothesis_transform=transformation,
)
print(f"WER: {metrics['wer']:.2%}")

测试结果：26.55%

训练

更多训练细节请参考 使用阿拉伯语语音语料库进行微调。

本模型使用 Buckwalter 转写 格式表示阿拉伯语，该格式仅包含 ASCII 字符。使用 lang-trans 包进行阿拉伯语字母的转写。

使用 此脚本 首先在 Arabic Speech Corpus 数据集的训练集上对 facebook/wav2vec2-large-xlsr-53 进行微调，使用测试集进行模型选择，得到的模型保存为 elgeish/wav2vec2-large-xlsr-53-levantine-arabic。

然后使用 Common Voice 数据集的训练集继续训练，使用验证集进行模型选择。训练在 Fine-Tune-XLSR Week 的截止日期停止，此模型是在 100k 步时的检查点，验证集的字错率（WER）为 23.39%。

值得注意的是，验证集的字错率呈下降趋势，这表明进一步训练（以 7e-6 的衰减学习率继续训练）有提升模型性能的潜力。

🔧 技术细节

文档未提供具体技术细节，故跳过此章节。

📄 许可证

本模型使用的许可证为 Apache-2.0。

💡 使用建议

• 探索在模型输入中使用 attention_mask，可参考 此处 的建议。
• 尝试使用 此处 列出的训练模型所用的数据集进行数据增强。