Transformers 文档

Wav2Vec2-BERT

Wav2Vec2-BERT

概述

Wav2Vec2-BERT模型是由Meta AI的无缝通信团队在Seamless: Multilingual Expressive and Streaming Speech Translation中提出的。

该模型在超过450万小时的无标签音频数据上进行了预训练,涵盖了超过143种语言。它需要微调才能用于下游任务,如自动语音识别(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 的适配器网络,而不是简单的卷积网络。

资源

Automatic Speech Recognition
Audio Classification

Wav2Vec2BertConfig

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, optional) — Wav2Vec2Bert模型的词汇表大小。定义了调用Wav2Vec2BertModel时传递的inputs_ids可以表示的不同令牌的数量。模型的词汇表大小。定义了传递给Wav2Vec2BertModelinputs_ids可以表示的不同令牌的数量。
  • hidden_size (int, optional, defaults to 1024) — 编码器层和池化层的维度。
  • num_hidden_layers (int, optional, defaults to 24) — Transformer编码器中的隐藏层数量。
  • num_attention_heads (int, optional, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数。
  • intermediate_size (int, optional, 默认为 4096) — Transformer 编码器中“中间”(即前馈)层的维度。
  • feature_projection_input_dim (int, optional, defaults to 160) — 该模型的输入维度,即使用SeamlessM4TFeatureExtractorWav2Vec2BertProcessor处理输入音频后的维度。
  • hidden_act (strfunction, 可选, 默认为 "swish") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu", "relu", "selu", "swish""gelu_new".
  • hidden_dropout (float, optional, defaults to 0.0) — 嵌入层、编码器和池化器中所有全连接层的dropout概率。
  • activation_dropout (float, optional, defaults to 0.0) — 全连接层内激活函数的丢弃比例。
  • attention_dropout (float, optional, defaults to 0.0) — 注意力概率的dropout比率.
  • feat_proj_dropout (float, optional, 默认为 0.0) — 特征投影的 dropout 概率.
  • final_dropout (float, optional, defaults to 0.1) — Wav2Vec2BertForCTC 的最终投影层的 dropout 概率。
  • layerdrop (float, optional, 默认为 0.1) — LayerDrop 概率。更多详情请参阅 [LayerDrop 论文](see https://arxiv.org/abs/1909.11556)。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float, optional, defaults to 1e-05) — 层归一化层使用的epsilon值。
  • apply_spec_augment (bool, 可选, 默认为 True) — 是否对特征编码器的输出应用SpecAugment数据增强。有关参考,请参见 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition.
  • mask_time_prob (float, optional, 默认为 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, optional, defaults to 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, optional, 默认为 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 is True 时相关。
  • mask_feature_length (int, optional, defaults to 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, optional, 默认为 768) — 分类前用于标记平均池化的投影维度.
  • 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模块中每个一维卷积层的扩张因子。tdnn_dilation的长度必须与tdnn_dim的长度匹配。
  • xvector_output_dim (int, optional, 默认为 512) — XVector 嵌入向量的维度。
  • pad_token_id (int, 可选, 默认为 0) — beginning-of-stream 令牌的 ID.
  • bos_token_id (int, optional, 默认为 1) — padding 标记的 id.
  • eos_token_id (int, optional, 默认为 2) — end-of-stream 令牌的 id.
  • add_adapter (bool, 可选, 默认为 False) — 是否应该在Wav2Vec2Bert编码器之上堆叠一个卷积注意力网络。这对于为SpeechEncoderDecoder模型预热Wav2Vec2Bert非常有用。
  • adapter_kernel_size (int, 可选, 默认为 3) — 适配器网络中卷积层的核大小。仅在 add_adapter is True 时相关。
  • adapter_stride (int, optional, 默认为 2) — 适配器网络中卷积层的步幅。仅在 add_adapter is True 时相关。
  • num_adapter_layers (int, 可选, 默认为 1) — 适配器网络中应使用的卷积层数。仅在 add_adapter is True 时相关。
  • adapter_act (strfunction, 可选, 默认为 "relu") — 适配器层中的非线性激活函数(函数或字符串)。如果是字符串,支持 "gelu""relu""selu""swish""gelu_new"
  • use_intermediate_ffn_before_adapter (bool, 可选, 默认为 False) — 是否应在Wav2Vec2Bert编码器之上并在适配器网络之前堆叠一个中间前馈块。 仅在add_adapter is True时相关。
  • output_hidden_size (int, optional) — 编码器输出层的维度。如果未定义,则默认为 hidden-size。仅在 add_adapter is True 时相关。
  • position_embeddings_type (str, 可选, 默认为 "relative_key") — 可以指定为:
  • rotary_embedding_base (int, 可选, 默认为 10000) — 如果使用 "rotary" 位置嵌入,定义嵌入基础的大小。
  • max_source_positions (int, 可选, 默认为 5000) — 如果使用 "relative" 位置嵌入,定义最大源输入位置。
  • left_max_position_embeddings (int, optional, defaults to 64) — 如果使用"relative_key"(即Shaw)位置嵌入,定义相对位置的左裁剪值。
  • right_max_position_embeddings (int, 可选, 默认为 8) — 如果使用 "relative_key"(即 Shaw)位置嵌入,定义相对位置的右裁剪值。
  • conv_depthwise_kernel_size (int, optional, 默认为 31) — Conformer 块中卷积深度一维层的核大小。
  • conformer_conv_dropout (float, optional, defaults to 0.1) — Conformer 块中所有卷积层的 dropout 概率。

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

transformers.Wav2Vec2BertProcessor

< >

( feature_extractor tokenizer )

参数

构建一个Wav2Vec2-BERT处理器,它将Wav2Vec2-BERT特征提取器和Wav2Vec2 CTC分词器封装到一个单一的处理器中。

Wav2Vec2Processor 提供了 SeamlessM4TFeatureExtractorPreTrainedTokenizer 的所有功能。 有关更多信息,请参阅 call()decode() 的文档字符串。

__call__

< >

( audio: typing.Union[ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), typing.List[ForwardRef('np.ndarray')], typing.List[ForwardRef('torch.Tensor')]] = None text: typing.Union[str, typing.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 时,返回令牌注意力掩码。
  • labels — 用于输入模型的令牌ID列表。当 textaudio 都不是 None 时返回。
  • input_ids — 用于输入模型的令牌ID列表。当 text 不是 NoneaudioNone 时返回。

准备模型的一个或多个序列和音频的主要方法。如果audio不为None,则此方法将audiokwargs参数转发给SeamlessM4TFeatureExtractor的call()以预处理音频。为了准备目标序列,如果text不为None,则此方法将textkwargs参数转发给PreTrainedTokenizer的call()。有关更多信息,请参考上述两个方法的文档字符串。

pad

< >

( input_features = None labels = None **kwargs )

如果 input_features 不是 None,此方法将 input_featureskwargs 参数转发给 SeamlessM4TFeatureExtractor 的 pad() 以填充输入特征。 如果 labels 不是 None,此方法将 labelskwargs 参数转发给 PreTrainedTokenizer 的 pad() 以填充标签。 请参考上述两个方法的文档字符串以获取更多信息。

from_pretrained

< >

( pretrained_model_name_or_path **kwargs )

save_pretrained

< >

( save_directory push_to_hub: bool = False **kwargs )

参数

  • save_directory (str or os.PathLike) — 将保存特征提取器 JSON 文件和分词器文件的目录(如果目录不存在,将会创建)。
  • push_to_hub (bool, optional, defaults to 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()。请参考该方法的文档字符串以获取更多信息。

解码

< >

( *args **kwargs )

此方法将其所有参数转发给PreTrainedTokenizer的decode()。请参考该方法的文档字符串以获取更多信息。

Wav2Vec2BertModel

transformers.Wav2Vec2BertModel

< >

( config: Wav2Vec2BertConfig )

参数

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

裸的Wav2Vec2Bert模型转换器输出原始隐藏状态,没有任何特定的头部。 Wav2Vec2Bert是由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文档以获取与一般使用和行为相关的所有信息。

前进

< >

( 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.Wav2Vec2BaseModelOutputtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor of shape (batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将.flac.wav音频文件加载到List[float]类型的数组或numpy.ndarray中获取值,例如通过soundfile库(pip install soundfile)。要将数组准备为input_features,应使用AutoProcessor进行填充并转换为torch.FloatTensor类型的张量。详情请参见Wav2Vec2BertProcessor.call()
  • attention_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing convolution and attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.Wav2Vec2BaseModelOutputtuple(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 (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 之后,用于计算自注意力头中的加权平均值。

Wav2Vec2BertModel 的前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from transformers import AutoProcessor, Wav2Vec2BertModel
>>> 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("hf-audio/wav2vec2-bert-CV16-en")
>>> model = Wav2Vec2BertModel.from_pretrained("hf-audio/wav2vec2-bert-CV16-en")

>>> # 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, 146, 1024]

Wav2Vec2BertForCTC

transformers.Wav2Vec2BertForCTC

< >

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

参数

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

Wav2Vec2Bert 模型,顶部带有语言建模头,用于连接时序分类(CTC)。 Wav2Vec2Bert 是由 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文档以获取与一般使用和行为相关的所有信息。

前进

< >

( 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.CausalLMOutputtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor 形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。可以通过将 .flac.wav 音频文件加载到类型为 List[float]numpy.ndarray 的数组中来获取这些值,例如 通过 soundfile 库 (pip install soundfile)。要将数组准备为 input_features,应使用 AutoProcessor 进行填充并转换为类型为 torch.FloatTensor 的张量。详情请参见 Wav2Vec2BertProcessor.call().
  • attention_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing convolution and attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个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.CausalLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(Wav2Vec2BertConfig)和输入。

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

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

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

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

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 由 torch.FloatTensor 组成的元组(每一层一个)形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

Wav2Vec2BertForCTC 的前向方法,重写了 __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", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

>>> processor = AutoProcessor.from_pretrained("hf-audio/wav2vec2-bert-CV16-en")
>>> model = Wav2Vec2BertForCTC.from_pretrained("hf-audio/wav2vec2-bert-CV16-en")

>>> # 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]
'mr 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)
17.04

Wav2Vec2BertForSequenceClassification

transformers.Wav2Vec2BertForSequenceClassification

< >

( config )

参数

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

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

Wav2Vec2Bert 是由 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文档以获取与一般使用和行为相关的所有信息。

前进

< >

( 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.SequenceClassifierOutputtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor of shape (batch_size, sequence_length)) — Float values of input raw speech waveform. Values can be obtained by loading a .flac or .wav audio file into an array of type List[float] or a numpy.ndarray, e.g. via the soundfile library (pip install soundfile). To prepare the array into input_features, the AutoProcessor should be used for padding and conversion into a tensor of type torch.FloatTensor. See Wav2Vec2BertProcessor.call() for details.
  • attention_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing convolution and attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 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.SequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(Wav2Vec2BertConfig)和输入。

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

Wav2Vec2BertForSequenceClassification 的前向方法,重写了 __call__ 特殊方法。

尽管前向传递的配方需要在此函数内定义,但之后应该调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例:

>>> from transformers import AutoFeatureExtractor, Wav2Vec2BertForSequenceClassification
>>> 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/w2v-bert-2.0")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0")

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

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

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

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

Wav2Vec2BertForAudioFrameClassification

transformers.Wav2Vec2BertForAudioFrameClassification

< >

( config )

参数

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

Wav2Vec2Bert 模型,顶部带有帧分类头,适用于说话人日志等任务。

Wav2Vec2Bert 是由 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文档以获取与一般使用和行为相关的所有信息。

前进

< >

( 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.TokenClassifierOutputtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor of shape (batch_size, sequence_length)) — Float values of input raw speech waveform. Values can be obtained by loading a .flac or .wav audio file into an array of type List[float] or a numpy.ndarray, e.g. via the soundfile library (pip install soundfile). To prepare the array into input_features, the AutoProcessor should be used for padding and conversion into a tensor of type torch.FloatTensor. See Wav2Vec2BertProcessor.call() for details.
  • attention_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing convolution and attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量下的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个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.TokenClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(Wav2Vec2BertConfig)和输入。

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

  • logits (torch.FloatTensor 形状为 (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 后的注意力权重,用于计算自注意力头中的加权平均值。

Wav2Vec2BertForAudioFrameClassification 的前向方法,重写了 __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", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForAudioFrameClassification.from_pretrained("facebook/w2v-bert-2.0")

>>> # 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()

Wav2Vec2BertForXVector

transformers.Wav2Vec2BertForXVector

< >

( config )

参数

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

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

Wav2Vec2Bert 是由 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文档以获取与一般使用和行为相关的所有信息。

前进

< >

( 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.XVectorOutputtuple(torch.FloatTensor)

参数

  • input_features (torch.FloatTensor of shape (batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将.flac.wav音频文件加载到List[float]类型的数组或numpy.ndarray中获取值,例如通过soundfile库(pip install soundfile)。要将数组准备为input_features,应使用AutoProcessor进行填充并转换为torch.FloatTensor类型的张量。详情请参见Wav2Vec2BertProcessor.call()
  • attention_mask (torch.LongTensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing convolution and attention on padding token indices. Mask values selected in [0, 1]:
    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    什么是注意力掩码?

  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量下的hidden_states
  • return_dict (bool, 可选) — 是否返回一个 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.XVectorOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.XVectorOutput 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种 元素,具体取决于配置(Wav2Vec2BertConfig)和输入。

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

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

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

  • hidden_states (tuple(torch.FloatTensor)可选,当传递 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 后的注意力权重,用于计算自注意力头中的加权平均值。

Wav2Vec2BertForXVector 的前向方法,重写了 __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", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForXVector.from_pretrained("facebook/w2v-bert-2.0")

>>> # 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!")
< > Update on GitHub