Wav2Vec2-Conformer

概述

Wav2Vec2-Conformer 被 Changhan Wang、Yun Tang、Xutai Ma、Anne Wu、Sravya Popuri、Dmytro Okhonko 和 Juan Pino 新增到 fairseq S2T: Fast Speech-to-Text Modeling with fairseq 的更新版本中。

該模型的官方結果可在論文的表 3 和表 4 中找到。

Wav2Vec2-Conformer 權重由 Meta AI 團隊在 Fairseq 庫中釋出。

該模型由 patrickvonplaten 貢獻。原始程式碼可在此處找到。

注意：Meta (FAIR) 釋出了 Wav2Vec2-BERT 2.0 的新版本——它在 450 萬小時的音訊上進行了預訓練。我們特別建議將其用於微調任務，例如按照本指南。

使用技巧

Wav2Vec2-Conformer 遵循 Wav2Vec2 相同的架構，但用 Conformer: Convolution-augmented Transformer for Speech Recognition 中引入的 Conformer 塊替換了 Attention 塊。
對於相同數量的層，Wav2Vec2-Conformer 需要比 Wav2Vec2 更多的引數，但也會產生更好的詞錯誤率。
Wav2Vec2-Conformer 使用與 Wav2Vec2 相同的分詞器和特徵提取器。
Wav2Vec2-Conformer 可以透過設定正確的 config.position_embeddings_type 來使用無相對位置嵌入、Transformer-XL 式位置嵌入或旋轉位置嵌入。

資源

Wav2Vec2ConformerConfig

類 transformers.Wav2Vec2ConformerConfig

< 來源 >

( vocab_size = None 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 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 = 'sum' 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 add_adapter = False adapter_kernel_size = 3 adapter_stride = 2 num_adapter_layers = 3 output_hidden_size = None position_embeddings_type = 'relative' rotary_embedding_base = 10000 max_source_positions = 5000 conv_depthwise_kernel_size = 31 conformer_conv_dropout = 0.1 **kwargs )

引數

