Transformers 文件
Splinter
並獲得增強的文件體驗
開始使用
Splinter
概述
Splinter 模型由 Ori Ram、Yuval Kirstain、Jonathan Berant、Amir Globerson 和 Omer Levy 在論文《Few-Shot Question Answering by Pretraining Span Selection》中提出。Splinter 是一個僅編碼器的 Transformer 模型（類似於 BERT），它在一個包含維基百科和多倫多圖書語料庫的大型語料庫上使用重複片段選擇任務進行預訓練。
論文摘要如下：
在多個問答基準測試中，預訓練模型透過在大約 100,000 個帶標註的問題和答案上進行微調，達到了與人類相當的水平。我們探索了更現實的小樣本設定，其中只有幾百個訓練樣本可用，並觀察到標準模型表現不佳，這突顯了當前預訓練目標與問答任務之間的差異。我們提出了一種專為問答量身定製的新預訓練方案：重複片段選擇。給定一段包含多組重複片段的文字，我們在每組中掩蓋除一個之外的所有重複片段，並要求模型為每個被掩蓋的片段在段落中選擇正確的片段。被掩蓋的片段被一個特殊的標記替換，該標記被視為問題表示，隨後在微調期間用於選擇答案片段。由此產生的模型在多個基準測試中獲得了令人驚訝的好結果（例如，在 SQuAD 上僅用 128 個訓練樣本就達到了 72.7 的 F1 分數），同時在高資源設定下仍保持有競爭力的效能。
此模型由 yuvalkirstain 和 oriram 貢獻。原始程式碼可以在此處找到。
使用技巧
- Splinter 被訓練用於根據一個特殊的 [QUESTION] 標記來預測答案片段。這些標記會根據上下文生成問題表示，用於預測答案。這一層稱為 QASS，是 SplinterForQuestionAnswering 類中的預設行為。因此：
- 請使用 SplinterTokenizer（而不是 BertTokenizer），因為它已經包含了這個特殊的標記。此外，它的預設行為是在給定兩個序列時使用此標記（例如，在 run_qa.py 指令碼中）。
- 如果您計劃在 run_qa.py 之外使用 Splinter，請記住問題標記——它可能對模型的成功至關重要，尤其是在小樣本設定中。
- 請注意，每種大小的 Splinter 都有兩個不同的檢查點。兩者基本相同，只是其中一個還包含了 QASS 層的預訓練權重（tau/splinter-base-qass 和 tau/splinter-large-qass），而另一個沒有（tau/splinter-base 和 tau/splinter-large）。這樣做是為了支援在微調時隨機初始化該層，因為論文中表明，在某些情況下這樣做可以獲得更好的結果。
資源
SplinterConfig
class transformers.SplinterConfig
< 來源 >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 use_cache = True pad_token_id = 0 question_token_id = 104 **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — Splinter 模型的詞彙表大小。定義了在呼叫 SplinterModel 時傳入的inputs_ids可以表示的不同標記的數量。 - hidden_size (
int, 可選, 預設為 768) — 編碼器層和池化層的維度。 - num_hidden_layers (
int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int, 可選, 預設為 3072) — Transformer 編碼器中“中間”（即前饋）層的維度。 - hidden_act (
strorfunction, 可選, 預設為"gelu") — 編碼器和池化層中的非線性啟用函式（函式或字串）。如果為字串，支援"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可選, 預設為 0.1) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。 - attention_probs_dropout_prob (
float, 可選, 預設為 0.1) — 注意力機率的丟棄率。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常將其設定為一個較大的值以備不時之需（例如，512、1024 或 2048）。 - type_vocab_size (
int, 可選, 預設為 2) — 呼叫 SplinterModel 時傳入的token_type_ids的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - use_cache (
bool, 可選, 預設為True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅在config.is_decoder=True時相關。 - question_token_id (
int, 可選, 預設為 104) —[QUESTION]標記的 ID。
這是用於儲存 SplinterModel 配置的配置類。它用於根據指定的引數例項化 Splinter 模型，定義模型架構。使用預設值例項化配置將產生與 Splinter tau/splinter-base 架構類似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。更多資訊請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import SplinterModel, SplinterConfig
>>> # Initializing a Splinter tau/splinter-base style configuration
>>> configuration = SplinterConfig()
>>> # Initializing a model from the tau/splinter-base style configuration
>>> model = SplinterModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configSplinterTokenizer
class transformers.SplinterTokenizer
< 來源 >( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' question_token = '[QUESTION]' tokenize_chinese_chars = True strip_accents = None **kwargs )
引數
- vocab_file (
str) — 包含詞彙表的檔案。 - do_lower_case (
bool, 可選, 預設為True) — 是否在分詞時將輸入轉換為小寫。 - do_basic_tokenize (
bool, 可選, 預設為True) — 是否在 WordPiece 分詞前進行基本分詞。 - never_split (
Iterable, 可選) — 在分詞過程中永遠不會被分割的標記集合。僅在do_basic_tokenize=True時有效。 - unk_token (
str, 可選, 預設為"[UNK]") — 未知標記。不在詞彙表中的標記無法轉換為 ID，將被設定為此標記。 - sep_token (
str, 可選, 預設為"[SEP]") — 分隔符標記，用於從多個序列構建一個序列，例如用於序列分類的兩個序列，或用於問答任務的文字和問題。它也用作帶有特殊標記構建的序列的最後一個標記。 - pad_token (
str, optional, defaults to"[PAD]") — 用於填充的詞元，例如在批處理不同長度的序列時使用。 - cls_token (
str, optional, defaults to"[CLS]") — 分類器詞元，用於序列分類任務（對整個序列進行分類，而不是逐詞元分類）。在使用特殊詞元構建序列時，它是序列的第一個詞元。 - mask_token (
str, optional, defaults to"[MASK]") — 用於掩碼值的詞元。在使用掩碼語言建模訓練此模型時使用此詞元。模型將嘗試預測此詞元。 - question_token (
str, optional, defaults to"[QUESTION]") — 用於構建問題表示的詞元。 - tokenize_chinese_chars (
bool, optional, defaults toTrue) — 是否對中文字元進行分詞。對於日語，此選項可能需要停用（參見此 issue）。
- strip_accents (
bool, optional) — 是否移除所有重音符號。如果未指定此選項，則將由lowercase的值決定（與原始 BERT 一致）。
構建一個 Splinter 分詞器。基於 WordPiece。
該分詞器繼承自 PreTrainedTokenizer，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
引數
- token_ids_0 (
list[int]) — 如果 pad_on_right 為真，則為問題詞元 ID，否則為上下文詞元 ID。 - token_ids_1 (
list[int], optional) — 如果 pad_on_right 為真，則為上下文詞元 ID，否則為問題詞元 ID。
返回
list[int]
帶有適當特殊標記的輸入ID列表。
透過拼接和新增特殊詞元，為問答任務從一對序列構建模型輸入。一個 Splinter 序列具有以下格式
- 單個序列：
[CLS] X [SEP] - 用於問答的序列對：
[CLS] 問題詞元 [QUESTION] . [SEP] 上下文詞元 [SEP]
get_special_tokens_mask
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
create_token_type_ids_from_sequences
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？
如果模型有特殊的構建方式，應在子類中重寫此方法。
SplinterTokenizerFast
class transformers.SplinterTokenizerFast
< 來源 >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' question_token = '[QUESTION]' tokenize_chinese_chars = True strip_accents = None **kwargs )
引數
- vocab_file (
str) — 包含詞彙表的檔案。 - do_lower_case (
bool, optional, defaults toTrue) — 是否在分詞時將輸入轉換為小寫。 - unk_token (
str, optional, defaults to"[UNK]") — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，將被設定為此詞元。 - sep_token (
str, optional, defaults to"[SEP]") — 分隔符詞元，用於從多個序列構建一個序列，例如用於序列分類的兩個序列，或用於問答的文字和問題。它也用作使用特殊詞元構建的序列的最後一個詞元。 - pad_token (
str, optional, defaults to"[PAD]") — 用於填充的詞元，例如在批處理不同長度的序列時使用。 - cls_token (
str, optional, defaults to"[CLS]") — 分類器詞元，用於序列分類任務（對整個序列進行分類，而不是逐詞元分類）。在使用特殊詞元構建序列時，它是序列的第一個詞元。 - mask_token (
str, optional, defaults to"[MASK]") — 用於掩碼值的詞元。在使用掩碼語言建模訓練此模型時使用此詞元。模型將嘗試預測此詞元。 - question_token (
str, optional, defaults to"[QUESTION]") — 用於構建問題表示的詞元。 - clean_text (
bool, optional, defaults toTrue) — 是否在分詞前透過移除所有控制字元並將所有空白符替換為經典空格來清理文字。 - tokenize_chinese_chars (
bool, optional, defaults toTrue) — 是否對中文字元進行分詞。對於日語，此選項可能需要停用（參見此 issue）。 - strip_accents (
bool, optional) — 是否移除所有重音符號。如果未指定此選項，則將由lowercase的值決定（與原始 BERT 一致）。 - wordpieces_prefix (
str, optional, defaults to"##") — 子詞的字首。
構建一個“快速”的 Splinter 分詞器（由 HuggingFace 的 *tokenizers* 庫支援）。基於 WordPiece。
該分詞器繼承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< 來源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
引數
- token_ids_0 (
list[int]) — 如果 pad_on_right 為真，則為問題詞元 ID，否則為上下文詞元 ID。 - token_ids_1 (
list[int], optional) — 如果 pad_on_right 為真，則為上下文詞元 ID，否則為問題詞元 ID。
返回
list[int]
帶有適當特殊標記的輸入ID列表。
透過拼接和新增特殊詞元，為問答任務從一對序列構建模型輸入。一個 Splinter 序列具有以下格式
- 單個序列：
[CLS] X [SEP] - 用於問答的序列對：
[CLS] 問題詞元 [QUESTION] . [SEP] 上下文詞元 [SEP]
SplinterModel
class transformers.SplinterModel
< 來源 >( config )
引數
- config (SplinterModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請查閱 from_pretrained() 方法來載入模型權重。
基礎的 Splinter 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。
此模型繼承自 PreTrainedModel。請查閱超類的文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 來源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[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 ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor, 形狀為(batch_size, sequence_length), optional) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形狀為(batch_size, sequence_length), optional) — 用於避免對填充詞元索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
- token_type_ids (
torch.LongTensor, 形狀為batch_size, sequence_length, optional) — 分段詞元索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於*句子 A* 的詞元，
- 1 對應於*句子 B* 的詞元。
- position_ids (
torch.LongTensor, 形狀為batch_size, sequence_length, optional) — 每個輸入序列詞元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (
torch.Tensor, 形狀為(num_heads,)或(num_layers, num_heads), optional) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭部未被掩碼，
- 0 表示頭部被掩碼。
- inputs_embeds (
torch.Tensor, 形狀為(batch_size, sequence_length, hidden_size), optional) — 可選地，你可以不傳遞input_ids，而是直接傳遞嵌入表示。如果你想比模型的內部嵌入查詢矩陣有更多控制權來將input_ids索引轉換為相關向量，這將非常有用。 - encoder_hidden_states (
torch.Tensor, 形狀為(batch_size, sequence_length, hidden_size), optional) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則在交叉注意力中使用。 - encoder_attention_mask (
torch.Tensor, 形狀為(batch_size, sequence_length), optional) — 用於避免對編碼器輸入的填充詞元索引執行注意力的掩碼。如果模型被配置為解碼器，則在交叉注意力中使用此掩碼。掩碼值在[0, 1]中選擇：- 1 表示詞元未被掩碼，
- 0 表示詞元被掩碼。
- past_key_values (
list[torch.FloatTensor], optional) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括模型在解碼的前一個階段返回的 `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`（那些沒有為其提供過去鍵值狀態的詞元），形狀為 `(batch_size, 1)`，而不是所有形狀為 `(batch_size, sequence_length)` 的 `input_ids`。
- use_cache (
bool, optional) — 如果設定為True，則返回 `past_key_values` 鍵值狀態，可用於加速解碼（參見 `past_key_values`）。 - output_attentions (
bool, optional) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的 `attentions`。 - output_hidden_states (
bool, optional) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的 `hidden_states`。 - return_dict (
bool, optional) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（SplinterConfig）和輸入，包含不同的元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。如果使用了
past_key_values，則只輸出形狀為(batch_size, 1, hidden_size)的序列的最後一個隱藏狀態。 -
past_key_values (
Cache, optional, 在傳遞use_cache=True或config.use_cache=True時返回) — 這是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值，如果 `config.is_encoder_decoder=True`，則還包括交叉注意力塊中的鍵和值），可用於（參見 `past_key_values` 輸入）加速序列解碼。
-
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — `torch.FloatTensor` 的元組（一個用於嵌入層的輸出（如果模型有嵌入層），再加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True和config.add_cross_attention=True或config.output_attentions=True時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
SplinterModel 的 forward 方法，重寫了 `__call__` 特殊方法。
雖然前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。
SplinterForQuestionAnswering
class transformers.SplinterForQuestionAnswering
< 源 >( config )
引數
- config (SplinterForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Splinter 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 token_type_ids: 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 start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None question_positions: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - 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索引轉換為相關向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。 - start_positions (
torch.LongTensor，形狀為(batch_size,)，可選) — 標記片段開始位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。 - end_positions (
torch.LongTensor，形狀為(batch_size,)，可選) — 標記片段結束位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。 - question_positions (
torch.LongTensor，形狀為(batch_size, num_questions)，可選) — 所有問題標記的位置。如果給定，start_logits 和 end_logits 的形狀將為(batch_size, num_questions, sequence_length)。如果為 None，批次中每個序列的第一個問題標記將是唯一計算 start_logits 和 end_logits 的標記，它們的形狀將為(batch_size, sequence_length)。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（SplinterConfig）和輸入而異的各種元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 在傳遞output_hidden_states=True或config.output_hidden_states=True時返回) — `torch.FloatTensor` 的元組（一個用於嵌入層的輸出（如果模型有嵌入層），再加上每個層的輸出），形狀為 `(batch_size, sequence_length, hidden_size)`。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), optional, 在傳遞output_attentions=True或config.output_attentions=True時返回) — `torch.FloatTensor` 的元組（每層一個），形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
SplinterForQuestionAnswering 的 forward 方法會覆蓋 __call__ 特殊方法。
雖然前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, SplinterForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("tau/splinter-base")
>>> model = SplinterForQuestionAnswering.from_pretrained("tau/splinter-base")
>>> 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)
...SplinterForPreTraining
class transformers.SplinterForPreTraining
< 源 >( config )
引數
- config (SplinterForPreTraining) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Splinter 模型用於在預訓練期間執行的重複片段選擇任務。與 QA 任務不同的是，我們沒有一個問題，而是用多個問題標記替換重複片段的出現。
此模型繼承自 PreTrainedModel。請查閱超類的文件，瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規的 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None question_positions: typing.Optional[torch.LongTensor] = None ) → transformers.models.splinter.modeling_splinter.SplinterForPreTrainingOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_questions, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充標記索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被掩碼，
- 0 表示標記已被掩碼。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_questions, sequence_length)，可選) — 段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 *句子 A* 的標記，
- 1 對應於 *句子 B* 的標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, num_questions, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置零自注意力模組中選定頭的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭未被掩碼，
- 0 表示頭已被掩碼。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, num_questions, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果你想對如何將 *input_ids* 索引轉換為相關向量進行更多控制，而不是使用模型內部的嵌入查詢矩陣，這會很有用。 - start_positions (
torch.LongTensor，形狀為(batch_size, num_questions)，可選) — 標記片段開始位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。 - end_positions (
torch.LongTensor，形狀為(batch_size, num_questions)，可選) — 標記片段結束位置（索引）的標籤，用於計算標記分類損失。位置被限制在序列長度（sequence_length）範圍內。序列之外的位置不計入損失計算。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。 - question_positions (
torch.LongTensor，形狀為(batch_size, num_questions)，可選) — 所有問題標記的位置。如果給定，start_logits 和 end_logits 的形狀將為(batch_size, num_questions, sequence_length)。如果為 None，批次中每個序列的第一個問題標記將是唯一計算 start_logits 和 end_logits 的標記，它們的形狀將為(batch_size, sequence_length)。
返回
transformers.models.splinter.modeling_splinter.SplinterForPreTrainingOutput 或 tuple(torch.FloatTensor)
一個 transformers.models.splinter.modeling_splinter.SplinterForPreTrainingOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置（SplinterConfig）和輸入而異的各種元素。
-
loss (
torch.FloatTensor，形狀為(1,)，可選，在提供開始和結束位置時返回) — 總片段提取損失是開始和結束位置的交叉熵損失之和。 -
start_logits (
torch.FloatTensor，形狀為(batch_size, num_questions, sequence_length)) — 片段開始分數（在 SoftMax 之前）。 -
end_logits (
torch.FloatTensor，形狀為(batch_size, num_questions, sequence_length)) — 片段結束分數（在 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 後的注意力權重，用於計算自注意力頭中的加權平均值。
SplinterForPreTraining 的 forward 方法會覆蓋 __call__ 特殊方法。
雖然前向傳播的配方需要在此函式中定義，但之後應呼叫 Module 例項而不是此函式，因為前者會負責執行前處理和後處理步驟，而後者會靜默地忽略它們。