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 的新版本——它在 450 万小时的音频上进行了预训练。我们特别建议将其用于微调任务，例如按照本指南。

使用技巧

Wav2Vec2-Conformer 遵循 Wav2Vec2 相同的架构，但用 Conformer: Convolution-augmented Transformer for Speech Recognition 中引入的 Conformer 块替换了 Attention 块。
对于相同数量的层，Wav2Vec2-Conformer 需要比 Wav2Vec2 更多的参数，但也会产生更好的词错误率。
Wav2Vec2-Conformer 使用与 Wav2Vec2 相同的分词器和特征提取器。
Wav2Vec2-Conformer 可以通过设置正确的 config.position_embeddings_type 来使用无相对位置嵌入、Transformer-XL 式位置嵌入或旋转位置嵌入。

资源

Wav2Vec2ConformerConfig

类 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 可以表示的不同 token 的数量。模型的词汇量大小。定义了可以由传递给 Wav2Vec2ConformerModel 的前向方法的 inputs_ids 表示的不同 token。
hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。
num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
intermediate_size (int, 可选, 默认为 3072) — 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) — Wav2Vec2ConformerForCTC 最终投影层的 dropout 概率。
layerdrop (float, 可选, 默认为 0.1) — LayerDrop 概率。更多详细信息请参见 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。
feat_extract_norm (str, 可选, 默认为 "group") — 应用于特征编码器中一维卷积层的归一化类型。对于仅对第一个一维卷积层进行组归一化，使用 "group"；对于所有一维卷积层进行层归一化，使用 "layer"。
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 (tuple[int] 或 list[int], 可选, 默认为 (512, 512, 512, 512, 512, 512, 512)) — 定义特征编码器中每个一维卷积层的输入和输出通道数的整数元组。conv_dim 的长度定义了一维卷积层的数量。
conv_stride (tuple[int] 或 list[int], 可选, 默认为 (5, 2, 2, 2, 2, 2, 2)) — 定义特征编码器中每个一维卷积层步幅的整数元组。conv_stride 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。
conv_kernel (tuple[int] 或 list[int], 可选, 默认为 (10, 3, 3, 3, 3, 3, 3)) — 定义特征编码器中每个一维卷积层核大小的整数元组。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: 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_prob * len(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_prob 的值如何，每次在特征轴上生成的长度为 mask_feature_length 的掩码的最小数量。仅当 "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 (bool, 可选, 默认为 False) — 是否使用带学习权重的层输出的加权平均值。仅在使用 Wav2Vec2ConformerForSequenceClassification 实例时相关。
classifier_proj_size (int, 可选, 默认为 256) — 分类前标记平均池化投影的维度。
tdnn_dim (tuple[int] 或 list[int], 可选, 默认为 (512, 512, 512, 512, 1500)) — 定义 XVector 模型 TDNN 模块中每个 1D 卷积层输出通道数量的整数元组。tdnn_dim 的长度定义了 TDNN 层的数量。
tdnn_kernel (tuple[int] 或 list[int], 可选, 默认为 (5, 3, 3, 1, 1)) — 定义 XVector 模型 TDNN 模块中每个 1D 卷积层核大小的整数元组。tdnn_kernel 的长度必须与 tdnn_dim 的长度匹配。
tdnn_dilation (tuple[int] 或 list[int], 可选, 默认为 (1, 2, 3, 1, 1)) — 定义 XVector 模型 TDNN 模块中每个 1D 卷积层膨胀因子的整数元组。tdnn_dilation 的长度必须与 tdnn_dim 的长度匹配。
xvector_output_dim (int, 可选, 默认为 512) — XVector 嵌入向量的维度。
add_adapter (bool, 可选, 默认为 False) — 是否在 Wav2Vec2Conformer 编码器顶部堆叠卷积网络。对于语音编码器解码器模型的热启动 Wav2Vec2Conformer 可能非常有用。
adapter_kernel_size (int, 可选, 默认为 3) — 适配器网络中卷积层的核大小。仅当 add_adapter 为 True 时相关。
adapter_stride (int, 可选, 默认为 2) — 适配器网络中卷积层的步长。仅当 add_adapter 为 True 时相关。
num_adapter_layers (int, 可选, 默认为 3) — 适配器网络中应使用的卷积层数。仅当 add_adapter 为 True 时相关。
output_hidden_size (int, 可选) — 编码器输出层的维度。如果未定义，则默认为 hidden-size。仅当 add_adapter 为 True 时相关。
position_embeddings_type (str, 可选, 默认为 "relative") — 可以指定为 relative 或 rotary，分别用于相对位置嵌入或旋转位置嵌入。如果保留 None，则不应用相对位置嵌入。
rotary_embedding_base (int, 可选, 默认为 10000) — 如果使用 "rotary" 位置嵌入，则定义嵌入基的大小。
max_source_positions (int, 可选, 默认为 5000) — 如果使用 "relative" 位置嵌入，则定义最大源输入位置。
conv_depthwise_kernel_size (int, 可选, 默认为 31) — Conformer 块中卷积深度可分离 1D 层的核大小。
conformer_conv_dropout (float, 可选, 默认为 0.1) — Conformer 块中所有卷积层的 dropout 概率。

这是存储 Wav2Vec2ConformerModel 配置的配置类。它用于根据指定参数实例化 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

Wav2Vec2ConformerForPreTrainingOutput

class transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput

< 来源 >

( loss: typing.Optional[torch.FloatTensor] = None projected_states: typing.Optional[torch.FloatTensor] = None projected_quantized_states: typing.Optional[torch.FloatTensor] = None codevector_perplexity: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None contrastive_loss: typing.Optional[torch.FloatTensor] = None diversity_loss: typing.Optional[torch.FloatTensor] = None )

参数

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，表示用于对比损失的正目标向量。
codevector_perplexity (形状为 (1,) 的 torch.FloatTensor) — 码向量分布的困惑度，用于衡量码本的多样性。
hidden_states (tuple[torch.FloatTensor], 可选, 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（如果模型有嵌入层，则包括嵌入输出，以及每个层的输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple[torch.FloatTensor], 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

在注意力 softmax 之后，用于计算自注意力头中加权平均值的注意力权重。
contrastive_loss (*可选*, 当传入 sample_negative_indices 时返回, 形状为 (1,) 的 torch.FloatTensor) — 对照损失（L_m），如官方论文中所述。
diversity_loss (*可选*, 当传入 sample_negative_indices 时返回, 形状为 (1,) 的 torch.FloatTensor) — 多样性损失（L_d），如官方论文中所述。

的输出类型 Wav2Vec2ConformerForPreTraining，具有潜在的隐藏状态和注意力。

Wav2Vec2ConformerModel

class transformers.Wav2Vec2ConformerModel

< 来源 >

( config: Wav2Vec2ConformerConfig )

参数

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

裸 Wav2Vec2 Conformer 模型，输出原始隐藏状态，顶部没有特定头部。

此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取所有与通用用法和行为相关的信息。

forward

< 来源 >

( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None mask_time_indices: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)

参数

input_values (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 类型数组或 numpy.ndarray 中获取，例如通过 soundfile 库（pip install soundfile）。为了将数组准备到 input_values 中，应使用 AutoProcessor 进行填充和转换为 torch.FloatTensor 类型张量。有关详细信息，请参阅 {processor_class}.__call__。
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 之间：
- 1 表示**未掩码**的标记，
- 0 表示**已掩码**的标记。
什么是注意力掩码？
mask_time_indices (形状为 (batch_size, sequence_length) 的 torch.BoolTensor, 可选) — 用于对比损失的掩码提取特征的索引。在训练模式下，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

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

如果传入 return_dict=False 或 config.return_dict=False，则返回 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 torch.FloatTensor 元组，其中包含根据配置 (Wav2Vec2ConformerConfig) 和输入的不同元素。

last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。
extract_features (torch.FloatTensor 形状为 (batch_size, sequence_length, conv_dim[-1])) — 模型最后一个卷积层的提取特征向量序列。
hidden_states (tuple(torch.FloatTensor), 可选, 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（如果模型有嵌入层，则包括嵌入输出，以及每个层的输出）。

模型在每个层输出的隐藏状态加上初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

的 Wav2Vec2ConformerModel forward 方法，重写了 __call__ 特殊方法。

虽然前向传播的配方需要在此函数中定义，但在此之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默忽略它们。

Wav2Vec2ConformerForCTC

class transformers.Wav2Vec2ConformerForCTC

< 来源 >

( config target_lang: typing.Optional[str] = None )

参数

config (Wav2Vec2ConformerForCTC) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法加载模型权重。
target_lang (str, 可选) — 适配器权重的语言 ID。适配器权重以 adapter..safetensors 或 adapter..bin 格式存储。仅在使用带适配器的 UniSpeechSatForCTC 实例时相关。默认使用“eng”。

带有 语言建模 头的 Wav2Vec2Conformer 模型，用于连接主义时间分类（CTC）。

此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取所有与通用用法和行为相关的信息。

forward

< 来源 >

( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)

参数

input_values (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 类型数组或 numpy.ndarray 中获取，例如通过 soundfile 库（pip install soundfile）。为了将数组准备到 input_values 中，应使用 AutoProcessor 进行填充和转换为 torch.FloatTensor 类型张量。有关详细信息，请参阅 {processor_class}.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
什么是注意力掩码？
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
labels (torch.LongTensor of shape (batch_size, target_length), optional) — 用于连接主义时间分类的标签。注意 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），包含根据配置 (Wav2Vec2ConformerConfig) 和输入的不同元素。

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。
hidden_states (tuple(torch.FloatTensor), optional, 当传入 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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2ConformerForCTC 的 forward 方法，重写了 __call__ 特殊方法。

示例

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

>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

>>> processor = AutoProcessor.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForCTC.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

>>> # 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]
...

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

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

Wav2Vec2ConformerForSequenceClassification

class transformers.Wav2Vec2ConformerForSequenceClassification

< source >

( config )

参数

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

Wav2Vec2Conformer 模型，顶部带有一个序列分类头（池化输出上的线性层），用于 SUPERB 关键词识别等任务。

此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取所有与通用用法和行为相关的信息。

forward

< source >

参数

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 类型的张量。详情请参阅 Wav2Vec2ConformerProcessor.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
什么是注意力掩码？
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 之间。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

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

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (Wav2Vec2ConformerConfig) 和输入的不同元素。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。
logits (形状为 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor), optional, 当传入 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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2ConformerForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

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

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2ConformerForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large", problem_type="multi_label_classification")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

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

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained(
...     "facebook/wav2vec2-conformer-rel-pos-large", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss

Wav2Vec2ConformerForAudioFrameClassification

class transformers.Wav2Vec2ConformerForAudioFrameClassification

< source >

( config )

参数

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

Wav2Vec2 Conformer 模型，顶部带有一个帧分类头，用于说话人分离等任务。

此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取所有与通用用法和行为相关的信息。

forward

< source >

( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(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 类型的张量。详情请参阅 Wav2Vec2ConformerProcessor.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
什么是注意力掩码？
labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 之间。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。

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

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (Wav2Vec2ConformerConfig) 和输入的不同元素。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失。
logits (形状为 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分类分数（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor), optional, 当传入 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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2ConformerForAudioFrameClassification 的 forward 方法，重写了 __call__ 特殊方法。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForAudioFrameClassification
>>> from datasets import load_dataset
>>> import torch

>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

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

>>> # 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()
>>> labels[0].tolist()
...

Wav2Vec2ConformerForXVector

class transformers.Wav2Vec2ConformerForXVector

< source >

( config )

参数

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

Wav2Vec2Conformer 模型，顶部带有一个 XVector 特征提取头，用于说话人验证等任务。

此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取所有与通用用法和行为相关的信息。

forward

< source >

参数

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 类型的张量。详情请参阅 Wav2Vec2ConformerProcessor.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
什么是注意力掩码？
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 之间。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

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

一个 transformers.modeling_outputs.XVectorOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (Wav2Vec2ConformerConfig) 和输入的不同元素。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失。
logits (形状为 (batch_size, config.xvector_output_dim) 的 torch.FloatTensor) — AMSoftmax 之前的分类隐藏状态。
embeddings (形状为 (batch_size, config.xvector_output_dim) 的 torch.FloatTensor) — 用于基于向量相似性检索的话语嵌入。
hidden_states (tuple(torch.FloatTensor), 可选, 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（如果模型有嵌入层，则包括嵌入输出，以及每个层的输出）。

模型在每个层输出的隐藏状态加上初始嵌入输出。
attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每个层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2ConformerForXVector 的 forward 方法，重写了 __call__ 特殊方法。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForXVector
>>> from datasets import load_dataset
>>> import torch

>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

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

>>> # 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!")
>>> round(similarity.item(), 2)
...

Wav2Vec2ConformerForPreTraining

class transformers.Wav2Vec2ConformerForPreTraining

< source >

( config: Wav2Vec2ConformerConfig )

参数

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

Wav2Vec2Conformer 模型，顶部带有一个量化器和 VQ 头。

此模型继承自 PreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取所有与通用用法和行为相关的信息。

forward

< source >

( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None mask_time_indices: typing.Optional[torch.BoolTensor] = None sampled_negative_indices: typing.Optional[torch.BoolTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或 tuple(torch.FloatTensor)

参数

input_values (torch.Tensor of shape (batch_size, sequence_length), optional) — 输入原始语音波形的浮点值。可以通过加载 .flac 或 .wav 音频文件到 list[float] 类型数组或 numpy.ndarray 来获取值，例如通过 soundfile 库（pip install soundfile）。为了将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。详情请参阅 {processor_class}.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
什么是注意力掩码？
mask_time_indices (torch.BoolTensor of shape (batch_size, sequence_length), optional) — 用于对比损失的掩码提取特征的索引。在训练模式下，模型学习预测 config.proj_codevector_dim 空间中的掩码提取特征。
sampled_negative_indices (torch.BoolTensor of shape (batch_size, sequence_length, num_negatives), optional) — 指示哪些量化目标向量用作对比损失中的负采样向量的索引。预训练的必需输入。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。

transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或一个 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (Wav2Vec2ConformerConfig) 和输入的不同元素。

loss (*optional*, 当传入 sample_negative_indices 时返回，torch.FloatTensor of shape (1,)) — 总损失，是官方论文中所述的对比损失 (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 的量化提取特征向量，表示对比损失的正目标向量。
codevector_perplexity (形状为(1,)的torch.FloatTensor) — 码向量分布的困惑度，用于衡量码本的多样性。
hidden_states (tuple[torch.FloatTensor], optional, 当传入 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 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
contrastive_loss (*optional*, 当传入 sample_negative_indices 时返回，torch.FloatTensor of shape (1,)) — 官方论文中所述的对比损失 (L_m)。
diversity_loss (*optional*, 当传入 sample_negative_indices 时返回，torch.FloatTensor of shape (1,)) — 官方论文中所述的多样性损失 (L_d)。

Wav2Vec2ConformerForPreTraining 的 forward 方法，重写了 __call__ 特殊方法。

示例

>>> 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-base")
>>> model = Wav2Vec2ConformerForPreTraining.from_pretrained("facebook/wav2vec2_conformer-base")

>>> 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 上更新

Transformers

Wav2Vec2-Conformer

概述

使用技巧

资源

Wav2Vec2ConformerConfig

类 transformers.Wav2Vec2ConformerConfig

Wav2Vec2ConformerForPreTrainingOutput

class transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput

Wav2Vec2ConformerModel

class transformers.Wav2Vec2ConformerModel

forward

Wav2Vec2ConformerForCTC

class transformers.Wav2Vec2ConformerForCTC

forward

Wav2Vec2ConformerForSequenceClassification

class transformers.Wav2Vec2ConformerForSequenceClassification

forward

Wav2Vec2ConformerForAudioFrameClassification

class transformers.Wav2Vec2ConformerForAudioFrameClassification

forward

Wav2Vec2ConformerForXVector

class transformers.Wav2Vec2ConformerForXVector

forward

Wav2Vec2ConformerForPreTraining

class transformers.Wav2Vec2ConformerForPreTraining

forward