vocab_size (int, 可選) — Wav2Vec2Conformer 模型的詞彙量大小。定義了呼叫 Wav2Vec2ConformerModel 時傳遞的 inputs_ids 可以表示的不同 token 的數量。模型的詞彙量大小。定義了可以由傳遞給 Wav2Vec2ConformerModel 的前向方法的 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) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。
activation_dropout (float, 可選, 預設為 0.1) — 全連線層內部啟用的 dropout 比率。
attention_dropout (float, 可選, 預設為 0.1) — 注意力機率的 dropout 比率。
final_dropout (float, 可選, 預設為 0.1) — Wav2Vec2ConformerForCTC 最終投影層的 dropout 機率。
layerdrop (float, 可選, 預設為 0.1) — LayerDrop 機率。更多詳細資訊請參見 [LayerDrop 論文](參見 https://huggingface.co/papers/1909.11556)。
initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。
layer_norm_eps (float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon。
feat_extract_norm (str, 可選, 預設為 "group") — 應用於特徵編碼器中一維卷積層的歸一化型別。對於僅對第一個一維卷積層進行組歸一化，使用 "group"；對於所有一維卷積層進行層歸一化，使用 "layer"。
feat_proj_dropout (float, 可選, 預設為 0.0) — 特徵編碼器輸出的 dropout 機率。
feat_extract_activation (str, 可選, 預設為 "gelu") -- 特徵提取器中一維卷積層的非線性啟用函式（函式或字串）。如果為字串，則支援 "gelu"、"relu"、"selu" 和 "gelu_new"。
feat_quantizer_dropout (float, 可選, 預設為 0.0) — 量化特徵編碼器狀態的 dropout 機率。
conv_dim (tuple[int] 或 list[int], 可選, 預設為 (512, 512, 512, 512, 512, 512, 512)) — 定義特徵編碼器中每個一維卷積層的輸入和輸出通道數的整數元組。conv_dim 的長度定義了一維卷積層的數量。
conv_stride (tuple[int] 或 list[int], 可選, 預設為 (5, 2, 2, 2, 2, 2, 2)) — 定義特徵編碼器中每個一維卷積層步幅的整數元組。conv_stride 的長度定義了卷積層的數量，並且必須與 conv_dim 的長度匹配。
conv_kernel (tuple[int] 或 list[int], 可選, 預設為 (10, 3, 3, 3, 3, 3, 3)) — 定義特徵編碼器中每個一維卷積層核大小的整數元組。conv_kernel 的長度定義了卷積層的數量，並且必須與 conv_dim 的長度匹配。
conv_bias (bool, 可選, 預設為 False) — 一維卷積層是否包含偏置。
num_conv_pos_embeddings (int, 可選, 預設為 128) — 卷積位置嵌入的數量。定義了一維卷積位置嵌入層的核大小。
num_conv_pos_embedding_groups (int, 可選, 預設為 16) — 一維卷積位置嵌入層的組數。
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_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_prob 的值如何，每次在特徵軸上生成的長度為 mask_feature_length 的掩碼的最小數量。僅當 "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。
feat_quantizer_dropout (float, 可選, 預設為 0.0) — 量化器使用的特徵編碼器輸出的 dropout 機率。
num_negatives (int, 可選, 預設為 100) — 對比損失的負樣本數量。
codevector_dim (int, 可選, 預設為 256) — 量化特徵向量的維度。
proj_codevector_dim (int, 可選, 預設為 256) — 量化特徵和 Transformer 特徵最終投影的維度。
diversity_loss_weight (int, 可選, 預設為 0.1) — 碼本多樣性損失分量的權重。
ctc_loss_reduction (str, 可選, 預設為 "sum") — 指定應用於 torch.nn.CTCLoss 輸出的歸約方法。僅在訓練 Wav2Vec2ConformerForCTC 例項時相關。
ctc_zero_infinity (bool, 可選, 預設為 False) — 是否將 torch.nn.CTCLoss 的無限損失和相關梯度置零。無限損失主要發生在輸入太短而無法與目標對齊時。僅在訓練 Wav2Vec2ConformerForCTC 例項時相關。
use_weighted_layer_sum (bool, 可選, 預設為 False) — 是否使用帶學習權重的層輸出的加權平均值。僅在使用 Wav2Vec2ConformerForSequenceClassification 例項時相關。
classifier_proj_size (int, 可選, 預設為 256) — 分類前標記平均池化投影的維度。
tdnn_dim (tuple[int] 或 list[int], 可選, 預設為 (512, 512, 512, 512, 1500)) — 定義 XVector 模型 TDNN 模組中每個 1D 卷積層輸出通道數量的整數元組。tdnn_dim 的長度定義了 TDNN 層的數量。
tdnn_kernel (tuple[int] 或 list[int], 可選, 預設為 (5, 3, 3, 1, 1)) — 定義 XVector 模型 TDNN 模組中每個 1D 卷積層核大小的整數元組。tdnn_kernel 的長度必須與 tdnn_dim 的長度匹配。
tdnn_dilation (tuple[int] 或 list[int], 可選, 預設為 (1, 2, 3, 1, 1)) — 定義 XVector 模型 TDNN 模組中每個 1D 卷積層膨脹因子的整數元組。tdnn_dilation 的長度必須與 tdnn_dim 的長度匹配。
xvector_output_dim (int, 可選, 預設為 512) — XVector 嵌入向量的維度。
add_adapter (bool, 可選, 預設為 False) — 是否在 Wav2Vec2Conformer 編碼器頂部堆疊卷積網路。對於語音編碼器解碼器模型的熱啟動 Wav2Vec2Conformer 可能非常有用。
adapter_kernel_size (int, 可選, 預設為 3) — 介面卡網路中卷積層的核大小。僅當 add_adapter 為 True 時相關。
adapter_stride (int, 可選, 預設為 2) — 介面卡網路中卷積層的步長。僅當 add_adapter 為 True 時相關。
num_adapter_layers (int, 可選, 預設為 3) — 介面卡網路中應使用的卷積層數。僅當 add_adapter 為 True 時相關。
output_hidden_size (int, 可選) — 編碼器輸出層的維度。如果未定義，則預設為 hidden-size。僅當 add_adapter 為 True 時相關。
position_embeddings_type (str, 可選, 預設為 "relative") — 可以指定為 relative 或 rotary，分別用於相對位置嵌入或旋轉位置嵌入。如果保留 None，則不應用相對位置嵌入。
rotary_embedding_base (int, 可選, 預設為 10000) — 如果使用 "rotary" 位置嵌入，則定義嵌入基的大小。
max_source_positions (int, 可選, 預設為 5000) — 如果使用 "relative" 位置嵌入，則定義最大源輸入位置。
conv_depthwise_kernel_size (int, 可選, 預設為 31) — Conformer 塊中卷積深度可分離 1D 層的核大小。
conformer_conv_dropout (float, 可選, 預設為 0.1) — Conformer 塊中所有卷積層的 dropout 機率。

這是儲存 Wav2Vec2ConformerModel 配置的配置類。它用於根據指定引數例項化 Wav2Vec2Conformer 模型，定義模型架構。使用預設值例項化配置將產生與 Wav2Vec2Conformer facebook/wav2vec2-conformer-rel-pos-large 架構類似的配置。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。

示例

>>> from transformers import Wav2Vec2ConformerConfig, Wav2Vec2ConformerModel

>>> # Initializing a Wav2Vec2Conformer facebook/wav2vec2-conformer-rel-pos-large style configuration
>>> configuration = Wav2Vec2ConformerConfig()

>>> # Initializing a model (with random weights) from the facebook/wav2vec2-conformer-rel-pos-large style configuration
>>> model = Wav2Vec2ConformerModel(configuration)

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

Wav2Vec2ConformerForPreTrainingOutput

class transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput

< 來源 >

( 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 contrastive_loss: typing.Optional[torch.FloatTensor] = None diversity_loss: typing.Optional[torch.FloatTensor] = None )

引數

loss (*可選*, 當傳入 sample_negative_indices 時返回, 形狀為 (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，表示用於對比損失的正目標向量。
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 之後，用於計算自注意力頭中加權平均值的注意力權重。
contrastive_loss (*可選*, 當傳入 sample_negative_indices 時返回, 形狀為 (1,) 的 torch.FloatTensor) — 對照損失（L_m），如官方論文中所述。
diversity_loss (*可選*, 當傳入 sample_negative_indices 時返回, 形狀為 (1,) 的 torch.FloatTensor) — 多樣性損失（L_d），如官方論文中所述。

的輸出型別 Wav2Vec2ConformerForPreTraining，具有潛在的隱藏狀態和注意力。

Wav2Vec2ConformerModel

class transformers.Wav2Vec2ConformerModel

< 來源 >

( config: Wav2Vec2ConformerConfig )

引數

config (Wav2Vec2ConformerConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法載入模型權重。

裸 Wav2Vec2 Conformer 模型，輸出原始隱藏狀態，頂部沒有特定頭部。

此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 子類。將其用作常規 PyTorch 模組，並參考 PyTorch 文件以獲取所有與通用用法和行為相關的資訊。

forward

< 來源 >

( 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)

如果傳入 return_dict=False 或 config.return_dict=False，則返回 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 torch.FloatTensor 元組，其中包含根據配置 (Wav2Vec2ConformerConfig) 和輸入的不同元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

的 Wav2Vec2ConformerModel forward 方法，重寫了 __call__ 特殊方法。

雖然前向傳播的配方需要在此函式中定義，但在此之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則靜默忽略它們。

Wav2Vec2ConformerForCTC

class transformers.Wav2Vec2ConformerForCTC

< 來源 >

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

引數

config (Wav2Vec2ConformerForCTC) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法載入模型權重。
target_lang (str, 可選) — 介面卡權重的語言 ID。介面卡權重以 adapter..safetensors 或 adapter..bin 格式儲存。僅在使用帶介面卡的 UniSpeechSatForCTC 例項時相關。預設使用“eng”。

帶有 語言建模 頭的 Wav2Vec2Conformer 模型，用於連線主義時間分類（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 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 (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），包含根據配置 (Wav2Vec2ConformerConfig) 和輸入的不同元素。

loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。
logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。
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), 可選, 當傳入 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每個層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

Wav2Vec2ConformerForCTC 的 forward 方法，重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoProcessor, Wav2Vec2ConformerForCTC
>>> 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("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForCTC.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

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

Wav2Vec2ConformerForSequenceClassification

class transformers.Wav2Vec2ConformerForSequenceClassification

< source >

( config )

引數

config (Wav2Vec2ConformerForSequenceClassification) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Wav2Vec2Conformer 模型，頂部帶有一個序列分類頭（池化輸出上的線性層），用於 SUPERB 關鍵詞識別等任務。

此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 子類。將其用作常規 PyTorch 模組，並參考 PyTorch 文件以獲取所有與通用用法和行為相關的資訊。

forward

< source >

引數

input_values (torch.FloatTensor of shape (batch_size, sequence_length)) — 輸入原始語音波形的浮點值。可以透過載入 .flac 或 .wav 音訊檔案到 list[float] 型別陣列或 numpy.ndarray 來獲取值，例如透過 soundfile 庫（pip install soundfile）。為了將陣列準備成 input_values，應使用 AutoProcessor 進行填充並轉換為 torch.FloatTensor 型別的張量。詳情請參閱 Wav2Vec2ConformerProcessor.__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,), optional) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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），包含根據配置 (Wav2Vec2ConformerConfig) 和輸入的不同元素。

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), optional, 當傳入 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 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每個層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

Wav2Vec2ConformerForSequenceClassification 的 forward 方法，重寫了 __call__ 特殊方法。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2ConformerForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

>>> 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 = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2ConformerForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForSequenceClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large", 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 = Wav2Vec2ConformerForSequenceClassification.from_pretrained(
...     "facebook/wav2vec2-conformer-rel-pos-large", 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

Wav2Vec2ConformerForAudioFrameClassification

class transformers.Wav2Vec2ConformerForAudioFrameClassification

< source >

( config )

引數

config (Wav2Vec2ConformerForAudioFrameClassification) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Wav2Vec2 Conformer 模型，頂部帶有一個幀分類頭，用於說話人分離等任務。

此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 子類。將其用作常規 PyTorch 模組，並參考 PyTorch 文件以獲取所有與通用用法和行為相關的資訊。

forward

< source >

( 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 of shape (batch_size, sequence_length)) — 輸入原始語音波形的浮點值。可以透過載入 .flac 或 .wav 音訊檔案到 list[float] 型別陣列或 numpy.ndarray 來獲取值，例如透過 soundfile 庫（pip install soundfile）。為了將陣列準備成 input_values，應使用 AutoProcessor 進行填充並轉換為 torch.FloatTensor 型別的張量。詳情請參閱 Wav2Vec2ConformerProcessor.__call__。
attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選擇在 [0, 1] 中：
- 1 表示 未被掩碼 的標記，
- 0 表示 被掩碼 的標記。
什麼是注意力掩碼？
labels (torch.LongTensor of shape (batch_size,), optional) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 之間。如果 config.num_labels == 1，則計算迴歸損失（均方損失），如果 config.num_labels > 1，則計算分類損失（交叉熵損失）。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元組。

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

一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置 (Wav2Vec2ConformerConfig) 和輸入的不同元素。

loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 labels 時返回) — 分類損失。
logits (形狀為 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分類分數（SoftMax 之前）。
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), 可選, 當傳入 output_attentions=True 或 config.output_attentions=True 時返回) — 形狀為 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元組（每個層一個）。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。

Wav2Vec2ConformerForAudioFrameClassification 的 forward 方法，重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForAudioFrameClassification
>>> 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("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForAudioFrameClassification.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

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

Wav2Vec2ConformerForXVector

class transformers.Wav2Vec2ConformerForXVector

< source >

( config )

引數

config (Wav2Vec2ConformerForXVector) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Wav2Vec2Conformer 模型，頂部帶有一個 XVector 特徵提取頭，用於說話人驗證等任務。

此模型繼承自 PreTrainedModel。請檢視超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。

此模型也是 PyTorch torch.nn.Module 子類。將其用作常規 PyTorch 模組，並參考 PyTorch 文件以獲取所有與通用用法和行為相關的資訊。

forward

< source >

引數

input_values (torch.FloatTensor of shape (batch_size, sequence_length)) — 輸入原始語音波形的浮點值。可以透過載入 .flac 或 .wav 音訊檔案到 list[float] 型別陣列或 numpy.ndarray 來獲取值，例如透過 soundfile 庫（pip install soundfile）。為了將陣列準備成 input_values，應使用 AutoProcessor 進行填充並轉換為 torch.FloatTensor 型別的張量。詳情請參閱 Wav2Vec2ConformerProcessor.__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,), optional) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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），包含根據配置 (Wav2Vec2ConformerConfig) 和輸入的不同元素。

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 後的注意力權重，用於計算自注意力頭中的加權平均值。

