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