Transformers 文件
FNet
並獲得增強的文件體驗
開始使用
FNet
概述
FNet 模型由 James Lee-Thorp、Joshua Ainslie、Ilya Eckstein 和 Santiago Ontanon 在論文 FNet: Mixing Tokens with Fourier Transforms 中提出。該模型用傅立葉變換替換了 BERT 模型中的自注意力層，並且只返回變換的實部。由於引數更少且記憶體效率更高，該模型比 BERT 模型快得多。在 GLUE 基準測試中，該模型達到了 BERT 對應模型約 92-97% 的準確率，並且訓練速度遠快於 BERT 模型。論文摘要如下：
我們表明，透過用簡單的線性變換來“混合”輸入標記（token），可以在有限的準確率損失下加速 Transformer 編碼器架構。這些線性混合器，與前饋層中的標準非線性函式一起，證明了在多個文字分類任務中能夠有效地建模語義關係。最令人驚訝的是，我們發現用標準的、無引數的傅立葉變換替換 Transformer 編碼器中的自注意力子層，在 GLUE 基準測試中能達到 BERT 對應模型 92-97% 的準確率，但在標準 512 輸入長度下，其在 GPU 上的訓練速度快 80%，在 TPU 上的訓練速度快 70%。在更長的輸入長度下，我們的 FNet 模型速度明顯更快：與 Long Range Arena 基準測試中的“高效”Transformer 相比，FNet 的準確率與最準確的模型相當，同時在所有序列長度的 GPU 上（以及在 TPU 上的相對較短長度上）都超過了最快的模型。最後，FNet 的記憶體佔用小，在較小的模型尺寸下尤其高效；在固定的速度和準確率預算下，小型 FNet 模型優於其 Transformer 對應模型。
此模型由 gchhablani 貢獻。原始程式碼可以在這裡找到。
使用技巧
該模型是基於傅立葉變換的，因此在訓練時沒有使用注意力掩碼（attention mask）。模型訓練時使用的最大序列長度為 512，其中包括填充標記（pad tokens）。因此，強烈建議在微調和推理時使用相同的最大序列長度。
資源
FNetConfig
class transformers.FNetConfig
< 原始碼 >( vocab_size = 32000 hidden_size = 768 num_hidden_layers = 12 intermediate_size = 3072 hidden_act = 'gelu_new' hidden_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 4 initializer_range = 0.02 layer_norm_eps = 1e-12 use_tpu_fourier_optimizations = False tpu_short_seq_length = 512 pad_token_id = 3 bos_token_id = 1 eos_token_id = 2 **kwargs )
引數
- vocab_size (
int, 可選, 預設為 32000) — FNet 模型的詞彙表大小。定義了呼叫 FNetModel 或TFFNetModel時傳遞的 `inputs_ids` 可以表示的不同標記的數量。 - hidden_size (
int, 可選, 預設為 768) — 編碼器層和池化層的維度。 - num_hidden_layers (
int, 可選, 預設為 12) — Transformer 編碼器中隱藏層的數量。 - intermediate_size (
int, 可選, 預設為 3072) — Transformer 編碼器中“中間”層（即前饋層）的維度。 - hidden_act (
str或function, 可選, 預設為"gelu_new") — 編碼器和池化層中的非線性啟用函式（函式或字串）。如果為字串，支援"gelu","relu","selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可選, 預設為 0.1) — 嵌入層、編碼器和池化層中所有全連線層的丟棄機率。 - max_position_embeddings (
int, 可選, 預設為 512) — 該模型可能使用的最大序列長度。通常將其設定為一個較大的值以備不時之需（例如 512、1024 或 2048）。 - type_vocab_size (
int, 可選, 預設為 4) — 呼叫 FNetModel 或TFFNetModel時傳遞的 `token_type_ids` 的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - use_tpu_fourier_optimizations (
bool, 可選, 預設為 `False`) — 決定是否使用 TPU 最佳化的 FFT。如果為 `True`，模型將傾向於使用軸向 FFT 變換。對於 GPU/CPU 硬體，請設定為 `False`，此時將使用 n 維 FFT。 - tpu_short_seq_length (
int, 可選, 預設為 512) — 使用 TPU 時模型期望的序列長度。僅當 *use_tpu_fourier_optimizations* 設定為 `True` 且輸入序列短於或等於 4096 個標記時，此引數才會用於初始化 DFT 矩陣。
這是用於儲存 FNetModel 配置的配置類。它用於根據指定的引數例項化一個 FNet 模型，定義模型架構。使用預設值例項化配置將產生與 FNet google/fnet-base 架構類似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。
示例
>>> from transformers import FNetConfig, FNetModel
>>> # Initializing a FNet fnet-base style configuration
>>> configuration = FNetConfig()
>>> # Initializing a model (with random weights) from the fnet-base style configuration
>>> model = FNetModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configFNetTokenizer
class transformers.FNetTokenizer
< 原始碼 >( vocab_file do_lower_case = False remove_space = True keep_accents = True unk_token = '<unk>' sep_token = '[SEP]' pad_token = '<pad>' cls_token = '[CLS]' mask_token = '[MASK]' sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None **kwargs )
引數
- vocab_file (
str) — SentencePiece 檔案（通常副檔名為 *.spm*），其中包含例項化分詞器所需的詞彙表。 - do_lower_case (
bool, 可選, 預設為 `False`) — 是否在分詞時將輸入轉換為小寫。 - remove_space (
bool, 可選, 預設為 `True`) — 是否在分詞時去除文字前後多餘的空格。 - keep_accents (
bool, 可選, 預設為True) — 在分詞時是否保留重音符號。 - unk_token (
str, 可選, 預設為"<unk>") — 未知詞元（unknown token）。詞彙表中不存在的詞元無法轉換為 ID，將被設定為此詞元。 - sep_token (
str, 可選, 預設為"[SEP]") — 分隔符詞元（separator token），用於從多個序列構建一個序列時，例如，用於序列分類的兩個序列，或用於問答任務的文字和問題。它也用作帶有特殊詞元的序列的最後一個詞元。 - pad_token (
str, 可選, 預設為"<pad>") — 用於填充的詞元，例如在批處理不同長度的序列時使用。 - cls_token (
str, 可選, 預設為"[CLS]") — 分類符詞元（classifier token），在進行序列分類（對整個序列進行分類而非逐詞元分類）時使用。當使用特殊詞元構建序列時，它是序列的第一個詞元。 - mask_token (
str, 可選, 預設為"[MASK]") — 用於掩蓋值的詞元。在使用掩碼語言模型（masked language modeling）訓練此模型時使用此詞元。模型將嘗試預測此詞元。 - 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 是無限的，並使用前向過濾-後向取樣演算法從所有假設（lattice）中取樣。
-
alpha: Unigram 取樣的平滑引數，以及 BPE-dropout 的合併操作的丟棄機率。
-
- sp_model (
SentencePieceProcessor) — 用於每次轉換（字串、詞元和 ID）的 SentencePiece 處理器。
構建一個 FNet 分詞器。改編自 AlbertTokenizer。基於 SentencePiece。此分詞器繼承自 PreTrainedTokenizer，其中包含大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
build_inputs_with_special_tokens
< 原始碼 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
透過連線和新增特殊詞元，從單個序列或序列對為序列分類任務構建模型輸入。FNet 序列具有以下格式：
- 單個序列：
[CLS] X [SEP] - 序列對：
[CLS] A [SEP] B [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？
如果模型有特殊的構建方式，應在子類中重寫此方法。
FNetTokenizerFast
class transformers.FNetTokenizerFast
< 原始碼 >( vocab_file = None tokenizer_file = None do_lower_case = False remove_space = True keep_accents = True unk_token = '<unk>' sep_token = '[SEP]' pad_token = '<pad>' cls_token = '[CLS]' mask_token = '[MASK]' **kwargs )
引數
- vocab_file (
str) — SentencePiece 檔案（通常副檔名為 .spm），其中包含例項化分詞器所需的詞彙表。 - do_lower_case (
bool, 可選, 預設為False) — 在分詞時是否將輸入轉換為小寫。 - remove_space (
bool, 可選, 預設為True) — 在分詞時是否去除文字中的多餘空格（刪除字串前後多餘的空格）。 - keep_accents (
bool, 可選, 預設為True) — 在分詞時是否保留重音符號。 - unk_token (
str, 可選, 預設為"<unk>") — 未知詞元（unknown token）。詞彙表中不存在的詞元無法轉換為 ID，將被設定為此詞元。 - sep_token (
str, 可選, 預設為"[SEP]") — 分隔符詞元（separator token），用於從多個序列構建一個序列時，例如，用於序列分類的兩個序列，或用於問答任務的文字和問題。它也用作帶有特殊詞元的序列的最後一個詞元。 - pad_token (
str, 可選, 預設為"<pad>") — 用於填充的詞元，例如在批處理不同長度的序列時使用。 - cls_token (
str, 可選, 預設為"[CLS]") — 分類符詞元（classifier token），在進行序列分類（對整個序列進行分類而非逐詞元分類）時使用。當使用特殊詞元構建序列時，它是序列的第一個詞元。 - mask_token (
str, 可選, 預設為"[MASK]") — 用於掩蓋值的詞元。在使用掩碼語言模型（masked language modeling）訓練此模型時使用此詞元。模型將嘗試預測此詞元。
構建一個“快速”的 FNetTokenizer（由 HuggingFace 的 tokenizers 庫支援）。改編自 AlbertTokenizerFast。基於 Unigram。此分詞器繼承自 PreTrainedTokenizerFast，其中包含大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
FNetModel
class transformers.FNetModel
< 原始碼 >( config add_pooling_layer = True )
引數
- config (FNetModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool, 可選, 預設為True) — 是否新增池化層
裸 FNet 模型，輸出原始的隱藏狀態，頂部沒有任何特定的頭。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput or tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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.n_positions - 1]範圍內選擇。 - inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想比模型的內部嵌入查詢矩陣有更多控制權來將 `input_ids` 索引轉換為相關向量，這將非常有用。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的 `hidden_states`。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），包含各種元素，具體取決於配置 (FNetConfig) 和輸入。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetModel 的前向方法，重寫了 `__call__` 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
FNetForPreTraining
class transformers.FNetForPreTraining
< 原始碼 >( config )
引數
- config (FNetForPreTraining) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
FNet 模型頂部帶有兩個頭，用於預訓練：一個 `掩碼語言建模` 頭和一個 `下一句預測 (分類)` 頭。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None next_sentence_label: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.fnet.modeling_fnet.FNetForPreTrainingOutput or tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length), 可選) — 詞彙表中輸入序列詞元的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 A 句子 標記，
- 1 對應於 B 句子 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）你可以選擇直接傳遞嵌入式表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記進行計算。 - next_sentence_label (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算下一序列預測（分類）損失的標籤。輸入應為序列對（參見input_ids文件字串）。索引應在[0, 1]範圍內：- 0 表示序列 B 是序列 A 的延續，
- 1 表示序列 B 是一個隨機序列。
- output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.models.fnet.modeling_fnet.FNetForPreTrainingOutput 或 tuple(torch.FloatTensor)
一個 transformers.models.fnet.modeling_fnet.FNetForPreTrainingOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (FNetConfig) 和輸入包含不同的元素。
-
loss (
*可選*，當提供了labels時返回，torch.FloatTensor，形狀為(1,)) — 總損失，為掩碼語言建模損失和下一序列預測（分類）損失之和。 -
prediction_logits (
torch.FloatTensor形狀為(batch_size, sequence_length, config.vocab_size)) — 語言建模頭的預測分數（SoftMax 之前的每個詞彙 token 的分數）。 -
seq_relationship_logits (
torch.FloatTensor形狀為(batch_size, 2)) — 下一序列預測（分類）頭的預測分數（SoftMax 之前的 True/False 延續分數）。 -
hidden_states (
tuple[torch.FloatTensor]，可選，當傳遞output_hidden_states=True或當config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出，如果模型有嵌入層，+ 每個層的輸出一個），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
FNetForPreTraining 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FNetForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForPreTraining.from_pretrained("google/fnet-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsFNetForMaskedLM
class transformers.FNetForMaskedLM
< 原始碼 >( config )
引數
- config (FNetForMaskedLM) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有 `語言建模` 頭的 Fnet 模型。”
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 A 句子 標記，
- 1 對應於 B 句子 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）你可以選擇直接傳遞嵌入式表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的標記將被忽略（掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記進行計算。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (FNetConfig) 和輸入包含不同的元素。
-
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=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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetForMaskedLM 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FNetForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForMaskedLM.from_pretrained("google/fnet-base")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> 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)
>>> 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, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...FNetForNextSentencePrediction
class transformers.FNetForNextSentencePrediction
< 原始碼 >( config )
引數
- config (FNetForNextSentencePrediction) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有 `下一句預測（分類）` 頭的 FNet 模型。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 A 句子 標記，
- 1 對應於 B 句子 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）你可以選擇直接傳遞嵌入式表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算下一序列預測（分類）損失的標籤。輸入應為序列對（參見input_ids文件字串）。索引應在[0, 1]範圍內：- 0 表示序列 B 是序列 A 的延續，
- 1 表示序列 B 是一個隨機序列。
- output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.NextSentencePredictorOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (FNetConfig) 和輸入包含不同的元素。
-
loss (
torch.FloatTensor，形狀為(1,)，可選，當提供next_sentence_label時返回) — 下一個序列預測（分類）損失。 -
logits (
torch.FloatTensor，形狀為(batch_size, 2)) — 下一個序列預測（分類）頭的預測分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetForNextSentencePrediction 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FNetForNextSentencePrediction
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForNextSentencePrediction.from_pretrained("google/fnet-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")
>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1] # next sentence was randomFNetForSequenceClassification
class transformers.FNetForSequenceClassification
< 原始碼 >( config )
引數
- config (FNetForSequenceClassification) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有序列分類/迴歸頭的 FNet 模型轉換器（池化輸出之上有一個線性層），例如用於 GLUE 任務。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 A 句子 標記，
- 1 對應於 B 句子 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）你可以選擇直接傳遞嵌入式表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為相關向量，這會非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回的張量下的hidden_states。 - return_dict (
bool，可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (FNetConfig) 和輸入包含不同的元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetForSequenceClassification 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, FNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForSequenceClassification.from_pretrained("google/fnet-base")
>>> 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 = FNetForSequenceClassification.from_pretrained("google/fnet-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, FNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForSequenceClassification.from_pretrained("google/fnet-base", 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 = FNetForSequenceClassification.from_pretrained(
... "google/fnet-base", 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).lossFNetForMultipleChoice
class transformers.FNetForMultipleChoice
< 原始碼 >( config )
引數
- config (FNetForMultipleChoice) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有選擇題分類頭的 Fnet 模型（池化輸出之上有一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 片段標記索引，用於指示輸入的第一部分和第二部分。索引在[0, 1]中選擇：- 0 對應於 A 句子 標記，
- 1 對應於 B 句子 標記。
- position_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - inputs_embeds (
torch.FloatTensor，形狀為(batch_size, num_choices, sequence_length, hidden_size)，可選) — （可選）你可以選擇直接傳遞嵌入式表示，而不是傳遞input_ids。如果你想比模型內部的嵌入查詢矩陣更好地控制如何將 input_ids 索引轉換為相關向量，這會非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算多項選擇分類損失的標籤。索引應在 `[0, ..., num_choices-1]` 範圍內，其中 `num_choices` 是輸入張量第二個維度的大小。（參見上面的 `input_ids`） - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的 `hidden_states`。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MultipleChoiceModelOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），包含根據配置（FNetConfig）和輸入而變化的不同元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetForMultipleChoice 的 forward 方法會覆蓋 `__call__` 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FNetForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForMultipleChoice.from_pretrained("google/fnet-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsFNetForTokenClassification
class transformers.FNetForTokenClassification
< 原始碼 >( config )
引數
- config (FNetForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有詞元分類頭的 Fnet transformer（在隱藏狀態輸出之上加一個線性層），例如用於命名實體識別（NER）任務。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在 `[0, 1]` 中選擇：- 0 對應於 *A 句* 標記，
- 1 對應於 *B 句* 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在 `[0, config.n_positions - 1]` 範圍內選擇。 - inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想更多地控制如何將 `input_ids` 索引轉換為相關向量，而不是使用模型的內部嵌入查詢矩陣，這會很有用。 - labels (
torch.LongTensor，形狀為 `(batch_size, sequence_length)`，可選) — 用於計算詞元分類損失的標籤。索引應在 `[0, ..., config.num_labels - 1]` 範圍內。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的 `hidden_states`。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），包含根據配置（FNetConfig）和輸入而變化的不同元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetForTokenClassification 的 forward 方法會覆蓋 `__call__` 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FNetForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForTokenClassification.from_pretrained("google/fnet-base")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...FNetForQuestionAnswering
class transformers.FNetForQuestionAnswering
< 原始碼 >( config )
引數
- config (FNetForQuestionAnswering) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有片段分類頭的 Fnet transformer，用於像 SQuAD 這樣的抽取式問答任務（在隱藏狀態輸出之上加一個線性層來計算 `span start logits` 和 `span end logits`）。
此模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪注意力頭等）。
該模型也是 PyTorch 的 torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下將忽略填充。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入的第一部分和第二部分的段標記索引。索引在 `[0, 1]` 中選擇：- 0 對應於 *A 句* 標記，
- 1 對應於 *B 句* 標記。
- position_ids (
torch.Tensor，形狀為 `(batch_size, sequence_length)`，可選) — 位置嵌入中每個輸入序列標記的位置索引。在 `[0, config.n_positions - 1]` 範圍內選擇。 - inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 `input_ids`。如果你想更多地控制如何將 `input_ids` 索引轉換為相關向量，而不是使用模型的內部嵌入查詢矩陣，這會很有用。 - start_positions (
torch.Tensor，形狀為(batch_size,)，可選) — 用於計算詞元分類損失的標記片段開始位置（索引）的標籤。位置被限制在序列長度（`sequence_length`）內。超出序列的位置不計入損失計算。 - end_positions (
torch.Tensor，形狀為 `(batch_size,)`，可選) — 用於計算詞元分類損失的標記片段結束位置（索引）的標籤。位置被限制在序列長度（`sequence_length`）內。超出序列的位置不計入損失計算。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳情請參閱返回張量下的 `hidden_states`。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通的元組。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 `torch.FloatTensor` 的元組（如果傳遞了 `return_dict=False` 或 `config.return_dict=False`），包含根據配置（FNetConfig）和輸入而變化的不同元素。
-
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), 可選, 在傳遞 `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 後的注意力權重，用於計算自注意力頭中的加權平均值。
FNetForQuestionAnswering 的 forward 方法會覆蓋 `__call__` 特殊方法。
雖然前向傳播的流程需要在此函式中定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理前後處理步驟，而後者會默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, FNetForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/fnet-base")
>>> model = FNetForQuestionAnswering.from_pretrained("google/fnet-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)
...