Wav2vec2 Large Xlsr 53 German

🚀 Wav2vec2 German Model

このモデルは、wav2vec-large-xlsr-53をドイツ語のCommonVoiceデータセットでファインチューニングしたものです。 完全なテストデータセットで11.26のWER（Word Error Rate）を達成しています。 基本的には、Max Idahl が提供するコードを使用してトレーニングされ、データ前処理とトレーニングパラメータに若干の調整が加えられています。

🚀 クイックスタート

以下のコードを使用して、独自のファイルを文字起こしすることができます。ただし、入力ファイルは *.wav 形式で、16kHzでエンコードされ、単一チャンネルである必要があります。ffmpegを使用してオーディオファイルを変換するには、"ffmpeg -i input.wav -ar 16000 -ac 1 output.wav" というコマンドを使用します。文字起こしプロセスは非常にメモリを消費します（10秒あたり約10GB）。スクリプトが "Killed" で終了した場合は、Pythonインタープリターがメモリ不足になったことを意味します。この場合は、より短いオーディオファイルで試してみてください。

基本的な使用法

# !pip3 install transformers torch soundfile
import soundfile as sf
import torch
from transformers import Wav2Vec2ForCTC, Wav2Vec2Tokenizer

# load pretrained model
tokenizer = Wav2Vec2Tokenizer.from_pretrained("Noricum/wav2vec2-large-xlsr-53-german")
model = Wav2Vec2ForCTC.from_pretrained("Noricum/wav2vec2-large-xlsr-53-german")

#load audio
audio_input, _ = sf.read("/path/to/your/audio.wav")

# transcribe
input_values = tokenizer(audio_input, return_tensors="pt").input_values
logits = model(input_values).logits
predicted_ids = torch.argmax(logits, dim=-1)
transcription = tokenizer.batch_decode(predicted_ids)[0]
print(str(transcription))

📚 ドキュメント

完全なCommonVoiceテストデータセットでモデルを評価するには、以下のスクリプトを実行します。

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

test_dataset = load_dataset("common_voice", "de", split="test") # use "test[:1%]" for 1% sample
wer = load_metric("wer")

processor = Wav2Vec2Processor.from_pretrained("Noricum/wav2vec2-large-xlsr-53-german")
model = Wav2Vec2ForCTC.from_pretrained("Noricum/wav2vec2-large-xlsr-53-german")
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 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=4) # batch_size=8 -> requires ~14.5GB GPU memory

# Chunked version, see https://discuss.huggingface.co/t/spanish-asr-fine-tuning-wav2vec2/4586/5:
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("Total (chunk_size=1000), WER: {:2f}".format(100 * chunked_wer(result["pred_strings"], result["sentence"], chunk_size=1000)))

出力結果：Total (chunk_size=1000), WER: 11.256522

⚠️ 重要提示

入力ファイルは *.wav 形式で、16kHzでエンコードされ、単一チャンネルである必要があります。文字起こしプロセスは非常にメモリを消費します（10秒あたり約10GB）。スクリプトが "Killed" で終了した場合は、Pythonインタープリターがメモリ不足になったことを意味します。この場合は、より短いオーディオファイルで試してみてください。

💡 使用建议

完全なCommonVoiceテストデータセットでの評価を行う際には、メモリ使用量を考慮してバッチサイズを適切に設定してください。また、テストデータセットの一部のみを使用する場合は、"test[:1%]" のように指定することができます。