UniSpeech

概述

UniSpeech 模型由 Chengyi Wang、Yu Wu、Yao Qian、Kenichi Kumatani、Shujie Liu、Furu Wei、Michael Zeng、Xuedong Huang 在论文 UniSpeech: Unified Speech Representation Learning with Labeled and Unlabeled Data 中提出。

论文摘要如下：

在本文中，我们提出了一种名为 UniSpeech 的统一预训练方法，用于同时利用有标签和无标签数据学习语音表征。该方法以多任务学习的方式，同时进行监督式音素 CTC 学习和音素感知的对比自监督学习。由此产生的表征能够捕获与音素结构更相关的信息，并提高跨语言和跨领域的泛化能力。我们在公开的 CommonVoice 语料库上评估了 UniSpeech 在跨语言表征学习方面的有效性。结果表明，UniSpeech 在语音识别任务中，相较于自监督预训练和监督迁移学习，其相对音素错误率分别最高降低了 13.4% 和 17.8%（在所有测试语言上取平均值）。UniSpeech 的可迁移性也在一个领域迁移的语音识别任务中得到验证，与之前的方法相比，其相对词错误率降低了 6%。

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

使用技巧

UniSpeech 是一个语音模型，它接受一个与语音信号原始波形相对应的浮点数组。请使用 Wav2Vec2Processor 进行特征提取。
UniSpeech 模型可以使用联结主义时间分类（CTC）进行微调，因此模型输出必须使用 Wav2Vec2CTCTokenizer 进行解码。

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

资源

UniSpeechConfig

class transformers.UniSpeechConfig

< 来源 >

( 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 num_ctc_classes = 80 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 replace_prob = 0.5 **kwargs )

参数

