Transformers 文件

Reformer 模型

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

Reformer

PyTorch

概述

Reformer 模型由 Nikita Kitaev、Łukasz Kaiser、Anselm Levskaya 在論文 Reformer: 高效 Transformer 中提出。

論文摘要如下:

大型 Transformer 模型在多項任務上通常能達到最先進的結果,但訓練這些模型的成本可能高得令人望而卻步,尤其是在長序列上。我們引入了兩種技術來提高 Transformer 的效率。首先,我們將點積注意力替換為使用區域性敏感雜湊的注意力,將其複雜度從 O(L^2) 改變為 O(Llog(L)),其中 L 是序列的長度。此外,我們使用可逆殘差層而不是標準殘差層,這使得在訓練過程中只需儲存一次啟用(而不是 N 次,N 是層數)。由此產生的模型 Reformer 在效能上與 Transformer 模型相當,同時在長序列上更節省記憶體且速度更快。

此模型由 patrickvonplaten 貢獻。作者的程式碼可以在 這裡 找到。

使用技巧

  • 由於 PyTorch 中的一個 bug,Reformer 支援 torch.nn.DataParallel,參見 問題 #36035
  • 使用軸向位置編碼(詳見下文)。這是一種透過將巨大位置編碼矩陣分解為較小矩陣來避免其過大(當序列長度非常大時)的機制。
  • 用 LSH(區域性敏感雜湊)注意力替換傳統注意力(詳見下文)。這是一種避免在注意力層中計算完整查詢-鍵乘積的技術。
  • 透過使用可逆 Transformer 層,避免儲存每個層的中間結果,從而在反向傳播過程中獲取它們(從下一層的輸入中減去殘差即可恢復它們)或重新計算給定層內部的結果(效率低於儲存但節省記憶體)。
  • 分塊而不是對整個批次計算前饋操作。

軸向位置編碼

軸向位置編碼最初由 Google 的 trax 庫 實現,並由該模型論文的作者開發。在處理非常長輸入序列的模型中,傳統的位置 ID 編碼儲存一個大小為dd的嵌入向量,其中 config.hidden_size 是每個位置的i,,nsi, \ldots, n_s,其中nsn_sconfig.max_embedding_size。這意味著如果序列長度為ns=2190.5Mn_s = 2^{19} \approx 0.5M,並且 config.hidden_sized=2101000d = 2^{10} \approx 1000,將導致位置編碼矩陣Xi,j, with i[1,,d] and j[1,,ns]X_{i,j}, \text{ with } i \in \left[1,\ldots, d\right] \text{ and } j \in \left[1,\ldots, n_s\right]

,其本身就有超過 5 億個引數需要儲存。軸向位置編碼將Xi,jX_{i,j}分解為兩個矩陣Xi,j1, with i[1,,d1] and j[1,,ns1]X^{1}_{i,j}, \text{ with } i \in \left[1,\ldots, d^1\right] \text{ and } j \in \left[1,\ldots, n_s^1\right]

Xi,j2, with i[1,,d2] and j[1,,ns2]X^{2}_{i,j}, \text{ with } i \in \left[1,\ldots, d^2\right] \text{ and } j \in \left[1,\ldots, n_s^2\right]

,其中d=d1+d2 and ns=ns1×ns2.d = d^1 + d^2 \text{ and } n_s = n_s^1 \times n_s^2 .

