Transformers 文档

UniSpeech-SAT

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

UniSpeech-SAT

概述

UniSpeech-SAT 模型在 UniSpeech-SAT: Universal Speech Representation Learning with Speaker Aware Pre-Training 中提出,作者是 Sanyuan Chen, Yu Wu, Chengyi Wang, Zhengyang Chen, Zhuo Chen, Shujie Liu, Jian Wu, Yao Qian, Furu Wei, Jinyu Li, Xiangzhan Yu 。

论文摘要如下:

自监督学习 (SSL) 长期以来是语音处理领域的目标,因为它利用大规模的无标签数据,避免了大量的人工标注。近年来,自监督学习在语音识别领域的应用取得了巨大成功,但在将 SSL 应用于建模说话人特征方面,探索仍然有限。在本文中,我们旨在改进现有的 SSL 框架,以用于说话人表征学习。我们引入了两种方法来增强无监督说话人信息提取。首先,我们将多任务学习应用于当前的 SSL 框架,将 utterance-wise 对比损失与 SSL 目标函数相结合。其次,为了更好地进行说话人区分,我们提出了一种 utterance 混合策略用于数据增强,其中额外重叠的 utterances 是以无监督的方式创建的,并在训练期间加入。我们将所提出的方法整合到 HuBERT 框架中。在 SUPERB 基准测试上的实验结果表明,所提出的系统在通用表征学习方面取得了最先进的性能,尤其是在面向说话人识别的任务中。我们进行了消融研究,验证了每种所提出方法的有效性。最后,我们将训练数据集扩展到 9.4 万小时的公共音频数据,并在所有 SUPERB 任务中实现了进一步的性能提升。

此模型由 patrickvonplaten 贡献。作者的代码可以在 这里 找到。

使用提示

  • UniSpeechSat 是一个语音模型,它接受对应于语音信号原始波形的浮点数组。请使用 Wav2Vec2Processor 进行特征提取。
  • UniSpeechSat 模型可以使用连接时序分类 (CTC) 进行微调,因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。
  • UniSpeechSat 在说话人验证、说话人识别和说话人日志任务上表现尤其出色。

资源

UniSpeechSatConfig

class transformers.UniSpeechSatConfig

< >

( vocab_size = 32 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 do_stable_layer_norm = False 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 = 'mean' 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 num_clusters = 504 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 32) — UniSpeechSat 模型的词汇表大小。定义了在调用 UniSpeechSatModel 时传递的 inputs_ids 可以表示的不同 token 的数量。模型的词汇表大小。定义了传递给 UniSpeechSatModel 的前向方法的 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 (strfunction, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu", "relu", "selu""gelu_new"
  • hidden_dropout (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。
  • activation_dropout (float, 可选, 默认为 0.1) — 全连接层内部激活的 dropout 比率。
  • attention_dropout (float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。
  • feat_proj_dropout (float, 可选, 默认为 0.0) — 特征编码器输出的 dropout 概率。
  • feat_quantizer_dropout (float, 可选, 默认为 0.0) — 特征编码器输出的 dropout 概率,该输出被量化器使用。
  • final_dropout (float, 可选, 默认为 0.1) — UniSpeechSatForCTC 的最终投影层的 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-05) — 层归一化层使用的 epsilon 值。
  • feat_extract_norm (str, 可选, 默认为 "group") — 要应用于特征编码器中 1D 卷积层的归一化方法。可以是 "group"(仅对第一个 1D 卷积层进行组归一化)或 "layer"(对所有 1D 卷积层进行层归一化)。
  • feat_extract_activation (str, 可选, 默认为 “gelu”) -- 特征提取器的 1D 卷积层中的非线性激活函数(函数或字符串)。如果为字符串,则支持 “gelu”, “relu”, “selu”“gelu_new”
  • 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, 2, 2)) — 定义特征编码器中每个 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 卷积位置嵌入层组的数量。
  • do_stable_layer_norm (bool, 可选, 默认为 False) — 是否应用 Transformer 编码器的稳定层归一化架构。do_stable_layer_norm is True 对应于在注意力层之前应用层归一化,而 do_stable_layer_norm is False 对应于在注意力层之后应用层归一化。
  • apply_spec_augment (bool, 可选, 默认为 True) — 是否将 SpecAugment 数据增强应用于特征编码器的输出。有关参考,请参阅 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition
  • mask_time_prob (float, 可选, 默认为 0.05) — 沿时间轴屏蔽所有特征向量的百分比(介于 0 和 1 之间)。掩码过程沿轴生成 “mask_time_prob*len(time_axis)/mask_time_length” 个独立的掩码。如果从每个特征向量被选为要掩码的向量跨度的起点的概率来推断,mask_time_prob 应该为 `prob_vector_start*mask_time_length`。 请注意,重叠可能会减少实际屏蔽向量的百分比。这仅在 apply_spec_augment is 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 is 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
  • num_negatives (int, 可选, 默认为 100) — 对比损失的负样本数量。
  • codevector_dim (int, 可选, 默认为 256) — 量化特征向量的维度。
  • proj_codevector_dim (int, 可选, 默认为 256) — 量化特征和 transformer 特征的最终投影的维度。
  • diversity_loss_weight (int, 可选, 默认为 0.1) — 码本多样性损失分量的权重。
  • ctc_loss_reduction (str, 可选, 默认为 "mean") — 指定应用于 torch.nn.CTCLoss 输出的缩减方式。仅在训练 UniSpeechSatForCTC 实例时相关。
  • ctc_zero_infinity (bool, 可选, 默认为 False) — 是否将 torch.nn.CTCLoss 的无限损失和相关梯度归零。当输入太短而无法与目标对齐时,主要会发生无限损失。仅在训练 UniSpeechSatForCTC 实例时相关。
  • use_weighted_layer_sum (bool, 可选, 默认为 False) — 是否使用层输出的加权平均值和学习到的权重。仅在使用 UniSpeechSatForSequenceClassification 实例时相关。
  • classifier_proj_size (int, 可选, 默认为 256) — 分类前 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, optional, defaults to 0) — padding token 的 id。
  • bos_token_id (int, optional, defaults to 1) — “sequence-start” token 的 id。
  • eos_token_id (int, optional, defaults to 2) — “sequence-end” token 的 id。
  • num_clusters (int, optional, defaults to 504) — 用于弱标签聚类的数量。仅在使用 UniSpeechSatForPreTraining 实例时相关。

