Transformers 文件
UniSpeech-SAT
並獲得增強的文件體驗
開始使用
UniSpeech-SAT
概述
UniSpeech-SAT 模型由 Sanyuan Chen, Yu Wu, Chengyi Wang, Zhengyang Chen, Zhuo Chen, Shujie Liu, Jian Wu, Yao Qian, Furu Wei, Jinyu Li, Xiangzhan Yu 在論文 UniSpeech-SAT: Universal Speech Representation Learning with Speaker Aware Pre-Training 中提出。
論文摘要如下:
自監督學習 (SSL) 是語音處理領域的一個長期目標,因為它利用大規模無標註資料,避免了繁瑣的人工標註。近年來,自監督學習在語音識別領域取得了巨大成功,但在說話人特徵建模方面的探索卻很有限。在本文中,我們旨在改進現有的 SSL 框架以用於說話人表示學習。我們引入了兩種方法來增強無監督說話人資訊提取。首先,我們將多工學習應用於當前的 SSL 框架,將話語級對比損失與 SSL 目標函式相結合。其次,為了更好地區分說話人,我們提出了一種用於資料增強的話語混合策略,透過無監督地建立額外的重疊話語,並將其納入訓練過程。我們將所提出的方法整合到 HuBERT 框架中。在 SUPERB 基準上的實驗結果表明,所提出的系統在通用表示學習方面達到了最先進的效能,尤其是在面向說話人識別的任務上。透過消融研究驗證了每種方法的有效性。最後,我們將訓練資料集擴充套件到 94,000 小時的公開音訊資料,並在所有 SUPERB 任務上實現了進一步的效能提升。
此模型由 patrickvonplaten 貢獻。作者的程式碼可以在這裡找到。
使用技巧
- UniSpeechSat 是一個語音模型,它接受一個與語音訊號原始波形相對應的浮點陣列。請使用 Wav2Vec2Processor 進行特徵提取。
- UniSpeechSat 模型可以使用連線主義時間分類(CTC)進行微調,因此模型輸出必須使用 Wav2Vec2CTCTokenizer 進行解碼。
- UniSpeechSat 在說話人驗證、說話人識別和說話人分割任務上表現尤為出色。
[!NOTE] 當使用除 “eager” 之外的任何注意力實現時,`head_mask` 引數會被忽略。如果你有一個 `head_mask` 並且希望它生效,請使用 `XXXModel.from_pretrained(model_id, attn_implementation="eager")` 載入模型。
資源
UniSpeechSatConfig
class transformers.UniSpeechSatConfig
< 源 >( vocab_size = 32 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout = 0.1 activation_dropout = 0.1 attention_dropout = 0.1 feat_proj_dropout = 0.0 feat_quantizer_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 feat_extract_norm = 'group' feat_extract_activation = 'gelu' conv_dim = (512, 512, 512, 512, 512, 512, 512) conv_stride = (5, 2, 2, 2, 2, 2, 2) conv_kernel = (10, 3, 3, 3, 3, 2, 2) conv_bias = False num_conv_pos_embeddings = 128 num_conv_pos_embedding_groups = 16 do_stable_layer_norm = False apply_spec_augment = True mask_time_prob = 0.05 mask_time_length = 10 mask_time_min_masks = 2 mask_feature_prob = 0.0 mask_feature_length = 10 mask_feature_min_masks = 0 num_codevectors_per_group = 320 num_codevector_groups = 2 contrastive_logits_temperature = 0.1 num_negatives = 100 codevector_dim = 256 proj_codevector_dim = 256 diversity_loss_weight = 0.1 ctc_loss_reduction = 'mean' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 tdnn_dim = (512, 512, 512, 512, 1500) tdnn_kernel = (5, 3, 3, 1, 1) tdnn_dilation = (1, 2, 3, 1, 1) xvector_output_dim = 512 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 num_clusters = 504 **kwargs )
引數
- vocab_size (
int
, 可選, 預設為 32) — UniSpeechSat 模型的詞彙表大小。定義了在呼叫 UniSpeechSatModel 時傳遞的 `inputs_ids` 可以表示的不同標記的數量。模型的詞彙表大小。定義了可以由傳遞給 UniSpeechSatModel 的 forward 方法的 *inputs_ids* 表示的不同標記。 - hidden_size (
int
, 可選, 預設為 768) — 編碼器層和池化層的維度。 - num_hidden_layers (
int
, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數。 - num_attention_heads (
int
, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數。 - intermediate_size (
int
, 可選, 預設為 3072) — Transformer 編碼器中“中間”(即前饋)層的維度。 - hidden_act (
str
或function
, 可選, 預設為"gelu"
) — 編碼器和池化器中的非線性啟用函式(函式或字串)。如果為字串,支援"gelu"
、"relu"
、"selu"
和"gelu_new"
。 - hidden_dropout (
float
, 可選, 預設為 0.1) — 嵌入層、編碼器和池化器中所有全連線層的丟棄機率。 - activation_dropout (
float
, 可選, 預設為 0.1) — 全連線層內啟用函式的丟棄率。 - attention_dropout (
float
, 可選, 預設為 0.1) — 注意力機率的丟棄率。 - feat_proj_dropout (
float
, 可選, 預設為 0.0) — 特徵編碼器輸出的丟棄機率。 - feat_quantizer_dropout (
float
, 可選, 預設為 0.0) — 量化器使用的特徵編碼器輸出的丟棄機率。 - final_dropout (
float
, 可選, 預設為 0.1) — UniSpeechSatForCTC 最終投影層的丟棄機率。 - layerdrop (
float
, 可選, 預設為 0.1) — LayerDrop 機率。更多細節請參見 [LayerDrop 論文](參見 https://huggingface.co/papers/1909.11556)。 - initializer_range (
float
, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float
, 可選, 預設為 1e-05) — 層歸一化層使用的 epsilon 值。 - feat_extract_norm (
str
, 可選, 預設為"group"
) — 應用於特徵編碼器中 1D 卷積層的歸一化方法。`"group"` 表示僅對第一個 1D 卷積層進行組歸一化,`"layer"` 表示對所有 1D 卷積層進行層歸一化。 - feat_extract_activation (
str
, *可選*, 預設為 `“gelu”`) -- 特徵提取器中 1D 卷積層的非線性啟用函式(函式或字串)。如果為字串,支援 `“gelu”`、`“relu”`、`“selu”` 和 `“gelu_new”`。 - conv_dim (
tuple[int]
或list[int]
, 可選, 預設為(512, 512, 512, 512, 512, 512, 512)
) — 一個整數元組,定義了特徵編碼器中每個 1D 卷積層的輸入和輸出通道數。conv_dim 的長度定義了 1D 卷積層的數量。 - conv_stride (
tuple[int]
或list[int]
, 可選, 預設為(5, 2, 2, 2, 2, 2, 2)
) — 一個整數元組,定義了特徵編碼器中每個 1D 卷積層的步幅。conv_stride 的長度定義了卷積層的數量,並且必須與 conv_dim 的長度匹配。 - conv_kernel (
tuple[int]
或list[int]
, 可選, 預設為(10, 3, 3, 3, 3, 2, 2)
) — 一個整數元組,定義了特徵編碼器中每個 1D 卷積層的核大小。conv_kernel 的長度定義了卷積層的數量,並且必須與 conv_dim 的長度匹配。 - conv_bias (
bool
, 可選, 預設為False
) — 1D 卷積層是否帶有偏置。 - num_conv_pos_embeddings (
int
, 可選, 預設為 128) — 卷積位置嵌入的數量。定義了 1D 卷積位置嵌入層的核大小。 - num_conv_pos_embedding_groups (
int
, 可選, 預設為 16) — 1D 卷積位置嵌入層的組數。 - do_stable_layer_norm (
bool
, 可選, 預設為False
) — 是否應用 Transformer 編碼器的*穩定*層歸一化架構。`do_stable_layer_norm is True` 對應於在注意力層之前應用層歸一化,而 `do_stable_layer_norm is False` 對應於在注意力層之後應用層歸一化。 - apply_spec_augment (
bool
, 可選, 預設為True
) — 是否對特徵編碼器的輸出應用 *SpecAugment* 資料增強。參考論文 SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition。 - mask_time_prob (
float
, 可選, 預設為 0.05) — 沿時間軸的所有特徵向量中將被掩碼的百分比(介於 0 和 1 之間)。掩碼過程會沿時間軸生成 “mask_time_prob*len(time_axis)/mask_time_length” 個獨立的掩碼。如果從每個特徵向量被選為要掩碼的向量跨度起點的機率來推斷,則 *mask_time_prob* 應為 `prob_vector_start*mask_time_length`。請注意,重疊可能會減少實際被掩碼向量的百分比。僅在 `apply_spec_augment` 為 True 時 relevant。 - mask_time_length (
int
, 可選, 預設為 10) — 沿時間軸的向量跨度長度。 - mask_time_min_masks (
int
, 可選, 預設為 2) — 沿時間軸生成的長度為 `mask_feature_length` 的最小掩碼數量,每個時間步都生成,與 `mask_feature_prob` 無關。僅在 “mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 時相關。 - mask_feature_prob (
float
, 可選, 預設為 0.0) — 沿特徵軸的所有特徵向量中將被掩碼的百分比(介於 0 和 1 之間)。掩碼過程會沿特徵軸生成 “mask_feature_prob*len(feature_axis)/mask_time_length” 個獨立的掩碼。如果從每個特徵向量被選為要掩碼的向量跨度起點的機率來推斷,則 *mask_feature_prob* 應為 `prob_vector_start*mask_feature_length`。請注意,重疊可能會減少實際被掩碼向量的百分比。僅在 `apply_spec_augment` 為 True 時相關。 - mask_feature_length (
int
, 可選, 預設為 10) — 沿特徵軸的向量跨度長度。 - mask_feature_min_masks (
int
, 可選, 預設為 0) — 沿特徵軸生成的長度為 `mask_feature_length` 的最小掩碼數量,每個時間步都生成,與 `mask_feature_prob` 無關。僅在 “mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 時相關。 - num_codevectors_per_group (
int
, 可選, 預設為 320) — 每個量化碼本(組)中的條目數。 - num_codevector_groups (
int
, 可選, 預設為 2) — 用於乘積碼本量化的碼本組數。 - contrastive_logits_temperature (
float
, 可選, 預設為 0.1) — 對比損失中的溫度 *kappa*。 - num_negatives (
int
, 可選, 預設為 100) — 對比損失的負樣本數量。 - codevector_dim (
int
, 可選, 預設為 256) — 量化特徵向量的維度。 - proj_codevector_dim (
int
, 可選, 預設為 256) — 量化特徵和 Transformer 特徵最終投影的維度。 - diversity_loss_weight (
int
, 可選, 預設為 0.1) — 碼本多樣性損失分量的權重。 - ctc_loss_reduction (
str
, 可選, 預設為"mean"
) — 指定應用於 `torch.nn.CTCLoss` 輸出的規約方式。僅在訓練 UniSpeechSatForCTC 例項時相關。 - ctc_zero_infinity (
bool
, 可選, 預設為False
) — 是否將 `torch.nn.CTCLoss` 的無限損失和相關梯度置零。無限損失主要發生在輸入過短而無法與目標對齊時。僅在訓練 UniSpeechSatForCTC 例項時相關。 - use_weighted_layer_sum (
bool
, 可選, 預設為False
) — 是否使用帶有學習權重的層輸出的加權平均。僅在使用 UniSpeechSatForSequenceClassification 例項時相關。 - classifier_proj_size (
int
, 可選, 預設為 256) — 用於分類任務時,在詞元均值池化(token mean-pooling)之前的投影維度。 - tdnn_dim (
tuple[int]
或list[int]
, 可選, 預設為(512, 512, 512, 512, 1500)
) — 一個整數元組,定義了 XVector 模型中 TDNN 模組內每個一維卷積層的輸出通道數。tdnn_dim 的長度定義了 TDNN 層的數量。 - tdnn_kernel (
tuple[int]
或list[int]
, 可選, 預設為(5, 3, 3, 1, 1)
) — 一個整數元組,定義了 XVector 模型中 TDNN 模組內每個一維卷積層的核大小。tdnn_kernel 的長度必須與 tdnn_dim 的長度相匹配。 - tdnn_dilation (
tuple[int]
或list[int]
, 可選, 預設為(1, 2, 3, 1, 1)
) — 一個整數元組,定義了 XVector 模型中 TDNN 模組內每個一維卷積層的擴張因子。tdnn_dilation 的長度必須與 tdnn_dim 的長度相匹配。 - xvector_output_dim (
int
, 可選, 預設為 512) — XVector 嵌入向量的維度。 - pad_token_id (
int
, 可選, 預設為 0) — 填充詞元的 ID。 - bos_token_id (
int
, 可選, 預設為 1) — “序列開始”詞元的 ID。 - eos_token_id (
int
, 可選, 預設為 2) — “序列結束”詞元的 ID。 - num_clusters (
int
, 可選, 預設為 504) — 用於弱標籤的聚類數量。僅在使用 UniSpeechSatForPreTraining 的例項時相關。
這是一個配置類,用於儲存 UniSpeechSatModel 的配置。它用於根據指定的引數例項化一個 UniSpeechSat 模型,定義了模型架構。使用預設值例項化配置將產生一個與 UniSpeechSat microsoft/unispeech-sat-base-100h-libri-ft 架構相似的配置。
配置物件繼承自 PretrainedConfig,可用於控制模型輸出。更多資訊請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import UniSpeechSatModel, UniSpeechSatConfig
>>> # Initializing a UniSpeechSat microsoft/unispeech-sat-base-100h-libri-ft style configuration
>>> configuration = UniSpeechSatConfig()
>>> # Initializing a model from the microsoft/unispeech-sat-base-100h-libri-ft style configuration
>>> model = UniSpeechSatModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
UniSpeechSat 特定輸出
class transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput
< source >( loss: typing.Optional[torch.FloatTensor] = None logits: typing.Optional[torch.FloatTensor] = None projected_states: typing.Optional[torch.FloatTensor] = None projected_quantized_states: typing.Optional[torch.FloatTensor] = None codevector_perplexity: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )
引數
- loss (
*可選*
,在模型處於訓練模式時返回,形狀為(1,)
的torch.FloatTensor
) — 總損失,是對比損失 (L_m) 和多樣性損失 (L_d) 的和,如 官方論文 所述。(分類)損失。 - logits (形狀為
(batch_size, sequence_length, config.proj_codevector_dim)
的torch.FloatTensor
, 可選) — 對比損失模型的預測分數,即最終 softmax 之前的模型輸出。 - projected_states (形狀為
(batch_size, sequence_length, config.proj_codevector_dim)
的torch.FloatTensor
) — 模型的隱藏狀態,被投影到 config.proj_codevector_dim 維度,可用於預測被掩碼的投影量化狀態。 - projected_quantized_states (形狀為
(batch_size, sequence_length, config.proj_codevector_dim)
的torch.FloatTensor
) — 量化後的提取特徵向量,被投影到 config.proj_codevector_dim 維度,代表對比損失的正目標向量。 - codevector_perplexity (形狀為
(1,)
的torch.FloatTensor
) — 碼向量分佈的困惑度,用於衡量碼本的多樣性。 - hidden_states (
tuple[torch.FloatTensor]
, 可選, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) — 形狀為(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元組(一個是嵌入層的輸出,如果模型有嵌入層,+ 每個層的輸出)。模型在每層輸出處的隱藏狀態,以及可選的初始嵌入輸出。
- attentions (
tuple[torch.FloatTensor]
, 可選, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元組(每層一個)。經過注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatForPreTrainingOutput
的輸出型別,可能包含隱藏狀態和注意力。
UniSpeechSatModel
class transformers.UniSpeechSatModel
< source >( config: UniSpeechSatConfig )
引數
- config (UniSpeechSatConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
基礎的 Unispeech Sat 模型,輸出原始隱藏狀態,頂部沒有任何特定的頭。
該模型繼承自 PreTrainedModel。有關該庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等),請檢視超類的文件。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None mask_time_indices: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
引數
- input_values (形狀為
(batch_size, sequence_length)
的torch.Tensor
, 可選) — 輸入原始語音波形的浮點數值。可以透過將.flac
或.wav
音訊檔案載入到list[float]
型別的陣列或numpy.ndarray
中獲得,例如透過 soundfile 庫(pip install soundfile
)。為了將陣列準備成input_values
,應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor
型別的張量。詳情請參閱{processor_class}.__call__
。 - attention_mask (形狀為
(batch_size, sequence_length)
的torch.Tensor
, 可選) — 掩碼,用於避免對填充詞元索引執行注意力。掩碼值在[0, 1]
中選擇:- 1 表示詞元未被掩碼,
- 0 表示詞元被掩碼。
- mask_time_indices (形狀為
(batch_size, sequence_length)
的torch.BoolTensor
, 可選) — 用於掩碼提取特徵以進行對比損失的索引。在訓練模式下,模型學習在 config.proj_codevector_dim 空間中預測被掩碼的提取特徵。 - output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
, 可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或一個 torch.FloatTensor
元組(如果傳遞了 return_dict=False
或 config.return_dict=False
),根據配置(UniSpeechSatConfig)和輸入的不同,包含不同的元素。
-
last_hidden_state (
torch.FloatTensor
, 形狀為(batch_size, sequence_length, hidden_size)
) — 模型最後一層輸出的隱藏狀態序列。 -
extract_features (
torch.FloatTensor
形狀為(batch_size, sequence_length, conv_dim[-1])
) — 模型最後一個卷積層的提取特徵向量序列。 -
hidden_states (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) — 形狀為(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元組(一個是嵌入層的輸出 + 每個層的輸出)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元組(每層一個)。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatModel 的 forward 方法,覆蓋了 __call__
特殊方法。
雖然前向傳播的流程需要在此函式內定義,但之後應呼叫 Module
例項而不是此函式,因為前者會處理預處理和後處理步驟,而後者會默默地忽略它們。
UniSpeechSatForCTC
class transformers.UniSpeechSatForCTC
< source >( config target_lang: typing.Optional[str] = None )
引數
- config (UniSpeechSatForCTC) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- target_lang (
str
, 可選) — 介面卡權重的語言 ID。介面卡權重以 `adapter..safetensors` 或 `adapter. .bin` 的格式儲存。僅在使用帶介面卡的 UniSpeechSatForCTC 例項時相關。預設使用‘eng’。
UniSpeechSat 模型,頂部帶有一個用於連線時序分類 (CTC) 的 語言建模
頭。
該模型繼承自 PreTrainedModel。有關該庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等),請檢視超類的文件。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
引數
- input_values (形狀為
(batch_size, sequence_length)
的torch.Tensor
, 可選) — 輸入原始語音波形的浮點數值。可以透過將.flac
或.wav
音訊檔案載入到list[float]
型別的陣列或numpy.ndarray
中獲得,例如透過 soundfile 庫(pip install soundfile
)。為了將陣列準備成input_values
,應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor
型別的張量。詳情請參閱{processor_class}.__call__
。 - attention_mask (形狀為
(batch_size, sequence_length)
的torch.Tensor
, 可選) — 掩碼,用於避免對填充詞元索引執行注意力。掩碼值在[0, 1]
中選擇:- 1 表示詞元未被掩碼,
- 0 表示詞元被掩碼。
- output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
, 可選) — 是否返回 ModelOutput 而不是普通的元組。 - labels (形狀為
(batch_size, target_length)
的torch.LongTensor
, 可選) — 用於連線時序分類的標籤。請注意,target_length
必須小於或等於輸出 logits 的序列長度。索引在[-100, 0, ..., config.vocab_size - 1]
中選擇。所有設定為-100
的標籤都將被忽略(掩碼),損失僅針對[0, ..., config.vocab_size - 1]
中的標籤計算。
返回
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutput 或一個 torch.FloatTensor
元組(如果傳遞了 return_dict=False
或 config.return_dict=False
),根據配置(UniSpeechSatConfig)和輸入的不同,包含不同的元素。
-
loss (
torch.FloatTensor
形狀為(1,)
,可選,當提供labels
時返回) — 語言建模損失(用於下一個 token 預測)。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)
的torch.FloatTensor
) — 語言建模頭部的預測分數(SoftMax 之前的每個詞彙標記的分數)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) — 形狀為(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元組(一個是嵌入層的輸出,如果模型有嵌入層,+ 每個層的輸出)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元組(每層一個)。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatForCTC 的 forward 方法,覆蓋了 __call__
特殊方法。
雖然前向傳播的流程需要在此函式內定義,但之後應呼叫 Module
例項而不是此函式,因為前者會處理預處理和後處理步驟,而後者會默默地忽略它們。
示例
>>> from transformers import AutoProcessor, UniSpeechSatForCTC
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForCTC.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...
UniSpeechSatForSequenceClassification
class transformers.UniSpeechSatForSequenceClassification
< source >( config )
引數
- config (UniSpeechSatForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
UniSpeechSat 模型,頂部帶有一個序列分類頭(在池化輸出上加一個線性層),用於像 SUPERB 關鍵詞識別這樣的任務。
該模型繼承自 PreTrainedModel。有關該庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等),請檢視超類的文件。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< source >( input_values: 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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_values (
torch.FloatTensor
,形狀為(batch_size, sequence_length)
) — 浮點值的輸入原始語音波形。可以透過將.flac
或.wav
音訊檔案載入到型別為list[float]
或numpy.ndarray
的陣列中來獲取值,例如透過 soundfile 庫 (pip install soundfile
)。要將陣列準備成input_values
,應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor
型別的張量。有關詳細資訊,請參閱UniSpeechSatProcessor.__call__
。 - attention_mask (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被遮蔽,
- 0 表示標記被遮蔽。
- output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。 - labels (
torch.LongTensor
,形狀為(batch_size,)
,可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]
範圍內。如果config.num_labels == 1
,則計算迴歸損失(均方損失);如果config.num_labels > 1
,則計算分類損失(交叉熵)。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),包含各種元素,具體取決於配置 (UniSpeechSatConfig) 和輸入。
-
loss (形狀為
(1,)
的torch.FloatTensor
,可選,當提供labels
時返回) — 分類損失(如果 config.num_labels==1,則為迴歸損失)。 -
logits (形狀為
(batch_size, config.num_labels)
的torch.FloatTensor
) — 分類(如果 config.num_labels==1,則為迴歸)分數(SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) — 形狀為(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元組(一個是嵌入層的輸出,如果模型有嵌入層,+ 每個層的輸出)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元組(每層一個)。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatForSequenceClassification 的 forward 方法會覆蓋 __call__
特殊方法。
雖然前向傳播的流程需要在此函式內定義,但之後應呼叫 Module
例項而不是此函式,因為前者會處理預處理和後處理步驟,而後者會默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, UniSpeechSatForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForSequenceClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = UniSpeechSatForSequenceClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...
多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, UniSpeechSatForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForSequenceClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = UniSpeechSatForSequenceClassification.from_pretrained(
... "microsoft/unispeech-sat-base-100h-libri-ft", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss
UniSpeechSatForAudioFrameClassification
class transformers.UniSpeechSatForAudioFrameClassification
< 原始碼 >( config )
引數
- config (UniSpeechSatForAudioFrameClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有幀分類頭的 Unispeech Sat 模型,適用於說話人分割等任務。
該模型繼承自 PreTrainedModel。有關該庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等),請檢視超類的文件。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_values (
torch.FloatTensor
,形狀為(batch_size, sequence_length)
) — 浮點值的輸入原始語音波形。可以透過將.flac
或.wav
音訊檔案載入到型別為list[float]
或numpy.ndarray
的陣列中來獲取值,例如透過 soundfile 庫 (pip install soundfile
)。要將陣列準備成input_values
,應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor
型別的張量。有關詳細資訊,請參閱UniSpeechSatProcessor.__call__
。 - attention_mask (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被遮蔽,
- 0 表示標記被遮蔽。
- labels (
torch.LongTensor
,形狀為(batch_size,)
,可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]
範圍內。如果config.num_labels == 1
,則計算迴歸損失(均方損失);如果config.num_labels > 1
,則計算分類損失(交叉熵)。 - output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),包含各種元素,具體取決於配置 (UniSpeechSatConfig) 和輸入。
-
loss (形狀為
(1,)
的torch.FloatTensor
,可選,當提供labels
時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)
的torch.FloatTensor
) — 分類分數(SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) — 形狀為(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元組(一個是嵌入層的輸出,如果模型有嵌入層,+ 每個層的輸出)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元組(每層一個)。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatForAudioFrameClassification 的 forward 方法會覆蓋 __call__
特殊方法。
雖然前向傳播的流程需要在此函式內定義,但之後應呼叫 Module
例項而不是此函式,因為前者會處理預處理和後處理步驟,而後者會默默地忽略它們。
示例
>>> from transformers import AutoFeatureExtractor, UniSpeechSatForAudioFrameClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForAudioFrameClassification.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], return_tensors="pt", sampling_rate=sampling_rate)
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> probabilities = torch.sigmoid(logits[0])
>>> # labels is a one-hot array of shape (num_frames, num_speakers)
>>> labels = (probabilities > 0.5).long()
>>> labels[0].tolist()
...
UniSpeechSatForXVector
class transformers.UniSpeechSatForXVector
< 原始碼 >( config )
引數
- config (UniSpeechSatForXVector) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有 XVector 特徵提取頭的 UniSpeechSat 模型,適用於說話人驗證等任務。
該模型繼承自 PreTrainedModel。有關該庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等),請檢視超類的文件。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( input_values: 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.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
型別的張量。有關詳細資訊,請參閱UniSpeechSatProcessor.__call__
。 - attention_mask (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被遮蔽,
- 0 表示標記被遮蔽。
- output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。 - labels (
torch.LongTensor
,形狀為(batch_size,)
,可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]
範圍內。如果config.num_labels == 1
,則計算迴歸損失(均方損失);如果config.num_labels > 1
,則計算分類損失(交叉熵)。
返回
transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.XVectorOutput 或一個 torch.FloatTensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),包含各種元素,具體取決於配置 (UniSpeechSatConfig) 和輸入。
-
loss (形狀為
(1,)
的torch.FloatTensor
,可選,當提供labels
時返回) — 分類損失。 -
logits (形狀為
(batch_size, config.xvector_output_dim)
的torch.FloatTensor
) — AMSoftmax 之前的分類隱藏狀態。 -
embeddings (形狀為
(batch_size, config.xvector_output_dim)
的torch.FloatTensor
) — 用於基於向量相似性檢索的話語嵌入。 -
hidden_states (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) — 形狀為(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
元組(一個是嵌入層的輸出 + 每個層的輸出)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
, 可選, 當傳遞output_attentions=True
或config.output_attentions=True
時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
元組(每層一個)。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatForXVector 的 forward 方法會覆蓋 __call__
特殊方法。
雖然前向傳播的流程需要在此函式內定義,但之後應呼叫 Module
例項而不是此函式,因為前者會處理預處理和後處理步驟,而後者會默默地忽略它們。
示例
>>> from transformers import AutoFeatureExtractor, UniSpeechSatForXVector
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> model = UniSpeechSatForXVector.from_pretrained("microsoft/unispeech-sat-base-100h-libri-ft")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(
... [d["array"] for d in dataset[:2]["audio"]], sampling_rate=sampling_rate, return_tensors="pt", padding=True
... )
>>> with torch.no_grad():
... embeddings = model(**inputs).embeddings
>>> embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()
>>> # the resulting embeddings can be used for cosine similarity-based retrieval
>>> cosine_sim = torch.nn.CosineSimilarity(dim=-1)
>>> similarity = cosine_sim(embeddings[0], embeddings[1])
>>> threshold = 0.7 # the optimal threshold is dataset-dependent
>>> if similarity < threshold:
... print("Speakers are not the same!")
>>> round(similarity.item(), 2)
...
UniSpeechSatForPreTraining
class transformers.UniSpeechSatForPreTraining
< 原始碼 >( config: UniSpeechSatConfig )
引數
- config (UniSpeechSatConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型關聯的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
UniSpeechSat 模型帶有用於預訓練的向量量化模組和 ctc 損失。
該模型繼承自 PreTrainedModel。有關該庫為其所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭等),請檢視超類的文件。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput 或 tuple(torch.FloatTensor)
引數
- input_values (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 浮點值的輸入原始語音波形。可以透過將.flac
或.wav
音訊檔案載入到型別為list[float]
或numpy.ndarray
的陣列中來獲取值,例如透過 soundfile 庫 (pip install soundfile
)。要將陣列準備成input_values
,應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor
型別的張量。有關詳細資訊,請參閱{processor_class}.__call__
。 - attention_mask (
torch.Tensor
,形狀為(batch_size, sequence_length)
,可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示標記未被遮蔽,
- 0 表示標記被遮蔽。
- output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關詳細資訊,請參閱返回張量下的hidden_states
。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput 或 tuple(torch.FloatTensor)
一個 transformers.models.unispeech_sat.modeling_unispeech_sat.UniSpeechSatForPreTrainingOutput 或一個 torch.FloatTensor
的元組(如果傳遞了 return_dict=False
或當 config.return_dict=False
時),包含各種元素,具體取決於配置 (UniSpeechSatConfig) 和輸入。
-
loss (
*可選*
,在模型處於訓練模式時返回,torch.FloatTensor
,形狀為(1,)
) — 總損失,為對比損失 (L_m) 和多樣性損失 (L_d) 的和,如官方論文所述。(分類)損失。 -
logits (
torch.FloatTensor
,形狀為(batch_size, sequence_length, config.proj_codevector_dim)
,可選) — 對比損失模型的預測分數,即最終 softmax 之前的模型輸出。 -
projected_states (
torch.FloatTensor
,形狀為(batch_size, sequence_length, config.proj_codevector_dim)
) — 模型投影到 config.proj_codevector_dim 的隱藏狀態,可用於預測被掩蔽的投影量化狀態。 -
projected_quantized_states (
torch.FloatTensor
,形狀為(batch_size, sequence_length, config.proj_codevector_dim)
) — 投影到 config.proj_codevector_dim 的量化提取特徵向量,表示對比損失的正目標向量。 -
codevector_perplexity (形狀為
(1,)
的torch.FloatTensor
) — 碼向量分佈的困惑度,用於衡量碼本的多樣性。 -
hidden_states (
tuple[torch.FloatTensor]
,可選,當傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —torch.FloatTensor
的元組(如果模型有嵌入層,則一個用於嵌入層的輸出,+ 每個層一個輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple[torch.FloatTensor]
,可選,當傳遞output_attentions=True
或config.output_attentions=True
時返回) —torch.FloatTensor
的元組(每層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
UniSpeechSatForPreTraining 的 forward 方法會覆蓋 __call__
特殊方法。
雖然前向傳播的流程需要在此函式內定義,但之後應呼叫 Module
例項而不是此函式,因為前者會處理預處理和後處理步驟,而後者會默默地忽略它們。
示例
>>> import torch
>>> from transformers import AutoFeatureExtractor, UniSpeechSatForPreTraining
>>> from transformers.models.unispeech_sat.modeling_unispeech_sat import _compute_mask_indices
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("microsoft/unispeech-sat-base")
>>> model = UniSpeechSatForPreTraining.from_pretrained("microsoft/unispeech-sat-base")
>>> # TODO: Add full pretraining example