Wav2vec2 Large Xlsr Vietnamese

🚀 Wav2Vec2-Large-XLSR-53-Vietnamese

このモデルは、ベトナム語の音声認識タスクに特化しており、facebook/wav2vec2-large-xlsr-53 を Common Voice と Infore_25h dataset（パスワード: BroughtToYouByInfoRe）を用いてファインチューニングしたものです。

基本情報

モデルの結果

• モデル名: Cuong-Cong XLSR Wav2Vec2 Large 53
• タスク: 音声認識 (Automatic Speech Recognition)
• データセット: Common Voice vi
• 評価指標: Test WER = 58.63%

🚀 クイックスタート

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

💻 使用例

基本的な使用法

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

test_dataset = load_dataset("common_voice", "vi", split="test[:2%]") 
processor = Wav2Vec2Processor.from_pretrained("CuongLD/wav2vec2-large-xlsr-vietnamese") 
model = Wav2Vec2ForCTC.from_pretrained("CuongLD/wav2vec2-large-xlsr-vietnamese")

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

高度な使用法

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

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

processor = Wav2Vec2Processor.from_pretrained("CuongLD/wav2vec2-large-xlsr-vietnamese") 
model = Wav2Vec2ForCTC.from_pretrained("CuongLD/wav2vec2-large-xlsr-vietnamese") 
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)

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

テスト結果: 58.63 %

📚 ドキュメント

学習について

Common Voice の train、validation データセットと Infore_25h データセットを学習に使用しました。学習に使用したスクリプトは こちら から取得できます。

学習済みチェックポイントの評価方法

モデルをアップロードした後、最終的な評価を行う必要があります。これは、モデルカードの評価コードをPythonスクリプトにコピーして実行するだけです。最終結果をモデルカードのYAMLタグの下と評価コードの下の "Test Results" に記載することを忘れないでください。

学習と評価のルール

• 学習データ: 公式のCommon Voice test データセットを除くすべてのデータを学習データとして使用できます。Common Voiceに含まれない言語でモデルを学習する場合は、評価用のデータを適切に残すようにしてください。
• データ前処理: データを小文字に正規化することや、印刷記号や句読点を削除することは許可されています。ただし、単語の意味を変えるような記号は削除しないでください。
• 評価: 上記の評価コードを使用してモデルを評価できます。

ヒントとコツ

• 複数のデータセットを結合する方法: こちら の記事を参照してください。
• 限られたRAMとハードドライブ容量で効率的にデータセットをロードする方法: こちら の記事を参照してください。

参考資料

Wav2Vec2の理論的な仕組みを理解することは、モデルのファインチューニングに役立ちます。以下のリソースを参考にしてください。

• Facebook's Wav2Vec2 blog post
• Official Wav2Vec2 paper
• Official XLSR Wav2vec2 paper
• Hugging Face Blog
• How does CTC (Connectionist Temporal Classification) work

FAQ

• 参加者は複数の言語のモデルをファインチューニングできますか？
  • はい、参加者は好きなだけの言語のモデルをファインチューニングできます。
• 参加者は追加のデータ（Common Voiceデータ以外）を使用できますか？
  • はい、公式のCommon Voice test データを除くすべてのデータを学習に使用できます。Common Voiceに含まれない言語でモデルを学習する場合は、評価用のデータを適切に残すようにしてください。
• 高リソース言語のモデルをファインチューニングできますか？
  • はい、英語のモデルをファインチューニングすることは推奨されませんが、フランス語、スペイン語、ドイツ語などの他の「高リソース」言語のモデルをファインチューニングすることは大歓迎です。その場合は、ローカルで学習し、遅延データローディングなどのテクニックを適用する必要があるかもしれません。

ライセンス

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

モデルは huggingface.co/CuongLD/wav2vec2-large-xlsr-vietnamese で誰でも使用できます 🎉。