这是用于存储 UniSpeechSatModel 配置的配置类。它用于根据指定的参数实例化 UniSpeechSat 模型,定义模型架构。使用默认值实例化配置将产生与 UniSpeechSat microsoft/unispeech-sat-base-100h-libri-ft 架构类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。请阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import UniSpeechSatModel, UniSpeechSatConfig

>>> # Initializing a UniSpeechSat microsoft/unispeech-sat-base-100h-libri-ft style configuration
>>> configuration = UniSpeechSatConfig()

>>> # Initializing a model from the microsoft/unispeech-sat-base-100h-libri-ft style configuration
>>> model = UniSpeechSatModel(configuration)

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

UniSpeechSat 特定输出

class transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput

< >

( loss: Optional = None logits: FloatTensor = None projected_states: FloatTensor = None projected_quantized_states: FloatTensor = None codevector_perplexity: FloatTensor = None hidden_states: Optional = None attentions: Optional = None )

参数

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

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

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

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

UniSpeechSatModel

class transformers.UniSpeechSatModel

< >

( config: UniSpeechSatConfig )

参数

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

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

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

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

前向传播

< >

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

参数

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

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

    什么是注意力掩码?

    只有当对应的 processor 具有 config.return_attention_mask == True 时,才应传递 attention_mask。对于所有 processor 具有 config.return_attention_mask == False 的模型,例如 microsoft/unispeech-sat-base-100h-libri-ft,应传递 attention_mask,以避免在执行批量推理时性能下降。对于此类模型,input_values 应简单地用 0 填充并传递,而无需 attention_mask。请注意,这些模型也会产生略有不同的结果,具体取决于 input_values 是否填充。

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

返回值

transformers.modeling_outputs.Wav2Vec2BaseModelOutputtuple(torch.FloatTensor)

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

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

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

  • hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — torch.FloatTensor 的元组 (每个嵌入输出层 + 每个层输出层各一个),形状为 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

UniSpeechSatModel 的前向传播方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoProcessor, UniSpeechSatModel
>>> 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("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatModel.from_pretrained("microsoft/unispeech-sat-base-100h-libri-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, 768]

UniSpeechSatForCTC

class transformers.UniSpeechSatForCTC

< >

( config target_lang: Optional = None )

参数

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

带有用于连接时序分类 (CTC) 的 language modeling 头的 UniSpeechSat 模型。UniSpeechSat 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。

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

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

前向传播

< >

