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: 具有说话人感知预训练的通用语音表征学习中提出。
论文中的摘要如下
自监督学习 (SSL) 是语音处理领域长期以来的目标，因为它利用了大规模无标签数据，并避免了大量的人工标注。近年来，自监督学习在语音识别领域取得了巨大成功，而针对说话人特征建模的 SSL 应用探索却十分有限。本文旨在改进现有的 SSL 框架，用于说话人表征学习。为了增强无监督说话人信息提取，本文提出了两种方法。首先，我们在现有的 SSL 框架中应用多任务学习，将语段级对比损失与 SSL 目标函数相结合。其次，为了更好地进行说话人辨别，我们提出了一种用于数据增强的语段混合策略，该策略在训练过程中无监督地创建额外的重叠语段并将其整合到训练中。我们将所提出的方法集成到 HuBERT 框架中。在 SUPERB 基准测试上的实验结果表明，所提出的系统在通用表征学习方面取得了最先进的性能，尤其是针对说话人识别相关的任务。我们进行了消融研究，验证了每种所提出方法的有效性。最后，我们将训练数据集扩展到 94,000 小时的公开音频数据，并在所有 SUPERB 任务中取得了进一步的性能提升。
此模型由patrickvonplaten贡献。作者的代码可以在这里找到这里.
使用技巧
- UniSpeechSat 是一个语音模型，它接受一个浮点数组，对应语音信号的原始波形。请使用 Wav2Vec2Processor 进行特征提取。
- UniSpeechSat 模型可以使用连接性时序分类 (CTC) 进行微调，因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。
- UniSpeechSat 在说话人验证、说话人识别和说话人分离任务中表现尤为出色。
资源
UniSpeechSatConfig
class transformers.UniSpeechSatConfig
< source >( 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 的 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) — 嵌入、编码器和池化器中所有全连接层的 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 概率。 - initializer_range (
float, 可选, 默认为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。 - 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 卷积位置嵌入层的内核大小。 - do_stable_layer_norm (
bool, 可选, 默认值为False) — 是否应用 Transformer 编码器的稳定层归一化架构。do_stable_layer_norm 为 True对应于在注意力层之前应用层归一化，而do_stable_layer_norm 为 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_problen(time_axis)/mask_time_length”个独立的屏蔽。如果从每个特征向量被选为要屏蔽的向量跨度的起始位置的概率进行推理，则mask_time_prob 应该是 `prob_vector_startmask_time_length`。请注意，重叠可能会降低实际屏蔽向量的百分比。这仅在apply_spec_augment 为 True时才相关。 - mask_time_length (
int, 可选, 默认值为 10) — 时间轴上向量跨度的长度。 - mask_time_min_masks (
int, 可选, 默认值为 2) — 沿时间轴生成的长度为mask_feature_length的屏蔽的最小数量，每次步骤，与mask_feature_prob无关。仅当“mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 时才相关。 - mask_feature_prob (
float, 可选, 默认值为 0.0) — 特征轴上所有特征向量将被屏蔽的百分比（介于 0 到 1 之间）。屏蔽过程在轴上生成“mask_feature_problen(feature_axis)/mask_time_length”个独立的屏蔽。如果从每个特征向量被选为要屏蔽的向量跨度的起始位置的概率进行推理，则mask_feature_prob 应该是 `prob_vector_startmask_feature_length`。请注意，重叠可能会降低实际屏蔽向量的百分比。这仅在apply_spec_augment 为 True时才相关。 - mask_feature_length (
int, 可选, 默认值为 10) — 沿特征轴上向量跨度的长度。 - mask_feature_min_masks (
int, 可选, 默认值为 0) — 沿特征轴生成的长度为mask_feature_length的屏蔽的最小数量，每次步骤，与mask_feature_prob无关。仅当“mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 时才相关。 - num_codevectors_per_group (
int, 可选, 默认值为 320) — 每个量化码本（组）中的条目数。 - num_codevector_groups (
int, 可选, 默认 - 对比损失温度 (
float, 可选, 默认值 0.1) — 对比损失中的温度 *kappa*。 - 负样本数量 (
int, 可选, 默认值 100) — 对比损失的负样本数量。 - 代码向量维度 (
int, 可选, 默认值 256) — 量化特征向量的维度。 - 代码向量投影维度 (
int, 可选, 默认值 256) — 量化特征和 Transformer 特征的最终投影的维度。 - 多样性损失权重 (
int, 可选, 默认值 0.1) — 代码簿多样性损失组件的权重。 - CTC 损失缩减 (
str, 可选, 默认值"mean") — 指定应用于torch.nn.CTCLoss输出的缩减。仅在训练 UniSpeechSatForCTC 的实例时相关。 - CTC 零无穷 (
bool, 可选, 默认值False) — 是否将torch.nn.CTCLoss的无限损失和相关梯度归零。无限损失主要发生在输入太短而无法与目标对齐时。仅在训练 UniSpeechSatForCTC 的实例时相关。 - 使用加权层求和 (
bool, 可选, 默认值False) — 是否使用具有学习权重的层输出的加权平均值。仅在使用 UniSpeechSatForSequenceClassification 的实例时相关。 - 分类器投影大小 (
int, 可选, 默认值 256) — 用于分类的 token 平均池化之前的投影维度。 - TDNN 维度 (
Tuple[int]或List[int], 可选, 默认值(512, 512, 512, 512, 1500)) — 一组整数，定义 *XVector* 模型中 *TDNN* 模块中每个 1D 卷积层的输出通道数。tdnn_dim 的长度定义了 *TDNN* 层的数量。 - 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.configUniSpeechSat 特定输出
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 (可选, 当模型处于训练模式时返回, 形状为
(1,)的torch.FloatTensor) — 总损失，是对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。(分类) 损失。 - projected_states (
torch.FloatTensor形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 模型的隐藏状态投影到 config.proj_codevector_dim，可用于预测掩码后的投影量化状态。 - projected_quantized_states (
torch.FloatTensor形状为(batch_size, sequence_length, config.proj_codevector_dim)) — 量化后的提取特征向量投影到 config.proj_codevector_dim，表示对比损失的正目标向量。 - hidden_states (
tuple(torch.FloatTensor), 可选, 在传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size).模型在每一层输出的隐藏状态，加上初始嵌入输出。
- attentions (
tuple(torch.FloatTensor), 可选, 在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length).自注意力头中用于计算加权平均值的注意力 softmax 后的权重。
UniSpeechSatForPreTrainingOutput 的输出类型，可能包含隐藏状态和注意力。
UniSpeechSatModel
class transformers.UniSpeechSatModel
< 源代码 >( config: UniSpeechSatConfig )
参数
- config (UniSpeechSatConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
UniSpeechSat 模型的裸 Transformer，输出原始隐藏状态，没有特定的头部。
该模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存等）。
该模型是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解有关一般用法和行为的所有事项。
forward
< 源代码 >( 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.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型的数组中来获取，例如 通过 soundfile 库 (pip install soundfile)。要将数组准备成input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 掩码以避免在填充标记索引上执行卷积和注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
只有当相应的处理器具有
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 而不是普通元组。
返回
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时返回) —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 后的注意力权重，用于计算自注意力头中的加权平均值。
The 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, 可选) — 适配器权重的语言 ID。适配器权重以 adapter..safetensors 或 adapter. .bin 的格式存储。仅在使用带有适配器的 UniSpeechSatForCTC 实例时相关。默认情况下使用 'eng'。
UniSpeechSat 模型，顶部带有用于连接主义时间分类 (CTC) 的语言建模头。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 模块，并参考 PyTorch 文档，了解有关一般用法和行为的所有事项。
forward
< 源代码 >( 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.CausalLMOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型数组中获得，例如，通过 soundfile 库 (pip install soundfile)。为了将数组准备为input_values，应该使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。有关详细信息，请参见 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行卷积和注意力。掩码值选择在[0, 1]中:- 1 表示未掩码的标记，
- 0 表示掩码的标记。
attention_mask仅在相应的处理器具有config.return_attention_mask == True时才应传递。对于所有处理器具有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, target_length), 可选) — 连接主义时间分类标签。注意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时返回) — 语言建模损失（用于下一个词预测）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The 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.88UniSpeechSatForSequenceClassification
class transformers.UniSpeechSatForSequenceClassification
< source >( config )
参数
- config (UniSpeechSatConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
UniSpeechSat 模型，在其顶部有一个序列分类头（池化输出上的线性层），用于像 SUPERB 关键词识别这样的任务。
UniSpeechSat 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli 在 wav2vec 2.0：一种用于语音表征的自监督学习框架 中提出。
该模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存等）。
该模型是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解有关一般用法和行为的所有事项。
forward
< source >( 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.SequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型的数组中获得，例如 通过 soundfile 库（pip install soundfile）。要将数组准备成input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行卷积和注意力的掩码。掩码值选择在[0, 1]中：- 1 表示 **未被掩码** 的标记，
- 0 表示 **被掩码** 的标记。
只有当相应的处理器具有
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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包括根据配置 (UniSpeechSatConfig) 和输入的不同元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The 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).lossUniSpeechSatForAudioFrameClassification
class transformers.UniSpeechSatForAudioFrameClassification
< 源代码 >( config )
参数
- config (UniSpeechSatConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。
UniSpeech-SAT 模型，顶部带有一个帧分类头，用于扬声器区分等任务。
UniSpeechSat 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli 在 wav2vec 2.0：一种用于语音表征的自监督学习框架 中提出。
该模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存等）。
该模型是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解有关一般用法和行为的所有事项。
forward
< 源代码 >( input_values: 可选 attention_mask: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以使用 soundfile 库（pip install soundfile）将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型数组中，从而获得这些值。为了将数组准备成input_values，应使用 AutoProcessor 进行填充，并将其转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行卷积和注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记
- 0 表示屏蔽的标记
只有当相应的处理器具有
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.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），它包含各种元素，具体取决于配置 (UniSpeechSatConfig) 和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The UniSpeechSatForAudioFrameClassification 正向方法，重写了 __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
类 transformers.UniSpeechSatForXVector
< 源代码 >( config )
参数
- config (UniSpeechSatConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 XVector 特征提取头的 UniSpeech-SAT 模型，用于扬声器验证等任务。
UniSpeechSat 由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli 在 wav2vec 2.0：一种用于语音表征的自监督学习框架 中提出。
该模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存等）。
该模型是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解有关一般用法和行为的所有事项。
forward
< 源代码 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) → transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。可以通过将.flac或.wav音频文件加载到类型为List[float]或numpy.ndarray的数组中来获取值，例如 通过 soundfile 库 (pip install soundfile)。要将数组准备成input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。查看 Wav2Vec2Processor.call() 了解更多详情。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 掩码，用于避免对填充令牌索引执行卷积和注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的令牌,
- 0 表示掩码的令牌。
attention_mask仅在相应的处理器具有config.return_attention_mask == True时才应传递。对于所有处理器具有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.XVectorOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.XVectorOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置 (UniSpeechSatConfig) 和输入的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
The UniSpeechSatForXVector 正向方法，覆盖了 __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.97UniSpeechSatForPreTraining
class transformers.UniSpeechSatForPreTraining
< source >( config: UniSpeechSatConfig )
参数
- config (UniSpeechSatConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
UniSpeechSat 模型，顶部有一个量化器和 VQ 头。UniSpeechSat 在 wav2vec 2.0：语音表示的自监督学习框架 中提出，由 Alexei Baevski、Henry Zhou、Abdelrahman Mohamed、Michael Auli 提出。
该模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存等）。
该模型是一个 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解有关一般用法和行为的所有事项。
forward
< source >( 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.UniSpeechSatForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor形状为(batch_size, sequence_length)) — 输入原始语音波形的浮点值。值可以通过将.flac或.wav音频文件加载到List[float]或numpy.ndarray类型数组中获得，例如 通过 soundfile 库 (pip install soundfile)。要将数组准备为input_values，应使用 AutoProcessor 进行填充并转换为torch.FloatTensor类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充令牌索引执行卷积和注意力。掩码值在[0, 1]中选择：- 1 表示未屏蔽的令牌，
- 0 表示屏蔽的令牌。
attention_mask仅在相应的处理器具有config.return_attention_mask == True时才会传递。对于所有处理器具有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.UniSpeechSatForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含取决于配置 (UniSpeechSatConfig) 和输入的各种元素。
-
loss (可选，当模型处于训练模式时返回，形状为
(1,)的torch.FloatTensor) — 总损失，作为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。 (分类) 损失。 -
projected_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 模型的隐藏状态投影到 config.proj_codevector_dim，可用于预测掩码投影量化状态。 -
projected_quantized_states (形状为
(batch_size, sequence_length, config.proj_codevector_dim)的torch.FloatTensor) — 量化提取的特征向量投影到 config.proj_codevector_dim，表示对比损失的正目标向量。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) —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 前向方法，覆盖了 __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