Wav2vec2 Large Xlsr 53 Es

🚀 西班牙文Wav2Vec2-Large-XLSR-53模型

本项目基于Common Voice数据集，在西班牙文上对facebook/wav2vec2-large-xlsr-53模型进行了微调。使用该模型时，请确保语音输入的采样率为16kHz。

🚀 快速开始

本模型可直接使用（无需语言模型），具体操作如下：

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

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

processor = Wav2Vec2Processor.from_pretrained("pcuenq/wav2vec2-large-xlsr-53-es")
model = Wav2Vec2ForCTC.from_pretrained("pcuenq/wav2vec2-large-xlsr-53-es")

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):
	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["speech"][:2], 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["sentence"][:2])

✨ 主要特性

• 基于大规模预训练模型facebook/wav2vec2-large-xlsr-53进行微调，适用于西班牙文语音识别任务。
• 对Common Voice数据集中的西班牙文数据进行了处理，去除了大量非西班牙文的字符，保留了西班牙文的变音符号，在准确性和语义理解上取得了较好的平衡。
• 通过多次调整训练参数和策略，不断优化模型的WER（词错误率），最终达到了约10.5%的测试WER。

💻 使用示例

基础用法

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

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

processor = Wav2Vec2Processor.from_pretrained("pcuenq/wav2vec2-large-xlsr-53-es")
model = Wav2Vec2ForCTC.from_pretrained("pcuenq/wav2vec2-large-xlsr-53-es")

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):
	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["speech"][:2], 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["sentence"][:2])

高级用法

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

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

processor = Wav2Vec2Processor.from_pretrained("pcuenq/wav2vec2-large-xlsr-53-es")
model = Wav2Vec2ForCTC.from_pretrained("pcuenq/wav2vec2-large-xlsr-53-es")
model.to("cuda")

## Text pre-processing

chars_to_ignore_regex = '[\,\¿\?\.\¡\!\-\;\:\"\“\%\‘\”\\…\’\ː\'\‹\›\`\´\®\—\→]'
chars_to_ignore_pattern = re.compile(chars_to_ignore_regex)

def remove_special_characters(batch):
    batch["sentence"] = chars_to_ignore_pattern.sub('', batch["sentence"]).lower() + " "
    return batch

def replace_diacritics(batch):
    sentence = batch["sentence"]
    sentence = re.sub('ì', 'í', sentence)
    sentence = re.sub('ù', 'ú', sentence)
    sentence = re.sub('ò', 'ó', sentence)
    sentence = re.sub('à', 'á', sentence)
    batch["sentence"] = sentence
    return batch

def replace_additional(batch):
    sentence = batch["sentence"]
    sentence = re.sub('ã', 'a', sentence)   # Portuguese, as in São Paulo
    sentence = re.sub('ō', 'o', sentence)   # Japanese
    sentence = re.sub('ê', 'e', sentence)   # Português
    batch["sentence"] = sentence
    return batch

## Audio pre-processing

# I tried to perform the resampling using a `torchaudio` `Resampler` transform,
# but found that the process deadlocked when using multiple processes.
# Perhaps my torchaudio is using the wrong sox library under the hood, I'm not sure.
# Fortunately, `librosa` seems to work fine, so that's what I'll use for now.

import librosa
def speech_file_to_array_fn(batch):
    speech_array, sample_rate = torchaudio.load(batch["path"])
    batch["speech"] = librosa.resample(speech_array.squeeze().numpy(), sample_rate, 16_000)
    return batch

# One-pass mapping function

# Text transformation and audio resampling
def cv_prepare(batch):
    batch = remove_special_characters(batch)
    batch = replace_diacritics(batch)
    batch = replace_additional(batch)
    batch = speech_file_to_array_fn(batch)
    return batch

# Number of CPUs or None
num_proc = 16

test_dataset = test_dataset.map(cv_prepare, remove_columns=['path'], num_proc=num_proc)

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)

# WER Metric computation
# `wer.compute` crashes in my computer with more than ~10000 samples.
# Until I confirm in a different one, I created a "chunked" version of the computation.
# It gives the same results as `wer.compute` for smaller datasets.

import jiwer

def chunked_wer(targets, predictions, chunk_size=None):                                          
    if chunk_size is None: return jiwer.wer(targets, predictions)                                
    start = 0                                                                                    
    end = chunk_size                                                                             
    H, S, D, I = 0, 0, 0, 0                                                                      
    while start < len(targets):                                                                  
        chunk_metrics = jiwer.compute_measures(targets[start:end], predictions[start:end])       
        H = H + chunk_metrics["hits"]                                                            
        S = S + chunk_metrics["substitutions"]                                                   
        D = D + chunk_metrics["deletions"]                                                       
        I = I + chunk_metrics["insertions"]                                                      
        start += chunk_size                                                                      
        end += chunk_size                                                                        
    return float(S + D + I) / float(H + S + D)

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

📚 详细文档

文本处理

Common Voice的西班牙文数据集即使在去除分隔符和标点符号后，仍包含大量非西班牙文的字符。因此，对这些字符进行了处理，去除了大部分无关字符，并保留了所有西班牙文的变音符号。虽然仅使用非重音字符可能会获得更好的WER分数，但保留变音符号在语义理解上更为准确。具体的处理规则在评估脚本中有所体现。

训练过程

使用了Common Voice的train和validation数据集进行训练。为了更好地观察训练进度并及时调整策略，最初将train和validation数据集按10%进行分割。具体训练过程如下：

1. 仅在第一个分割数据集上训练30个epoch，使用与Patrick在演示笔记本中类似的参数，批量大小为24，梯度累积步数为2，在完整测试集上的WER约为16.3%。
2. 在剩余的9个分割数据集上分别训练3个epoch，使用更快的75步热身，WER约为11.7%。
3. 在10个分割数据集上分别训练3个epoch，使用较小的学习率1e-4和75步热身，最终模型的WER约为11.7%。
4. 使用完整数据集进行训练，选择带有硬重启的余弦调度，参考学习率为3e-5，训练10个epoch，无热身，最终WER约为10.5%。

其他尝试

• 从相同的微调模型开始，比较了恒定学习率1e-4和带热身的线性调度，线性调度效果更好（WER分别为11.85%和12.72%）。
• 尝试使用西班牙文模型改进巴斯克文模型，但未取得效果。
• 标签平滑方法未起作用。

问题与技术挑战

• Datasets抽象基于内存映射文件，可处理任意大小的数据集，但需要了解其局限性和权衡。缓存使用方便，但磁盘空间消耗快，需要了解缓存文件的存储方式，并在必要时手动保存数据。
• 训练开始前存在明显延迟，已找到原因并讨论出解决方案。
• wer.compute在处理大数据集时会崩溃，因此实现了一个分块计算的版本。
• torchaudio在使用多进程时会出现死锁问题，目前使用librosa进行重采样。
• 在笔记本中使用num_proc时，无法看到进度条，可能是权限问题。

🔧 技术细节

模型信息

训练参数调整

在训练过程中，多次调整了学习率、热身步数、训练轮数等参数，以优化模型的性能。具体的参数调整过程和效果在训练部分有详细描述。

数据处理

对文本数据进行了特殊字符去除、变音符号替换等处理，对音频数据进行了重采样，以确保输入数据的质量和一致性。具体的处理函数和规则在评估脚本中有所体现。

📄 许可证

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