Hugging Face 的 LOGO

Transformers 文件

BigBirdPegasus

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

BigBirdPegasus

PyTorch

概述

BigBird 模型由 Zaheer、Manzil、Guruganesh、Guru、Dubey、Kumar Avinava、Ainslie、Joshua、Alberti、Chris、Ontanon、Santiago、Pham、Philip、Ravula、Anirudh、Wang、Qifan、Yang、Li 等人在 Big Bird: Transformers for Longer Sequences 中提出。BigBird 是一種基於稀疏注意力的 Transformer，它將 BERT 等基於 Transformer 的模型擴充套件到更長的序列。除了稀疏注意力，BigBird 還對輸入序列應用了全域性注意力和隨機注意力。理論上，稀疏、全域性和隨機注意力的結合可以近似全注意力，同時在處理長序列時計算效率更高。由於能夠處理更長的上下文，BigBird 在各種長文件 NLP 任務（如問答和摘要）上的表現優於 BERT 或 RoBERTa。

論文摘要如下：

基於 Transformers 的模型（如 BERT）已成為 NLP 領域最成功的深度學習模型之一。然而，它們的一個核心限制是，由於其全注意力機制，其（主要是在記憶體方面）對序列長度的依賴性是二次的。為解決此問題，我們提出了 BigBird，這是一種稀疏注意力機制，可將二次依賴性降至線性。我們證明了 BigBird 是序列函式的通用近似器並且是圖靈完備的，從而保留了二次全注意力模型的這些特性。同時，我們的理論分析揭示了在稀疏注意力機制中加入關注整個序列的 O(1) 全域性標記（如 CLS）的一些好處。所提出的稀疏注意力機制能夠處理比以往使用類似硬體所能處理的序列長 8 倍的序列。由於能夠處理更長的上下文，BigBird 在問答和摘要等各種 NLP 任務中的效能得到了顯著提升。我們還提出了在基因組學資料上的新應用。

原始程式碼可以在這裡找到。

使用技巧

  • 有關 BigBird 注意力機制工作原理的詳細解釋，請參閱這篇部落格文章。
  • BigBird 有兩種實現方式：**original_full** 和 **block_sparse**。對於序列長度小於 1024 的情況，建議使用 **original_full**，因為使用 **block_sparse** 注意力沒有優勢。
  • 當前程式碼使用 3 個塊的視窗大小和 2 個全域性塊。
  • 序列長度必須能被塊大小整除。
  • 當前實現僅支援 **ITC**。
  • 當前實現不支援 **num_random_blocks = 0**。
  • BigBirdPegasus 使用 PegasusTokenizer。
  • BigBird 是一個帶有絕對位置嵌入的模型，因此通常建議在輸入的右側而不是左側進行填充。

資源

BigBirdPegasusConfig

class transformers.BigBirdPegasusConfig

< >

( vocab_size = 96103 max_position_embeddings = 4096 encoder_layers = 16 encoder_ffn_dim = 4096 encoder_attention_heads = 16 decoder_layers = 16 decoder_ffn_dim = 4096 decoder_attention_heads = 16 encoder_layerdrop = 0.0 decoder_layerdrop = 0.0 use_cache = True is_encoder_decoder = True activation_function = 'gelu_new' d_model = 1024 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 init_std = 0.02 decoder_start_token_id = 2 classifier_dropout = 0.0 scale_embedding = True pad_token_id = 0 bos_token_id = 2 eos_token_id = 1 attention_type = 'block_sparse' block_size = 64 num_random_blocks = 3 use_bias = False **kwargs )

