Transformers 文档
Wav2Vec2-Conformer
并获取增强的文档体验
开始使用
Wav2Vec2-Conformer
概述
Wav2Vec2-Conformer 被添加到 fairseq S2T: Fast Speech-to-Text Modeling with fairseq 的更新版本中，作者是 Changhan Wang, Yun Tang, Xutai Ma, Anne Wu, Sravya Popuri, Dmytro Okhonko, Juan Pino。
该模型的官方结果可以在论文的表 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 块。
- 对于相同数量的层，Wav2Vec2-Conformer 比 Wav2Vec2 需要更多的参数，但也产生了改进的词错误率。
- Wav2Vec2-Conformer 使用与 Wav2Vec2 相同的分词器和特征提取器。
- Wav2Vec2-Conformer 可以通过设置正确的
config.position_embeddings_type来使用无相对位置嵌入、类似 Transformer-XL 的位置嵌入或旋转位置嵌入。
资源
Wav2Vec2ConformerConfig
class transformers.Wav2Vec2ConformerConfig
< source >( 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 的 forward 方法的 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 的最终 projection 层的 dropout 概率。 - layerdrop (
float, 可选, 默认为 0.1) — LayerDrop 概率。 有关更多详细信息，请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — layer normalization 层使用的 epsilon 值。 - feat_extract_norm (
str, 可选, 默认为"group") — 应用于特征编码器中 1D 卷积层的 norm。 可以是"group"(仅对第一个 1D 卷积层进行 group normalization) 或"layer"(对所有 1D 卷积层进行 layer normalization)。 - feat_proj_dropout (
float, 可选, 默认为 0.0) — 特征编码器输出的 dropout 概率。 - feat_extract_activation (
str,optional, defaults to“gelu”) -- 特征提取器的 1D 卷积层中的非线性激活函数（函数或字符串）。 如果是字符串，则支持“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)) — 定义特征编码器中每个 1D 卷积层的输入和输出通道数的整数元组。 conv_dim 的长度定义了 1D 卷积层的数量。 - conv_stride (
Tuple[int]或List[int], 可选, 默认为(5, 2, 2, 2, 2, 2, 2)) — 定义特征编码器中每个 1D 卷积层的步长的整数元组。 conv_stride 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。 - conv_kernel (
Tuple[int]或List[int], 可选, 默认为(10, 3, 3, 3, 3, 3, 3)) — 定义特征编码器中每个 1D 卷积层的内核大小的整数元组。 conv_kernel 的长度定义了卷积层的数量，并且必须与 conv_dim 的长度匹配。 - conv_bias (
bool, 可选, 默认为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_problen(time_axis)/mask_time_length” 个独立的掩码。 如果从每个特征向量被选为要屏蔽的向量跨度的起点的概率来推理，则 mask_time_prob 应为 `prob_vector_startmask_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_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” 时相关 - 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 特征的最终 projection 的维度。 - 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) — 用于分类的 token 均值池化之前的投影维度。 - tdnn_dim (
Tuple[int]或List[int], 可选, 默认为(512, 512, 512, 512, 1500)) — 一个整数元组，定义了 XVector 模型的 TDNN 模块中每个一维卷积层的输出通道数。 tdnn_dim 的长度定义了 TDNN 层的数量。 - tdnn_kernel (
Tuple[int]或List[int], 可选, 默认为(5, 3, 3, 1, 1)) — 一个整数元组，定义了 XVector 模型的 TDNN 模块中每个一维卷积层的内核大小。 tdnn_kernel 的长度必须与 tdnn_dim 的长度匹配。 - tdnn_dilation (
Tuple[int]或List[int], 可选, 默认为(1, 2, 3, 1, 1)) — 一个整数元组，定义了 XVector 模型的 TDNN 模块中每个一维卷积层的扩张因子。 tdnn_dilation 的长度必须与 tdnn_dim 的长度匹配。 - xvector_output_dim (
int, 可选, 默认为 512) — XVector 嵌入向量的维度。 - add_adapter (
bool, 可选, 默认为False) — 是否应在 Wav2Vec2Conformer 编码器之上堆叠卷积网络。对于为 SpeechEncoderDecoder 模型热启动 Wav2Vec2Conformer 非常有用。 - adapter_kernel_size (
int, 可选, 默认为 3) — 适配器网络中卷积层的内核大小。仅当add_adapter is True时相关。 - adapter_stride (
int, 可选, 默认为 2) — 适配器网络中卷积层的步幅。仅当add_adapter is 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") — 可以指定为relative或rotary分别用于相对或旋转位置嵌入。如果保留为None，则不应用相对位置嵌入。 - rotary_embedding_base (
int, 可选, 默认为 10000) — 如果使用"rotary"位置嵌入，则定义嵌入基的大小。 - max_source_positions (
int, 可选, 默认为 5000) — 如果使用"relative"位置嵌入，则定义最大源输入位置。 - conv_depthwise_kernel_size (
int, 可选, 默认为 31) — Conformer 块中卷积深度可分离一维层的内核大小。 - 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.configWav2Vec2Conformer 特定输出
class transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None projected_states: FloatTensor = None projected_quantized_states: FloatTensor = None codevector_perplexity: FloatTensor = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None attentions: typing.Optional[typing.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，表示对比损失的正目标向量。 - 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时返回,torch.FloatTensor类型，形状为(1,)) — 多样性损失 (L_d)，如 官方论文 中所述。
Wav2Vec2ConformerForPreTraining 的输出类型，包含潜在的隐藏状态和注意力。
Wav2Vec2ConformerModel
class transformers.Wav2Vec2ConformerModel
< 源码 >( config: Wav2Vec2ConformerConfig )
参数
- config (Wav2Vec2ConformerConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
裸 Wav2Vec2Conformer 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的头部。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: 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 (
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), 可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
只有当对应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 的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 而不是普通元组。
返回值
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类型，形状为(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时返回) —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 之后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ConformerModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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
class transformers.Wav2Vec2ConformerForCTC
< 源码 >( config target_lang: typing.Optional[str] = None )
参数
- config (Wav2Vec2ConformerConfig) — 模型的配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Wav2Vec2Conformer 模型，顶部带有用于连接时序分类 (CTC) 的语言建模头。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: 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 (
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), 可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
只有当对应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 的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.LongTensorof shape(batch_size, target_length), optional) — Labels for connectionist temporal classification. Note thattarget_lengthhas to be smaller or equal to the sequence length of the output logits. Indices are selected in[-100, 0, ..., config.vocab_size - 1]. All labels set to-100are ignored (masked), the loss is only computed for labels in[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 (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇表 token 的分数）。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ConformerForCTC 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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.21Wav2Vec2ConformerForSequenceClassification
class transformers.Wav2Vec2ConformerForSequenceClassification
< source >( config )
参数
- config (Wav2Vec2ConformerConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有序列分类头的 Wav2Vec2Conformer 模型（池化输出之上的线性层），用于像 SUPERB 关键词识别这样的任务。
Wav2Vec2Conformer 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。
此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch nn.Module 的子类。请将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与通用用法和行为相关的所有事项。
forward
< source >( 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.SequenceClassifierOutput 或 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)，可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
只有当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 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 (
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ConformerForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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).lossWav2Vec2ConformerForAudioFrameClassification
class transformers.Wav2Vec2ConformerForAudioFrameClassification
< source >( config )
参数
- config (Wav2Vec2ConformerConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有帧分类头的 Wav2Vec2Conformer 模型，用于像说话人日志这样的任务。
Wav2Vec2Conformer 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。
此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch 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，形状为(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)，可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
只有当相应的处理器具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有处理器具有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, optional) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是一个普通的 tuple。 - labels (
torch.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (Wav2Vec2ConformerConfig) 和输入。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensorof shape(batch_size, sequence_length, config.num_labels)) — 分类得分（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 之后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ConformerForAudioFrameClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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
class transformers.Wav2Vec2ConformerForXVector
< source >( config )
参数
- config (Wav2Vec2ConformerConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 XVector 特征提取头的 Wav2Vec2Conformer 模型，用于说话人验证等任务。
Wav2Vec2Conformer 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。
此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch nn.Module 的子类。请将其用作常规 PyTorch 模块，并参阅 PyTorch 文档以了解与通用用法和行为相关的所有事项。
forward
< source >( 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.XVectorOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensorof 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.LongTensorof shape(batch_size, sequence_length), optional) — 用于避免对 padding token 索引执行卷积和 attention 的掩码。在[0, 1]中选择的掩码值：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
只有当相应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-conformer-rel-pos-large，不应 传递attention_mask，以避免在执行批量推理时性能下降。对于此类模型，input_values应简单地用 0 填充并在没有attention_mask的情况下传递。请注意，这些模型也会根据input_values是否填充而产生略有不同的结果。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是一个普通的 tuple。 - labels (
torch.LongTensorof 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 的 tuple (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (Wav2Vec2ConformerConfig) 和输入。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensorof shape(batch_size, config.xvector_output_dim)) — AMSoftmax 之前的分类 hidden states。 -
embeddings (
torch.FloatTensorof shape(batch_size, config.xvector_output_dim)) — 用于基于向量相似度检索的 utterance embeddings。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
Wav2Vec2ConformerForXVector forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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
< source >( config: Wav2Vec2ConformerConfig )
参数
- config (Wav2Vec2ConformerConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有量化器和 VQ 头的 Wav2Vec2Conformer 模型。Wav2Vec2Conformer 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中提出，作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。
此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存等）。
此模型是 PyTorch 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.FloatTensorof 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.LongTensorof shape(batch_size, sequence_length), optional) — 用于避免对 padding token 索引执行卷积和 attention 的掩码。在[0, 1]中选择的掩码值：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
只有当相应的 processor 具有
config.return_attention_mask == True时，才应传递attention_mask。对于所有 processor 具有config.return_attention_mask == False的模型，例如 wav2vec2-conformer-rel-pos-large，不应 传递attention_mask，以避免在执行批量推理时性能下降。对于此类模型，input_values应简单地用 0 填充并在没有attention_mask的情况下传递。请注意，这些模型也会根据input_values是否填充而产生略有不同的结果。 - output_attentions (
bool, optional) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回的 tensors 下的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.Wav2Vec2ConformerForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (Wav2Vec2ConformerConfig) 和输入。
-
loss (可选，当传递
sample_negative_indices时返回，torch.FloatTensor，形状为(1,)) — 总损失，为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。(分类) 损失。 -
projected_states (
torch.FloatTensor，形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 模型投影到 config.proj_codevector_dim 的隐藏状态，可用于预测被掩蔽的投影量化状态。 -
projected_quantized_states (
torch.FloatTensor，形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 投影到 config.proj_codevector_dim 的量化提取特征向量，代表对比损失的正目标向量。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
contrastive_loss (可选，当传递
sample_negative_indices时返回，torch.FloatTensor，形状为(1,)) — 对比损失 (L_m)，如 官方论文 中所述。 -
diversity_loss (可选，当传递
sample_negative_indices时返回，torch.FloatTensor，形状为(1,)) — 多样性损失 (L_d)，如 官方论文 中所述。
Wav2Vec2ConformerForPreTraining 的 forward 方法覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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