Wav2vec2 Large Superb Ks

🚀 Wav2Vec2-Large 用于关键词识别

本项目基于 Wav2Vec2-Large 模型实现关键词识别功能，可将语音输入分类为预定义的关键词集合，适用于需要快速响应的设备端应用。

🚀 快速开始

本模型基于 wav2vec2-large-lv60 模型，该模型在 16kHz 采样的语音音频上进行了预训练。使用模型时，请确保输入的语音也采样于 16kHz。

更多信息请参考 SUPERB: Speech processing Universal PERformance Benchmark。

✨ 主要特性

• 移植自 S3PRL 的 Wav2Vec2 用于 SUPERB 关键词识别任务。
• 基于预训练的 wav2vec2-large-lv60 模型，在 16kHz 采样的语音音频上进行训练。
• 可通过音频分类管道或直接使用模型进行关键词识别。

📦 安装指南

文档未提及具体安装步骤，故跳过此章节。

💻 使用示例

基础用法

你可以通过音频分类管道使用该模型：

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

📚 详细文档

任务和数据集描述

关键词识别（KS）通过将语音分类为预定义的单词集合来检测预注册的关键词。该任务通常在设备端执行，以实现快速响应时间。因此，准确性、模型大小和推理时间都至关重要。SUPERB 使用广泛使用的 Speech Commands 数据集 v1.0 进行该任务。该数据集由十个关键词类、一个静音类和一个未知类组成，以包含误报。

有关原始模型的训练和评估说明，请参考 S3PRL 下游任务 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 许可证。