vocab_size (int, 可选, 默认为 32) — UniSpeech 模型的词汇表大小。定义了在调用 UniSpeechModel 时传递的 `inputs_ids` 可以表示的不同 token 的数量。模型的词汇表大小。定义了传递给 UniSpeechModel 的前向方法的 *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 (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) — UniSpeechForCTC 最终投影层的丢弃概率。
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 为 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_prob*len(time_axis)/mask_time_length” 个独立的掩码。如果从每个特征向量被选为要掩码的向量跨度起点的概率来推断，*mask_time_prob* 应该等于 `prob_vector_start*mask_time_length`。注意，重叠可能会减少实际被掩码向量的百分比。此参数仅在 `apply_spec_augment 为 True` 时有效。
mask_time_length (int, 可选, 默认为 10) — 时间轴上向量跨度的长度。
mask_time_min_masks (int, 可选, 默认为 2) — 无论 `mask_feature_prob` 如何，在每个时间步沿时间轴生成长度为 `mask_feature_length` 的最小掩码数量。仅当 “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_prob` 如何，在每个时间步沿特征轴生成长度为 `mask_feature_length` 的最小掩码数量。仅当 “mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 时相关。
num_codevectors_per_group (int, optional, defaults to 320) — 每个量化码本（组）中的条目数。
num_codevector_groups (int, optional, defaults to 2) — 用于乘积码向量量化的码向量组数。
contrastive_logits_temperature (float, optional, defaults to 0.1) — 对比损失中的温度参数 kappa。
num_negatives (int, optional, defaults to 100) — 对比损失的负样本数量。
codevector_dim (int, optional, defaults to 256) — 量化特征向量的维度。
proj_codevector_dim (int, optional, defaults to 256) — 量化特征和 Transformer 特征的最终投影维度。
diversity_loss_weight (int, optional, defaults to 0.1) — 码本多样性损失分量的权重。
ctc_loss_reduction (str, optional, defaults to "mean") — 指定应用于 torch.nn.CTCLoss 输出的规约方式。仅在训练 UniSpeechForCTC 实例时相关。
ctc_zero_infinity (bool, optional, defaults to False) — 是否将 torch.nn.CTCLoss 的无限损失及其相关梯度置零。无限损失主要发生在输入过短而无法与目标对齐时。仅在训练 UniSpeechForCTC 实例时相关。
use_weighted_layer_sum (bool, optional, defaults to False) — 是否使用带有学习权重的层输出的加权平均。仅在使用 UniSpeechForSequenceClassification 实例时相关。
classifier_proj_size (int, optional, defaults to 256) — 在进行词元均值池化以进行分类之前的投影维度。
num_ctc_classes (int, optional, defaults to 80) — 指定音素级 CTC 损失的类别数（音素词元和空白词元）。仅在使用 UniSpeechForPreTraining 实例时相关。
pad_token_id (int, optional, defaults to 0) — 填充词元的 ID。
bos_token_id (int, optional, defaults to 1) — “序列开始”词元的 ID。
eos_token_id (int, optional, defaults to 2) — “序列结束”词元的 ID。
replace_prob (float, optional, defaults to 0.5) — 在预训练中，Transformer 特征被量化特征替换的概率。

这是用于存储 UniSpeechModel 配置的配置类。它用于根据指定的参数实例化一个 UniSpeech 模型，定义模型架构。使用默认值实例化配置将产生与 UniSpeech microsoft/unispeech-large-1500h-cv 架构类似的配置。

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

示例

>>> from transformers import UniSpeechConfig, UniSpeechModel

>>> # Initializing a UniSpeech facebook/unispeech-base-960h style configuration
>>> configuration = UniSpeechConfig()

>>> # Initializing a model (with random weights) from the facebook/unispeech-base-960h style configuration
>>> model = UniSpeechModel(configuration)

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

UniSpeech 特定输出

class transformers.models.unispeech.modeling_unispeech.UniSpeechForPreTrainingOutput

< source >

( loss: 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 (*optional*, 在模型处于训练模式时返回, 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，代表对比损失的正目标向量。
codevector_perplexity (torch.FloatTensor of shape (1,)) — 码向量分布的困惑度，用于衡量码本的多样性。
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, 当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

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

UniSpeechModel

class transformers.UniSpeechModel

< source >

( config: UniSpeechConfig )

参数

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

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

此模型继承自 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 or tuple(torch.FloatTensor)

参数

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

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

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

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), optional, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出 + 每层的输出各一个），形状为 (batch_size, sequence_length, hidden_size)。

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

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

UniSpeechModel 的前向方法，重写了 __call__ 特殊方法。

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

UniSpeechForCTC

class transformers.UniSpeechForCTC

< source >

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

参数

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

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

此模型继承自 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 or tuple(torch.FloatTensor)

参数

input_values (torch.Tensor of shape (batch_size, sequence_length), optional) — 输入原始语音波形的浮点数值。可以通过将 .flac 或 .wav 音频文件加载到 list[float] 或 numpy.ndarray 类型的数组中来获取这些值，例如，通过 soundfile 库（pip install soundfile）。为了将数组准备成 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 {processor_class}.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免在填充词元索引上执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示**未被掩码**的词元，
- 0 表示**被掩码**的词元。
什么是注意力掩码？
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。
labels (torch.LongTensor of shape (batch_size, target_length), optional) — 用于连接主义时间分类的标签。请注意，target_length 必须小于或等于输出 logits 的序列长度。索引在 [-100, 0, ..., config.vocab_size - 1] 中选择。所有设置为 -100 的标签都将被忽略（掩码），损失仅针对 [0, ..., config.vocab_size - 1] 中的标签计算。

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

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

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 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个为嵌入层的输出，另外每个层各有一个输出），形状为 (batch_size, sequence_length, hidden_size)。

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

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

UniSpeechForCTC 的 forward 方法重写了 __call__ 特殊方法。

示例

>>> from transformers import AutoProcessor, UniSpeechForCTC
>>> 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-large-1500h-cv")
>>> model = UniSpeechForCTC.from_pretrained("microsoft/unispeech-large-1500h-cv")

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

UniSpeechForSequenceClassification

class transformers.UniSpeechForSequenceClassification

< 源代码 >

( config )

参数

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

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

此模型继承自 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 类型的张量。有关详细信息，请参阅 UniSpeechProcessor.__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 时），根据配置（UniSpeechConfig）和输入，包含各种元素。

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 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个为嵌入层的输出，另外每个层各有一个输出），形状为 (batch_size, sequence_length, hidden_size)。

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

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

UniSpeechForSequenceClassification 的 forward 方法重写了 __call__ 特殊方法。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, UniSpeechForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/unispeech-large-1500h-cv")
>>> model = UniSpeechForSequenceClassification.from_pretrained("microsoft/unispeech-large-1500h-cv")

>>> 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 = UniSpeechForSequenceClassification.from_pretrained("microsoft/unispeech-large-1500h-cv", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, UniSpeechForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/unispeech-large-1500h-cv")
>>> model = UniSpeechForSequenceClassification.from_pretrained("microsoft/unispeech-large-1500h-cv", 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 = UniSpeechForSequenceClassification.from_pretrained(
...     "microsoft/unispeech-large-1500h-cv", 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

UniSpeechForPreTraining

class transformers.UniSpeechForPreTraining

< 源代码 >

( config: UniSpeechConfig )

参数

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

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

此模型继承自 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.modeling_unispeech.UniSpeechForPreTrainingOutput 或 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.modeling_unispeech.UniSpeechForPreTrainingOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.unispeech.modeling_unispeech.UniSpeechForPreTrainingOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（UniSpeechConfig）和输入，包含各种元素。

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，表示对照损失的正向目标向量。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

UniSpeechForPreTraining 的 forward 方法重写了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoFeatureExtractor, UniSpeechForPreTraining

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-large-1500h-cv")
>>> model = UniSpeechForPreTraining.from_pretrained("microsoft/unispeech-large-1500h-cv")
>>> # TODO: Add full pretraining example

< > 在 GitHub 上更新

Transformers

UniSpeech

概述

使用技巧

资源

UniSpeechConfig

class transformers.UniSpeechConfig

UniSpeech 特定输出

class transformers.models.unispeech.modeling_unispeech.UniSpeechForPreTrainingOutput

UniSpeechModel

class transformers.UniSpeechModel

forward

UniSpeechForCTC

class transformers.UniSpeechForCTC

forward

UniSpeechForSequenceClassification

class transformers.UniSpeechForSequenceClassification

forward

UniSpeechForPreTraining

class transformers.UniSpeechForPreTraining

forward