Wav2vec2 Large Superb Ks

🚀 Wav2Vec2-Large for Keyword Spotting

このモデルは、キーワード検出（Keyword Spotting）タスクに特化したWav2Vec2-Largeモデルです。キーワード検出とは、発話を事前定義された単語のセットに分類することで、登録済みのキーワードを検出するタスクです。

🚀 クイックスタート

このモデルは、音声分類パイプラインを介して使用することができます。以下のコード例を参考にしてください。

✨ 主な機能

• キーワード検出タスクに特化したWav2Vec2-Largeモデルです。
• ベースモデルは、16kHzサンプリングの音声オーディオで事前学習された wav2vec2-large-lv60 です。
• モデルを使用する際には、音声入力も16kHzでサンプリングされていることを確認してください。

📦 インストール

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

pip install datasets transformers torchaudio

💻 使用例

基本的な使用法

from datasets import load_dataset
from transformers import pipeline

dataset = load_dataset("anton-l/superb_demo", "ks", split="test")

classifier = pipeline("audio-classification", model="superb/wav2vec2-large-superb-ks")
labels = classifier(dataset[0]["file"], top_k=5)

高度な使用法

import torch
from datasets import load_dataset
from transformers import Wav2Vec2ForSequenceClassification, Wav2Vec2FeatureExtractor
from torchaudio.sox_effects import apply_effects_file

effects = [["channels", "1"], ["rate", "16000"], ["gain", "-3.0"]]
def map_to_array(example):
    speech, _ = apply_effects_file(example["file"], effects)
    example["speech"] = speech.squeeze(0).numpy()
    return example

# load a demo dataset and read audio files
dataset = load_dataset("anton-l/superb_demo", "ks", split="test")
dataset = dataset.map(map_to_array)

model = Wav2Vec2ForSequenceClassification.from_pretrained("superb/wav2vec2-large-superb-ks")
feature_extractor = Wav2Vec2FeatureExtractor.from_pretrained("superb/wav2vec2-large-superb-ks")

# compute attention masks and normalize the waveform if needed
inputs = feature_extractor(dataset[:4]["speech"], sampling_rate=16000, padding=True, return_tensors="pt")

logits = model(**inputs).logits
predicted_ids = torch.argmax(logits, dim=-1)
labels = [model.config.id2label[_id] for _id in predicted_ids.tolist()]

📚 ドキュメント

モデルの説明

このモデルは、S3PRL's Wav2Vec2 for the SUPERB Keyword Spotting task の移植版です。ベースモデルは、16kHzサンプリングの音声オーディオで事前学習された wav2vec2-large-lv60 です。モデルを使用する際には、音声入力も16kHzでサンプリングされていることを確認してください。詳細については、SUPERB: Speech processing Universal PERformance Benchmark を参照してください。

タスクとデータセットの説明

キーワード検出（KS）は、発話を事前定義された単語のセットに分類することで、登録済みのキーワードを検出するタスクです。このタスクは、高速な応答時間が必要なため、通常はデバイス上で実行されます。したがって、精度、モデルサイズ、および推論時間はすべて重要です。SUPERBは、このタスクに広く使用されている Speech Commands dataset v1.0 を使用しています。このデータセットは、10種類のキーワードクラス、無音クラス、および誤検出を含む未知クラスで構成されています。元のモデルのトレーニングと評価の手順については、S3PRL downstream task README を参照してください。

評価結果

評価指標は精度です。

BibTeXエントリと引用情報

@article{yang2021superb,
  title={SUPERB: Speech processing Universal PERformance Benchmark},
  author={Yang, Shu-wen and Chi, Po-Han and Chuang, Yung-Sung and Lai, Cheng-I Jeff and Lakhotia, Kushal and Lin, Yist Y and Liu, Andy T and Shi, Jiatong and Chang, Xuankai and Lin, Guan-Ting and others},
  journal={arXiv preprint arXiv:2105.01051},
  year={2021}
}

📄 ライセンス

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