UniSpeech-SAT

概述

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

论文摘要如下：

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

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

使用技巧

UniSpeechSat 是一个语音模型，它接受一个与语音信号原始波形相对应的浮点数组。请使用 Wav2Vec2Processor 进行特征提取。
UniSpeechSat 模型可以使用连接主义时间分类（CTC）进行微调，因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。
UniSpeechSat 在说话人验证、说话人识别和说话人分割任务上表现尤为出色。

[!NOTE] 当使用除 “eager” 之外的任何注意力实现时，`head_mask` 参数会被忽略。如果你有一个 `head_mask` 并且希望它生效，请使用 `XXXModel.from_pretrained(model_id, attn_implementation="eager")` 加载模型。

资源

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` 可以表示的不同标记的数量。模型的词汇表大小。定义了可以由传递给 UniSpeechSatModel 的 forward 方法的 *inputs_ids* 表示的不同标记。
hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。
num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数。
num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。
intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。
hidden_act (str 或 function, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，支持 "gelu"、"relu"、"selu" 和 "gelu_new"。
hidden_dropout (float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。
activation_dropout (float, 可选, 默认为 0.1) — 全连接层内激活函数的丢弃率。
attention_dropout (float, 可选, 默认为 0.1) — 注意力概率的丢弃率。
feat_proj_dropout (float, 可选, 默认为 0.0) — 特征编码器输出的丢弃概率。
feat_quantizer_dropout (float, 可选, 默认为 0.0) — 量化器使用的特征编码器输出的丢弃概率。
final_dropout (float, 可选, 默认为 0.1) — UniSpeechSatForCTC 最终投影层的丢弃概率。
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 值。
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` 为 True 时 relevant。
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” 时相关。
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 mean-pooling）之前的投影维度。
tdnn_dim (tuple[int] 或 list[int], 可选, 默认为 (512, 512, 512, 512, 1500)) — 一个整数元组，定义了 XVector 模型中 TDNN 模块内每个一维卷积层的输出通道数。tdnn_dim 的长度定义了 TDNN 层的数量。
tdnn_kernel (tuple[int] 或 list[int], 可选, 默认为 (5, 3, 3, 1, 1)) — 一个整数元组，定义了 XVector 模型中 TDNN 模块内每个一维卷积层的核大小。tdnn_kernel 的长度必须与 tdnn_dim 的长度相匹配。
tdnn_dilation (tuple[int] 或 list[int], 可选, 默认为 (1, 2, 3, 1, 1)) — 一个整数元组，定义了 XVector 模型中 TDNN 模块内每个一维卷积层的扩张因子。tdnn_dilation 的长度必须与 tdnn_dim 的长度相匹配。
xvector_output_dim (int, 可选, 默认为 512) — XVector 嵌入向量的维度。
pad_token_id (int, 可选, 默认为 0) — 填充词元的 ID。
bos_token_id (int, 可选, 默认为 1) — “序列开始”词元的 ID。
eos_token_id (int, 可选, 默认为 2) — “序列结束”词元的 ID。
num_clusters (int, 可选, 默认为 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

< source >

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

参数

loss (*可选*，在模型处于训练模式时返回，形状为 (1,) 的 torch.FloatTensor) — 总损失，是对比损失 (L_m) 和多样性损失 (L_d) 的和，如官方论文所述。（分类）损失。
logits (形状为 (batch_size, sequence_length, config.proj_codevector_dim) 的 torch.FloatTensor, 可选) — 对比损失模型的预测分数，即最终 softmax 之前的模型输出。
projected_states (形状为 (batch_size, sequence_length, config.proj_codevector_dim) 的 torch.FloatTensor) — 模型的隐藏状态，被投影到 config.proj_codevector_dim 维度，可用于预测被掩码的投影量化状态。
projected_quantized_states (形状为 (batch_size, sequence_length, config.proj_codevector_dim) 的 torch.FloatTensor) — 量化后的提取特征向量，被投影到 config.proj_codevector_dim 维度，代表对比损失的正目标向量。
codevector_perplexity (形状为 (1,) 的 torch.FloatTensor) — 码向量分布的困惑度，用于衡量码本的多样性。
hidden_states (tuple[torch.FloatTensor], 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个是嵌入层的输出，如果模型有嵌入层，+ 每个层的输出）。

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

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

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

UniSpeechSatModel

class transformers.UniSpeechSatModel

< source >

( config: UniSpeechSatConfig )

参数

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

基础的 Unispeech Sat 模型，输出原始隐藏状态，顶部没有任何特定的头。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。

forward

< source >

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

参数

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

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

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

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

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

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

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

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

UniSpeechSatForCTC

class transformers.UniSpeechSatForCTC

< source >

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

参数

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

UniSpeechSat 模型，顶部带有一个用于连接时序分类 (CTC) 的 语言建模 头。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。

forward

< source >

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

参数

input_values (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 输入原始语音波形的浮点数值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 类型的数组或 numpy.ndarray 中获得，例如通过 soundfile 库（pip install soundfile）。为了将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。详情请参阅 {processor_class}.__call__。
attention_mask (形状为 (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, 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），根据配置（UniSpeechSatConfig）和输入的不同，包含不同的元素。

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

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")
>>> 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]
...

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

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

UniSpeechSatForSequenceClassification

class transformers.UniSpeechSatForSequenceClassification

< source >

( config )

参数

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

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

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。

forward

< source >

参数

input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 浮点值的输入原始语音波形。可以通过将 .flac 或 .wav 音频文件加载到类型为 list[float] 或 numpy.ndarray 的数组中来获取值，例如通过 soundfile 库 (pip install soundfile)。要将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 UniSpeechSatProcessor.__call__。
attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
什么是注意力掩码？
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵）。

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

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (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), 可选, 当传递 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 后的注意力权重，用于计算自注意力头中的加权平均值。

UniSpeechSatForSequenceClassification 的 forward 方法会覆盖 __call__ 特殊方法。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, UniSpeechSatForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForSequenceClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")

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

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, UniSpeechSatForSequenceClassification

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

UniSpeechSatForAudioFrameClassification

class transformers.UniSpeechSatForAudioFrameClassification

< 源码 >

( config )

参数

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

带有帧分类头的 Unispeech Sat 模型，适用于说话人分割等任务。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。

forward

< 源码 >

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

参数

input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 浮点值的输入原始语音波形。可以通过将 .flac 或 .wav 音频文件加载到类型为 list[float] 或 numpy.ndarray 的数组中来获取值，例如通过 soundfile 库 (pip install soundfile)。要将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 UniSpeechSatProcessor.__call__。
attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
什么是注意力掩码？
labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [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 时），包含各种元素，具体取决于配置 (UniSpeechSatConfig) 和输入。

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

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")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForAudioFrameClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")

>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], return_tensors="pt", sampling_rate=sampling_rate)
>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> probabilities = torch.sigmoid(logits[0])
>>> # labels is a one-hot array of shape (num_frames, num_speakers)
>>> labels = (probabilities > 0.5).long()
>>> labels[0].tolist()
...

UniSpeechSatForXVector

class transformers.UniSpeechSatForXVector

< 源码 >

( config )

参数

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

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

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。

forward

< 源码 >

参数

input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 浮点值的输入原始语音波形。可以通过将 .flac 或 .wav 音频文件加载到类型为 list[float] 或 numpy.ndarray 的数组中来获取值，例如通过 soundfile 库 (pip install soundfile)。要将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 UniSpeechSatProcessor.__call__。
attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
什么是注意力掩码？
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.XVectorOutput 或 tuple(torch.FloatTensor)

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

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

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")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForXVector.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")

>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(
...     [d["array"] for d in dataset[:2]["audio"]], sampling_rate=sampling_rate, return_tensors="pt", padding=True
... )
>>> with torch.no_grad():
...     embeddings = model(**inputs).embeddings

>>> embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()

>>> # the resulting embeddings can be used for cosine similarity-based retrieval
>>> cosine_sim = torch.nn.CosineSimilarity(dim=-1)
>>> similarity = cosine_sim(embeddings[0], embeddings[1])
>>> threshold = 0.7  # the optimal threshold is dataset-dependent
>>> if similarity < threshold:
...     print("Speakers are not the same!")
>>> round(similarity.item(), 2)
...

UniSpeechSatForPreTraining

class transformers.UniSpeechSatForPreTraining

< 源码 >

( config: UniSpeechSatConfig )

参数

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

UniSpeechSat 模型带有用于预训练的矢量量化模块和 ctc 损失。

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

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。

forward

< 源码 >

( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput 或 tuple(torch.FloatTensor)

参数

input_values (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 浮点值的输入原始语音波形。可以通过将 .flac 或 .wav 音频文件加载到类型为 list[float] 或 numpy.ndarray 的数组中来获取值，例如通过 soundfile 库 (pip install soundfile)。要将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 {processor_class}.__call__。
attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被屏蔽，
- 0 表示标记被屏蔽。
什么是注意力掩码？
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput 或 tuple(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) 的和，如官方论文所述。（分类）损失。
logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.proj_codevector_dim)，可选) — 对比损失模型的预测分数，即最终 softmax 之前的模型输出。
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 的量化提取特征向量，表示对比损失的正目标向量。
codevector_perplexity (形状为(1,)的torch.FloatTensor) — 码向量分布的困惑度，用于衡量码本的多样性。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

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

Transformers

UniSpeech-SAT

概述

使用技巧

资源

UniSpeechSatConfig

class transformers.UniSpeechSatConfig

UniSpeechSat 特定输出

class transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput

UniSpeechSatModel

class transformers.UniSpeechSatModel

forward

UniSpeechSatForCTC

class transformers.UniSpeechSatForCTC

forward

UniSpeechSatForSequenceClassification

class transformers.UniSpeechSatForSequenceClassification

forward

UniSpeechSatForAudioFrameClassification

class transformers.UniSpeechSatForAudioFrameClassification

forward

UniSpeechSatForXVector

class transformers.UniSpeechSatForXVector

forward

UniSpeechSatForPreTraining

class transformers.UniSpeechSatForPreTraining

forward