Hugging Face 的 LOGO

Transformers 文件

Wav2Vec2-BERT

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

Wav2Vec2-BERT

PyTorch

概述

Wav2Vec2-BERT 模型由 Meta AI 的 Seamless Communication 團隊在 Seamless: 多語言表達流式語音翻譯中提出。

該模型在涵蓋超過 143 種語言的 450 萬小時未標記音訊資料上進行了預訓練。它需要微調才能用於下游任務，例如自動語音識別 (ASR) 或音訊分類。

模型的官方結果可以在論文的 3.2.1 節中找到。

論文摘要如下：

自動語音翻譯的最新進展極大地擴充套件了語言覆蓋範圍，提高了多模態能力，並實現了廣泛的任務和功能。儘管如此，當今的大規模自動語音翻譯系統缺乏關鍵功能，這些功能有助於機器輔助通訊在與人際對話相比時感覺無縫。在這項工作中，我們引入了一系列模型，可以以流式方式實現端到端表達性和多語言翻譯。首先，我們貢獻了大規模多語言多模態 SeamlessM4T 模型的改進版本——SeamlessM4T v2。這個更新的模型融合了更新的 UnitY2 框架，在更多低資源語言資料上進行了訓練。SeamlessAlign 的擴充套件版本增加了 114,800 小時的自動對齊資料，總共涵蓋 76 種語言。SeamlessM4T v2 為我們兩個最新模型 SeamlessExpressive 和 SeamlessStreaming 的啟動奠定了基礎。SeamlessExpressive 實現了保留人聲風格和韻律的翻譯。與以往表達性語音研究的努力相比，我們的工作解決了韻律的一些未充分探索的方面，例如語速和停頓，同時還保留了語音的風格。至於 SeamlessStreaming，我們的模型利用高效單調多頭注意力 (EMMA) 機制，在不等待完整的源話語的情況下生成低延遲目標翻譯。作為首創，SeamlessStreaming 實現了多源和目標語言的同步語音到語音/文字翻譯。為了瞭解這些模型的效能，我們結合了現有自動指標的新穎和修改版本來評估韻律、延遲和魯棒性。對於人工評估，我們調整了現有協議，以衡量意義、自然度和表達性保留中最相關的屬性。為了確保我們的模型可以安全負責地使用，我們實施了首次已知的多模態機器翻譯紅隊工作，一個檢測和緩解增加毒性的系統，一個系統的性別偏見評估，以及一個旨在抑制深度偽造影響的不可聽區域性水印機制。因此，我們將 SeamlessExpressive 和 SeamlessStreaming 的主要元件結合起來，形成 Seamless，這是第一個公開可用的系統，可實現即時的富有表現力的跨語言通訊。總之，Seamless 讓我們對將通用語音翻譯器從科幻概念變為現實世界技術所需的技術基礎有了關鍵的瞭解。最後，這項工作的貢獻——包括模型、程式碼和水印檢測器——已公開發布，可透過以下連結訪問。

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

使用提示

  • Wav2Vec2-BERT 遵循 Wav2Vec2-Conformer 的相同架構，但採用因果深度卷積層，並使用音訊的梅爾頻譜圖表示作為輸入，而不是原始波形。
  • Wav2Vec2-BERT 可以透過設定正確的 config.position_embeddings_type 來使用無相對位置嵌入、類似 Shaw 的位置嵌入、類似 Transformer-XL 的位置嵌入或旋轉位置嵌入。
  • Wav2Vec2-BERT 還引入了基於 Conformer 的介面卡網路，而不是簡單的卷積網路。

資源

自動語音識別
音訊分類

Wav2Vec2BertConfig

class transformers.Wav2Vec2BertConfig

< >

( vocab_size = None hidden_size = 1024 num_hidden_layers = 24 num_attention_heads = 16 intermediate_size = 4096 feature_projection_input_dim = 160 hidden_act = 'swish' hidden_dropout = 0.0 activation_dropout = 0.0 attention_dropout = 0.0 feat_proj_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 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 ctc_loss_reduction = 'sum' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 768 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 = 1 adapter_act = 'relu' use_intermediate_ffn_before_adapter = False output_hidden_size = None position_embeddings_type = 'relative_key' rotary_embedding_base = 10000 max_source_positions = 5000 left_max_position_embeddings = 64 right_max_position_embeddings = 8 conv_depthwise_kernel_size = 31 conformer_conv_dropout = 0.1 **kwargs )