因此,以下成立:Xi,j={Xi,k1,if  i<d1 with k=jmodns1Xid1,l2,if id1 with l=jns1X_{i,j} = \begin{cases} X^{1}_{i, k}, & \text{if }\ i < d^1 \text{ with } k = j \mod n_s^1 \\ X^{2}_{i - d^1, l}, & \text{if } i \ge d^1 \text{ with } l = \lfloor\frac{j}{n_s^1}\rfloor \end{cases}

直觀地說,這意味著位置嵌入向量xjRdx_j \in \mathbb{R}^{d}現在是兩個分解嵌入向量的組合xk,l1+xl,k2x^1_{k, l} + x^2_{l, k},其中 config.max_embedding_size 維度jj被分解為k and lk \text{ and } l。這種設計確保了每個位置嵌入向量xjx_j是唯一的。

再次使用上面的例子,軸向位置編碼和d1=29,d2=29,ns1=29,ns2=210d^1 = 2^9, d^2 = 2^9, n_s^1 = 2^9, n_s^2 = 2^{10}可以將引數數量從 5 億個大幅減少到218+2197800002^{18} + 2^{19} \approx 780 000個引數,這意味著記憶體使用量減少了 85%。

在實踐中,引數 config.axial_pos_embds_dim 設定為元組(d1,d2)(d^1, d^2)其和必須等於 config.hidden_sizeconfig.axial_pos_shape 設定為元組(ns1,ns2)(n_s^1, n_s^2)其積必須等於 config.max_embedding_size,在訓練期間,它必須等於 input_ids序列長度

LSH 自注意力

在區域性敏感雜湊 (LSH) 自注意力中,鍵和查詢投影權重是繫結的。因此,鍵查詢嵌入向量也是繫結的。LSH 自注意力使用 用於角度距離的實用最優 LSH 中提出的區域性敏感雜湊機制,將每個繫結的鍵查詢嵌入向量分配到 config.num_buckets 個可能的桶中的一個。其前提是,“更相似”的鍵查詢嵌入向量(就餘弦相似度而言)彼此之間越相似,它們被分配到同一桶的可能性就越大。

LSH 機制的準確性可以透過增加 config.num_hashes 或直接增加前向函式的引數 num_hashes 來提高,從而使 LSH 自注意力的輸出更好地近似“正常”完整自注意力的輸出。然後對桶進行排序,並將其分塊為長度為 config.lsh_chunk_length 的查詢鍵嵌入向量塊。對於每個塊,查詢嵌入向量關注其鍵向量(與自身繫結)以及 config.lsh_num_chunks_before 個先前相鄰塊和 config.lsh_num_chunks_after 個後續相鄰塊的鍵嵌入向量。

欲瞭解更多資訊,請參閱原始論文或這篇優秀的部落格文章

請注意,config.num_buckets 也可以分解為一個列表(nbuckets1,nbuckets2)(n_{\text{buckets}}^1, n_{\text{buckets}}^2)。這樣,查詢鍵嵌入向量就不會被分配到(1,,nbuckets)(1,\ldots, n_{\text{buckets}})中的一個,而是被分配到(11,,nbuckets11,,1nbuckets2,,nbuckets1nbuckets2)(1-1,\ldots, n_{\text{buckets}}^1-1, \ldots, 1-n_{\text{buckets}}^2, \ldots, n_{\text{buckets}}^1-n_{\text{buckets}}^2)中的一個。這對於節省超長序列的記憶體至關重要。

從頭開始訓練模型時,建議將 config.num_buckets 留空,以便根據序列長度動態計算一個好的 num_buckets 值。該值將自動儲存在配置中,並應在推理時重複使用。

使用 LSH 自注意力,查詢-鍵矩陣乘法操作的記憶體和時間複雜度可以從O(ns×ns)\mathcal{O}(n_s \times n_s)O(ns×log(ns))\mathcal{O}(n_s \times \log(n_s))降低,這通常是 Transformer 模型中的記憶體和時間瓶頸,其中nsn_s是序列長度。

區域性自注意力

區域性自注意力本質上是“正常”的自注意力層,具有鍵、查詢和值投影,但它被分塊,以便在每個長度為 config.local_chunk_length 的塊中,查詢嵌入向量僅關注其塊中的鍵嵌入向量以及 config.local_num_chunks_before 個先前相鄰塊和 config.local_num_chunks_after 個後續相鄰塊的鍵嵌入向量。

使用區域性自注意力,查詢-鍵矩陣乘法操作的記憶體和時間複雜度可以從O(ns×ns)\mathcal{O}(n_s \times n_s)O(ns×log(ns))\mathcal{O}(n_s \times \log(n_s))降低,這通常是 Transformer 模型中的記憶體和時間瓶頸,其中nsn_s是序列長度。

訓練

在訓練過程中,我們必須確保序列長度設定為可以被 config.lsh_chunk_lengthconfig.local_chunk_length 的最小公倍數整除的值,並且軸向位置編碼的引數已如上所述正確設定。Reformer 的記憶體效率非常高,因此該模型可以輕鬆地在長達 64000 個標記的序列上進行訓練。

對於訓練,應按如下方式使用 ReformerModelWithLMHead

input_ids = tokenizer.encode("This is a sentence from the training data", return_tensors="pt")
loss = model(input_ids, labels=input_ids)[0]

資源

ReformerConfig

class transformers.ReformerConfig

< >

( attention_head_size = 64 attn_layers = ['local', 'lsh', 'local', 'lsh', 'local', 'lsh'] axial_norm_std = 1.0 axial_pos_embds = True axial_pos_shape = [64, 64] axial_pos_embds_dim = [64, 192] chunk_size_lm_head = 0 eos_token_id = 2 feed_forward_size = 512 hash_seed = None hidden_act = 'relu' hidden_dropout_prob = 0.05 hidden_size = 256 initializer_range = 0.02 is_decoder = False layer_norm_eps = 1e-12 local_num_chunks_before = 1 local_num_chunks_after = 0 local_attention_probs_dropout_prob = 0.05 local_attn_chunk_length = 64 lsh_attn_chunk_length = 64 lsh_attention_probs_dropout_prob = 0.0 lsh_num_chunks_before = 1 lsh_num_chunks_after = 0 max_position_embeddings = 4096 num_attention_heads = 12 num_buckets = None num_hashes = 1 pad_token_id = 0 vocab_size = 320 tie_word_embeddings = False use_cache = True classifier_dropout = None **kwargs )

引數

  • attention_head_size (int, 可選, 預設為 64) — 投影的鍵、查詢和值向量的維度
  • attn_layers (list[str], 可選, 預設為 ["local", "lsh", "local", "lsh", "local", "lsh"]) — 注意力層型別的升序列表。可以選擇 LSHSelfAttention 層("lsh")和 LocalSelfAttention 層("local")。

    有關 LSHSelfAttention 層的更多資訊,請參閱LSH 自注意力。有關 LocalSelfAttention 層的更多資訊,請參閱區域性自注意力

  • axial_pos_embds (bool, 可選, 預設為 True) — 是否使用軸向位置嵌入。有關軸向位置嵌入如何工作的更多資訊,請參閱軸向位置編碼
  • axial_norm_std (float, 可選, 預設為 1.0) — 用於初始化軸向位置編碼權重矩陣的 normal_initializer 的標準差。
  • axial_pos_shape (list[int], 可選, 預設為 [64, 64]) — 軸向位置編碼的位置維度。在訓練期間,位置維度的乘積必須等於序列長度。

    有關軸向位置嵌入如何工作的更多資訊,請參閱軸向位置編碼

  • axial_pos_embds_dim (list[int], 可選, 預設為 [64, 192]) — 軸向位置編碼的嵌入維度。嵌入維度之和必須等於隱藏大小。

    有關軸向位置嵌入如何工作的更多資訊,請參閱軸向位置編碼

  • chunk_size_lm_head (int, 可選, 預設為 0) — 最終語言模型前饋頭層的塊大小。塊大小為 0 意味著前饋層未分塊。塊大小為 n 意味著前饋層一次處理 n < 序列長度的嵌入。

    有關前饋分塊的更多資訊,請參閱前饋分塊如何工作?

  • eos_token_id (int, 可選, 預設為 2) — 句子結束標記的標記 ID。
  • feed_forward_size (int, 可選, 預設為 512) — 殘差注意力塊中 feed_forward 層的維度。
  • hash_seed (int, 可選) — 可用於使 LSHSelfAttention 中的區域性敏感雜湊確定性的種子。這應僅用於測試目的。對於評估和訓練目的,hash_seed 應保留為 None,以確保區域性敏感雜湊方案中的完全隨機旋轉。
  • hidden_act (strCallable, 可選, 預設為 "relu") — 殘差注意力塊中前饋層的非線性啟用函式(函式或字串)。如果為字串,支援 "gelu""relu""silu""gelu_new"
  • hidden_dropout_prob (float, 可選, 預設為 0.05) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。
  • hidden_size (int, 可選, 預設為 256) — 殘差注意力塊的輸出隱藏狀態的維度。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
  • is_decoder (bool, 可選, 預設為 False) — 是否使用因果掩碼以及傳遞給 ReformerModelattention_mask。當 Reformer 用於因果語言建模時,此引數應設定為 True
  • layer_norm_eps (float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon。
  • local_chunk_length (int, 可選, 預設為 64) — 在 LocalSelfAttention 中關注自身的塊的長度。分塊將記憶體複雜度從序列長度 x 序列長度(自注意力)降低到塊長度 x 塊長度 x 序列長度 / 塊長度(分塊自注意力)。
  • local_num_chunks_before (int, 可選, 預設為 1) — 在 LocalSelfAttention 層中,關注其自身的先前相鄰塊的數量。
  • local_num_chunks_after (int, 可選, 預設為 0) — 在 LocalSelfAttention 層中,除了自身外,關注的後續相鄰塊的數量。
  • local_attention_probs_dropout_prob (float, 可選, 預設為 0.1) — LocalSelfAttention 中注意力機率的 dropout 比率。
  • lsh_attn_chunk_length (int, 可選, 預設為 64) — 在 LSHSelfAttention 中關注自身的塊的長度。分塊將記憶體複雜度從序列長度 x 序列長度(自注意力)降低到塊長度 x 塊長度 x 序列長度 / 塊長度(分塊自注意力)。
  • lsh_num_chunks_before (int, 可選, 預設為 1) — 在 LSHSelfAttention 層中,關注其自身的先前相鄰塊的數量。
  • lsh_num_chunks_after (int, 可選, 預設為 0) — 在 LSHSelfAttention 層中,除了自身外,關注的後續相鄰塊的數量。
  • lsh_attention_probs_dropout_prob (float, 可選, 預設為 0.1) — LSHSelfAttention 中注意力機率的 dropout 比率。
  • max_position_embeddings (int, 可選, 預設為 4096) — 該模型可能使用的最大序列長度。通常為了以防萬一會將其設定為一個較大的值(例如 512 或 1024 或 2048)。
  • num_attention_heads (int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。
  • num_buckets (intlist[int], 可選) — 桶的數量,可以使用區域性敏感雜湊方案將鍵查詢向量“雜湊”到其中。每個查詢鍵向量都被雜湊到 1, ..., num_buckets 中的一個雜湊中。為了提高記憶體複雜度,桶的數量也可以分解為一個列表。在這種情況下,如果 num_buckets 被分解為兩個因子,則每個查詢鍵向量都被雜湊到 1-1, 1-2, ..., num_buckets[0]-1, ..., num_buckets[0]-num_buckets[1] 中的一個雜湊中。桶的數量(或因子的乘積)應大約等於序列長度 / lsh_chunk_length。如果未設定 num_buckets,則會動態計算一個好的值。
  • num_hashes (int, 可選, 預設為 1) — 區域性敏感雜湊方案中的雜湊輪數(例如,隨機旋轉的數量)。num_hashes 越高,LSHSelfAttention 越準確,但雜湊的記憶體和時間消耗也越大。
  • pad_token_id (int, 可選, 預設為 0) — 填充標記的標記 ID。
  • vocab_size (int, 可選, 預設為 320) — Reformer 模型的詞彙表大小。定義了呼叫 ReformerModel 時傳遞的 inputs_ids 可以表示的不同標記的數量。
  • tie_word_embeddings (bool, 可選, 預設為 False) — 是否繫結輸入和輸出嵌入。
  • use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力(並非所有模型都使用)。
  • classifier_dropout (float, 可選) — 分類頭部的 dropout 比率。

這是用於儲存 ReformerModel 配置的配置類。它用於根據指定引數例項化 Reformer 模型,定義模型架構。使用預設值例項化配置將產生與 ReFormer google/reformer-crime-and-punishment 架構類似的配置。

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

示例

>>> from transformers import ReformerConfig, ReformerModel

>>> # Initializing a Reformer configuration
>>> configuration = ReformerConfig()

>>> # Initializing a Reformer model (with random weights)
>>> model = ReformerModel(configuration)

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

ReformerTokenizer

class transformers.ReformerTokenizer

< >

( vocab_file eos_token = '</s>' unk_token = '<unk>' additional_special_tokens = [] sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None **kwargs )

引數

  • vocab_file (str) — SentencePiece 檔案(通常具有 .spm 副檔名),其中包含例項化分詞器所需的詞彙表。
  • eos_token (str, 可選, 預設為 "</s>") — 序列結束符。

    當使用特殊令牌構建序列時,這不是用於序列結束的令牌。使用的令牌是 sep_token

  • unk_token (str, 可選, 預設為 "<unk>") — 未知令牌。不在詞彙表中的令牌不能轉換為 ID,而是設定為此令牌。
  • additional_special_tokens (list[str], 可選, 預設為 []) — 分詞器使用的其他特殊令牌。
  • sp_model_kwargs (dict, 可選) — 將傳遞給 SentencePieceProcessor.__init__() 方法。SentencePiece 的 Python 包裝器 可用於設定:

    • enable_sampling: 啟用子詞正則化。

    • nbest_size: Unigram 的取樣引數。對於 BPE-Dropout 無效。

      • nbest_size = {0,1}: 不執行取樣。
      • nbest_size > 1: 從 nbest_size 結果中取樣。
      • nbest_size < 0: 假設 nbest_size 是無限的,並使用前向過濾和後向取樣演算法從所有假設(格)中取樣。
    • alpha: Unigram 取樣的平滑引數,以及 BPE-dropout 合併操作的 dropout 機率。

構建 Reformer 分詞器。基於 SentencePiece

此分詞器繼承自 PreTrainedTokenizer,其中包含大部分主要方法。使用者應參閱此超類以獲取有關這些方法的更多資訊。

save_vocabulary

< >

( save_directory: str filename_prefix: typing.Optional[str] = None )

ReformerTokenizerFast

class transformers.ReformerTokenizerFast

< >

( vocab_file = None tokenizer_file = None eos_token = '</s>' unk_token = '<unk>' additional_special_tokens = [] **kwargs )

引數

  • vocab_file (str) — SentencePiece 檔案(通常具有 .spm 副檔名),其中包含例項化分詞器所需的詞彙表。
  • eos_token (str, 可選, 預設為 "</s>") — 序列結束符。

    當使用特殊令牌構建序列時,這不是用於序列結束的令牌。使用的令牌是 sep_token

  • unk_token (str, 可選, 預設為 "<unk>") — 未知令牌。不在詞彙表中的令牌不能轉換為 ID,而是設定為此令牌。
  • pad_token (str, 可選, 預設為 "<pad>") — 用於填充的令牌,例如當批次處理不同長度的序列時。
  • additional_special_tokens (list[str], 可選) — 分詞器使用的其他特殊令牌。

構建一個“快速”Reformer 分詞器(由 HuggingFace 的 tokenizers 庫支援)。基於 Unigram

此分詞器繼承自 PreTrainedTokenizerFast,其中包含大部分主要方法。使用者應參閱此超類以獲取有關這些方法的更多資訊。

ReformerModel

class transformers.ReformerModel

< >

( config )

引數

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

Reformer 模型輸出原始隱藏狀態,頂部沒有任何特定頭部。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None past_buckets_states: typing.Optional[list[tuple[torch.Tensor]]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.reformer.modeling_reformer.ReformerModelOutputtuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列令牌的索引。在訓練期間,input_ids 的序列長度必須是相關模型塊長度(LSH 的、本地的或兩者)的倍數。在評估期間,索引會自動填充為塊長度的倍數。

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

    什麼是輸入 ID?

  • attention_mask (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 避免對填充令牌索引執行注意力的掩碼。掩碼值選擇在 [0, 1]:

    • 1 表示令牌未被遮蔽
    • 0 表示令牌被遮蔽

    什麼是注意力掩碼?

  • position_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列令牌在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

  • head_mask (torch.Tensor 形狀為 (num_heads,)(num_layers, num_heads), 可選) — 遮蔽自注意力模組選定頭部的掩碼。掩碼值選擇在 [0, 1]:

    • 1 表示頭部未被遮蔽
    • 0 表示頭部被遮蔽
  • inputs_embeds (torch.Tensor 形狀為 (batch_size, sequence_length, hidden_size), 可選) — 可選地,除了傳遞 input_ids,您還可以直接傳遞嵌入表示。如果您希望對如何將 input_ids 索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這會很有用。
  • num_hashes (int, 可選) — 分桶期間應執行的雜湊輪數。設定此引數會覆蓋 config.num_hashes 中定義的預設值。

    有關更多資訊,請參閱 ReformerConfig 中的 num_hashes

  • past_buckets_states (list[tuple(torch.LongTensor, torch.FloatTensor)], 可選) — 長度為 config.n_layerstuple(torch.LongTensor, torch.FloatTensor 列表,第一個元素為形狀為 (batch_size, num_heads, num_hashes, sequence_length) 的前一個 buckets,第二個元素為形狀為 (batch_size, sequence_length, hidden_size) 的前一個 hidden_states)。

    包含預先計算的隱藏狀態和 buckets(僅與 LSH 自注意力相關)。可用於加速順序解碼。

  • use_cache (bool, 可選) — 如果設定為 True,將返回 past_key_values 鍵值狀態,可用於加速解碼(參見 past_key_values)。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的 hidden_states
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的 attentions
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通元組。

返回

transformers.models.reformer.modeling_reformer.ReformerModelOutputtuple(torch.FloatTensor)

一個 transformers.models.reformer.modeling_reformer.ReformerModelOutputtorch.FloatTensor 的元組(如果傳遞了 return_dict=Falseconfig.return_dict=False),包含根據配置 (ReformerConfig) 和輸入的不同元素。

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

    num_predict 對應於 target_mapping.shape[1]。如果 target_mappingNone,則 num_predict 對應於 sequence_length

  • past_buckets_states (list[tuple(torch.LongTensor, torch.FloatTensor)], 可選, 當傳遞 use_cache=Trueconfig.use_cache=True 時返回) — 長度為 config.n_layerstuple(torch.LongTensor, torch.FloatTensor 列表,第一個元素為形狀為 (batch_size, num_heads, num_hashes, sequence_length) 的前一個 buckets,第二個元素為形狀為 (batch_size, sequence_length, hidden_size) 的前一個 hidden_states)。

    包含預先計算的 buckets 和隱藏狀態,可用於(參見 past_buckets_states 輸入)加速順序解碼。

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

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

  • attentions (tuple[torch.FloatTensor], 可選, 當傳遞 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 的元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

ReformerModel 的 forward 方法,覆蓋了 __call__ 特殊方法。

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

ReformerModelWithLMHead

class transformers.ReformerModelWithLMHead

< >

( config )

引數

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

語言建模 頭部的 Reformer 模型。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None past_buckets_states: typing.Optional[list[tuple[torch.Tensor]]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None **kwargs ) transformers.modeling_outputs.CausalLMOutputtuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor 形狀為 (batch_size, sequence_length)) — 詞彙表中輸入序列令牌的索引。在訓練期間,input_ids 的序列長度必須是相關模型塊長度(LSH 的、本地的或兩者)的倍數。在評估期間,索引會自動填充為塊長度的倍數。

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

    什麼是輸入 ID?

  • position_ids (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 每個輸入序列令牌在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

  • attention_mask (torch.Tensor 形狀為 (batch_size, sequence_length), 可選) — 避免對填充令牌索引執行注意力的掩碼。掩碼值選擇在 [0, 1]:

    • 1 表示令牌未被遮蔽
    • 0 表示令牌被遮蔽

    什麼是注意力掩碼?

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

    • 1 表示頭部未被掩碼
    • 0 表示頭部被掩碼
  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor可選) — 可選地,您可以選擇直接傳入嵌入表示而不是 input_ids。如果您想對 input_ids 索引如何轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這將非常有用。
  • num_hashes (int, 可選) — 分桶期間應執行的雜湊輪數。設定此引數會覆蓋 config.num_hashes 中定義的預設值。

    更多資訊請參見 ReformerConfig 中的 num_hashes

  • past_buckets_states (list[tuple(torch.LongTensor, torch.FloatTensor)]可選) — 長度為 config.n_layerstuple(torch.LongTensor, torch.FloatTensor 列表,其中第一個元素是形狀為 (batch_size, num_heads, num_hashes, sequence_length) 的先前,第二個是形狀為 (batch_size, sequence_length, hidden_size) 的先前隱藏狀態)。

    包含預先計算的隱藏狀態和桶(僅與 LSH 自注意力相關)。可用於加速順序解碼。

  • use_cache (bool, 可選) — 如果設定為 True,則返回 past_key_values 鍵值狀態,可用於加速解碼(參見 past_key_values)。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量下的 hidden_states
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量下的 attentions
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。
  • labels (形狀為 (batch_size,)torch.LongTensor可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [-100, 0, ..., config.vocab_size - 1] 之間。所有設定為 -100 的標籤將被忽略(掩碼),損失僅針對 [0, ..., config.vocab_size] 中的標籤計算

返回

transformers.modeling_outputs.CausalLMOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.CausalLMOutputtorch.FloatTensor 的元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置 (ReformerConfig) 和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 的元組(如果模型有嵌入層,則為嵌入層輸出一個,每個層輸出一個),形狀為 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor)可選,當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 的元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

ReformerModelWithLMHead 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, ReformerModelWithLMHead

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerModelWithLMHead.from_pretrained("google/reformer-crime-and-punishment")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

ReformerForMaskedLM

class transformers.ReformerForMaskedLM

< >

( config )

引數

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

帶有 語言建模 頭的 Reformer 模型。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

引數

  • input_ids (形狀為 (batch_size, sequence_length)torch.LongTensor) — 詞彙表中輸入序列標記的索引。訓練期間,input_ids 的序列長度必須是相關模型塊長度(lsh、區域性或兩者)的倍數。評估期間,索引會自動填充為塊長度的倍數。

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

    什麼是輸入 ID?

  • position_ids (形狀為 (batch_size, sequence_length)torch.Tensor可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

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

    • 1 表示標記未被掩碼
    • 0 表示標記被掩碼

    什麼是注意力掩碼?

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

    • 1 表示頭部未被掩碼
    • 0 表示頭部被掩碼
  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor可選) — 可選地,您可以選擇直接傳入嵌入表示而不是 input_ids。如果您想對 input_ids 索引如何轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這將非常有用。
  • num_hashes (int, 可選) — 分桶期間應執行的雜湊輪數。設定此引數會覆蓋 config.num_hashes 中定義的預設值。

    更多資訊請參見 ReformerConfig 中的 num_hashes

  • labels (形狀為 (batch_size, sequence_length)torch.LongTensor可選) — 用於計算掩碼語言建模損失的標籤。索引應在 [-100, 0, ..., config.vocab_size] 之間(參見 input_ids 文件字串)。索引設定為 -100 的標記將被忽略(掩碼),損失僅針對帶有標籤的標記計算

    此示例使用了一個虛假檢查點,因為我們沒有 Reformer 架構的掩碼語言建模任務的任何可用預訓練模型。

  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量下的 hidden_states
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量下的 attentions
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。

返回

transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.MaskedLMOutputtorch.FloatTensor 的元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置 (ReformerConfig) 和輸入的不同元素。

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

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

  • hidden_states (tuple(torch.FloatTensor)可選,當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 的元組(如果模型有嵌入層,則為嵌入層輸出一個,每個層輸出一個),形狀為 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor)可選,當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 的元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

ReformerForMaskedLM 的 forward 方法,重寫了 __call__ 特殊方法。

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, ReformerForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("hf-internal-testing/tiny-random-reformer")
>>> model = ReformerForMaskedLM.from_pretrained("hf-internal-testing/tiny-random-reformer")

>>> # add mask_token
>>> tokenizer.add_special_tokens({"mask_token": "[MASK]"})
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")

>>> # resize model's embedding matrix
>>> model.resize_token_embeddings(new_num_tokens=model.config.vocab_size + 1)
>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]

>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> predicted_token = tokenizer.decode(predicted_token_id)
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = torch.where(
...     inputs.input_ids == tokenizer.mask_token_id, labels[:, : inputs["input_ids"].shape[-1]], -100
... )

>>> outputs = model(**inputs, labels=labels)
>>> loss = round(outputs.loss.item(), 2)

ReformerForSequenceClassification

class transformers.ReformerForSequenceClassification

< >

( config )

引數

Reformer 模型變換器,頂部帶有一個序列分類/迴歸頭(在池化輸出之上有一個線性層),例如用於 GLUE 任務。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

引數

  • input_ids (形狀為 (batch_size, sequence_length)torch.LongTensor) — 詞彙表中輸入序列標記的索引。訓練期間,input_ids 的序列長度必須是相關模型塊長度(lsh、區域性或兩者)的倍數。評估期間,索引會自動填充為塊長度的倍數。

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

    什麼是輸入 ID?

  • position_ids (形狀為 (batch_size, sequence_length)torch.Tensor可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

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

    • 1 表示標記未被掩碼
    • 0 表示標記被掩碼

    什麼是注意力掩碼?

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

    • 1 表示頭部未被掩碼
    • 0 表示頭部被掩碼
  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor可選) — 可選地,您可以選擇直接傳入嵌入表示而不是 input_ids。如果您想對 input_ids 索引如何轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這將非常有用。
  • num_hashes (int, 可選) — 分桶期間應執行的雜湊輪數。設定此引數會覆蓋 config.num_hashes 中定義的預設值。

    更多資訊請參見 ReformerConfig 中的 num_hashes

  • labels (形狀為 (batch_size,)torch.LongTensor可選) — 用於計算序列分類/迴歸損失的標籤。索引應在 [0, ..., config.num_labels - 1] 之間。如果 config.num_labels == 1,則計算迴歸損失(均方損失);如果 config.num_labels > 1,則計算分類損失(交叉熵損失)。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量下的 hidden_states
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量下的 attentions
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。

返回

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.SequenceClassifierOutputtorch.FloatTensor 的元組(如果傳入 return_dict=Falseconfig.return_dict=False),包含根據配置 (ReformerConfig) 和輸入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 的元組(如果模型有嵌入層,則為嵌入層輸出一個,每個層輸出一個),形狀為 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor)可選,當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 的元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

ReformerForSequenceClassification 的 forward 方法,重寫了 __call__ 特殊方法。

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

單標籤分類示例

>>> import torch
>>> from transformers import AutoTokenizer, ReformerForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerForSequenceClassification.from_pretrained("google/reformer-crime-and-punishment")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> label = 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 = ReformerForSequenceClassification.from_pretrained(
...     "google/reformer-crime-and-punishment", num_labels=num_labels
... )

>>> labels = torch.tensor(1)
>>> loss = model(**inputs, labels=labels).loss

ReformerForQuestionAnswering

class transformers.ReformerForQuestionAnswering

< >

( config )

引數

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

Reformer 變換器,頂部帶有一個用於抽取式問答任務(如 SQuAD)的跨度分類頭(在隱藏狀態輸出之上有一個線性層,用於計算 span start logitsspan end logits)。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

引數

  • input_ids (形狀為 (batch_size, sequence_length)torch.LongTensor) — 詞彙表中輸入序列標記的索引。訓練期間,input_ids 的序列長度必須是相關模型塊長度(lsh、區域性或兩者)的倍數。評估期間,索引會自動填充為塊長度的倍數。

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

    什麼是輸入 ID?

  • position_ids (形狀為 (batch_size, sequence_length)torch.Tensor可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為 [0, config.n_positions - 1]

    什麼是位置 ID?

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

    • 1 表示標記未被掩碼
    • 0 表示標記被掩碼

    什麼是注意力掩碼?

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

    • 1 表示頭部未被掩碼
    • 0 表示頭部被掩碼
  • inputs_embeds (形狀為 (batch_size, sequence_length, hidden_size)torch.Tensor可選) — 可選地,您可以選擇直接傳入嵌入表示而不是 input_ids。如果您想對 input_ids 索引如何轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制,這將非常有用。
  • num_hashes (int, 可選) — 分桶期間應執行的雜湊輪數。設定此引數會覆蓋 config.num_hashes 中定義的預設值。

    更多資訊請參見 ReformerConfig 中的 num_hashes

  • start_positions (形狀為 (batch_size,)torch.Tensor可選) — 用於計算標記分類損失的標籤跨度起始位置(索引)。位置被限制在序列長度(sequence_length)內。序列外的位置不計入損失計算。
  • end_positions (形狀為 (batch_size,)torch.Tensor可選) — 用於計算標記分類損失的標籤跨度結束位置(索引)。位置被限制在序列長度(sequence_length)內。序列外的位置不計入損失計算。
  • output_hidden_states (bool, 可選) — 是否返回所有層的隱藏狀態。更多詳情請參見返回張量下的 hidden_states
  • output_attentions (bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳情請參見返回張量下的 attentions
  • return_dict (bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 元組(如果傳入 return_dict=False 或當 config.return_dict=False 時),其中包含根據配置 (ReformerConfig) 和輸入而定的各種元素。

  • 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 之前)。

  • hidden_states (tuple(torch.FloatTensor)可選,當傳入 output_hidden_states=Trueconfig.output_hidden_states=True 時返回) — torch.FloatTensor 的元組(如果模型有嵌入層,則為嵌入層輸出一個,每個層輸出一個),形狀為 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor)可選,當傳入 output_attentions=Trueconfig.output_attentions=True 時返回) — torch.FloatTensor 的元組(每個層一個),形狀為 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

示例

>>> from transformers import AutoTokenizer, ReformerForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerForQuestionAnswering.from_pretrained("google/reformer-crime-and-punishment")

>>> 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)
...
< > 在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.