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进行解码。
资源
UniSpeechConfig
类 transformers.UniSpeechConfig
< 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 num_ctc_classes = 80 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 replace_prob = 0.5 **kwargs )
参数
- vocab_size (<code>int</code>, <em>可选</em>, 默认为 32) — UniSpeech 模型的词汇量。定义了在调用 <a href="/docs/transformers/v4.44.0/en/model_doc/unispeech#transformers.UniSpeechModel">UniSpeechModel</a> 时，<code>inputs_ids</code> 可以表示的不同标记的数量。模型词汇量。定义了通过 <a href="/docs/transformers/v4.44.0/en/model_doc/unispeech#transformers.UniSpeechModel">UniSpeechModel</a> 的 forward 方法传递的 <em>inputs_ids</em> 可以表示的不同标记。
- hidden_size (<code>int</code>, <em>可选</em>, 默认为 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概率。 - final_dropout (
float, 可选, 默认值为0.1) — UniSpeechForCTC的最终投影层的dropout概率。 - layerdrop (
float, 可选，默认为 0.1) — 层级Drop概率。参见[层级Drop论文](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（《字符串》可选，默认为
"group") — 应用于特征编码器中一维卷积层的归一化方法。选项之一是"group"，表示仅对第一个一维卷积层进行组归一化，或是"layer"表示对所有一维卷积层进行层归一化。 - feat_extract_activation（《字符串》可选，默认为
“gelu”) — 特征提取器中一维卷积层使用的非线性激活函数（函数或字符串）。如果为字符串，支持“gelu”、“relu”、“selu”和“gelu_new”。 - conv_dim（《整数元组`[int]`或`[int]`列表`[int], 可选，默认为
(512, 512, 512, 512, 512, 512, 512)) — 定义特征编码器中每个一维卷积层的输入和输出通道数的整数元组。`conv_dim`的长度定义了一维卷积层数量。 - conv_stride (
整数元组或整数列表，可选，默认为(5, 2, 2, 2, 2, 2, 2)）— 定义特征编码器中每个 1D 卷积层的步长的整数元组。conv_stride 的长度定义了卷积层的数量，且必须与 conv_dim 的长度匹配。 - conv_kernel (
整数元组或整数列表，可选，默认为(10, 3, 3, 3, 3, 2, 2)）— 定义特征编码器中每个 1D 卷积层的内核大小的整数元组。conv_kernel 的长度定义了卷积层的数量，且必须与 conv_dim 的长度匹配。 - conv_bias (
布尔值，可选，默认为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_probapply_spec_augment 为 True 时相关。 - mask_time_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, optional, defaults to 256) — 投影维度的最终量化变压器特征。 - diversity_loss_weight (
int, optional, defaults to 0.1) — 代码多样性损失的权重。 - ctc_loss_reduction (
str, optional, defaults to"mean") — 定义应用于torch.nn.CTCLoss输出的方法。仅在训练UniSpeechForCTC实例时相关。 - num_ctc_classes (
int, 可选, 默认为 80) — 指定声素级别的CTC损失的类别数（声素标记和空白标记）。只有在使用 UniSpeechForPreTraining 实例时相关。 - pad_token_id (
int, 可选, 默认为 0) — 填充标记的ID。 - bos_token_id (
int, 可选, 默认为 1) — “序列开始”标记的ID。 - eos_token_id (
int, 可选, 默认为 2) — “序列结束”标记的ID。 - replace_prob (
float, 可选，默认为0.5) — 对于预训练，变压器特征被量化特征替换的概率。
这是存储UniSpeech模型配置的配置类。它用于根据指定的参数实例化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.configUniSpeech特定输出
类 transformers.models.unispeech.modeling_unispeech.UniSpeechForPreTrainingOutput
< 源代码 >( loss: 可选 = None projected_states: FloatTensor = None projected_quantized_states: FloatTensor = None codevector_perplexity: FloatTensor = None hidden_states: 可选 = None attentions: 可选 = None )
参数
- 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)，可选，当传递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的元组（每个层一个）。注意力软阈值后的注意力权重，用于在自注意力头中计算加权的平均。
UniSpeechForPreTrainingOutput 的输出类型，可能包含隐藏状态和注意力信息。
UniSpeechModel
类 transformers.UniSpeechModel
< 源代码 >( config: UniSpeechConfig )
参数
- config (UniSpeechConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时，不会加载与模型关联的权重，只加载配置。检查 from_pretrained() 方法来加载模型权重。
一个裸UniSpeech模型变压器，输出原始隐藏状态而没有顶部特定头部。UniSpeech在《使用标签和非标签数据的统一的语音表示学习》论文中被提出，该论文的作者是 Chengyi Wang, Yu Wu, Yao Qian, Kenichi Kumatani, Shujie Liu, Furu Wei, Michael Zeng, Xuedong Huang。
该模型继承自 PreTrainedModel。请查看基类文档以了解库为所有模型（如下载或保存等）实现的通用方法。
此模型是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参照 PyTorch 文档了解所有有关通用用法和行为的相关事项。
正向
< source >( 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.FloatTensorof 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形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行卷积和注意力操作的掩码。所选的掩码值在[0, 1]范围内：- 1 对应于未掩码的标记
- 0 对应于掩码标记
attention_mask应仅在相应的处理器有config.return_attention_mask == True时传递。对于处理器有config.return_attention_mask == False的所有模型，应不传递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），这取决于配置（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)，可选，在传递了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后的注意力权重，用于在自注意力头中计算加权的平均值。
UniSpeechModel向前方法覆盖了特殊方法__call__。
尽管需要在这个函数内定义正向传递的配方，但应该在之后调用Module实例，而不仅仅是这个，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoProcessor, UniSpeechModel
>>> 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("patrickvonplaten/unispeech-large-1500h-cv-timit")
>>> model = UniSpeechModel.from_pretrained("patrickvonplaten/unispeech-large-1500h-cv-timit")
>>> # 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, 1024]UniSpeechForCTC
类 transformers.UniSpeechForCTC
< source >( config target_lang: Optional = None )
参数
- config (UniSpeechConfig) — 模型配置类，包含模型的全部参数。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看from_pretrained()方法来加载模型权重。
- target_lang (
str, 可选) — 适配器权重所存储的语语言id。适配器权重存储的格式为adapter..safetensors或adapter. .bin。在 使用带有适配器的UniSpeechForCTC实例时相关。默认使用‘eng’。
带有用于连接主义时序分类（CTC）的顶部分词模型的UniSpeech模型。UniSpeech由Chengyi Wang等人，在UniSpeech: Unified Speech Representation Learning with Labeled and Unlabeled Data中提出。
该模型继承自 PreTrainedModel。请查看基类文档以了解库为所有模型（如下载或保存等）实现的通用方法。
此模型是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参照 PyTorch 文档了解所有有关通用用法和行为的相关事项。
正向
< 源码 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = 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]之间 Selection:- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
attention_mask应仅在相应的处理器有config.return_attention_mask == True时传递。对于所有处理器具有config.return_attention_mask == False的模型，attention_mask应 不 传递，以避免批推理时的性能下降。对于此类模型，input_values简单地用 0 填充并传递不使用attention_mask。请注意，这些模型的结果也略微取决于input_values是否填充。 - output_attentions (
bool, 可选) — 是否返回所有注意力层 attention tensors。更多详情见返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情见返回的 tensors 下的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)
A transformers.modeling_outputs.CausalLMOutput 或一个紧跟 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），包含根据配置（如 UniSpeechConfig）和输入的配置而不同的各种元素。
-
loss（《torch.FloatTensor，形状为
(1,)，可选，当提供labels时返回） — 语言模型损失（用于下一个 token 预测）。 -
logits（《torch.FloatTensor，形状为
(batch_size, sequence_length, config.vocab_size)） — 语言模型头的预测得分（SoftMax 之前的每个词汇的得分）。 -
hidden_states（《torch.FloatTensor 的元组，可选，当传递
output_hidden_states=True或当config.output_hidden_states=True时返回） — 每层模型的隐藏状态（如果模型有嵌入层，则为嵌入层的输出 + 每层的输出）。形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出以及可选的初始嵌入输出中的隐藏状态。
-
attentions (
tuple(torch.FloatTensor)，可选，在传递了output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权的平均值。
UniSpeechForCTC 的向前方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义正向传递的配方，但应该在之后调用Module实例，而不仅仅是这个，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoProcessor, UniSpeechForCTC
>>> 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("patrickvonplaten/unispeech-large-1500h-cv-timit")
>>> model = UniSpeechForCTC.from_pretrained("patrickvonplaten/unispeech-large-1500h-cv-timit")
>>> # 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 quilter is the apposl of the midle classes and weare glad to welcom his gosepl'
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
17.17UniSpeechForSequenceClassification
类 transformers.UniSpeechForSequenceClassification
< 来源 >( config )
参数
- config (UniSpeechConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时不会加载模型相关联的权重，只加载配置。请查看 from_pretrained() 方法以加载模型权重。
UniSpeech 模型在顶部加上了序列分类头（池化输出的线性层），用于类似 SUPERB 关键词检测等任务。
UniSpeech 在 Chengyi Wang 等人发表的 UniSpeech: Unified Speech Representation Learning with Labeled and Unlabeled Data 中提出。
该模型继承自 PreTrainedModel。请查看基类文档以了解库为所有模型（如下载或保存等）实现的通用方法。
此模型是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参照 PyTorch 文档了解所有有关通用用法和行为的相关事项。
正向
< 来源 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensorof 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形状为(batch_size, sequence_length)，可选）—— 用于避免对填充标记索引执行卷积和注意力的掩码。掩码值在[0, 1]范围内选择：- 1 代表非掩码标记
- 0 代表掩码标记
attention_mask仅当相应的处理器有config.return_attention_mask == True时才需传递。对于所有处理器参数为config.return_attention_mask == False的模型，不要 传递attention_mask，以避免在批量推理时性能降低。对于此类模型，input_values应简单地用 0 填充并通过不带attention_mask传递。请注意，这些模型在输入值是否填充的情况下也会产生略微不同的结果。 - output_attentions （
bool，可选）—— 是否返回所有注意力层的注意力张量。关于返回张量下的attentions的更多详情，请参阅。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensorof shape(batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]之间。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.SequenceClassifierOutput 或一个包含 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），其组成取决于配置（UniSpeechConfig）和输入。
-
loss (
torch.FloatTensorof shape(1,), 可选, 返回当提供labels时) — 分类（或如果 config.num_labels==1，则为回归）损失。 -
logits (
torch.FloatTensorof shape(batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states（《torch.FloatTensor 的元组，可选，当传递
output_hidden_states=True或当config.output_hidden_states=True时返回） — 每层模型的隐藏状态（如果模型有嵌入层，则为嵌入层的输出 + 每层的输出）。形状为(batch_size, sequence_length, hidden_size)。模型在每个层的输出以及可选的初始嵌入输出中的隐藏状态。
-
attentions (
tuple(torch.FloatTensor)，可选，在传递了output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力softmax后的注意力权重，用于在自注意力头中计算加权的平均值。
UniSpeechForSequenceClassification 的 forward 方法，重写了 __call__ 特殊方法。
尽管需要在这个函数内定义正向传递的配方，但应该在之后调用Module实例，而不仅仅是这个，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, UniSpeechForSequenceClassification
>>> 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("patrickvonplaten/unispeech-large-1500h-cv-timit")
>>> model = UniSpeechForSequenceClassification.from_pretrained("patrickvonplaten/unispeech-large-1500h-cv-timit")
>>> # 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).lossUniSpeechForPreTraining
类 transformers.UniSpeechForPreTraining
< 来源 >( config: UniSpeechConfig )
参数
- config (UniSpeechConfig) — 模型配置类，包含所有模型参数。使用配置文件初始化时不会加载模型相关的权重，只有配置。请查看 from_pretrained() 方法来加载模型权重。
UniSpeech 模型带有向量量化模块和 ctc 损失函数用于预训练。UniSpeech 由 Chengyi Wang 等人在论文 UniSpeech: Unified Speech Representation Learning with Labeled and Unlabeled Data 中提出。
该模型继承自 PreTrainedModel。请查看基类文档以了解库为所有模型（如下载或保存等）实现的通用方法。
此模型是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参照 PyTorch 文档了解所有有关通用用法和行为的相关事项。
正向
< 源代码 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.models.unispeech.modeling_unispeech.UniSpeechForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensorof 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.LongTensorof shape(batch_size, sequence_length), optional) - 避免在填充token索引上执行卷积和注意力的掩码。掩码值选择在[0, 1]:- 1 表示 未掩码 的tokens，
- 0 表示 掩码 的tokens。
attention_mask只应在相应的处理器有config.return_attention_mask == True时传递。对于所有处理器有config.return_attention_mask == False的模型，应 不传递attention_mask，以避免批量推理时的性能下降。对于此类模型，input_values应简单地用0填充并传递，无需attention_mask。请注意，这些模型的结果也会因是否有填充的input_values而略有不同。 - output_attentions (
bool, optional) - 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) - 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput对象而不仅仅是普通元组。 - mask_time_indices (
torch.BoolTensor尺寸为(batch_size, sequence_length), 可选) — 用于对比损失的提取特征的索引进行屏蔽。在训练模式下，模型学习在config.proj_codevector_dim空间中预测屏蔽的提取特征。 - sampled_negative_indices (
torch.BoolTensor尺寸为(batch_size, sequence_length, num_negatives), 可选) — 指示在对比损失中使用哪些量化目标向量作为负采样向量的索引。预训练的必需输入。
返回值
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 (可选，在模型处于训练模式时返回，尺寸为
(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时返回) — 形状为(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后的注意力权重，用于在自注意力头中计算加权的平均值。
UniSpeechForPreTraining 前向方法覆盖了 __call__ 特殊方法。
尽管需要在这个函数内定义正向传递的配方，但应该在之后调用Module实例，而不仅仅是这个，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> 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