Hugging Face 的 LOGO

Transformers 文档

Wav2Vec2-BERT

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Wav2Vec2-BERT

PyTorch

概述

Wav2Vec2-BERT 模型由 Meta AI 的 Seamless Communication 团队在 Seamless: 多语言表达流式语音翻译中提出。

该模型在涵盖超过 143 种语言的 450 万小时未标记音频数据上进行了预训练。它需要微调才能用于下游任务，例如自动语音识别 (ASR) 或音频分类。

模型的官方结果可以在论文的 3.2.1 节中找到。

论文摘要如下：

自动语音翻译的最新进展极大地扩展了语言覆盖范围，提高了多模态能力，并实现了广泛的任务和功能。尽管如此，当今的大规模自动语音翻译系统缺乏关键功能，这些功能有助于机器辅助通信在与人际对话相比时感觉无缝。在这项工作中，我们引入了一系列模型，可以以流式方式实现端到端表达性和多语言翻译。首先，我们贡献了大规模多语言多模态 SeamlessM4T 模型的改进版本——SeamlessM4T v2。这个更新的模型融合了更新的 UnitY2 框架，在更多低资源语言数据上进行了训练。SeamlessAlign 的扩展版本增加了 114,800 小时的自动对齐数据，总共涵盖 76 种语言。SeamlessM4T v2 为我们两个最新模型 SeamlessExpressive 和 SeamlessStreaming 的启动奠定了基础。SeamlessExpressive 实现了保留人声风格和韵律的翻译。与以往表达性语音研究的努力相比，我们的工作解决了韵律的一些未充分探索的方面，例如语速和停顿，同时还保留了语音的风格。至于 SeamlessStreaming，我们的模型利用高效单调多头注意力 (EMMA) 机制，在不等待完整的源话语的情况下生成低延迟目标翻译。作为首创，SeamlessStreaming 实现了多源和目标语言的同步语音到语音/文本翻译。为了了解这些模型的性能，我们结合了现有自动指标的新颖和修改版本来评估韵律、延迟和鲁棒性。对于人工评估，我们调整了现有协议，以衡量意义、自然度和表达性保留中最相关的属性。为了确保我们的模型可以安全负责地使用，我们实施了首次已知的多模态机器翻译红队工作，一个检测和缓解增加毒性的系统，一个系统的性别偏见评估，以及一个旨在抑制深度伪造影响的不可听局部水印机制。因此，我们将 SeamlessExpressive 和 SeamlessStreaming 的主要组件结合起来，形成 Seamless，这是第一个公开可用的系统，可实现实时的富有表现力的跨语言通信。总之，Seamless 让我们对将通用语音翻译器从科幻概念变为现实世界技术所需的技术基础有了关键的了解。最后，这项工作的贡献——包括模型、代码和水印检测器——已公开发布，可通过以下链接访问。

此模型由 ylacombe 贡献。原始代码可在 此处 找到。

使用提示

  • Wav2Vec2-BERT 遵循 Wav2Vec2-Conformer 的相同架构，但采用因果深度卷积层，并使用音频的梅尔频谱图表示作为输入，而不是原始波形。
  • Wav2Vec2-BERT 可以通过设置正确的 config.position_embeddings_type 来使用无相对位置嵌入、类似 Shaw 的位置嵌入、类似 Transformer-XL 的位置嵌入或旋转位置嵌入。
  • Wav2Vec2-BERT 还引入了基于 Conformer 的适配器网络，而不是简单的卷积网络。

资源

自动语音识别
音频分类

Wav2Vec2BertConfig

class transformers.Wav2Vec2BertConfig

< >

( vocab_size = None hidden_size = 1024 num_hidden_layers = 24 num_attention_heads = 16 intermediate_size = 4096 feature_projection_input_dim = 160 hidden_act = 'swish' hidden_dropout = 0.0 activation_dropout = 0.0 attention_dropout = 0.0 feat_proj_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 apply_spec_augment = True mask_time_prob = 0.05 mask_time_length = 10 mask_time_min_masks = 2 mask_feature_prob = 0.0 mask_feature_length = 10 mask_feature_min_masks = 0 ctc_loss_reduction = 'sum' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 768 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 = 1 adapter_act = 'relu' use_intermediate_ffn_before_adapter = False output_hidden_size = None position_embeddings_type = 'relative_key' rotary_embedding_base = 10000 max_source_positions = 5000 left_max_position_embeddings = 64 right_max_position_embeddings = 8 conv_depthwise_kernel_size = 31 conformer_conv_dropout = 0.1 **kwargs )