引數

  • vocab_size (int, 可選) — Wav2Vec2Bert 模型的詞彙表大小。定義了呼叫 Wav2Vec2BertModel 時可以透過 inputs_ids 表示的不同 token 的數量。模型的詞彙表大小。定義了傳遞給 Wav2Vec2BertModel 的 forward 方法的 inputs_ids 可以表示的不同 token。
  • hidden_size (int, 可選, 預設為 1024) — 編碼器層和池化層的維度。
  • num_hidden_layers (int, 可選, 預設為 24) — Transformer 編碼器中的隱藏層數。
  • num_attention_heads (int, 可選, 預設為 16) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • intermediate_size (int, 可選, 預設為 4096) — Transformer 編碼器中“中間”（即前饋）層的維度。
  • feature_projection_input_dim (int, 可選, 預設為 160) — 此模型的輸入維度，即使用 SeamlessM4TFeatureExtractor 或 Wav2Vec2BertProcessor 處理輸入音訊後的維度。
  • hidden_act (str 或 function, 可選, 預設為 "swish") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果是字串，則支援 "gelu", "relu", "selu", "swish" 和 "gelu_new"。
  • hidden_dropout (float, 可選, 預設為 0.0) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。
  • activation_dropout (float, 可選, 預設為 0.0) — 全連線層內部啟用的 dropout 比率。
  • attention_dropout (float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。
  • feat_proj_dropout (float, 可選, 預設為 0.0) — 特徵投影的 dropout 機率。
  • final_dropout (float, 可選, 預設為 0.1) — Wav2Vec2BertForCTC 最終投影層的 dropout 機率。
  • 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 值。
  • apply_spec_augment (bool, 可選, 預設為 True) — 是否對特徵編碼器的輸出應用 SpecAugment 資料增強。參考 SpecAugment: 一種用於自動語音識別的簡單資料增強方法。
  • 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_length 的最小遮罩數量，每個時間步都獨立於 mask_feature_prob。僅在 mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks 時相關。
  • ctc_loss_reduction (str, 可選, 預設為 "sum") — 指定應用於 torch.nn.CTCLoss 輸出的歸約方式。僅在訓練 Wav2Vec2BertForCTC 例項時相關。
  • ctc_zero_infinity (bool, 可選, 預設為 False) — 是否將無限損失和 torch.nn.CTCLoss 的相關梯度置零。無限損失主要發生在輸入太短而無法與目標對齊時。僅在訓練 Wav2Vec2BertForCTC 例項時相關。
  • use_weighted_layer_sum (bool, 可選, 預設為 False) — 是否使用帶學習權重的層輸出的加權平均。僅在使用 Wav2Vec2BertForSequenceClassification 例項時相關。
  • classifier_proj_size (int, 可選, 預設為 768) — 用於分類的 token 均值池化前的投影維度。
  • 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 嵌入向量的維度。
  • pad_token_id (int, 可選, 預設為 0) — 流開始標記的 ID。
  • bos_token_id (int, 可選, 預設為 1) — 填充標記的 ID。
  • eos_token_id (int, 可選, 預設為 2) — 流結束標記的 ID。
  • add_adapter (bool, 可選, 預設為 False) — 是否在 Wav2Vec2Bert 編碼器之上堆疊一個卷積注意力網路。對於 SpeechEncoderDecoder 模型的熱啟動 Wav2Vec2Bert 非常有用。
  • adapter_kernel_size (int, 可選, 預設為 3) — 介面卡網路中卷積層的核大小。僅在 add_adapter 為 True 時相關。
  • adapter_stride (int, 可選, 預設為 2) — 介面卡網路中卷積層的步長。僅在 add_adapter 為 True 時相關。
  • num_adapter_layers (int, 可選, 預設為 1) — 介面卡網路中應使用的卷積層數。僅在 add_adapter 為 True 時相關。
  • adapter_act (str 或 function, 可選, 預設為 "relu") — 介面卡層中的非線性啟用函式（函式或字串）。如果是字串，支援 "gelu", "relu", "selu", "swish" 和 "gelu_new"。
  • use_intermediate_ffn_before_adapter (bool, 可選, 預設為 False) — 是否在 Wav2Vec2Bert 編碼器之上、介面卡網路之前堆疊一箇中間前饋塊。僅在 add_adapter 為 True 時相關。
  • output_hidden_size (int, 可選) — 編碼器輸出層的維度。如果未定義，則預設為 隱藏大小。僅在 add_adapter 為 True 時相關。
  • position_embeddings_type (str, 可選, 預設為 "relative_key") — 可指定為：
  • rotary_embedding_base (int, 可選, 預設為 10000) — 如果使用 "rotary" 位置嵌入，則定義嵌入基礎的大小。
  • max_source_positions (int, 可選, 預設為 5000) — 如果使用 "relative" 位置嵌入，則定義最大源輸入位置。
  • left_max_position_embeddings (int, 可選, 預設為 64) — 如果使用 "relative_key" (又名 Shaw) 位置嵌入，則定義相對位置的左裁剪值。
  • right_max_position_embeddings (int, 可選, 預設為 8) — 如果使用 "relative_key" (又名 Shaw) 位置嵌入，則定義相對位置的右裁剪值。
  • conv_depthwise_kernel_size (int, 可選, 預設為 31) — Conformer 塊中卷積深度可分離一維層的核大小。
  • conformer_conv_dropout (float, 可選, 預設為 0.1) — Conformer 塊中所有卷積層的 dropout 機率。

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

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

示例

>>> from transformers import Wav2Vec2BertConfig, Wav2Vec2BertModel

>>> # Initializing a Wav2Vec2Bert facebook/wav2vec2-bert-rel-pos-large style configuration
>>> configuration = Wav2Vec2BertConfig()

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

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

Wav2Vec2BertProcessor

class transformers.Wav2Vec2BertProcessor

 < >

( feature_extractor tokenizer )

引數

構造一個 Wav2Vec2-BERT 處理器，它將 Wav2Vec2-BERT 特徵提取器和 Wav2Vec2 CTC 分詞器包裝在一個處理器中。

Wav2Vec2Processor 提供 SeamlessM4TFeatureExtractor 和 PreTrainedTokenizer 的所有功能。有關更多資訊，請參閱 call() 和 decode() 的文件。

__call__

 < >

( audio: typing.Union[ForwardRef('np.ndarray'), ForwardRef('torch.Tensor'), list['np.ndarray'], list['torch.Tensor']] = None text: typing.Union[str, list[str], NoneType] = None images = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.wav2vec2_bert.processing_wav2vec2_bert.Wav2Vec2BertProcessorKwargs] ) → BatchEncoding

