Transformers 文件
MEGA
並獲得增強的文件體驗
開始使用
MEGA
該模型僅處於維護模式，我們不接受任何更改其程式碼的新 PR。如果您在執行此模型時遇到任何問題，請重新安裝支援此模型的最後一個版本：v4.40.2。您可以透過執行以下命令進行操作：pip install -U transformers==4.40.2。
概述
MEGA 模型由 Xuezhe Ma、Chunting Zhou、Xiang Kong、Junxian He、Liangke Gui、Graham Neubig、Jonathan May 和 Luke Zettlemoyer 在 Mega: Moving Average Equipped Gated Attention 中提出。MEGA 提出了一種新的自注意力方法，每個編碼器層除了一個標準點積注意力頭之外，還帶有一個多頭指數移動平均。這使得 MEGA 在包括 LRA 在內的標準基準測試中能夠與 Transformer 競爭，同時引數也顯著減少。MEGA 的計算效率使其能夠擴充套件到非常長的序列，使其成為長文件 NLP 任務的一個有吸引力的選擇。
論文摘要如下：
Transformer 注意力機制中的設計選擇，包括弱歸納偏差和二次計算複雜度，限制了其在建模長序列方面的應用。在本文中，我們引入了 Mega，這是一種簡單、有理論依據的單頭門控注意力機制，配備（指數）移動平均，以將位置感知區域性依賴的歸納偏差納入位置無關的注意力機制。我們進一步提出了一種 Mega 變體，透過將整個序列高效地分割成多個固定長度的塊，從而實現了線性的時間和空間複雜度，同時只產生最小的質量損失。在廣泛的序列建模基準測試中進行的廣泛實驗，包括長程競技場、神經機器翻譯、自迴歸語言建模以及影像和語音分類，表明 Mega 比其他序列模型（包括 Transformer 變體和最近的狀態空間模型）取得了顯著的改進。
使用技巧
- MEGA 可以用相對較少的引數表現得很好。有關在各種設定中表現良好的架構規範示例，請參閱 MEGA 論文的附錄 D。如果將 MEGA 用作解碼器，請務必設定
bidirectional=False以避免預設雙向的錯誤。 - Mega-chunk 是 mega 的一種變體，它將時間和空間複雜度從二次降低到線性。使用 MegaConfig.use_chunking 進行分塊，並使用 MegaConfig.chunk_size 控制分塊大小
實現注意事項
- MEGA 的原始實現對於填充和因果自注意力在 softmax 注意力與 Laplace/平方 ReLU 方法之間存在注意力掩碼的不一致期望。此實現解決了這種不一致性。
- 原始實現不包括令牌型別嵌入；此實現增加了對這些嵌入的支援，選項由 MegaConfig.add_token_type_embeddings 控制
MegaConfig
class transformers.MegaConfig
< source >( vocab_size = 30522 hidden_size = 128 num_hidden_layers = 4 intermediate_size = 256 ema_projection_size = 16 bidirectional = True shared_representation_size = 64 use_chunking = False chunk_size = -1 truncation = None normalize_before_mega = True normalization_type = 'scalenorm' norm_affine = True activation = 'silu' attention_activation = 'softmax' dropout_prob = 0.1 hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 use_feature_dropout = False use_normalized_ffn = True nffn_hidden_size = 256 normalize_before_ffn = True nffn_activation_dropout_prob = 0.1 max_positions = 2048 add_token_type_embeddings = False type_vocab_size = 2 initializer_range = 0.02 ema_delta_alpha_range = 0.2 ema_beta_range = 0.02 ema_gamma_omega_range = 1.0 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 relative_positional_bias = 'rotary' classifier_dropout = None use_cache = True add_lm_hidden_dense_layer = True **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — Mega 模型的詞彙量。定義了呼叫 MegaModel 時傳入的inputs_ids可以表示的不同標記的數量。 - hidden_size (
int, 可選, 預設為 128) — 編碼器層和池化器層的維度。 - num_hidden_layers (
int, 可選, 預設為 4) — Mega 編碼器中的隱藏層數量。 - intermediate_size (
int, 可選, 預設為 256) — Mega 編碼器中隱藏維度（自注意力值投影）的維度 - ema_projection_size (
int, 可選, 預設為 16) — MegaMultiDimensionDampedEma 的維度 - bidirectional (
bool, 可選, 預設為True) — Mega 的自注意力中使用的 MegaMultiDimensionDampedEma 是否應雙向 (True) 或單向 (False) 工作。雙向 EMA 與因果解碼不相容，因此如果您打算將模型用作解碼器，則應將其設定為 False。 - shared_representation_size (
int, 可選, 預設為 64) — 自注意力查詢和鍵的共享表示的線性投影維度 - use_chunking (
bool, 可選, 預設為False) — 是否對輸入進行分塊以實現線性自注意力複雜度（在論文中描述為 Mega-chunk） - chunk_size (
int, 可選, 預設為 -1) — 如果use_chunking設定為True，則確定應用於輸入序列的塊大小。如果使用分塊，輸入序列必須填充為chunk_size的倍數 - truncation (
int, 可選) — 如果指定，則為截斷 MegaMultiDimensionDampedEma 的序列長度 - normalize_before_mega (
bool, 可選, 預設為True) — 在透過 Mega 編碼器塊之前 (True) 還是之後 (False) 進行歸一化。 - normalization_type (
str, 可選, 預設為"scalenorm") — Mega 編碼器塊中使用的歸一化型別。選擇"scalenorm"、"layernorm"、"rmsnorm"、"batchnorm"或"syncbatchnorm"之一（syncbatchnorm 需要 GPU）。 - norm_affine (
bool, 可選, 預設為True) — 如果為True，則在歸一化期間對輸入應用引數化仿射變換 - activation (
str, 可選, 預設為"silu") — 在 Mega 編碼器塊中應用的啟用函式。選擇"silu"、"relu"、"linear"、"gelu"或"gelu_accurate"之一 - attention_activation (
str, 可選, 預設為"softmax") — 用於單頭自注意力（如 Transformer）的啟用函式。選擇"softmax"、"laplace"或"relu2"之一 - dropout_prob (
float, 可選, 預設為 0.1) — EMA 自注意力的 dropout 機率 - hidden_dropout_prob (
float, 可選, 預設為 0.1) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。 - attention_probs_dropout_prob (
float, 可選, 預設為 0.1) — 注意力機率的 dropout 比率。 - use_feature_dropout (
bool, 可選, 預設為False) — 是否使用基於特徵的 (True) 或標準 dropout (False) - use_normalized_ffn (
bool, 可選, 預設為True) — 是否在 Mega 塊中使用歸一化前饋子層 (True)，或按原樣傳遞 Mega 編碼器輸出 (False) - nffn_hidden_size (
int, 可選, 預設為 256) — 如果在 Mega 中使用歸一化前饋網路 (NFFN) 層 (use_normalized_ffn = True)，這是 NFFN 的隱藏大小 - normalize_before_ffn (
bool, optional, defaults toTrue) — 是否在 NFFN 的前饋部分之前 (True) 或之後 (False) 進行歸一化。 - nffn_activation_dropout_prob (
float, optional, defaults to 0.1) — NFFN 元件的 dropout 比率。 - max_positions (
int, optional, defaults to 2048) — 用於位置表示的最大序列長度。對於"simple"相對位置偏置，這是輸入長度的硬限制；"rotary"相對位置偏置將外推到更長的序列。 - add_token_type_embeddings (
bool, optional, defaults toTrue) — 是否在嵌入中考慮 token 型別。為了保持與原始實現的相容性，同時增加對 token 型別的支援，將其保留為可選。 - type_vocab_size (
int, optional, defaults to 2) — 呼叫 MegaModel 時傳遞的token_type_ids的詞彙表大小。僅當add_token_type_embeddings = True時使用。 - initializer_range (
float, optional, defaults to 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - ema_delta_alpha_range (
float, optional, defaults to 0.2) — 在 MegaMultiDimensionDampedEma 中初始化 delta（阻尼因子）和 alpha（衰減因子）引數的標準差。 - ema_beta_range (
float, optional, defaults to 0.02) — 在 MegaMultiDimensionDampedEma 中初始化 beta 引數（擴充套件矩陣）的標準差。 - ema_gamma_omega_range (
float, optional, defaults to 1.0) — 在 MultiDimensionEMA 中初始化 gamma（投影矩陣）和 omega（殘差權重）引數的標準差。 - relative_positional_bias (
str, optional, defaults to"rotary") — 相對位置編碼的型別。選擇"rotary"或"simple"。如果選擇"simple"，max_positions將用作輸入大小的限制，而"rotary"將外推超過max_positions。 - is_decoder (
bool, optional, defaults toFalse) — 模型是否用作解碼器。如果為False，則模型用作編碼器。 - use_cache (
bool, optional, defaults toTrue) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當config.is_decoder=True時相關。 - classifier_dropout (
float, optional) — 分類頭的 dropout 比率。 - add_lm_hidden_dense_layer (
bool, optional, defaults toTrue) — 是否包含一個隱藏層用於編碼器輸出和 LM 頭之間的投影 (True) 或直接將隱藏狀態傳遞給 LM 頭 (False)。為了與原始實現相容，它仍然是可選的。
這是用於儲存 MegaModel 配置的配置類。它用於根據指定的引數例項化 Mega 模型，定義模型架構。使用預設值例項化配置將生成類似於 Mega mnaylor/mega-base-wikitext 架構的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請參閱 PretrainedConfig 的文件。
示例
>>> from transformers import MegaConfig, MegaModel
>>> # Initializing a Mega configuration
>>> configuration = MegaConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = MegaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMegaModel
class transformers.MegaModel
< source >( config: MegaConfig add_pooling_layer = True )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，僅載入配置。請查閱 from_pretrained() 方法以載入模型權重。
裸露的 MEGA 模型轉換器，輸出原始隱藏狀態，頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
該模型既可以作為編碼器（僅有自注意力），也可以作為解碼器，在這種情況下，在自注意力之後新增一層交叉注意力，遵循 Xuezhe Ma、Chunting Zhou、Xiang Kong、Junxian He、Liangke Gui、Graham Neubig、Jonathan May 和 Luke Zettlemoyer 在《Mega: Moving Average Equipped Gated Attention》中描述的架構。
要作為解碼器使用，模型需要使用配置中 is_decoder 引數設定為 True 且 bidirectional 設定為 False 進行初始化。要在 Seq2Seq 模型中使用，模型需要使用 is_decoder=True 和 bidirectional=False 引數以及 add_cross_attention 設定為 True 進行初始化；此時期望 encoder_hidden_states 作為前向傳遞的輸入。
.. _Mega: Moving Average Equipped Gated Attention: https://huggingface.co/papers/2209.10655
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor, 形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor, 形狀為(batch_size, sequence_length), 可選) — 掩碼，用於避免在填充 token 索引上執行注意力。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的 token，
- 0 表示**被掩碼**的 token。
- token_type_ids (
torch.LongTensor, 形狀為(batch_size, sequence_length), 可選) — 分段 token 索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於 *句子 A* token，
- 1 對應於 *句子 B* token。此引數僅在模型使用
add_token_type_embeddings引數設定為True初始化時才能使用。此張量中的所有值應始終小於 config.type_vocab_size。
- inputs_embeds (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，除了傳遞input_ids，你也可以直接傳遞嵌入表示。如果你想對如何將input_ids索引轉換為相關向量有更多控制，而不是模型的內部嵌入查詢矩陣，這將很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。 - encoder_hidden_states (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size), 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
torch.FloatTensor, 形狀為(batch_size, sequence_length), 可選) — 掩碼，用於避免在編碼器輸入的填充 token 索引上執行注意力。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的 token，
- 0 表示**被掩碼**的 token。
- past_key_values (
tuple(tuple(torch.FloatTensor))，長度為config.n_layers，每個元組有 4 個張量，形狀為(batch_size, num_heads, sequence_length - 1, embed_size_per_head)) — 包含注意力塊的預計算鍵和值隱藏狀態。可用於加速解碼。如果使用
past_key_values，使用者可以選擇只輸入最後一個decoder_input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）形狀為(batch_size, 1)，而不是所有decoder_input_ids形狀為(batch_size, sequence_length)。 - use_cache (
bool, 可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置 (MegaConfig) 和輸入而變化的各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (
torch.FloatTensor，形狀為(batch_size, hidden_size)) — 序列第一個 token（分類 token）經過用於輔助預訓練任務的層進一步處理後的最後一層隱藏狀態。例如，對於 BERT 家族模型，這會返回分類 token 經過線性層和 tanh 啟用函式處理後的結果。線性層權重在預訓練期間根據下一個句子預測（分類）目標進行訓練。 -
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.add_cross_attention=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 cache 指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值，如果
config.is_encoder_decoder=True，則可選地在交叉注意力塊中），可用於（參見past_key_values輸入）加速序列解碼。
MegaModel 的前向方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MegaModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaModel.from_pretrained("mnaylor/mega-base-wikitext")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateMegaForCausalLM
class transformers.MegaForCausalLM
< source >( config: MegaConfig )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，僅載入配置。請查閱 from_pretrained() 方法以載入模型權重。
帶有 language modeling 頭的 MEGA 模型，用於因果語言模型 (CLM) 微調。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[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.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor, 形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列 token 的索引。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor, 形狀為(batch_size, sequence_length), 可選) — 掩碼，用於避免在填充 token 索引上執行注意力。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的 token，
- 0 表示**被掩碼**的 token。
- token_type_ids (
torch.LongTensor, 形狀為(batch_size, sequence_length), 可選) — 分段 token 索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於 *句子 A* token，
- 1 對應於 *句子 B* token。此引數僅在模型使用
add_token_type_embeddings引數設定為True初始化時才能使用。此張量中的所有值應始終小於 config.type_vocab_size。
- inputs_embeds (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，除了傳遞input_ids，你也可以直接傳遞嵌入表示。如果你想對如何將input_ids索引轉換為相關向量有更多控制，而不是模型的內部嵌入查詢矩陣，這將很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關詳細資訊，請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關詳細資訊，請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。 - encoder_hidden_states (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size), 可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
torch.FloatTensor, 形狀為(batch_size, sequence_length), 可選) — 掩碼，用於避免在編碼器輸入的填充 token 索引上執行注意力。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的 token，
- 0 表示**被掩碼**的 token。
- labels (
torch.LongTensor, 形狀為(batch_size, sequence_length), 可選) — 用於計算從左到右語言模型損失（下一個詞預測）的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）。索引設定為-100的 token 將被忽略（掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的 token 計算。 - past_key_values (
tuple(tuple(torch.FloatTensor))，長度為config.n_layers，每個元組有 4 個張量，形狀為(batch_size, num_heads, sequence_length - 1, embed_size_per_head)) — 包含注意力塊的預計算鍵和值隱藏狀態。可用於加速解碼。如果使用
past_key_values，使用者可以選擇只輸入最後一個decoder_input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）形狀為(batch_size, 1)，而不是所有decoder_input_ids形狀為(batch_size, sequence_length)。 - use_cache (
bool, 可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞了 return_dict=False 或 config.return_dict=False），包含根據配置 (MegaConfig) 和輸入而變化的各種元素。
-
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 cache 指南。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
MegaForCausalLM 的前向方法，覆蓋了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MegaForCausalLM, AutoConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> config = AutoConfig.from_pretrained("mnaylor/mega-base-wikitext")
>>> config.is_decoder = True
>>> config.bidirectional = False
>>> model = MegaForCausalLM.from_pretrained(
... "mnaylor/mega-base-wikitext", config=config, ignore_mismatched_sizes=True
... )
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsMegaForMaskedLM
class transformers.MegaForMaskedLM
< source >( config: MegaConfig )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
帶有 語言建模 頭部的 MEGA 模型。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。此引數僅在模型用
add_token_type_embeddings引數設定為True初始化時才能使用。此張量中的所有值應始終 < config.type_vocab_size。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 用於計算掩碼語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（請參閱input_ids文件字串）。索引設定為-100的標記將被忽略（掩碼），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - kwargs (
dict[str, any], 可選，預設為 {}) — 用於隱藏已棄用的舊引數。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置（MegaConfig）和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MegaForMaskedLM 的 forward 方法，重寫了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MegaForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaForMaskedLM.from_pretrained("mnaylor/mega-base-wikitext")
>>> 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)
' Paris'
>>> 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)
0.1MegaForSequenceClassification
class transformers.MegaForSequenceClassification
< source >( config )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
MEGA 模型轉換器，頂部帶有一個序列分類/迴歸頭部（池化輸出頂部的一個線性層），例如用於 GLUE 任務。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。此引數僅在模型用
add_token_type_embeddings引數設定為True初始化時才能使用。此張量中的所有值應始終 < config.type_vocab_size。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。 - labels (
torch.LongTensor，形狀為(batch_size,), 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置（MegaConfig）和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MegaForSequenceClassification 的 forward 方法，重寫了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, MegaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaForSequenceClassification.from_pretrained("mnaylor/mega-base-wikitext")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # 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 = MegaForSequenceClassification.from_pretrained("mnaylor/mega-base-wikitext", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, MegaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaForSequenceClassification.from_pretrained("mnaylor/mega-base-wikitext", 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 = MegaForSequenceClassification.from_pretrained(
... "mnaylor/mega-base-wikitext", 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).lossMegaForMultipleChoice
class transformers.MegaForMultipleChoice
< source >( config )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
MEGA 模型，頂部帶有多項選擇分類頭部（池化輸出頂部的一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, num_choices, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, num_choices, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。此引數僅在模型用
add_token_type_embeddings引數設定為True初始化時才能使用。此張量中的所有值應始終 < config.type_vocab_size。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, num_choices, sequence_length, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。 - labels (
torch.LongTensor，形狀為(batch_size,), 可選) — 用於計算多項選擇分類損失的標籤。索引應在[0, ..., num_choices-1]範圍內，其中num_choices是輸入張量第二個維度的大小。（請參閱上面的input_ids）
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MultipleChoiceModelOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置（MegaConfig）和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MegaForMultipleChoice 的 forward 方法，重寫了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MegaForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaForMultipleChoice.from_pretrained("mnaylor/mega-base-wikitext")
>>> 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.logitsMegaForTokenClassification
class transformers.MegaForTokenClassification
< source >( config )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
MEGA 模型，頂部帶有一個標記分類頭部（隱藏狀態輸出頂部的一個線性層），例如用於命名實體識別（NER）任務。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)) — 詞彙表中輸入序列標記的索引。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length), 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示**未被掩碼**的標記，
- 0 表示**被掩碼**的標記。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於 句子 A 標記，
- 1 對應於 句子 B 標記。此引數僅在模型用
add_token_type_embeddings引數設定為True初始化時才能使用。此張量中的所有值應始終 < config.type_vocab_size。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size), 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length), 可選) — 用於計算標記分類損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置（MegaConfig）和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MegaForTokenClassification 的 forward 方法，重寫了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MegaForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaForTokenClassification.from_pretrained("mnaylor/mega-base-wikitext")
>>> 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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossMegaForQuestionAnswering
class transformers.MegaForQuestionAnswering
< 源 >( config )
引數
- config (MegaConfig) — 模型配置類，包含模型的所有引數。用配置檔案初始化模型不會載入與模型相關的權重，只會載入配置。要載入模型權重，請檢視 from_pretrained() 方法。
MEGA 模型，頂部帶有一個跨度分類頭，用於抽取式問答任務，例如 SQuAD（在隱藏狀態輸出之上有一個線性層，用於計算 `span start logits` 和 `span end logits`）。
此模型繼承自 PreTrainedModel。請查閱超類文件，瞭解庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並查閱 PyTorch 文件中所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = 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 ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor) — 詞彙表中輸入序列 token 的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 用於避免對填充 token 索引執行注意力計算的掩碼。掩碼值在[0, 1]中選擇：- 1 表示未被掩蓋的 token，
- 0 表示被掩蓋的 token。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 分段 token 索引，用於指示輸入的第一個和第二個部分。索引在[0,1]中選擇：- 0 對應於句子 A token，
- 1 對應於句子 B token。此引數僅當模型初始化時
add_token_type_embeddings引數設定為True時才可使用。此張量中的所有值應始終小於 config.type_vocab_size。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — （可選）您可以選擇直接傳入嵌入表示，而不是傳入input_ids。如果您想對如何將input_ids索引轉換為關聯向量擁有比模型內部嵌入查詢矩陣更精細的控制，這會很有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通的元組。 - start_positions (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算 token 分類損失的標註跨度起始位置（索引）的標籤。位置被限制在序列長度（`sequence_length`）內。序列之外的位置不計入損失計算。 - end_positions (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算 token 分類損失的標註跨度結束位置（索引）的標籤。位置被限制在序列長度（`sequence_length`）內。序列之外的位置不計入損失計算。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一個 torch.FloatTensor 的元組（如果傳入了 return_dict=False 或 config.return_dict=False），包含根據配置 (MegaConfig) 和輸入的不同元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
MegaForQuestionAnswering 的 forward 方法，它重寫了 __call__ 特殊方法。
雖然前向傳遞的實現需要在該函式中定義，但之後應該呼叫 Module 例項而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默地忽略它們。
示例
>>> from transformers import AutoTokenizer, MegaForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("mnaylor/mega-base-wikitext")
>>> model = MegaForQuestionAnswering.from_pretrained("mnaylor/mega-base-wikitext")
>>> 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]
>>> # 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