参数

  • vocab_size (int, 可选) — Wav2Vec2Bert 模型的词汇表大小。定义了调用 Wav2Vec2BertModel 时可以通过 inputs_ids 表示的不同 token 的数量。模型的词汇表大小。定义了传递给 Wav2Vec2BertModel 的 forward 方法的 inputs_ids 可以表示的不同 token。
  • hidden_size (int, 可选, 默认为 1024) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为 24) — Transformer 编码器中的隐藏层数。
  • num_attention_heads (int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选, 默认为 4096) — Transformer 编码器中“中间”（即前馈）层的维度。
  • feature_projection_input_dim (int, 可选, 默认为 160) — 此模型的输入维度，即使用 SeamlessM4TFeatureExtractor 或 Wav2Vec2BertProcessor 处理输入音频后的维度。
  • hidden_act (str 或 function, 可选, 默认为 "swish") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持 "gelu", "relu", "selu", "swish" 和 "gelu_new"。
  • hidden_dropout (float, 可选, 默认为 0.0) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • activation_dropout (float, 可选, 默认为 0.0) — 全连接层内部激活的 dropout 比率。
  • attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。
  • feat_proj_dropout (float, 可选, 默认为 0.0) — 特征投影的 dropout 概率。
  • final_dropout (float, 可选, 默认为 0.1) — Wav2Vec2BertForCTC 最终投影层的 dropout 概率。
  • layerdrop (float, 可选, 默认为 0.1) — LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](参见 https://huggingface.co/papers/1909.11556)。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon 值。
  • apply_spec_augment (bool, 可选, 默认为 True) — 是否对特征编码器的输出应用 SpecAugment 数据增强。参考 SpecAugment: 一种用于自动语音识别的简单数据增强方法。
  • 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_length 的最小遮罩数量，每个时间步都独立于 mask_feature_prob。仅在 mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks 时相关。
  • ctc_loss_reduction (str, 可选, 默认为 "sum") — 指定应用于 torch.nn.CTCLoss 输出的归约方式。仅在训练 Wav2Vec2BertForCTC 实例时相关。
  • ctc_zero_infinity (bool, 可选, 默认为 False) — 是否将无限损失和 torch.nn.CTCLoss 的相关梯度置零。无限损失主要发生在输入太短而无法与目标对齐时。仅在训练 Wav2Vec2BertForCTC 实例时相关。
  • use_weighted_layer_sum (bool, 可选, 默认为 False) — 是否使用带学习权重的层输出的加权平均。仅在使用 Wav2Vec2BertForSequenceClassification 实例时相关。
  • classifier_proj_size (int, 可选, 默认为 768) — 用于分类的 token 均值池化前的投影维度。
  • 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 嵌入向量的维度。
  • pad_token_id (int, 可选, 默认为 0) — 流开始标记的 ID。
  • bos_token_id (int, 可选, 默认为 1) — 填充标记的 ID。
  • eos_token_id (int, 可选, 默认为 2) — 流结束标记的 ID。
  • add_adapter (bool, 可选, 默认为 False) — 是否在 Wav2Vec2Bert 编码器之上堆叠一个卷积注意力网络。对于 SpeechEncoderDecoder 模型的热启动 Wav2Vec2Bert 非常有用。
  • adapter_kernel_size (int, 可选, 默认为 3) — 适配器网络中卷积层的核大小。仅在 add_adapter 为 True 时相关。
  • adapter_stride (int, 可选, 默认为 2) — 适配器网络中卷积层的步长。仅在 add_adapter 为 True 时相关。
  • num_adapter_layers (int, 可选, 默认为 1) — 适配器网络中应使用的卷积层数。仅在 add_adapter 为 True 时相关。
  • adapter_act (str 或 function, 可选, 默认为 "relu") — 适配器层中的非线性激活函数（函数或字符串）。如果是字符串，支持 "gelu", "relu", "selu", "swish" 和 "gelu_new"。
  • use_intermediate_ffn_before_adapter (bool, 可选, 默认为 False) — 是否在 Wav2Vec2Bert 编码器之上、适配器网络之前堆叠一个中间前馈块。仅在 add_adapter 为 True 时相关。
  • output_hidden_size (int, 可选) — 编码器输出层的维度。如果未定义，则默认为 隐藏大小。仅在 add_adapter 为 True 时相关。
  • position_embeddings_type (str, 可选, 默认为 "relative_key") — 可指定为：
  • rotary_embedding_base (int, 可选, 默认为 10000) — 如果使用 "rotary" 位置嵌入，则定义嵌入基础的大小。
  • max_source_positions (int, 可选, 默认为 5000) — 如果使用 "relative" 位置嵌入，则定义最大源输入位置。
  • left_max_position_embeddings (int, 可选, 默认为 64) — 如果使用 "relative_key" (又名 Shaw) 位置嵌入，则定义相对位置的左裁剪值。
  • right_max_position_embeddings (int, 可选, 默认为 8) — 如果使用 "relative_key" (又名 Shaw) 位置嵌入，则定义相对位置的右裁剪值。
  • conv_depthwise_kernel_size (int, 可选, 默认为 31) — Conformer 块中卷积深度可分离一维层的核大小。
  • conformer_conv_dropout (float, 可选, 默认为 0.1) — Conformer 块中所有卷积层的 dropout 概率。

这是用于存储 Wav2Vec2BertModel 配置的配置类。它用于根据指定参数实例化 Wav2Vec2Bert 模型，定义模型架构。使用默认值实例化配置将生成与 Wav2Vec2Bert facebook/wav2vec2-bert-rel-pos-large 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 的文档。

示例

>>> from transformers import Wav2Vec2BertConfig, Wav2Vec2BertModel

>>> # Initializing a Wav2Vec2Bert facebook/wav2vec2-bert-rel-pos-large style configuration
>>> configuration = Wav2Vec2BertConfig()

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

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

Wav2Vec2BertProcessor

class transformers.Wav2Vec2BertProcessor

 < >

( feature_extractor tokenizer )

参数

构造一个 Wav2Vec2-BERT 处理器，它将 Wav2Vec2-BERT 特征提取器和 Wav2Vec2 CTC 分词器包装在一个处理器中。

Wav2Vec2Processor 提供 SeamlessM4TFeatureExtractor 和 PreTrainedTokenizer 的所有功能。有关更多信息，请参阅 call() 和 decode() 的文档。

__call__

 < >

( audio: typing.Union[ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), list['np.ndarray'], list['torch.Tensor']] = None text: typing.Union[str, list[str], NoneType] = None images = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.wav2vec2_bert.processing_wav2vec2_bert.Wav2Vec2BertProcessorKwargs] ) → BatchEncoding

