SEW
概述
SEW（压缩高效Wav2Vec）在Felix Wu、Kwangyoun Kim、Jing Pan、Kyu Han、Kilian Q. Weinberger、Yoav Artzi撰写的语音识别无监督预训练中的性能-效率权衡中提出。
论文摘要如下：
本文研究了用于自动语音识别 (ASR) 的预训练模型中的性能-效率权衡。我们专注于wav2vec 2.0，并形式化了影响模型性能及其效率的几种架构设计。将我们所有的观察结果放在一起，我们引入了SEW（压缩高效Wav2vec），这是一种预训练模型架构，在各种训练设置中，在性能和效率方面都取得了显著改进。例如，在LibriSpeech上的100h-960h半监督设置下，与wav2vec 2.0相比，SEW实现了1.9倍的推理速度提升，同时单词错误率相对降低了13.5%。在类似的推理时间下，SEW在不同模型大小下将单词错误率降低了25%到50%。
此模型由anton-l贡献。
使用技巧
- SEW是一个语音模型，它接受一个浮点数数组，该数组对应于语音信号的原始波形。
- SEWForCTC 使用连接时序分类 (CTC) 进行微调，因此模型输出必须使用Wav2Vec2CTCTokenizer进行解码。
资源
SEWConfig
类 transformers.SEWConfig
< 源代码 >( vocab_size = 32 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 squeeze_factor = 2 hidden_act = 'gelu' hidden_dropout = 0.1 activation_dropout = 0.1 attention_dropout = 0.1 feat_proj_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 feat_extract_norm = 'group' feat_extract_activation = 'gelu' conv_dim = (64, 128, 128, 128, 128, 256, 256, 256, 256, 512, 512, 512, 512) conv_stride = (5, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1) conv_kernel = (10, 3, 1, 3, 1, 3, 1, 3, 1, 2, 1, 2, 1) conv_bias = False num_conv_pos_embeddings = 128 num_conv_pos_embedding_groups = 16 apply_spec_augment = True mask_time_prob = 0.05 mask_time_length = 10 mask_time_min_masks = 2 mask_feature_prob = 0.0 mask_feature_length = 10 mask_feature_min_masks = 0 ctc_loss_reduction = 'mean' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32) — SEW 模型的词汇量大小。定义了调用SEW时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头的数量。 - intermediate_size (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - squeeze_factor (
int，可选，默认为 2) — 编码器之后序列长度下采样因子，以及 Transformer 之后的向上采样因子。 - hidden_act (
str或function，可选，默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout (
float，可选，默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - activation_dropout (
float，可选，默认为 0.1) — 全连接层内部激活的 dropout 比率。 - attention_dropout (
float，可选，默认为 0.1) — 注意力概率的 dropout 比率。 - final_dropout (
float，可选，默认为 0.1) — SEWForCTC 的最终投影层的 dropout 概率。 - layerdrop (
float，可选，默认为 0.1) — LayerDrop 概率。有关更多详细信息，请参阅 [LayerDrop 论文](参见 https://arxiv.org/abs/1909.11556)。 - initializer_range (
float，可选，默认为 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float，可选，默认为 1e-12) — 层归一化层使用的 epsilon。 - feat_extract_norm (
str，可选，默认为"group") — 应用于特征编码器中 1D 卷积层的范数。"group"表示仅对第一个 1D 卷积层进行组归一化，"layer"表示对所有 1D 卷积层进行层归一化。 - conv_dim (
Tuple[int]或List[int], 可选, 默认为(64, 128, 128, 128, 128, 256, 256, 256, 256, 512, 512, 512, 512)) — 定义特征编码器中每个一维卷积层输入和输出通道数的整数元组。conv_dim 的长度定义了一维卷积层的数量。 - conv_stride (
Tuple[int]或List[int], 可选, 默认为(5, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1, 2, 1)) — 定义特征编码器中每个一维卷积层的步长的整数元组。conv_stride 的长度定义了卷积层的数量，并且必须与conv_dim的长度匹配。 - conv_kernel (
Tuple[int]或List[int], 可选, 默认为(10, 3, 1, 3, 1, 3, 1, 3, 1, 2, 1, 2, 1)) — 定义特征编码器中每个一维卷积层的核大小的整数元组。conv_kernel 的长度定义了卷积层的数量，并且必须与conv_dim的长度匹配。 - conv_bias (
bool, 可选, 默认为False) — 一维卷积层是否具有偏置。 - num_conv_pos_embeddings (
int, 可选, 默认为 128) — 卷积位置嵌入的数量。定义了一维卷积位置嵌入层的核大小。 - num_conv_pos_embedding_groups (
int, 可选, 默认为 16) — 一维卷积位置嵌入层的组数。 - apply_spec_augment (
bool, 可选, 默认为True) — 是否将SpecAugment数据增强应用于特征编码器的输出。有关参考，请参阅 SpecAugment：一种用于自动语音识别的简单数据增强方法。 - mask_time_prob (
float, 可选, 默认为 0.05) — 时间轴上所有特征向量将被掩蔽的百分比（介于 0 和 1 之间）。掩蔽过程在轴上生成“mask_time_problen(time_axis)/mask_time_length”个独立的掩码。如果从每个特征向量被选为要掩蔽的向量跨度的起点的概率进行推理，则mask_time_prob 应为prob_vector_startmask_time_length。请注意，重叠可能会降低被掩蔽向量的实际百分比。这仅在apply_spec_augment 为 True时相关。 - mask_time_length (
int, 可选, 默认为 10) — 时间轴上向量跨度的长度。 - mask_feature_prob (
float, 可选, 默认为 0.0) — 特征轴上所有特征向量将被掩蔽的百分比（介于 0 和 1 之间）。掩蔽过程在轴上生成“mask_feature_problen(feature_axis)/mask_time_length”个独立的掩码。如果从每个特征向量被选为要掩蔽的向量跨度的起始点的概率进行推理，则mask_feature_prob 应为 `prob_vector_startmask_feature_length`。请注意，重叠可能会降低实际掩蔽向量的百分比。这仅在 apply_spec_augment 为 True 时才相关。 - mask_feature_length (
int, 可选, 默认为 10) — 特征轴上向量跨度的长度。 - mask_feature_min_masks (
int, 可选, 默认为 0) — 每次时间步长，沿特征轴生成的长度为mask_feature_length的掩码的最小数量，与mask_feature_prob无关。仅在“mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 时才相关 - ctc_loss_reduction (
str, 可选, 默认为"sum") — 指定应用于torch.nn.CTCLoss输出的约简。仅在训练 SEWForCTC 的实例时才相关。 - ctc_zero_infinity (
bool, 可选, 默认为False) — 是否将torch.nn.CTCLoss的无限损失及其关联的梯度清零。当输入太短而无法与目标对齐时，主要会出现无限损失。仅在训练 SEWForCTC 的实例时才相关。 - use_weighted_layer_sum (
bool, 可选, 默认为False) — 是否使用具有学习权重的层输出的加权平均值。仅在使用 Wav2Vec2ForSequenceClassification 的实例时才相关。 - classifier_proj_size (
int, 可选, 默认为 256) — 分类前令牌平均池化的投影维度。
这是用于存储 SEWModel 配置的配置类。它用于根据指定的参数实例化 SEW 模型，定义模型架构。使用默认值实例化配置将产生与 SEW asapp/sew-tiny-100k 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。
示例
>>> from transformers import SEWConfig, SEWModel
>>> # Initializing a SEW asapp/sew-tiny-100k style configuration
>>> configuration = SEWConfig()
>>> # Initializing a model (with random weights) from the asapp/sew-tiny-100k style configuration
>>> model = SEWModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configSEWModel
class transformers.SEWModel
< source >( config: SEWConfig )
SEWForCTC
类 transformers.SEWForCTC
< 源代码 >( config target_lang: 可选 = None )
参数
- config (SEWConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有一个用于连接时序分类 (CTC) 的语言建模头的 SEW 模型。SEW 在 Felix Wu、Kwangyoun Kim、Jing Pan、Kyu Han、Kilian Q. Weinberger 和 Yoav Artzi 发表的论文 Performance-Efficiency Trade-offs in Unsupervised Pre-training for Speech Recognition 中被提出。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
前向传播
< 源代码 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型的数组中来获取值，例如通过 soundfile 库 (pip install soundfile)。为了将数组准备成input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行卷积和注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor形状为(batch_size, target_length), 可选) — 连接时序分类的标签。请注意，target_length必须小于或等于输出 logits 的序列长度。索引选择在[-100, 0, ..., config.vocab_size - 1]中。所有设置为-100的标签都将被忽略（掩码），损失仅针对[0, ..., config.vocab_size - 1]中的标签计算。
返回值
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutput 或一个torch.FloatTensor元组（如果传递了return_dict=False或当config.return_dict=False时），包含根据配置(SEWConfig)和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每一层的输出）形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
SEWForCTC 的前向方法覆盖了__call__特殊方法。
尽管前向传递的步骤需要在此函数中定义，但之后应该调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoProcessor, SEWForCTC
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("asapp/sew-tiny-100k-ft-ls100h")
>>> model = SEWForCTC.from_pretrained("asapp/sew-tiny-100k-ft-ls100h")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
'MISTER QUILTER IS THE APPOSTILE OF THE MIDDLE CLASSES AND WE ARE GLAD TO WELCOME HIS GOSPOLLE'
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
0.42