转换器文档

Wav2Vec2-Conformer

Hugging Face's logo
加入Hugging Face社区

并获得增强的文档体验

开始使用

Wav2Vec2-Conformer

概述

Wav2Vec2-Conformer被添加到由Changhan Wang, Yun Tang, Xutai Ma, Anne Wu, Sravya Popuri, Dmytro Okhonko, Juan Pino在fairseq S2T: Fast Speech-to-Text Modeling with fairseq提供的更新版本的文档中。

模型的官方结果可以在论文的第3表和第4表中找到。

Wav2Vec2-Conformer 权重由 Meta AI 团队发布于 Fairseq 库 中。

此模型由 patrickvonplaten 捐献。原始代码可在 此处 找到。

注意:Meta (FAIR) 发布了 Wav2Vec2-BERT 2.0 的新版本,该版本在 4.5M 小时的音频上进行了预训练。我们特别推荐用于微调任务,例如按照 此指南

使用技巧

  • Wav2Vec2-Conformer 按照与 Wav2Vec2 相同的架构设计,但将 Attention 模块替换为由 Conformer: Convolution-augmented Transformer for Speech Recognition 引入的 Conformer 模块。
  • 对于相同数量的层,Wav2Vec2-Conformer 需要更多的参数,但也能提供更低的词错误率。
  • Wav2Vec2-Conformer 使用与 Wav2Vec2 相同的分词器和特征提取器。
  • 通过设置正确的 config.position_embeddings_type,Wav2Vec2-Conformer 可以使用无相对位置编码、Transformer-XL 类似的位置编码或旋转位置编码。

资源

Wav2Vec2ConformerConfig

class transformers.Wav2Vec2ConformerConfig

< >

( vocab_size = None hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout = 0.1 activation_dropout = 0.1 attention_dropout = 0.1 feat_proj_dropout = 0.0 feat_quantizer_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 = (512, 512, 512, 512, 512, 512, 512) conv_stride = (5, 2, 2, 2, 2, 2, 2) conv_kernel = (10, 3, 3, 3, 3, 2, 2) 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 num_codevectors_per_group = 320 num_codevector_groups = 2 contrastive_logits_temperature = 0.1 num_negatives = 100 codevector_dim = 256 proj_codevector_dim = 256 diversity_loss_weight = 0.1 ctc_loss_reduction = 'sum' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 tdnn_dim = (512, 512, 512, 512, 1500) tdnn_kernel = (5, 3, 3, 1, 1) tdnn_dilation = (1, 2, 3, 1, 1) xvector_output_dim = 512 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 add_adapter = False adapter_kernel_size = 3 adapter_stride = 2 num_adapter_layers = 3 output_hidden_size = None position_embeddings_type = 'relative' rotary_embedding_base = 10000 max_source_positions = 5000 conv_depthwise_kernel_size = 31 conformer_conv_dropout = 0.1 **kwargs )