参数

  • audio (np.ndarray, torch.Tensor, list[np.ndarray], list[torch.Tensor]) — 要准备的音频或批处理音频。每个音频可以是 NumPy 数组或 PyTorch 张量。如果是 NumPy 数组/PyTorch 张量，每个音频的形状应为 (C, T)，其中 C 是通道数，T 是音频的样本长度。
  • text (str, list[str], list[list[str]]) — 要编码的序列或批处理序列。每个序列可以是字符串或字符串列表（预分词字符串）。如果序列以字符串列表（预分词）形式提供，则必须设置 is_split_into_words=True（以消除与一批序列的歧义）。

返回

BatchEncoding

一个 BatchEncoding，包含以下字段：

  • input_features — 要馈送到模型的音频输入特征。当 audio 不为 None 时返回。
  • attention_mask — 当 audio 不为 None 时，指定模型应关注哪些时间戳的索引列表。当仅指定 text 时，返回 token 注意力掩码。
  • labels — 要馈送到模型的 token ID 列表。当 text 和 audio 都不为 None 时返回。
  • input_ids — 要馈送到模型的 token ID 列表。当 text 不为 None 且 audio 为 None 时返回。

用于为模型准备一个或多个序列和音频的主要方法。如果 audio 不为 None，此方法将 audio 和 kwargs 参数转发到 SeamlessM4TFeatureExtractor 的 call() 以预处理音频。如果 text 不为 None，此方法将 text 和 kwargs 参数转发到 PreTrainedTokenizer 的 call() 以准备目标序列。有关更多信息，请参阅上述两种方法的文档。