( input_values: Optional attention_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None labels: Optional = None ) transformers.modeling_outputs.CausalLMOutputtuple(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), optional) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

    只有当对应的 processor 具有 config.return_attention_mask == True 时,才应传递 attention_mask。对于所有 processor 具有 config.return_attention_mask == False 的模型,例如 microsoft/unispeech-sat-base-100h-libri-ft不应 传递 attention_mask,以避免在进行批量推理时性能下降。对于此类模型,input_values 应该简单地用 0 填充,并在不使用 attention_mask 的情况下传递。请注意,这些模型也会根据 input_values 是否填充产生略微不同的结果。

  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor,形状为 (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.CausalLMOutputtorch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置 (UniSpeechSatConfig) 和输入。

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

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

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(如果模型具有嵌入层,则为嵌入输出的张量,+ 每层输出的张量),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

UniSpeechSatForCTC forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoProcessor, UniSpeechSatForCTC
>>> 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("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForCTC.from_pretrained("microsoft/unispeech-sat-base-100h-libri-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 QUILDER 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)
39.88

UniSpeechSatForSequenceClassification

class transformers.UniSpeechSatForSequenceClassification

< >

( config )

参数

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

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

UniSpeechSat 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。

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

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

前向传播

< >

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

参数

  • input_values (torch.FloatTensor,形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点值。这些值可以通过将 .flac.wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得,例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备为 input_values,应该使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息,请参阅 Wav2Vec2Processor.call()
  • attention_mask (torch.LongTensor,形状为 (batch_size, sequence_length), optional) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

    只有当对应的 processor 具有 config.return_attention_mask == True 时,才应传递 attention_mask。对于所有 processor 具有 config.return_attention_mask == False 的模型,例如 microsoft/unispeech-sat-base-100h-libri-ft不应 传递 attention_mask,以避免在进行批量推理时性能下降。对于此类模型,input_values 应该简单地用 0 填充,并在不使用 attention_mask 的情况下传递。请注意,这些模型也会根据 input_values 是否填充产生略微不同的结果。

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

返回值

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

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

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

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

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(如果模型具有嵌入层,则为嵌入输出的张量,+ 每层输出的张量),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

UniSpeechSatForSequenceClassification 的 forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoFeatureExtractor, UniSpeechSatForSequenceClassification
>>> 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("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForSequenceClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")

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

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

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

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

UniSpeechSatForAudioFrameClassification

class transformers.UniSpeechSatForAudioFrameClassification

< >

( config )

参数

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

带有帧分类头的 UniSpeech-SAT 模型,用于诸如说话人日记分割之类的任务。

UniSpeechSat 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。

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

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

前向传播

< >

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

参数

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

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

    只有当相应的处理器具有 config.return_attention_mask == True 时,才应传递 attention_mask。对于所有处理器具有 config.return_attention_mask == False 的模型,例如 microsoft/unispeech-sat-base-100h-libri-ft不应 传递 attention_mask,以避免在执行批量推理时性能下降。对于此类模型,input_values 应该简单地用 0 填充,并在不使用 attention_mask 的情况下传递。请注意,这些模型的结果也会因 input_values 是否填充而略有不同。

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

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

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

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

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(如果模型具有嵌入层,则为嵌入输出的张量,+ 每层输出的张量),形状为 (batch_size, sequence_length, hidden_size)

    模型在每层输出的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

UniSpeechSatForAudioFrameClassification 的 forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoFeatureExtractor, UniSpeechSatForAudioFrameClassification
>>> 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("microsoft/unispeech-sat-base-plus-sd")
>>> model = UniSpeechSatForAudioFrameClassification.from_pretrained("microsoft/unispeech-sat-base-plus-sd")

>>> # 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()
[0, 0]

UniSpeechSatForXVector

class transformers.UniSpeechSatForXVector

< >

( config )

参数

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

带有 XVector 特征提取头的 UniSpeech-SAT 模型,用于诸如说话人验证之类的任务。

UniSpeechSat 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli 提出。

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

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

前向传播

< >

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

参数

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

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

    只有当相应的处理器具有 config.return_attention_mask == True 时,才应传递 attention_mask。对于所有处理器具有 config.return_attention_mask == False 的模型,例如 microsoft/unispeech-sat-base-100h-libri-ft不应 传递 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.XVectorOutputtuple(torch.FloatTensor)

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

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

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

  • embeddings (torch.FloatTensor,形状为 (batch_size, config.xvector_output_dim)) — 用于基于向量相似度检索的 utterance embeddings。

  • hidden_states (tuple(torch.FloatTensor), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — torch.FloatTensor 的元组 (每个嵌入输出层 + 每个层输出层各一个),形状为 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

UniSpeechSatForXVector forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoFeatureExtractor, UniSpeechSatForXVector
>>> 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("microsoft/unispeech-sat-base-plus-sv")
>>> model = UniSpeechSatForXVector.from_pretrained("microsoft/unispeech-sat-base-plus-sv")

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

UniSpeechSatForPreTraining

class transformers.UniSpeechSatForPreTraining

< >

( config: UniSpeechSatConfig )

参数

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

带有量化器和 VQ 头部的 UniSpeechSat 模型。UniSpeechSat 在 wav2vec 2.0: A Framework for Self-Supervised Learning of Speech Representations 中被提出,作者是 Alexei Baevski, Henry Zhou, Abdelrahman Mohamed, Michael Auli。

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

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

前向传播

< >

( input_values: Optional attention_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutputtuple(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 的模型,例如 microsoft/unispeech-sat-base-100h-libri-ft不应传递 attention_mask,以避免在进行批量推理时性能下降。对于此类模型,input_values 应简单地用 0 填充,并在不使用 attention_mask 的情况下传递。请注意,这些模型的结果也会因 input_values 是否填充而略有不同。

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

返回值

transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutputtuple(torch.FloatTensor)

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

  • loss (可选,当模型处于训练模式时返回,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), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True) — torch.FloatTensor 的元组 (每个嵌入输出层 + 每个层输出层各一个),形状为 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — torch.FloatTensor 的元组 (每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

UniSpeechSatForPreTraining forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> import torch
>>> from transformers import AutoFeatureExtractor, UniSpeechSatForPreTraining
>>> from transformers.models.unispeech_sat.modeling_unispeech_sat import _compute_mask_indices

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-sat-base")
>>> model = UniSpeechSatForPreTraining.from_pretrained("microsoft/unispeech-sat-base")
>>> # TODO: Add full pretraining example
< > 在 GitHub 上更新