参数

  • vocab_size (int, 可选) — Wav2Vec2Conformer模型的词汇大小。定义了可以通过调用Wav2Vec2ConformerModel时的 inputs_ids 表示的不同令牌的数量。该模型的词汇大小,定义了传递给Wav2Vec2ConformerModel向前方法时的不同令牌的数量。
  • hidden_size (int, 可选,默认为768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为12) — Transformer编码器中隐藏层的数量。
  • num_attention_heads (int, 可选, 默认为12) — Transformer编码器中每个注意力层注意力头数。
  • intermediate_size (int, 可选, 默认为3072) — Transformer编码器中“中间”(即前馈)层的大小。
  • hidden_act (strfunction,可选,默认为 "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_dropoutfloat,可选,默认为0.1)— Wav2Vec2ConformerForCTC的最终投影层的dropout概率。[更多关于Wav2Vec2ConformerForCTC](/docs/transformers/v4.44.0/zh-cn/model_doc/wav2vec2-conformer#transformers.Wav2Vec2ConformerForCTC)。
  • layerdropfloat,可选,默认为0.1)— LayerDrop概率。详见[LayerDrop论文](https://arxiv.org/abs/1909.11556)。
  • initializer_rangefloat,可选,默认为0.02)— 用于初始化所有权重矩阵的truncated_normal_initializer的标准差。
  • layer_norm_eps (float, 可选, 默认 1e-12) — 层归一化层使用的epsilon。
  • feat_extract_norm (str, 可选, 默认为 "group") — 应用在特征编码器中1D卷积层的归一化方式。可以是"group"用于只对第一个1D卷积层进行组归一化,或"layer"用于所有1D卷积层进行层归一化。
  • feat_proj_dropout (float, 可选, 默认 0.0) — 特征编码器输出的dropout概率。
  • feat_extract_activation (str, 可选,默认为 "gelu") -- 特征提取器一维卷积层的非线性激活函数(函数或字符串)。如果为字符串,支持"gelu""relu""selu""gelu_new"
  • feat_quantizer_dropout (float, 可选,默认为 0.0) — 量化特征编码器状态的dropout概率。
  • conv_dim (整数元组整数列表,可选,默认为 (512, 512, 512, 512, 512, 512, 512)) — 定义特征编码器每个一维卷积层的输入和输出通道数的整数元组。conv_dim的长度定义了一维卷积层数量。
  • conv_stride(《元组[int]”或“列表[int]”, 可选,默认为(5, 2, 2, 2, 2, 2, 2))——定义特征编码器中每个1D卷积层步长的整数元组。conv_stride的长度定义了卷积层的数量,必须与conv_dim的长度匹配。
  • conv_kernel(《元组[int]”或“列表[int]”, 可选,默认为(10, 3, 3, 3, 3, 3, 3))——定义特征编码器中每个1D卷积层的核大小。conv_kernel的长度定义了卷积层的数量,并且必须与conv_dim的长度匹配。
  • conv_bias(《布尔型”,可选,默认为False)——判断1D卷积层是否包含偏置。
  • num_conv_pos_embeddings (int, 可选,默认为 128) — 卷积位置嵌入的数量。定义 1D 卷积位置嵌入层的核大小。
  • num_conv_pos_embedding_groups (int, 可选,默认为 16) — 1D 卷积位置嵌入层的组数。
  • apply_spec_augment (bool, 可选,默认为 True) — 是否将 SpecAugment 数据增强应用于特征编码器的输出。有关参考,请参阅 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition
  • mask_time_prob (float, 可选,默认为0.05) — 在时间轴上的所有特征向量中将被掩码的比例(介于0和1之间)。掩码过程在该轴上生成 “mask_time_prob * len(time_axis) / mask_time_length” 个独立的掩码。如果从每个特征向量被选为掩码向量范围的起始向量的概率推断,则 mask_time_prob 应为 `prob_vector_start * mask_time_length`。请注意,重叠可能会降低掩码向量的实际百分比。这仅在 apply_spec_augment 为 True 时相关。
  • mask_time_length (int, 可选,默认为10) — 时间轴上向量跨度长度。
  • mask_time_min_masks (int, 可选,默认为2) — 在时间轴上生成的长度为 mask_feature_length 的掩码的最小数量。每次时间步,无论 mask_feature_prob 如何。仅在 “mask_time_prob * len(time_axis) / mask_time_length < mask_time_min_masks” 时相关。
  • mask_feature_prob (float, 可选, 默认为 0.0) — 所有特征向量的特征轴上被掩蔽的比例(介于 0 和 1 之间)。掩蔽过程在轴上生成 “mask_feature_problen(feature_axis)/mask_time_length” 个独立的掩蔽。如果从每个特征向量被选为要掩蔽的向量区间的起始概率进行推理,则 mask_feature_prob 应为 `prob_vector_start*mask_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” 时相关。
  • num_codevectors_per_group (int, 可选, 默认为 320) — 每个量化代码本(组)中的条目数。
  • num_codevector_groups (int, 可选, 默认为 2) — 产品代码向量量化中的代码向量组数。
  • contrastive_logits_temperature (float, 可选, 默认为 0.1) — 对比损失中的温度 kappa
  • feat_quantizer_dropout (float, 可选,默认为0.0) — 用于量化器输出的特征编码器输出dropout概率。
  • num_negatives (int, 可选,默认为100) — 对比损失的负面样例数量。
  • codevector_dim (int, 可选,默认为256) — 量化特征向量的维度。
  • proj_codevector_dim (int, 可选,默认为256) — 量化和transformer特征最终投影的维度。
  • diversity_loss_weight (int, 可选,默认为0.1) — 代码本多样性损失组件的权重。
  • ctc_loss_reduction (str, 可选,默认为"sum") — 指定应用于torch.nn.CTCLoss输出的裁剪方式。仅在训练Wav2Vec2ConformerForCTC实例时相关。
  • ctc_zero_infinity (bool, 可选,默认为False) — 是否将无限损失和与之相关的torch.nn.CTCLoss的梯度设为零。无限损失主要发生在输入太短无法对齐目标时。仅在训练Wav2Vec2ConformerForCTC实例时相关。
  • use_weighted_layer_sum (布尔值, 可选, 默认为 False) — 表示是否使用具有学习权重的层输出加权平均。仅在使用 Wav2Vec2ConformerForSequenceClassification 的实例时相关。
  • classifier_proj_size (整数, 可选, 默认为 256) — 在对分类进行标记均值池化之前,投影维度的大小。
  • tdnn_dim (整数元组整数列表, 可选, 默认为 (512, 512, 512, 512, 1500)) — 定义 XVector 模型中 TDNN 模块的每个 1D 卷积层的输出通道数。tdnn_dim 的长度定义了 TDNN 层数的数量。
  • tdnn_kernelTuple[int]List[int]可选,默认为 (5, 3, 3, 1, 1)) —— 定义 XVector 模型中 TDNN 模块的每一层 1D 卷积核大小的整数元组。tdnn_kernel 的长度必须与 tdnn_dim 的长度相匹配。
  • tdnn_dilationTuple[int]List[int]可选,默认为 (1, 2, 3, 1, 1)) —— 定义 XVector 模型中 TDNN 模块的每一层 1D 卷积层膨胀率的整数元组。tdnn_dilation 的长度必须与 tdnn_dim 的长度相匹配。
  • xvector_output_dimint可选,默认为 512) —— XVector 嵌入向量的维数。
  • add_adapter (bool, 可选, 默认为 False) — 是否应在 Wav2Vec2Conformer 编码器之上堆叠卷积网络。对于为 SpeechEncoderDecoder 模型启动 Wav2Vec2Conformer 非常有用。
  • adapter_kernel_size (int, 可选, 默认为 3) — 适配器网络中卷积层的内核大小。只有当 add_adapter 为 True 时才相关。
  • adapter_stride (int, 可选, 默认为 2) — 适配器网络中卷积层的步长。只有当 add_adapter 为 True 时才相关。
  • num_adapter_layers (int, 可选, 默认为 3) — 适配器网络应使用的卷积层数量。只有当 add_adapter is True 时才相关。
  • output_hidden_size (int, 可选) — 编码器输出层的维度。如果未定义,则默认为 hidden-size。只有当 add_adapter is True 时才相关。
  • position_embeddings_type (str, 可选, 默认为 "relative") — 可以指定为 relativerotary 以分别使用相对或旋转位置嵌入。如果留为 None,则不应用相对位置嵌入。
  • rotary_embedding_base (int, 可选,默认为10000) — 如果使用"rotary"位置嵌入,定义嵌入基的大小。
  • max_source_positions (int, 可选,默认为5000) — 如果使用"relative"位置嵌入,定义最大源输入位置。
  • conv_depthwise_kernel_size (int, 可选,默认为31) — Conformer块中卷积深度可分离1D层的核大小。
  • conformer_conv_dropoutfloat可选,默认为0.1)— Conformer块中所有卷积层的dropout概率。

这是一个存储Wav2Vec2Conformer模型配置的配置类。它用于根据指定的参数实例化Wav2Vec2Conformer模型,定义模型架构。使用默认值实例化配置将得到类似于Wav2Vec2Conformer facebook/wav2vec2-conformer-rel-pos-large架构的配置。

配置对象继承自PretrainedConfig,可用于控制模型输出。更多信息请参考PretrainedConfig文档。

示例

>>> from transformers import Wav2Vec2ConformerConfig, Wav2Vec2ConformerModel

>>> # Initializing a Wav2Vec2Conformer facebook/wav2vec2-conformer-rel-pos-large style configuration
>>> configuration = Wav2Vec2ConformerConfig()

>>> # Initializing a model (with random weights) from the facebook/wav2vec2-conformer-rel-pos-large style configuration
>>> model = Wav2Vec2ConformerModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

Wav2Vec2Conformer特定输出

transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput

< >

( loss: 可选 = None projected_states: FloatTensor = None projected_quantized_states: FloatTensor = None codevector_perplexity: FloatTensor = None hidden_states: 可选 = None attentions: 可选 = None contrastive_loss: 可选 = None diversity_loss: 可选 = None )

参数

  • loss (可选,在传递 sample_negative_indices 时返回,形状为 (1,)torch.FloatTensor ) — 如论文 《官方论文》 中所述,总损失是对比损失 (L_m) 和多样性损失 (L_d) 的和。 (分类) 损失。
  • projected_states (torch.FloatTensor of shape (batch_size, sequence_length, config.proj_codevector_dim)) — 由模型投影到 config.proj_codevector_dim 的隐藏状态,可用于预测掩码投影量化状态。
  • projected_quantized_states (torch.FloatTensor of shape (batch_size, sequence_length, config.proj_codevector_dim)) — 抽取的特征向量的量化和投影到 config.proj_codevector_dim,代表对比损失的正目标向量。
  • hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — torch.FloatTensor 元组(一个用于嵌入输出,一个用于每个层级的输出)的形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层级的输出及初始嵌入输出的隐藏状态。

  • attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=Trueconfig.output_attentions=True 时返回) — 一个形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组(每个层一个)。
  • contrastive_loss (可选, 当传入 sample_negative_indices 时返回, torch.FloatTensor shape (1,)) — 在 官方论文 中所述的对比损失 (L_m)。
  • diversity_loss (可选, 当传入 sample_negative_indices 时返回, torch.FloatTensor shape (1,)) — 在 官方论文 中所述的多样性损失 (L_d)。

Wav2Vec2ConformerForPreTraining 的输出类型,可能包含隐藏状态和注意力。

Wav2Vec2ConformerModel

transformers.Wav2Vec2ConformerModel

< >

( config: Wav2Vec2ConformerConfig )

参数

  • config (Wav2Vec2ConformerConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化不会加载模型参数,只加载配置。查看 from_pretrained() 方法以加载模型权重。

裸Wav2Vec2Conformer模型,输出原始隐藏状态,顶部没有特定的头部。Wav2Vec2Conformer由Alexei Baevski、Henry Zhou、Abdelrahman Mohamed和Michael Auli在wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations一文中提出。

此模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用的方法(例如下载或保存等)。

此模型是 PyTorch nn.Module 子类。将其作为常规 PyTorch 模块使用,有关通用用法和行为的相关内容,请参阅 PyTorch 文档。

forward

< >

( input_values: 可选 attention_mask: 可选 = None mask_time_indices: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.Wav2Vec2BaseModelOutputtuple(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.调用()
  • attention_mask (形状为 (batch_size, sequence_length)torch.LongTensor,可选项) — 用于避免对填充标记索引执行卷积和注意力操作的掩码。掩码值选择范围为 [0, 1]

    • 1 表示 未掩码 的标记,
    • 0 表示 已掩码 的标记。

    什么是注意力掩码?

    仅当相应处理器具有 config.return_attention_mask == True 时才应传递 attention_mask。对于处理器具有 config.return_attention_mask == False 的所有模型,例如 wav2vec2-conformer-rel-pos-large,应 传递 attention_mask 以避免批推理时性能下降。对于此类模型,应仅用 0 填充 input_values 并不传递 attention_mask。请注意,这些模型在 input_values 是否填充的情况下也会产生略微不同的结果。

  • output_attentions (布尔值,可选项) — 是否返回所有注意力层的注意力张量。有关下文返回的各个张量中 attentions 的详细信息,请参阅相关内容。
  • output_hidden_states (布尔值,可选项) — 是否返回所有层的隐藏状态。有关下文返回的各个张量中 hidden_states 的详细信息,请参阅相关内容。
  • return_dict (bool, optional) — 是否返回ModelOutput而不是普通的元组。

返回值

transformers.modeling_outputs.Wav2Vec2BaseModelOutput或者tuple(torch.FloatTensor)

结果为transformers.modeling_outputs.Wav2Vec2BaseModelOutput或者一个由torch.FloatTensor组成的元组(如果传递return_dict=False或当config.return_dict=False时),包含基于配置(例如Wav2Vec2ConformerConfig)和输入的各种元素。

  • last_hidden_state (torch.FloatTensor shape (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的序列隐藏状态。

  • extract_features (torch.FloatTensor shape (batch_size, sequence_length, conv_dim[-1])) — 模型最后一卷积层的序列提取特征向量。

  • hidden_states (tuple(torch.FloatTensor), optional,当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个由torch.FloatTensor组成的元组(包括嵌入输出的输出和每一层的输出),shape为(batch_size, sequence_length, hidden_size)

    模型每一层输出的隐藏状态以及初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional,当传递output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor的元组(shape为(batch_size, num_heads, sequence_length, sequence_length))。

    在注意力softmax之后的注意力权重,用于在自我注意力头部计算加权平均值。

Wav2Vec2ConformerModel的前向方法覆盖了特殊方法__call__

虽然前向传递的公式需要定义在此函数中,但应该调用Module实例之后,而不是这个,因为前者在运行前处理和后处理步骤时会照顾好这些,而后者悄无声息地忽略了它们。

示例

>>> from transformers import AutoProcessor, Wav2Vec2ConformerModel
>>> import torch
>>> from datasets import load_dataset

>>> 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("facebook/wav2vec2-conformer-rope-large-960h-ft")
>>> model = Wav2Vec2ConformerModel.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")

>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 292, 1024]

Wav2Vec2ConformerForCTC

transformers.Wav2Vec2ConformerForCTC

< >

( config target_lang: Optional = None )

参数

  • config (Wav2Vec2ConformerConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只加载配置。查看 from_pretrained() 方法来加载模型权重。

在连接主义时序分类(CTC)顶部附加了 语言模型 头的 Wav2Vec2Conformer 模型。Wav2Vec2Conformer 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed 和 Michael Auli 在wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations一文中提出。

此模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用的方法(例如下载或保存等)。

此模型是 PyTorch nn.Module 子类。将其作为常规 PyTorch 模块使用,有关通用用法和行为的相关内容,请参阅 PyTorch 文档。

forward

< >

( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) transformers.modeling_outputs.CausalLMOutputtuple(torch.FloatTensor)

参数

  • input_values (torch.FloatTensor of shape (batch_size, sequence_length)) — 输入原始语音波形的高斯值。值可以通过将.flac或.wav音频文件的加载到类型为List[float]或numpy.ndarray的数组中获取,例如通过soundfile库(pip install soundfile)。要为input_values准备数组,应使用AutoProcessor进行填充和转换成类型为torch.FloatTensor的tensor。有关详细信息,请参阅Wav2Vec2Processor.call()
  • attention_mask (可选,torch.LongTensor 形状为(batch_size, sequence_length),类型)— 用于避免对填充标记索引执行卷积和注意力的掩码。掩码值选在[0, 1]之间:
    • 1对于未掩码的标记,
    • 0对于已掩码的标记。

    什么是注意力掩码?

    attention_mask 只应传递给相应处理器有 config.return_attention_mask == True 的情况。对于所有处理器有 config.return_attention_mask == False 的模型,例如 wav2vec2-conformer-rel-pos-largeattention_mask 应该不传递,以避免批量推理时性能下降。对于此类模型input_values应该简单填充0并传递,不传递attention_mask。注意,这些模型的结果也会根据input_values是否被填充而略有不同。

  • output_attentions (可选,bool)— 是否返回所有注意力层的注意量张量。更多详情请参阅返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。
  • labels (torch.LongTensor 形状为 (batch_size, target_length), 可选) — 连接时序分类的标签。请注意,target_length 必须小于或等于输出 tokens 的序列长度。索引从 [-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=Falseconfig.return_dict=False),包含各种元素,具体取决于配置(Wav2Vec2ConformerConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,), 可选,当提供 labels 时返回) — 语言建模损失(用于 next-token 预测)。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词汇分数)。

  • hidden_states (可选的,torch.FloatTensor 元组,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 元组,包含 torch.FloatTensor,用于嵌入输出的(如果模型有嵌入层)和每个层输出的状态,形状为 (batch_size, sequence_length, hidden_size)

    在每个层输出的模型中的隐藏状态,加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional,当传递output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor的元组(shape为(batch_size, num_heads, sequence_length, sequence_length))。

    在注意力softmax之后的注意力权重,用于在自我注意力头部计算加权平均值。

Wav2Vec2ConformerForCTC 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的公式需要定义在此函数中,但应该调用Module实例之后,而不是这个,因为前者在运行前处理和后处理步骤时会照顾好这些,而后者悄无声息地忽略了它们。

示例

>>> from transformers import AutoProcessor, Wav2Vec2ConformerForCTC
>>> 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("facebook/wav2vec2-conformer-rope-large-960h-ft")
>>> model = Wav2Vec2ConformerForCTC.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")

>>> # 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 APOSTLE OF THE MIDDLE CLASSES AND WE ARE GLAD TO WELCOME HIS GOSPEL'

>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids

>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
64.21

Wav2Vec2ConformerForSequenceClassification

transformers.Wav2Vec2ConformerForSequenceClassification

< >

( config )

参数

  • config (Wav2Vec2ConformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重,只有配置。请查看from_pretrained() 方法以加载模型权重。

序列分类头(在池化输出上的线性层)顶在Wav2Vec2Conformer模型上,用于如SUPERB关键字检测等任务。

Wav2Vec2Conformer由Alexei Baevski、Henry Zhou、Abdelrahman Mohamed和Michael Auli在wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations中提出。

此模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用的方法(例如下载或保存等)。

此模型是 PyTorch nn.Module 子类。将其作为常规 PyTorch 模块使用,有关通用用法和行为的相关内容,请参阅 PyTorch 文档。

forward

< >

input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None transformers.modeling_outputs.SequenceClassifierOutputtuple(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)可选) — 用于避免对填充标记索引执行卷积和注意力的掩码。选定的掩码值为:

    • 1 表示 未掩码 的标记,
    • 0 表示 掩码 的标记。

    什么是注意力掩码?

    attention_mask 应仅在相应的处理器有 config.return_attention_mask == True 时传递。对于所有处理器没有 config.return_attention_mask == False 的模型,例如 wav2vec2-conformer-rel-pos-large,在批处理推理时不要传递 attention_mask 以避免性能下降。对于此类模型,只需将 input_values 填充为 0 并传递,无需传递 attention_mask。请注意,这些模型的输出结果也略取决于 input_values 是否填充。

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多细节,请参阅返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多细节,请参阅返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size,)可选 ) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回值

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组(如果 return_dict=False 被传递或当 config.return_dict=False 时),包含各种元素,这些元素取决于配置(Wav2Vec2ConformerConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 分类(如果 config.num_labels==1 则为回归)损失。

  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels) ) — 分类(如果 config.num_labels==1 则为回归)得分(在 SoftMax 之前)。

  • hidden_states (可选的,torch.FloatTensor 元组,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 元组,包含 torch.FloatTensor,用于嵌入输出的(如果模型有嵌入层)和每个层输出的状态,形状为 (batch_size, sequence_length, hidden_size)

    在每个层输出的模型中的隐藏状态,加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional,当传递output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor的元组(shape为(batch_size, num_heads, sequence_length, sequence_length))。

    在注意力softmax之后的注意力权重,用于在自我注意力头部计算加权平均值。

Wav2Vec2ConformerForSequenceClassification 的 forward 方法,重写了 __call__ 特殊方法。

虽然前向传递的公式需要定义在此函数中,但应该调用Module实例之后,而不是这个,因为前者在运行前处理和后处理步骤时会照顾好这些,而后者悄无声息地忽略了它们。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForSequenceClassification
>>> 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

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")

>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_ids = torch.argmax(logits, dim=-1).item()
>>> predicted_label = model.config.id2label[predicted_class_ids]

>>> # compute loss - target_label is e.g. "down"
>>> target_label = model.config.id2label[0]
>>> inputs["labels"] = torch.tensor([model.config.label2id[target_label]])
>>> loss = model(**inputs).loss

Wav2Vec2ConformerForAudioFrameClassification

class transformers.Wav2Vec2ConformerForAudioFrameClassification

< >

( config )

参数

  • config (Wav2Vec2ConformerConfig) —— 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请参见 from_pretrained() 方法以加载模型权重。

Wav2Vec2Conformer 模型带有顶部帧分类头,适用于发言者分离等任务。

Wav2Vec2Conformer由Alexei Baevski、Henry Zhou、Abdelrahman Mohamed和Michael Auli在wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations中提出。

此模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用的方法(例如下载或保存等)。

此模型是 PyTorch nn.Module 子类。将其作为常规 PyTorch 模块使用,有关通用用法和行为的相关内容,请参阅 PyTorch 文档。

forward

< >

( input_values: Optional attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

参数

  • input_values (torch.FloatTensor 结构的 shape (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。可以通过将 .flac.wav 音频文件加载到类型为 List[float]numpy.ndarray 的数组中,例如通过 soundfile 库(pip install soundfile)来获得值。要将数组准备成 input_values,应使用 AutoProcessor 进行填充并将其转换为类型为 torch.FloatTensor 的张量。有关详细信息,请参见 Wav2Vec2Processor.call()
  • attention_masktorch.LongTensor 形状为 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行卷积和注意力计算的掩码。掩码值选择在 [0, 1] 范围内:《p

    • 1 代表 未掩码 的标记;
    • 0 代表 掩码 的标记。

    什么是注意力掩码?

    attention_mask 仅当对应的处理器具有 config.return_attention_mask == True 时才需要传递。对于所有处理器为 config.return_attention_mask == False 的模型,如 wav2vec2-conformer-rel-pos-largeattention_mask 应该不传递,以免在批量推理时性能降低。对于此类模型,应直接将 input_values 用 0 填充,并传递而无需 attention_mask。请注意,这些模型的结果也略微不同,具体取决于 input_values 是否填充。

  • output_attentionsbool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (类型: bool可选)- 是否返回所有层的隐藏状态。有关返回的张量中hidden_states的详细信息,请参阅。
  • return_dict (类型: bool可选)- 是否返回一个 ModelOutput 而不是普通的元组。
  • labels (类型: torch.LongTensor,形状 (batch_size,可选)- 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 区间内。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵损失)。

返回值

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),它根据配置(Wav2Vec2ConformerConfig)和输入包含各种元素。

  • loss (类型: torch.FloatTensor,形状 (1,)可选,在提供 labels 时返回)- 分类损失。

  • logits (torch.FloatTensor 的形状为 (batch_size, sequence_length, config.num_labels)) — 分类得分数(SoftMax 之前)。

  • hidden_states (可选的,torch.FloatTensor 元组,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 元组,包含 torch.FloatTensor,用于嵌入输出的(如果模型有嵌入层)和每个层输出的状态,形状为 (batch_size, sequence_length, hidden_size)

    在每个层输出的模型中的隐藏状态,加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional,当传递output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor的元组(shape为(batch_size, num_heads, sequence_length, sequence_length))。

    在注意力softmax之后的注意力权重,用于在自我注意力头部计算加权平均值。

Wav2Vec2ConformerForAudioFrameClassification 前向方法重写了 __call__ 特殊方法。

虽然前向传递的公式需要定义在此函数中,但应该调用Module实例之后,而不是这个,因为前者在运行前处理和后处理步骤时会照顾好这些,而后者悄无声息地忽略了它们。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForAudioFrameClassification
>>> 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

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")
>>> model = Wav2Vec2ConformerForAudioFrameClassification.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")

>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], return_tensors="pt", sampling_rate=sampling_rate)
>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> probabilities = torch.sigmoid(logits[0])
>>> # labels is a one-hot array of shape (num_frames, num_speakers)
>>> labels = (probabilities > 0.5).long()

Wav2Vec2ConformerForXVector

transformers.Wav2Vec2ConformerForXVector

< >

( config )

参数

  • config (Wav2Vec2ConformerConfig) — 包含模型所有参数的模型配置类。通过配置文件初始化不会加载与模型关联的权重,只加载配置。请查看 from_pretrained() 方法以加载数据集权重。

Wav2Vec2Conformer 模型顶部有一个 XVector 特征提取头,用于演讲者验证等任务。

Wav2Vec2Conformer由Alexei Baevski、Henry Zhou、Abdelrahman Mohamed和Michael Auli在wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations中提出。

此模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用的方法(例如下载或保存等)。

此模型是 PyTorch nn.Module 子类。将其作为常规 PyTorch 模块使用,有关通用用法和行为的相关内容,请参阅 PyTorch 文档。

forward

< >

( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) transformers.modeling_outputs.XVectorOutputtuple(torch.FloatTensor)

参数

  • input_values (torch.FloatTensor of shape (batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将 .flac.wav 音频文件加载到一个类型为 List[float]numpy.ndarray 的数组中来获得,例如使用 soundfile 库(pip install soundfile)。要将数组准备为 input_values,应使用 AutoProcessor 进行填充并转换为类型为 torch.FloatTensor 的张量。有关详细信息,请参阅 Wav2Vec2Processor.call()(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,)可选)—— 用于计算序列分类/回归损失的标签。索引应该在[0, ..., config.num_labels - 1]的范围内。如果config.num_labels == 1,则计算回归损失(均方损失),如果config.num_labels > 1,则计算分类损失(交叉熵)。

返回值

transformers.modeling_outputs.XVectorOutput或tuple(torch.FloatTensor)

A transformers.modeling_outputs.XVectorOutput或一个包含代码torch.FloatTensor的元组(若传递了return_dict=Falseconfig.return_dict=False时),其包含的元素取决于配置(Wav2Vec2ConformerConfig)和输入。

  • loss (类型: torch.FloatTensor,形状 (1,)可选,在提供 labels 时返回)- 分类损失。

  • logits (torch.FloatTensor,形状为(batch_size, config.xvector_output_dim))—— 在AMSoftmax之前的前馈隐藏状态。

  • embeddings (torch.FloatTensor,形状为(batch_size, config.xvector_output_dim))—— 构建用于向量相似性检索的词元嵌入。

  • hidden_states (tuple(torch.FloatTensor), optional,当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个由torch.FloatTensor组成的元组(包括嵌入输出的输出和每一层的输出),shape为(batch_size, sequence_length, hidden_size)

    模型每一层输出的隐藏状态以及初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional,当传递output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor的元组(shape为(batch_size, num_heads, sequence_length, sequence_length))。

    在注意力softmax之后的注意力权重,用于在自我注意力头部计算加权平均值。

The Wav2Vec2ConformerForXVector forward 方法覆盖了特殊方法 __call__。

虽然前向传递的公式需要定义在此函数中,但应该调用Module实例之后,而不是这个,因为前者在运行前处理和后处理步骤时会照顾好这些,而后者悄无声息地忽略了它们。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForXVector
>>> 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

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")
>>> model = Wav2Vec2ConformerForXVector.from_pretrained("facebook/wav2vec2-conformer-rope-large-960h-ft")

>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(
...     [d["array"] for d in dataset[:2]["audio"]], sampling_rate=sampling_rate, return_tensors="pt", padding=True
... )
>>> with torch.no_grad():
...     embeddings = model(**inputs).embeddings

>>> embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()

>>> # the resulting embeddings can be used for cosine similarity-based retrieval
>>> cosine_sim = torch.nn.CosineSimilarity(dim=-1)
>>> similarity = cosine_sim(embeddings[0], embeddings[1])
>>> threshold = 0.7  # the optimal threshold is dataset-dependent
>>> if similarity < threshold:
...     print("Speakers are not the same!")

Wav2Vec2ConformerForPreTraining

class transformers.Wav2Vec2ConformerForPreTraining

< >

( config: Wav2Vec2ConformerConfig )

参数

  • 配置 (Wav2Vec2ConformerConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只加载配置。查看from_pretrained()方法加载数据模型权重。

Wav2Vec2Conformer模型,顶部具有量化器《code>VQ头。Wav2Vec2Conformer由Alexei Baevski,Henry Zhou,Abdelrahman Mohamed和Michael Auli在《wav2vec 2.0: 一种用于自监督学习语音表示的框架》中提出,文章编号

此模型继承自PreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用的方法(例如下载或保存等)。

此模型是 PyTorch nn.Module 子类。将其作为常规 PyTorch 模块使用,有关通用用法和行为的相关内容,请参阅 PyTorch 文档。

forward

< >

( input_values: 可选 attention_mask: 可选 = None mask_time_indices: 可选 = None sampled_negative_indices: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutputtuple(torch.FloatTensor)

参数

  • input_values (shape=(batch_size, sequence_length) 的 torch.FloatTensor) — 输入原始语音波形的浮点值。可以由将 .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 而不是普通元组。
  • mask_time_indices (torch.BoolTensor,形状为 (batch_size, sequence_length)可选) — 用于对比损失的提取特征的掩码索引。在训练模式下,模型学习在 config.proj_codevector_dim 空间中预测掩码提取的特征。
  • sampled_negative_indices (torch.BoolTensor,形状为 (batch_size, sequence_length, num_negatives)可选) — 表示在对比损失中使用哪些量化目标向量作为负采样向量的索引。预训练所需的输入。

返回值

transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutputtuple(torch.FloatTensor)

transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或是一个 torch.FloatTensor 的元组(如果通过 return_dict=False 或当 config.return_dict=False 传递时),根据配置(Wav2Vec2ConformerConfig)和输入包括不同的元素。

  • loss (可选,当传递 sample_negative_indices 时返回,形状为 (1,)torch.FloatTensor) — 总损失是对比损失(L_m)和多样性损失(L_d)的和,如官方论文 中所述。(分类)损失。

  • projected_states (形状为 (batch_size, sequence_length, config.proj_codevector_dim)torch.FloatTensor) — 将模型的隐藏状态投影到 config.proj_codevector_dim,可用于预测被掩码的投影量化状态。

  • projected_quantized_states (形状为 (batch_size, sequence_length, config.proj_codevector_dim)torch.FloatTensor) — 量化提取的特征向量投影到 config.proj_codevector_dim,代表对比损失的正面目标向量。

  • hidden_states (tuple(torch.FloatTensor), optional,当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 一个由torch.FloatTensor组成的元组(包括嵌入输出的输出和每一层的输出),shape为(batch_size, sequence_length, hidden_size)

    模型每一层输出的隐藏状态以及初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional,当传递output_attentions=True或当config.output_attentions=True时返回) — 包含每个层的torch.FloatTensor的元组(shape为(batch_size, num_heads, sequence_length, sequence_length))。

    在注意力softmax之后的注意力权重,用于在自我注意力头部计算加权平均值。

  • contrastive_loss可选,当传递 sample_negative_indices 时返回,形状为 (1,)torch.FloatTensor) — 正如论文中所述的对比损失(L_m)。

  • diversity_loss可选,当传递 sample_negative_indices 时返回,形状为 (1,)torch.FloatTensor) — 正如论文中所述的多样性损失(L_d)。

Wav2Vec2ConformerForPreTraining 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的公式需要定义在此函数中,但应该调用Module实例之后,而不是这个,因为前者在运行前处理和后处理步骤时会照顾好这些,而后者悄无声息地忽略了它们。

示例

>>> import torch
>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForPreTraining
>>> from transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer import _compute_mask_indices, _sample_negative_indices
>>> from datasets import load_dataset

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForPreTraining.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> input_values = feature_extractor(ds[0]["audio"]["array"], return_tensors="pt").input_values  # Batch size 1

>>> # compute masked indices
>>> batch_size, raw_sequence_length = input_values.shape
>>> sequence_length = model._get_feat_extract_output_lengths(raw_sequence_length).item()
>>> mask_time_indices = _compute_mask_indices(
...     shape=(batch_size, sequence_length), mask_prob=0.2, mask_length=2
... )
>>> sampled_negative_indices = _sample_negative_indices(
...     features_shape=(batch_size, sequence_length),
...     num_negatives=model.config.num_negatives,
...     mask_time_indices=mask_time_indices,
... )
>>> mask_time_indices = torch.tensor(data=mask_time_indices, device=input_values.device, dtype=torch.long)
>>> sampled_negative_indices = torch.tensor(
...     data=sampled_negative_indices, device=input_values.device, dtype=torch.long
... )

>>> with torch.no_grad():
...     outputs = model(input_values, mask_time_indices=mask_time_indices)

>>> # compute cosine similarity between predicted (=projected_states) and target (=projected_quantized_states)
>>> cosine_sim = torch.cosine_similarity(outputs.projected_states, outputs.projected_quantized_states, dim=-1)

>>> # show that cosine similarity is much higher than random
>>> cosine_sim[mask_time_indices.to(torch.bool)].mean() > 0.5
tensor(True)

>>> # for contrastive loss training model should be put into train mode
>>> model = model.train()
>>> loss = model(
...     input_values, mask_time_indices=mask_time_indices, sampled_negative_indices=sampled_negative_indices
... ).loss
< > 更新于GitHub