Wav2vec2 Large Xlsr 53 Finnish

🚀 Wav2Vec2-Large-XLSR-53-Finnish

このモデルは、Common Voice、CSS10、およびFinnish parliament session 2のデータセットを使用して、フィンランド語でfacebook/wav2vec2-large-xlsr-53をファインチューニングしたものです。

このモデルを使用する際には、音声入力が16kHzでサンプリングされていることを確認してください。

🚀 クイックスタート

このモデルは、言語モデルを使用せずに直接使用することができます。

✨ 主な機能

• 音声入力が16kHzでサンプリングされていることを前提とした音声認識機能。
• フィンランド語に対してファインチューニングされているため、フィンランド語の音声認識に特化しています。

📦 インストール

このモデルを使用するには、必要なライブラリをインストールする必要があります。以下のコマンドを使用してインストールしてください。

pip install numpy torch torchaudio datasets transformers librosa

💻 使用例

基本的な使用法

import numpy as np
import torch
import torchaudio
from datasets import load_dataset
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor

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

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

resampler = lambda sr, y: librosa.resample(y.squeeze(), sr, 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(sampling_rate, speech_array.numpy()).squeeze()
	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 librosa
import torch
import torchaudio
from datasets import load_dataset, load_metric
from transformers import Wav2Vec2ForCTC, Wav2Vec2Processor
import re

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

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

chars_to_ignore_regex = '[\,\?\.\!\-\;\:\"\"\%\'\"\�\'\...\…\–\é]'

resampler = lambda sr, y: librosa.resample(y.numpy().squeeze(), sr, 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()
  speech_array, sampling_rate = torchaudio.load(batch["path"])
  batch["speech"] = resampler(sampling_rate, speech_array).squeeze()
  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"])))

テスト結果: 35.43 %

📚 ドキュメント

データセット

• Common Voice：一般的な音声データセットで、フィンランド語の音声データを含んでいます。
• CSS10：フィンランド語の単一話者音声データセットです。
• Finnish parliament session 2：フィンランド議会の会議音声データセットです。

評価指標

• WER (Word Error Rate)：単語誤り率を表し、音声認識の精度を評価するために使用されます。

トレーニング

Common Voiceのtrain、validation、otherデータセット、およびCSS10とFinnish parliament session 2がトレーニングに使用されました。 トレーニングに使用されたスクリプトはこちらで見つけることができます。（TODO: トレーニングスクリプトへのリンクを記入してください。Colabでモデルをトレーニングした場合は、そのリンクを記入してください。ローカルでモデルをトレーニングした場合は、トレーニングスクリプトをGitHubにアップロードして、そのリンクを貼り付けると良いでしょう。）

🔧 技術詳細

このモデルは、facebook/wav2vec2-large-xlsr-53をベースに、フィンランド語の音声データを使用してファインチューニングされています。音声入力が16kHzでサンプリングされていることを前提としており、言語モデルを使用せずに直接音声認識を行うことができます。

📄 ライセンス

このモデルは、Apache-2.0ライセンスの下で提供されています。

情報テーブル

| 属性 | 詳細 |
|------|------|
| モデルタイプ | Wav2Vec2-Large-XLSR-53-Finnish |
| トレーニングデータ | Common Voice、CSS10、Finnish parliament session 2 |

重要提示

⚠️ 重要提示

このモデルを使用する際には、音声入力が16kHzでサンプリングされていることを確認してください。

💡 使用アドバイス

トレーニングスクリプトのリンクを記入することで、他のユーザーがモデルを再現しやすくなります。