pad

 < >

( input_features = None labels = None **kwargs )

如果 input_features 不为 None，此方法将 input_features 和 kwargs 参数转发到 SeamlessM4TFeatureExtractor 的 pad() 以填充输入特征。如果 labels 不为 None，此方法将 labels 和 kwargs 参数转发到 PreTrainedTokenizer 的 pad() 以填充标签。有关更多信息，请参阅上述两种方法的文档。

from_pretrained

 < >

( pretrained_model_name_or_path **kwargs )

save_pretrained

 < >

( save_directory push_to_hub: bool = False **kwargs )

参数

  • save_directory (str 或 os.PathLike) — 特征提取器 JSON 文件和分词器文件将保存的目录（如果目录不存在，将创建）。
  • push_to_hub (bool, 可选, 默认为 False) — 是否在保存模型后将其推送到 Hugging Face 模型中心。您可以使用 repo_id 指定要推送到的仓库（将默认为您的命名空间中 save_directory 的名称）。
  • kwargs (dict[str, Any], 可选) — 传递给 push_to_hub() 方法的附加关键字参数。

将此处理器（特征提取器、分词器…）的属性保存到指定目录，以便可以使用 from_pretrained() 方法重新加载。

此类方法只是调用 save_pretrained() 和 save_pretrained()。有关更多信息，请参阅上述方法的文档。

batch_decode

 < >

( *args **kwargs )

此方法将其所有参数转发到 PreTrainedTokenizer 的 batch_decode()。有关更多信息，请参阅此方法的文档。

decode

 < >

( *args **kwargs )

此方法将其所有参数转发给 PreTrainedTokenizer 的 decode()。有关此方法的更多信息，请参阅其文档字符串。

Wav2Vec2BertModel

class transformers.Wav2Vec2BertModel

 < >

( config: Wav2Vec2BertConfig )

参数

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

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

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

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

forward

 < >