引數

  • audio (np.ndarray, torch.Tensor, list[np.ndarray], list[torch.Tensor]) — 要準備的音訊或批處理音訊。每個音訊可以是 NumPy 陣列或 PyTorch 張量。如果是 NumPy 陣列/PyTorch 張量，每個音訊的形狀應為 (C, T)，其中 C 是通道數，T 是音訊的樣本長度。
  • text (str, list[str], list[list[str]]) — 要編碼的序列或批處理序列。每個序列可以是字串或字串列表（預分詞字串）。如果序列以字串列表（預分詞）形式提供，則必須設定 is_split_into_words=True（以消除與一批序列的歧義）。

返回

BatchEncoding

一個 BatchEncoding，包含以下欄位：

  • input_features — 要饋送到模型的音訊輸入特徵。當 audio 不為 None 時返回。
  • attention_mask — 當 audio 不為 None 時，指定模型應關注哪些時間戳的索引列表。當僅指定 text 時，返回 token 注意力掩碼。
  • labels — 要饋送到模型的 token ID 列表。當 text 和 audio 都不為 None 時返回。
  • input_ids — 要饋送到模型的 token ID 列表。當 text 不為 None 且 audio 為 None 時返回。

用於為模型準備一個或多個序列和音訊的主要方法。如果 audio 不為 None，此方法將 audio 和 kwargs 引數轉發到 SeamlessM4TFeatureExtractor 的 call() 以預處理音訊。如果 text 不為 None，此方法將 text 和 kwargs 引數轉發到 PreTrainedTokenizer 的 call() 以準備目標序列。有關更多資訊，請參閱上述兩種方法的文件。

