Fonxlsr

🚀 Wav2Vec2-Large-XLSR-53-Fon

facebook/wav2vec2-large-xlsr-53 を Fon (or Fongbe) 言語で微調整した音声認識モデルです。Fon言語の音声認識タスクに特化しています。

🚀 クイックスタート

このモデルは、Fon Dataset を使用して Fon (or Fongbe) 言語で微調整されています。モデルを使用する際には、音声入力が16kHzでサンプリングされていることを確認してください。

✨ 主な機能

• このモデルは、Fon言語の音声を文字に変換する自動音声認識タスクに最適化されています。
• 言語モデルを使用せずに直接音声認識を行うことができます。

📦 インストール

インストールに関する具体的な手順は提供されていません。必要なライブラリは transformers や torch、torchaudio、datasets などです。以下のコマンドでインストールできます。

pip install transformers torch torchaudio datasets

💻 使用例

基本的な使用法

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


#Load test_dataset from saved files in folder
from datasets import load_dataset, load_metric

#for test
for root, dirs, files in os.walk(test/):
  test_dataset= load_dataset("json", data_files=[os.path.join(root,i) for i in files],split="train")

#Remove unnecessary chars
chars_to_ignore_regex = '[\\,\\?\\.\\!\\-\\;\\:\\\"\\“\\%\\‘\\”]'
def remove_special_characters(batch):
    batch["sentence"] = re.sub(chars_to_ignore_regex, '', batch["sentence"]).lower() + " "
    return batch

test_dataset = test_dataset.map(remove_special_characters)

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

#No need for resampling because audio dataset already at 16kHz
#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"]=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():
  tlogits = 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

for root, dirs, files in os.walk(test/):
  test_dataset = load_dataset("json", data_files=[os.path.join(root,i) for i in files],split="train")

chars_to_ignore_regex = '[\\,\\?\\.\\!\\-\\;\\:\\\"\\“\\%\\‘\\”]'
    batch["sentence"] = re.sub(chars_to_ignore_regex, '', batch["sentence"]).lower() + " "
    return batch

test_dataset = test_dataset.map(remove_special_characters)
wer = load_metric("wer")

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

# 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"] = speech_array[0].numpy()
    batch["sampling_rate"] = sampling_rate
    batch["target_text"] = batch["sentence"]
    return batch

test_dataset = test_dataset.map(speech_file_to_array_fn)

#Evaluation on test dataset
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"])))

📚 ドキュメント

テスト結果

テスト結果: 14.97 %

学習について

Fon dataset は train(8235サンプル), validation(1107サンプル), test(1061サンプル) に分割されました。学習に使用されたスクリプトは こちら で確認できます。

プロジェクトの協力者

• Chris C. Emezue (Twitter)|(chris.emezue@gmail.com)
• Bonaventure F.P. Dossou (HuggingFaceユーザー名: bonadossou)|(Twitter)|(femipancrace.dossou@gmail.com)

関連プロジェクト

このプロジェクトは OkwuGbé: End-to-End Speech Recognition for Fon and Igbo の研究を継続した共同プロジェクトです。

📄 ライセンス

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

⚠️ 重要提示

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