Wav2vec2 Large XLSR 53 Catalan

🚀 カタルーニャ語用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", "ca", split="test[:2%]") 

processor = Wav2Vec2Processor.from_pretrained("PereLluis13/Wav2Vec2-Large-XLSR-53-catalan")
model = Wav2Vec2ForCTC.from_pretrained("PereLluis13/Wav2Vec2-Large-XLSR-53-catalan")

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

モデルの評価

このモデルは、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", "ca", split="test") 
wer = load_metric("wer")

processor = Wav2Vec2Processor.from_pretrained("PereLluis13/Wav2Vec2-Large-XLSR-53-catalan") 
model = Wav2Vec2ForCTC.from_pretrained("PereLluis13/Wav2Vec2-Large-XLSR-53-catalan") 
model.to("cuda")

chars_to_ignore_regex = '[\,\?\.\!\;\:\"\“]'
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):
    batch["sentence"] = re.sub(chars_to_ignore_regex, '', batch["sentence"]).lower()
    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 aduio 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)
import jiwer

# Chunk WER computation due to memory issues, taken from https://huggingface.co/pcuenq/wav2vec2-large-xlsr-53-es
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)))

テスト結果: 8.11 %

🔧 学習について

学習にはCommon Voiceのtrainとvalidationデータセットが使用されました。2エポック目でメモリの問題で学習が中断され、バッチサイズを小さくして再開しましたが、累積勾配ステップを調整して、学習全体を通じてバッチサイズを32に保ちました。その後、男性サンプルの半分をピッチアップしてさらに10エポック学習しました。

学習に使用されたスクリプトはこちらで見つけることができます。学習中の長さによるソートを高速化するために若干の修正が加えられており、その詳細はこちらで確認できます。カタルーニャ語用に学習された別のバージョンはこちらにあり、追加のデータで長時間学習されているため、このモデルよりも良い性能を示す可能性があります。ただし、Common Voiceのテストセットの一部を含む異なる分割を使用しているため、このバージョンはCommon Voiceデータセットのベースラインを取得するために使用できます。

📄 免責事項

このモデルはCommon Voice 6で学習されています。カタルーニャ語の自動音声認識モデルが必要な場合は、wav2vec2-xls-r-1b-ca-lmをチェックすることをおすすめします。これはCV8+で学習されたLM付きの10億パラメータモデルで、性能が大幅に向上しています。また、wav2vec2-xls-r-300m-ca-lmもあり、これはこのモデルと同じサイズ（3億パラメータ）で、CV8+と同じLMで学習されています。