pad

 < >

( input_features = None labels = None **kwargs )

如果 input_features 不為 None，此方法將 input_features 和 kwargs 引數轉發到 SeamlessM4TFeatureExtractor 的 pad() 以填充輸入特徵。如果 labels 不為 None，此方法將 labels 和 kwargs 引數轉發到 PreTrainedTokenizer 的 pad() 以填充標籤。有關更多資訊，請參閱上述兩種方法的文件。

from_pretrained

 < >

( pretrained_model_name_or_path **kwargs )

save_pretrained

 < >

( save_directory push_to_hub: bool = False **kwargs )

引數

  • save_directory (str 或 os.PathLike) — 特徵提取器 JSON 檔案和分詞器檔案將儲存的目錄（如果目錄不存在，將建立）。
  • push_to_hub (bool, 可選, 預設為 False) — 是否在儲存模型後將其推送到 Hugging Face 模型中心。您可以使用 repo_id 指定要推送到的倉庫（將預設為您的名稱空間中 save_directory 的名稱）。
  • kwargs (dict[str, Any], 可選) — 傳遞給 push_to_hub() 方法的附加關鍵字引數。

將此處理器（特徵提取器、分詞器…）的屬性儲存到指定目錄，以便可以使用 from_pretrained() 方法重新載入。

此類方法只是呼叫 save_pretrained() 和 save_pretrained()。有關更多資訊，請參閱上述方法的文件。

batch_decode

 < >

( *args **kwargs )

此方法將其所有引數轉發到 PreTrainedTokenizer 的 batch_decode()。有關更多資訊，請參閱此方法的文件。

decode

 < >

( *args **kwargs )

此方法將其所有引數轉發給 PreTrainedTokenizer 的 decode()。有關此方法的更多資訊，請參閱其文件字串。

Wav2Vec2BertModel

class transformers.Wav2Vec2BertModel

 < >

( config: Wav2Vec2BertConfig )

引數

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

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

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

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

forward

 < >