引數

  • vocab_size (int, 可選, 預設為 96103) — BigBirdPegasus 模型的詞彙表大小。定義了在呼叫 BigBirdPegasusModel 時，inputs_ids 可以表示的不同詞元數量。
  • d_model (int, 可選, 預設為 1024) — 各層和池化層的維度。
  • encoder_layers (int, 可選, 預設為 16) — 編碼器層數。
  • decoder_layers (int, 可選, 預設為 16) — 解碼器層數。
  • encoder_attention_heads (int, 可選, 預設為 16) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • decoder_attention_heads (int, 可選, 預設為 16) — Transformer 解碼器中每個注意力層的注意力頭數量。
  • decoder_ffn_dim (int, 可選, 預設為 4096) — 解碼器中“中間”層（通常稱為前饋層）的維度。
  • encoder_ffn_dim (int, 可選, 預設為 4096) — 編碼器中“中間”層（通常稱為前饋層）的維度。
  • activation_function (str 或 function, 可選, 預設為 "gelu_new") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果為字串，則支援 "gelu"、"relu"、"silu" 和 "gelu_new"。
  • dropout (float, 可選, 預設為 0.1) — 嵌入層、編碼器和池化器中所有全連線層的 dropout 機率。
  • attention_dropout (float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。
  • activation_dropout (float, 可選, 預設為 0.0) — 全連線層中啟用函式的 dropout 比率。
  • classifier_dropout (float, 可選, 預設為 0.0) — 分類器的 dropout 比率。
  • max_position_embeddings (int, 可選, 預設為 4096) — 此模型可能使用的最大序列長度。通常將其設定為一個較大的值以防萬一（例如 1024、2048 或 4096）。
  • init_std (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態分佈初始化器的標準差。
  • encoder_layerdrop (float, 可選, 預設為 0.0) — 編碼器的 LayerDrop 機率。更多細節請參見 [LayerDrop 論文](https://huggingface.co/papers/1909.11556)。
  • decoder_layerdrop (float, 可選, 預設為 0.0) — 解碼器的 LayerDrop 機率。更多細節請參見 [LayerDrop 論文](https://huggingface.co/papers/1909.11556)。
  • use_cache (bool, 可選, 預設為 `True`) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。
  • attention_type (str, 可選, 預設為 "block_sparse") — 在編碼器中是使用論文中介紹的塊稀疏注意力（複雜度為 n）還是原始注意力層（複雜度為 n^2）。可能的值為 "original_full" 和 "block_sparse"。
  • use_bias (bool, 可選, 預設為 False) — 是否在查詢、鍵、值中使用偏置。
  • block_size (int, 可選, 預設為 64) — 每個塊的大小。僅在 attention_type == "block_sparse" 時有效。
  • num_random_blocks (int, 可選, 預設為 3) — 每個查詢將關注的隨機塊數量。僅在 attention_type == "block_sparse" 時有效。
  • scale_embeddings (bool, 可選, 預設為 True) — 是否使用 (hidden_size ** 0.5) 來縮放嵌入。

這是一個配置類，用於儲存 BigBirdPegasusModel 的配置。它用於根據指定的引數例項化 BigBirdPegasus 模型，定義模型架構。使用預設值例項化配置將產生與 BigBirdPegasus google/bigbird-pegasus-large-arxiv 架構類似的配置。

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

示例

>>> from transformers import BigBirdPegasusConfig, BigBirdPegasusModel

>>> # Initializing a BigBirdPegasus bigbird-pegasus-base style configuration
>>> configuration = BigBirdPegasusConfig()

>>> # Initializing a model (with random weights) from the bigbird-pegasus-base style configuration
>>> model = BigBirdPegasusModel(configuration)

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

BigBirdPegasusModel

class transformers.BigBirdPegasusModel

< >

( config: BigBirdPegasusConfig )

引數

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

基礎的 Bigbird Pegasus 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭（head）。

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

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqModelOutput or tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充（Padding）將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記被遮蓋。

    什麼是注意力掩碼？

  • decoder_input_ids (torch.LongTensor，形狀為 (batch_size, target_sequence_length), 可選) — 為翻譯和摘要訓練提供。預設情況下，模型將按照論文中的方法，透過將 `input_ids` 右移來建立此張量。
  • decoder_attention_mask (torch.LongTensor，形狀為 (batch_size, target_sequence_length), 可選) — 預設行為：生成一個忽略 `decoder_input_ids` 中填充標記的張量。預設情況下也會使用因果掩碼。

    如果你想改變填充行為，應閱讀 `modeling_bigbird_pegasus._prepare_decoder_attention_mask` 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示該頭未被遮蓋，
    • 0 表示該頭被遮蓋。
  • decoder_head_mask (torch.Tensor，形狀為 (num_layers, num_heads), 可選) — 用於使解碼器中注意力模組選定的頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示該頭未被遮蓋，
    • 0 表示該頭被遮蓋。
  • cross_attn_head_mask (torch.Tensor，形狀為 (num_layers, num_heads), 可選) — 用於使交叉注意力模組中選定的頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示該頭未被遮蓋，
    • 0 表示該頭被遮蓋。
  • encoder_outputs (list[torch.FloatTensor], 可選) — 元組，包含 (`last_hidden_state`, *可選*: `hidden_states`, *可選*: `attentions`)。`last_hidden_state` 的形狀為 `(batch_size, sequence_length, hidden_size)`，*可選*）是編碼器最後一層輸出的隱藏狀態序列。用於解碼器的交叉注意力。
  • past_key_values (list[torch.FloatTensor], 可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包含模型在先前解碼階段返回的 `past_key_values`，當 `use_cache=True` 或 `config.use_cache=True` 時。

    允許兩種格式：

    • 一個 Cache 例項，請參閱我們的 kv 快取指南；
    • 一個長度為 `config.n_layers` 的 `tuple(torch.FloatTensor)` 的元組，每個元組包含 2 個形狀為 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的張量。這也稱為舊版快取格式。

    模型將輸出與輸入相同的快取格式。如果未傳遞 `past_key_values`，將返回舊版快取格式。

    如果使用 `past_key_values`，使用者可以選擇只輸入最後的 `input_ids`（那些沒有為其提供過去鍵值狀態的 `input_ids`），其形狀為 `(batch_size, 1)`，而不是所有形狀為 `(batch_size, sequence_length)` 的 `input_ids`。

  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關向量，這將非常有用。
  • decoder_inputs_embeds (torch.FloatTensor，形狀為 (batch_size, target_sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `decoder_input_ids`。如果使用 `past_key_values`，可以選擇只輸入最後的 `decoder_inputs_embeds` (見 `past_key_values`)。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `decoder_input_ids` 索引轉換為相關向量，這將非常有用。

    如果 `decoder_input_ids` 和 `decoder_inputs_embeds` 都未設定，`decoder_inputs_embeds` 將取 `inputs_embeds` 的值。

  • use_cache (bool, 可選) — 如果設定為 `True`，將返回 `past_key_values` 鍵值狀態，可用於加速解碼（參見 `past_key_values`）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
  • cache_position (torch.LongTensor，形狀為 (sequence_length), 可選) — 描繪輸入序列標記在序列中位置的索引。與 `position_ids` 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。

返回

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

一個 transformers.modeling_outputs.Seq2SeqModelOutput 或一個 `torch.FloatTensor` 元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（BigBirdPegasusConfig）和輸入，包含各種元素。

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

    如果使用了 past_key_values，則只輸出形狀為 (batch_size, 1, hidden_size) 的序列的最後一個隱藏狀態。

  • past_key_values (EncoderDecoderCache, 可選, 當 `use_cache=True` 被傳遞或當 `config.use_cache=True` 時返回) — 這是一個 EncoderDecoderCache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

    包含預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    解碼器在每個層輸出的隱藏狀態，加上可選的初始嵌入輸出。

  • decoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

  • encoder_last_hidden_state (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 模型編碼器最後一層輸出的隱藏狀態序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    編碼器在每個層輸出的隱藏狀態，加上可選的初始嵌入輸出。

  • encoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    編碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

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

儘管前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

BigBirdPegasusForConditionalGeneration

class transformers.BigBirdPegasusForConditionalGeneration

< >

( config: BigBirdPegasusConfig )

引數

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

帶有語言建模頭的 BigBirdPegasus 模型。可用於摘要任務。

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

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqLMOutput or tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充（Padding）將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length), 可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示標記未被遮蓋，
    • 0 表示標記被遮蓋。

    什麼是注意力掩碼？

  • decoder_input_ids (torch.LongTensor，形狀為 (batch_size, target_sequence_length), 可選) — 為翻譯和摘要訓練提供。預設情況下，模型將按照論文中的方法，透過將 `input_ids` 右移來建立此張量。
  • decoder_attention_mask (torch.LongTensor，形狀為 (batch_size, target_sequence_length), 可選) — 預設行為：生成一個忽略 `decoder_input_ids` 中填充標記的張量。預設情況下也會使用因果掩碼。

    如果你想改變填充行為，應閱讀 `modeling_bigbird_pegasus._prepare_decoder_attention_mask` 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads), 可選) — 用於使自注意力模組中選定的頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示該頭未被遮蓋，
    • 0 表示該頭被遮蓋。
  • decoder_head_mask (torch.Tensor，形狀為 (num_layers, num_heads), 可選) — 用於使解碼器中注意力模組選定的頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示該頭未被遮蓋，
    • 0 表示該頭被遮蓋。
  • cross_attn_head_mask (torch.Tensor，形狀為 (num_layers, num_heads), 可選) — 用於使交叉注意力模組中選定的頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇：

    • 1 表示該頭未被遮蓋，
    • 0 表示該頭被遮蓋。
  • encoder_outputs (list[torch.FloatTensor], 可選) — 元組，包含 (`last_hidden_state`, *可選*: `hidden_states`, *可選*: `attentions`)。`last_hidden_state` 的形狀為 `(batch_size, sequence_length, hidden_size)`，*可選*）是編碼器最後一層輸出的隱藏狀態序列。用於解碼器的交叉注意力。
  • past_key_values (list[torch.FloatTensor], 可選) — 預先計算的隱藏狀態（自注意力和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包含模型在先前解碼階段返回的 `past_key_values`，當 `use_cache=True` 或 `config.use_cache=True` 時。

    允許兩種格式：

    • 一個 Cache 例項，請參閱我們的 kv 快取指南；
    • 一個長度為 `config.n_layers` 的 `tuple(torch.FloatTensor)` 的元組，每個元組包含 2 個形狀為 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的張量。這也稱為舊版快取格式。

    模型將輸出與輸入相同的快取格式。如果未傳遞 `past_key_values`，將返回舊版快取格式。

    如果使用 `past_key_values`，使用者可以選擇只輸入最後的 `input_ids`（那些沒有為其提供過去鍵值狀態的 `input_ids`），其形狀為 `(batch_size, 1)`，而不是所有形狀為 `(batch_size, sequence_length)` 的 `input_ids`。

  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `input_ids` 索引轉換為相關向量，這將非常有用。
  • decoder_inputs_embeds (torch.FloatTensor，形狀為 (batch_size, target_sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `decoder_input_ids`。如果使用 `past_key_values`，可以選擇只輸入最後的 `decoder_inputs_embeds` (見 `past_key_values`)。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 `decoder_input_ids` 索引轉換為相關向量，這將非常有用。

    如果 `decoder_input_ids` 和 `decoder_inputs_embeds` 都未設定，`decoder_inputs_embeds` 將取 `inputs_embeds` 的值。

  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在 `[0, ..., config.vocab_size]` 或 -100 之間（見 `input_ids` 文件）。索引設定為 `-100` 的標記將被忽略（遮蓋），損失僅對標籤在 `[0, ..., config.vocab_size]` 範圍內的標記進行計算。
  • use_cache (bool, 可選) — 如果設定為 `True`，將返回 `past_key_values` 鍵值狀態，可用於加速解碼（參見 `past_key_values`）。
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。
  • return_dict (bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
  • cache_position (torch.LongTensor，形狀為 (sequence_length), 可選) — 描繪輸入序列標記在序列中位置的索引。與 `position_ids` 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。

返回

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

一個 transformers.modeling_outputs.Seq2SeqLMOutput 或一個 `torch.FloatTensor` 元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），根據配置（BigBirdPegasusConfig）和輸入，包含各種元素。

  • loss (torch.FloatTensor，形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。

  • past_key_values (EncoderDecoderCache, 可選, 當 `use_cache=True` 被傳遞或當 `config.use_cache=True` 時返回) — 這是一個 EncoderDecoderCache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

    包含預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    解碼器在每一層輸出時的隱藏狀態以及初始嵌入輸出。

  • decoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

  • encoder_last_hidden_state (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 模型編碼器最後一層輸出的隱藏狀態序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    編碼器在每一層輸出時的隱藏狀態以及初始嵌入輸出。

  • encoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    編碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

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

儘管前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

摘要示例

>>> from transformers import AutoTokenizer, BigBirdPegasusForConditionalGeneration

>>> model = BigBirdPegasusForConditionalGeneration.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")

>>> ARTICLE_TO_SUMMARIZE = (
...     "The dominant sequence transduction models are based on complex recurrent or convolutional neural "
...     "networks in an encoder-decoder configuration. The best performing models also connect the encoder "
...     "and decoder through an attention mechanism. We propose a new simple network architecture, the Transformer, "
...     "based solely on attention mechanisms, dispensing with recurrence and convolutions entirely. "
...     "Experiments on two machine translation tasks show these models to be superior in quality "
...     "while being more parallelizable and requiring significantly less time to train."
... )
>>> inputs = tokenizer([ARTICLE_TO_SUMMARIZE], max_length=4096, return_tensors="pt", truncation=True)

>>> # Generate Summary
>>> summary_ids = model.generate(inputs["input_ids"], num_beams=4, max_length=15)
>>> tokenizer.batch_decode(summary_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'dominant sequence models are based on recurrent or convolutional neural networks .'

BigBirdPegasusForSequenceClassification

class transformers.BigBirdPegasusForSequenceClassification

< >

( config: BigBirdPegasusConfig **kwargs )

引數

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

BigBirdPegasus 模型，頂部帶有一個序列分類/頭（在池化輸出之上有一個線性層），例如用於 GLUE 任務。

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

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • decoder_input_ids (torch.LongTensor，形狀為 (batch_size, target_sequence_length)，可選) — 為翻譯和摘要訓練提供。預設情況下，模型將按照論文中的方法將 input_ids 向右移動來建立此張量。
  • decoder_attention_mask (torch.LongTensor，形狀為 (batch_size, target_sequence_length)，可選) — 預設行為：生成一個忽略 decoder_input_ids 中填充標記的張量。預設情況下也會使用因果掩碼。

    如果你想更改填充行為，應閱讀 modeling_bigbird_pegasus._prepare_decoder_attention_mask 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖1。

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • decoder_head_mask (torch.Tensor，形狀為 (num_layers, num_heads)，可選) — 用於置零解碼器中注意力模組選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • cross_attn_head_mask (torch.Tensor，形狀為 (num_layers, num_heads)，可選) — 用於置零交叉注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • encoder_outputs (list[torch.FloatTensor]，可選) — 元組，包含 (last_hidden_state, 可選: hidden_states, 可選: attentions)。形狀為 (batch_size, sequence_length, hidden_size) 的 last_hidden_state (可選) 是編碼器最後一層輸出的隱藏狀態序列。在解碼器的交叉注意力中使用。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會很有用。
  • decoder_inputs_embeds (torch.FloatTensor，形狀為 (batch_size, target_sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 decoder_input_ids。如果使用了 past_key_values，則可以選擇只輸入最後一個 decoder_inputs_embeds（參見 past_key_values）。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 decoder_input_ids 索引轉換為關聯向量，這會很有用。

    如果 decoder_input_ids 和 decoder_inputs_embeds 都未設定，decoder_inputs_embeds 將取 inputs_embeds 的值。

  • labels (torch.LongTensor，形狀為 (batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 範圍內。如果 config.num_labels > 1，則計算分類損失（交叉熵）。
  • use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool，可選) — 是返回一個 ModelOutput 而不是一個普通的元組。
  • cache_position (torch.LongTensor，形狀為 (sequence_length)，可選) — 描述輸入序列標記在序列中位置的索引。與 position_ids 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。

返回

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

一個 transformers.modeling_outputs.Seq2SeqSequenceClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（BigBirdPegasusConfig）和輸入而變化的不同元素。

  • loss (形狀為 (1,) 的 torch.FloatTensor，可選，當提供 label 時返回) — 分類 (如果 config.num_labels==1 則為迴歸) 損失。

  • logits (形狀為 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。

  • past_key_values (EncoderDecoderCache, 可選, 當 `use_cache=True` 被傳遞或當 `config.use_cache=True` 時返回) — 這是一個 EncoderDecoderCache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

    包含預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    解碼器在每一層輸出時的隱藏狀態以及初始嵌入輸出。

  • decoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

  • encoder_last_hidden_state (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 模型編碼器最後一層輸出的隱藏狀態序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    編碼器在每一層輸出時的隱藏狀態以及初始嵌入輸出。

  • encoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    編碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

BigBirdPegasusForSequenceClassification 的 forward 方法重寫了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, BigBirdPegasusForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForSequenceClassification.from_pretrained("google/bigbird-pegasus-large-arxiv")

>>> 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 = BigBirdPegasusForSequenceClassification.from_pretrained("google/bigbird-pegasus-large-arxiv", num_labels=num_labels)

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

多標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, BigBirdPegasusForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForSequenceClassification.from_pretrained("google/bigbird-pegasus-large-arxiv", 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 = BigBirdPegasusForSequenceClassification.from_pretrained(
...     "google/bigbird-pegasus-large-arxiv", 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

BigBirdPegasusForQuestionAnswering

class transformers.BigBirdPegasusForQuestionAnswering

< >

( config )

引數

帶有區間分類頭的 Bigbird Pegasus transformer，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上有一個線性層，用於計算 `span start logits` 和 `span end logits`）。

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

該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None decoder_input_ids: typing.Optional[torch.LongTensor] = None decoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None decoder_head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None encoder_outputs: typing.Optional[list[torch.FloatTensor]] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None decoder_inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值選自 [0, 1]：

    • 1 表示標記未被掩碼，
    • 0 表示標記已被掩碼。

    什麼是注意力掩碼？

  • decoder_input_ids (torch.LongTensor，形狀為 (batch_size, target_sequence_length)，可選) — 為翻譯和摘要訓練提供。預設情況下，模型將按照論文中的方法將 input_ids 向右移動來建立此張量。
  • decoder_attention_mask (torch.LongTensor，形狀為 (batch_size, target_sequence_length)，可選) — 預設行為：生成一個忽略 decoder_input_ids 中填充標記的張量。預設情況下也會使用因果掩碼。

    如果你想更改填充行為，應閱讀 modeling_bigbird_pegasus._prepare_decoder_attention_mask 並根據需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖1。

  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • decoder_head_mask (torch.Tensor，形狀為 (num_layers, num_heads)，可選) — 用於置零解碼器中注意力模組選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • cross_attn_head_mask (torch.Tensor，形狀為 (num_layers, num_heads)，可選) — 用於置零交叉注意力模組中選定頭的掩碼。掩碼值選自 [0, 1]：

    • 1 表示頭未被掩碼，
    • 0 表示頭已被掩碼。
  • encoder_outputs (list[torch.FloatTensor]，可選) — 元組，包含 (last_hidden_state, 可選: hidden_states, 可選: attentions)。形狀為 (batch_size, sequence_length, hidden_size) 的 last_hidden_state (可選) 是編碼器最後一層輸出的隱藏狀態序列。在解碼器的交叉注意力中使用。
  • start_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 標記的區間開始位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不予考慮。
  • end_positions (torch.LongTensor，形狀為 (batch_size,)，可選) — 標記的區間結束位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）內。序列之外的位置在計算損失時不予考慮。
  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為關聯向量，這會很有用。
  • decoder_inputs_embeds (torch.FloatTensor，形狀為 (batch_size, target_sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 decoder_input_ids。如果使用了 past_key_values，則可以選擇只輸入最後一個 decoder_inputs_embeds（參見 past_key_values）。如果你希望比模型內部的嵌入查詢矩陣更能控制如何將 decoder_input_ids 索引轉換為關聯向量，這會很有用。

    如果 decoder_input_ids 和 decoder_inputs_embeds 都未設定，decoder_inputs_embeds 將取 inputs_embeds 的值。

  • use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool，可選) — 是返回一個 ModelOutput 而不是一個普通的元組。
  • cache_position (torch.LongTensor，形狀為 (sequence_length)，可選) — 描述輸入序列標記在序列中位置的索引。與 position_ids 不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。

返回

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

一個 transformers.modeling_outputs.Seq2SeqQuestionAnsweringModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（BigBirdPegasusConfig）和輸入而變化的不同元素。

  • loss (torch.FloatTensor of shape (1,), 可選, 當提供 labels 時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。

  • past_key_values (EncoderDecoderCache, 可選, 當 `use_cache=True` 被傳遞或當 `config.use_cache=True` 時返回) — 這是一個 EncoderDecoderCache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

    包含預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

  • decoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    解碼器在每一層輸出時的隱藏狀態以及初始嵌入輸出。

  • decoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。

  • encoder_last_hidden_state (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 模型編碼器最後一層輸出的隱藏狀態序列。

  • encoder_hidden_states (tuple(torch.FloatTensor), 可選, 當 `output_hidden_states=True` 被傳遞或當 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組（如果模型有嵌入層，則一個是嵌入層的輸出，加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。

    編碼器在每一層輸出時的隱藏狀態以及初始嵌入輸出。

  • encoder_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

    編碼器的注意力權重，在注意力 softmax 之後，用於計算自注意力頭中的加權平均。

BigBirdPegasusForQuestionAnswering 的 forward 方法重寫了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

示例

>>> from transformers import AutoTokenizer, BigBirdPegasusForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForQuestionAnswering.from_pretrained("google/bigbird-pegasus-large-arxiv")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...

>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...

BigBirdPegasusForCausalLM

class transformers.BigBirdPegasusForCausalLM

< >

( config )

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力操作的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蔽，
    • 0 表示標記已被遮蔽。

    什麼是注意力掩碼？

  • encoder_hidden_states (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則用於交叉注意力。
  • encoder_attention_mask (torch.FloatTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入的填充標記索引執行注意力操作的掩碼。如果模型配置為解碼器，此掩碼用於交叉注意力。掩碼值在 [0, 1] 中選擇：

    • 1 表示標記未被遮蔽，
    • 0 表示標記已被遮蔽。
  • head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被遮蔽，
    • 0 表示頭已被遮蔽。
  • cross_attn_head_mask (torch.Tensor，形狀為 (decoder_layers, decoder_attention_heads)，可選) — 用於置零交叉注意力模組中選定頭的掩碼。掩碼值在 [0, 1] 中選擇：

    • 1 表示頭未被遮蔽，
    • 0 表示頭已被遮蔽。
  • past_key_values (tuple[tuple[torch.Tensor]], 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括在解碼的先前階段，當 use_cache=True 或 config.use_cache=True 時，模型返回的 past_key_values。

    允許兩種格式：

    • Cache 例項，請參閱我們的 kv 快取指南；
    • 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含 2 個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也稱為舊版快取格式。

    模型將輸出與輸入相同的快取格式。如果未傳遞 past_key_values，將返回舊版快取格式。

    如果使用 past_key_values，使用者可以選擇只輸入形狀為 (batch_size, 1) 的最後 input_ids（那些沒有提供其過去鍵值狀態給此模型的 ID），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。

  • inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果您希望比模型內部的嵌入查詢矩陣更能控制如何將 input_ids 索引轉換為相關向量，這將非常有用。
  • labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [0, ..., config.vocab_size] 或 -100 之間（參見 input_ids 文件字串）。索引設定為 -100 的標記將被忽略（遮蔽），損失僅對標籤在 [0, ..., config.vocab_size] 中的標記計算。
  • use_cache (bool，可選) — 如果設定為 True，則返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
  • output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 attentions。
  • output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 hidden_states。
  • return_dict (bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
  • cache_position (torch.LongTensor，形狀為 (sequence_length)，可選) — 描述輸入序列標記在序列中位置的索引。與 position_ids 相反，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。

返回

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

一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（BigBirdPegasusConfig）和輸入，包含各種元素。

  • loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。

  • logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。

  • hidden_states (tuple(torch.FloatTensor), 可選, 當傳遞 output_hidden_states=True 或 config.output_hidden_states=True 時返回) — torch.FloatTensor 的元組（一個用於嵌入層的輸出（如果模型有嵌入層），每個層的輸出各一個），形狀為 (batch_size, sequence_length, hidden_size)。

    模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。

  • attentions (tuple(torch.FloatTensor), 可選, 當傳遞 output_attentions=True 或 config.output_attentions=True 時返回) — torch.FloatTensor 的元組（每層一個），形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

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

  • cross_attentions (tuple(torch.FloatTensor), 可選, 當 `output_attentions=True` 被傳遞或當 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。

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

  • past_key_values (Cache, 可選, 當傳遞 use_cache=True 或 config.use_cache=True 時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。

    包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

BigBirdPegasusForCausalLM 的前向方法覆蓋了 __call__ 特殊方法。

儘管前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。

示例

>>> from transformers import AutoTokenizer, BigBirdPegasusForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("google/bigbird-pegasus-large-arxiv")
>>> model = BigBirdPegasusForCausalLM.from_pretrained(
...     "google/bigbird-pegasus-large-arxiv", add_cross_attention=False
... )
>>> assert model.config.is_decoder, f"{model.__class__} has to be configured as a decoder."
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> logits = outputs.logits
< > 在 GitHub 上更新

←BigBird BioGpt→
© . This site is unofficial and not affiliated with Hugging Face, Inc.