Wav2Vec2ConformerForXVector 的 forward 方法，重寫了 __call__ 特殊方法。

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForXVector
>>> 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("facebook/wav2vec2-conformer-rel-pos-large")
>>> model = Wav2Vec2ConformerForXVector.from_pretrained("facebook/wav2vec2-conformer-rel-pos-large")

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

Wav2Vec2ConformerForPreTraining

class transformers.Wav2Vec2ConformerForPreTraining

< source >

( config: Wav2Vec2ConformerConfig )

引數

config (Wav2Vec2ConformerConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

Wav2Vec2Conformer 模型，頂部帶有一個量化器和 VQ 頭。

此模型繼承自 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.BoolTensor] = None sampled_negative_indices: typing.Optional[torch.BoolTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或 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 空間中的掩碼提取特徵。
sampled_negative_indices (torch.BoolTensor of shape (batch_size, sequence_length, num_negatives), optional) — 指示哪些量化目標向量用作對比損失中的負取樣向量的索引。預訓練的必需輸入。
output_attentions (bool, optional) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元組。

transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或 tuple(torch.FloatTensor)

一個 transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置 (Wav2Vec2ConformerConfig) 和輸入的不同元素。

loss (*optional*, 當傳入 sample_negative_indices 時返回，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 (形狀為(1,)的torch.FloatTensor) — 碼向量分佈的困惑度，用於衡量碼本的多樣性。
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
contrastive_loss (*optional*, 當傳入 sample_negative_indices 時返回，torch.FloatTensor of shape (1,)) — 官方論文中所述的對比損失 (L_m)。
diversity_loss (*optional*, 當傳入 sample_negative_indices 時返回，torch.FloatTensor of shape (1,)) — 官方論文中所述的多樣性損失 (L_d)。

Wav2Vec2ConformerForPreTraining 的 forward 方法，重寫了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoFeatureExtractor, Wav2Vec2ConformerForPreTraining
>>> from transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer import _compute_mask_indices, _sample_negative_indices
>>> from datasets import load_dataset

>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/wav2vec2_conformer-base")
>>> model = Wav2Vec2ConformerForPreTraining.from_pretrained("facebook/wav2vec2_conformer-base")

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> input_values = feature_extractor(ds[0]["audio"]["array"], return_tensors="pt").input_values  # Batch size 1

>>> # compute masked indices
>>> batch_size, raw_sequence_length = input_values.shape
>>> sequence_length = model._get_feat_extract_output_lengths(raw_sequence_length).item()
>>> mask_time_indices = _compute_mask_indices(
...     shape=(batch_size, sequence_length), mask_prob=0.2, mask_length=2
... )
>>> sampled_negative_indices = _sample_negative_indices(
...     features_shape=(batch_size, sequence_length),
...     num_negatives=model.config.num_negatives,
...     mask_time_indices=mask_time_indices,
... )
>>> mask_time_indices = torch.tensor(data=mask_time_indices, device=input_values.device, dtype=torch.long)
>>> sampled_negative_indices = torch.tensor(
...     data=sampled_negative_indices, device=input_values.device, dtype=torch.long
... )

>>> with torch.no_grad():
...     outputs = model(input_values, mask_time_indices=mask_time_indices)

>>> # compute cosine similarity between predicted (=projected_states) and target (=projected_quantized_states)
>>> cosine_sim = torch.cosine_similarity(outputs.projected_states, outputs.projected_quantized_states, dim=-1)

>>> # show that cosine similarity is much higher than random
>>> cosine_sim[mask_time_indices.to(torch.bool)].mean() > 0.5
tensor(True)

>>> # for contrastive loss training model should be put into train mode
>>> model = model.train()
>>> loss = model(
...     input_values, mask_time_indices=mask_time_indices, sampled_negative_indices=sampled_negative_indices
... ).loss

< > 在 GitHub 上更新

Transformers

Wav2Vec2-Conformer

概述

使用技巧

資源

Wav2Vec2ConformerConfig

類 transformers.Wav2Vec2ConformerConfig

Wav2Vec2ConformerForPreTrainingOutput

class transformers.models.wav2vec2_conformer.modeling_wav2vec2_conformer.Wav2Vec2ConformerForPreTrainingOutput

Wav2Vec2ConformerModel

class transformers.Wav2Vec2ConformerModel

forward

Wav2Vec2ConformerForCTC

class transformers.Wav2Vec2ConformerForCTC

forward

Wav2Vec2ConformerForSequenceClassification

class transformers.Wav2Vec2ConformerForSequenceClassification

forward

Wav2Vec2ConformerForAudioFrameClassification

class transformers.Wav2Vec2ConformerForAudioFrameClassification

forward

Wav2Vec2ConformerForXVector

class transformers.Wav2Vec2ConformerForXVector

forward

Wav2Vec2ConformerForPreTraining

class transformers.Wav2Vec2ConformerForPreTraining

forward