( input_features: 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_features (形狀為 (batch_size, sequence_length) 的 torch.FloatTensor) — 輸入原始語音波形的浮點值。可以透過將 .flac 或 .wav 音訊檔案載入到 list[float] 型別陣列或 numpy.ndarray 中來獲取這些值，例如透過 soundfile 庫（pip install soundfile）。要將陣列準備為 input_features，應使用 AutoProcessor 進行填充並轉換為 torch.FloatTensor 型別張量。有關詳細資訊，請參閱 Wav2Vec2BertProcessor.call()。
  • attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充 token 索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 對於 未掩碼 的 token 為 1，
    • 對於 已掩碼 的 token 為 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），包含根據配置 (Wav2Vec2BertConfig) 和輸入的不同元素。

  • last_hidden_state (torch.FloatTensor, 形狀為 (batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。

  • extract_features (形狀為 (batch_size, sequence_length, conv_dim[-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 後的注意力權重，用於計算自注意力頭中的加權平均值。

Wav2Vec2BertModel forward 方法，覆蓋 __call__ 特殊方法。

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

Wav2Vec2BertForCTC

class transformers.Wav2Vec2BertForCTC

 < >

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

引數

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

帶有用於連線主義時間分類 (CTC) 的 語言建模 頭部的 Wav2Vec2Bert 模型。

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

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

forward

 < >

( input_features: 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_features (形狀為 (batch_size, sequence_length) 的 torch.FloatTensor) — 輸入原始語音波形的浮點值。可以透過將 .flac 或 .wav 音訊檔案載入到 list[float] 型別陣列或 numpy.ndarray 中來獲取這些值，例如透過 soundfile 庫（pip install soundfile）。要將陣列準備為 input_features，應使用 AutoProcessor 進行填充並轉換為 torch.FloatTensor 型別張量。有關詳細資訊，請參閱 Wav2Vec2BertProcessor.call()。
  • attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor, 可選) — 用於避免在填充 token 索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 對於 未掩碼 的 token 為 1，
    • 對於 已掩碼 的 token 為 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），包含根據配置（Wav2Vec2BertConfig）和輸入而定的各種元素。

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

Wav2Vec2BertForCTC 的 forward 方法，覆蓋了 __call__ 特殊方法。

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

示例

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

Wav2Vec2BertForSequenceClassification

class transformers.Wav2Vec2BertForSequenceClassification

< >

( config )

引數

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

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

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

forward

< >

( input_features: 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_features (形狀為 (batch_size, sequence_length) 的 torch.FloatTensor) — 輸入原始語音波形的浮點值。可以透過載入 .flac 或 .wav 音訊檔案到 list[float] 型別陣列或 numpy.ndarray 來獲取值，例如透過 soundfile 庫（pip install soundfile）。要將陣列準備為 input_features，應使用 AutoProcessor 進行填充和轉換為 torch.FloatTensor 型別張量。有關詳細資訊，請參見 Wav2Vec2BertProcessor.__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,) 的 torch.LongTensor，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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），包含根據配置（Wav2Vec2BertConfig）和輸入而定的各種元素。

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

Wav2Vec2BertForSequenceClassification 的 forward 方法，覆蓋了 __call__ 特殊方法。

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2BertForSequenceClassification

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

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

Wav2Vec2BertForAudioFrameClassification

class transformers.Wav2Vec2BertForAudioFrameClassification

< >

( config )

引數

Wav2Vec2 Bert 模型，頂部帶有用於說話人識別等任務的幀分類頭。

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

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

forward

< >

( input_features: 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_features (形狀為 (batch_size, sequence_length) 的 torch.FloatTensor) — 輸入原始語音波形的浮點值。可以透過載入 .flac 或 .wav 音訊檔案到 list[float] 型別陣列或 numpy.ndarray 來獲取值，例如透過 soundfile 庫（pip install soundfile）。要將陣列準備為 input_features，應使用 AutoProcessor 進行填充和轉換為 torch.FloatTensor 型別張量。有關詳細資訊，請參見 Wav2Vec2ConformerProcessor.__call__。
  • attention_mask (形狀為 (batch_size, sequence_length) 的 torch.Tensor，可選) — 避免對填充令牌索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示未被遮蓋的令牌，
    • 0 表示被遮蓋的令牌。

    什麼是注意力掩碼？

  • labels (形狀為 (batch_size,) 的 torch.LongTensor，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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），包含根據配置（Wav2Vec2BertConfig）和輸入而定的各種元素。

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

Wav2Vec2BertForAudioFrameClassification 的 forward 方法，覆蓋了 __call__ 特殊方法。

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

示例

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

Wav2Vec2BertForXVector

class transformers.Wav2Vec2BertForXVector

< >

( config )

引數

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

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

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

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

forward

< >

( input_features: 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_features (形狀為 (batch_size, sequence_length) 的 torch.FloatTensor) — 輸入原始語音波形的浮點值。可以透過載入 .flac 或 .wav 音訊檔案到 list[float] 型別陣列或 numpy.ndarray 來獲取值，例如透過 soundfile 庫（pip install soundfile）。要將陣列準備為 input_features，應使用 AutoProcessor 進行填充和轉換為 torch.FloatTensor 型別張量。有關詳細資訊，請參見 Wav2Vec2ConformerProcessor.__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,) 的 torch.LongTensor，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [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），包含根據配置（Wav2Vec2BertConfig）和輸入而定的各種元素。

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

Wav2Vec2BertForXVector 的 forward 方法，覆蓋了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoFeatureExtractor, Wav2Vec2BertForXVector
>>> 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-bert-rel-pos-large")
>>> model = Wav2Vec2BertForXVector.from_pretrained("facebook/wav2vec2-bert-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)
...
< > 在 GitHub 上更新

←Wav2Vec2 Wav2Vec2-Conformer→
© . This site is unofficial and not affiliated with Hugging Face, Inc.