( input_features: 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_features (形状为 (batch_size, sequence_length) 的 torch.FloatTensor) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 类型数组或 numpy.ndarray 中来获取这些值，例如通过 soundfile 库（pip install soundfile）。要将数组准备为 input_features，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型张量。有关详细信息，请参阅 Wav2Vec2BertProcessor.call()。
  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值在 [0, 1] 中选择：

    • 对于 未掩码 的 token 为 1，
    • 对于 已掩码 的 token 为 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)

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

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

  • extract_features (形状为 (batch_size, sequence_length, conv_dim[-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 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2BertModel forward 方法，覆盖 __call__ 特殊方法。

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

Wav2Vec2BertForCTC

class transformers.Wav2Vec2BertForCTC

 < >

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

参数

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

带有用于连接主义时间分类 (CTC) 的 语言建模 头部的 Wav2Vec2Bert 模型。

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

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

forward

 < >

( input_features: 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_features (形状为 (batch_size, sequence_length) 的 torch.FloatTensor) — 输入原始语音波形的浮点值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 类型数组或 numpy.ndarray 中来获取这些值，例如通过 soundfile 库（pip install soundfile）。要将数组准备为 input_features，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型张量。有关详细信息，请参阅 Wav2Vec2BertProcessor.call()。
  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值在 [0, 1] 中选择：

    • 对于 未掩码 的 token 为 1，
    • 对于 已掩码 的 token 为 0。

    什么是注意力掩码？

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (形状为 (batch_size, target_length) 的 torch.LongTensor，可选) — 用于连接主义时间分类的标签。请注意，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），包含根据配置（Wav2Vec2BertConfig）和输入而定的各种元素。

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

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

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2BertForCTC 的 forward 方法，覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoProcessor, Wav2Vec2BertForCTC
>>> 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-bert-rel-pos-large")
>>> model = Wav2Vec2BertForCTC.from_pretrained("facebook/wav2vec2-bert-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)
...

Wav2Vec2BertForSequenceClassification

class transformers.Wav2Vec2BertForSequenceClassification

< >

( config )

参数

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

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

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

forward

< >

( input_features: 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_features (形状为 (batch_size, sequence_length) 的 torch.FloatTensor) — 输入原始语音波形的浮点值。可以通过加载 .flac 或 .wav 音频文件到 list[float] 类型数组或 numpy.ndarray 来获取值，例如通过 soundfile 库（pip install soundfile）。要将数组准备为 input_features，应使用 AutoProcessor 进行填充和转换为 torch.FloatTensor 类型张量。有关详细信息，请参见 Wav2Vec2BertProcessor.__call__()。
  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 避免对填充令牌索引执行注意力操作的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示未被遮盖的令牌，
    • 0 表示被遮盖的令牌。

    什么是注意力掩码？

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在 [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），包含根据配置（Wav2Vec2BertConfig）和输入而定的各种元素。

  • 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), 可选, 当 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 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2BertForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2BertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-bert-rel-pos-large")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/wav2vec2-bert-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 = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/wav2vec2-bert-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, Wav2Vec2BertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-bert-rel-pos-large")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/wav2vec2-bert-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 = Wav2Vec2BertForSequenceClassification.from_pretrained(
...     "facebook/wav2vec2-bert-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

Wav2Vec2BertForAudioFrameClassification

class transformers.Wav2Vec2BertForAudioFrameClassification

< >

( config )

参数

Wav2Vec2 Bert 模型，顶部带有用于说话人识别等任务的帧分类头。

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

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

forward

< >

( input_features: 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_features (形状为 (batch_size, sequence_length) 的 torch.FloatTensor) — 输入原始语音波形的浮点值。可以通过加载 .flac 或 .wav 音频文件到 list[float] 类型数组或 numpy.ndarray 来获取值，例如通过 soundfile 库（pip install soundfile）。要将数组准备为 input_features，应使用 AutoProcessor 进行填充和转换为 torch.FloatTensor 类型张量。有关详细信息，请参见 Wav2Vec2ConformerProcessor.__call__。
  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 避免对填充令牌索引执行注意力操作的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示未被遮盖的令牌，
    • 0 表示被遮盖的令牌。

    什么是注意力掩码？

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

返回

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

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（Wav2Vec2BertConfig）和输入而定的各种元素。

  • loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失。

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

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2BertForAudioFrameClassification 的 forward 方法，覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2BertForAudioFrameClassification
>>> 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-bert-rel-pos-large")
>>> model = Wav2Vec2BertForAudioFrameClassification.from_pretrained("facebook/wav2vec2-bert-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()
...

Wav2Vec2BertForXVector

class transformers.Wav2Vec2BertForXVector

< >

( config )

参数

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

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

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

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

forward

< >

( input_features: 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_features (形状为 (batch_size, sequence_length) 的 torch.FloatTensor) — 输入原始语音波形的浮点值。可以通过加载 .flac 或 .wav 音频文件到 list[float] 类型数组或 numpy.ndarray 来获取值，例如通过 soundfile 库（pip install soundfile）。要将数组准备为 input_features，应使用 AutoProcessor 进行填充和转换为 torch.FloatTensor 类型张量。有关详细信息，请参见 Wav2Vec2ConformerProcessor.__call__。
  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 避免对填充令牌索引执行注意力操作的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示未被遮盖的令牌，
    • 0 表示被遮盖的令牌。

    什么是注意力掩码？

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在 [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），包含根据配置（Wav2Vec2BertConfig）和输入而定的各种元素。

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

Wav2Vec2BertForXVector 的 forward 方法，覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2BertForXVector
>>> 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-bert-rel-pos-large")
>>> model = Wav2Vec2BertForXVector.from_pretrained("facebook/wav2vec2-bert-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)
...
< > 在 GitHub 上更新

←Wav2Vec2 Wav2Vec2-Conformer→