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：移动平均加权门控注意力 中提出。MEGA 提出了一种新的自注意力方法，每个编码器层除了一个标准点积注意力的单头外，还有一个多头指数移动平均值，为注意力机制提供了更强的位置偏差。这使得 MEGA 在包括 LRA 在内的标准基准测试中能够与 Transformer 相媲美，同时参数也显著减少。MEGA 的计算效率使其能够扩展到非常长的序列，使其成为长文档 NLP 任务的理想选择。
论文摘要如下：
Transformer 注意力机制的设计选择，包括弱归纳偏差和二次计算复杂度，限制了其在建模长序列方面的应用。在本文中，我们介绍了 Mega，这是一种简单、理论上合理的单头门控注意力机制，它配备了（指数）移动平均值，将位置感知局部依赖性的归纳偏差整合到位置无关的注意力机制中。我们进一步提出了一种 Mega 变体，它提供了线性时间和空间复杂度，但仅产生最小的质量损失，通过有效地将整个序列分成多个固定长度的块来实现。对各种序列建模基准的广泛实验，包括长范围竞技场、神经机器翻译、自回归语言建模以及图像和语音分类，表明 Mega 在其他序列模型（包括 Transformer 变体和最新的状态空间模型）上取得了显著改进。
该模型由 mnaylor 贡献。原始代码可以在 这里 找到。
使用技巧
- 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
< 源代码 >( 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) — 是否在（True）或之后（False）通过 Mega 编码器块进行归一化 - 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 概率。 - 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, 可选, 默认为True) — 是否在 NFFN 的前馈部分之前 (True) 或之后 (False) 进行归一化 - nffn_activation_dropout_prob (
float, 可选, 默认为 0.1) — NFFN 组件的 dropout 比率。 - max_positions (
int, 可选, 默认为 2048) — 用于位置表示的最大序列长度。对于"simple"相对位置偏差，这是对输入长度的硬性限制；"rotary"相对位置偏差将推断到更长的序列 - add_token_type_embeddings (
bool, 可选, 默认为True) — 是否在嵌入中考虑标记类型。保留为可选，以保持与原始实现的兼容性，同时添加对标记类型的支持。 - type_vocab_size (
int, 可选, 默认为 2) — 调用 MegaModel 时传递的token_type_ids的词汇量大小。仅当add_token_type_embeddings = True时使用 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。 - ema_delta_alpha_range (
float, 可选, 默认为 0.2) — 在 MegaMultiDimensionDampedEma 中初始化 delta (阻尼因子) 和 alpha (衰减因子) 参数的标准差。 - relative_positional_bias (
str, 可选, 默认值"rotary") — 相对位置编码类型。选择"rotary"或"simple"之一。如果选择"simple"，则max_positions用于限制输入大小，而"rotary"则会超出max_positions进行推断。 - is_decoder (
bool, 可选, 默认值False) — 模型是否用作解码器。如果为False，则模型用作编码器。 - use_cache (
bool, 可选, 默认值True) — 模型是否应该返回最后的键值注意力（并非所有模型都使用）。仅当config.is_decoder=True时才相关。 - classifier_dropout (
float, 可选) — 分类头的 dropout 比率。 - add_lm_hidden_dense_layer (
bool, 可选, 默认值True) — 是否为编码器输出和 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://arxiv.org/abs/2209.10655
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 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 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对编码器输入的填充令牌索引执行注意力操作。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值选择在[0, 1]中：- 1 表示未掩码的令牌，
- 0 表示掩码的令牌。
- 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)) — 序列第一个令牌（分类令牌）在经过用于辅助预训练任务的层进一步处理后的最后一层隐藏状态。例如，对于 BERT 系列模型，这将返回在经过线性层和 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 (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或当config.use_cache=True时返回) —tuple(torch.FloatTensor)元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量，并且如果config.is_encoder_decoder=True则可选地包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块中的键和值，以及如果
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() 方法以加载模型权重。
具有用于 CLM 微调的 语言建模 头的 MEGA 模型。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为相关的所有事宜。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None past_key_values: Tuple = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 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 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示已掩码的标记。
- labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）。索引设置为-100的标记被忽略（屏蔽），损失仅针对标签在[0, ..., config.vocab_size]中的标记进行计算。 - 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时返回) — 语言建模损失（用于下一个词预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 (
tuple(tuple(torch.FloatTensor)), 可选, 当传递了use_cache=True或者当config.use_cache=True时返回) — 长度为config.n_layers的torch.FloatTensor元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置。仅在config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
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
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = 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 (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 掩码语言模型 (MLM) 损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
The 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: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = 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 (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或回归，如果 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 后的注意力权重，用于计算自注意力头中的加权平均值。
The 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
< 源代码 >( config )
参数
- config (MegaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
具有多项选择分类头的 MEGA 模型（在池化输出之上进行线性层，并在其之上进行 softmax）例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为相关的所有事宜。
forward
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None attention_mask: Optional = None labels: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = 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 (
torch.FloatTensor形状为 (1,), 可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, num_choices)) — 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 后的注意力权重，用于计算自注意力头中的加权平均值。
The MegaForMultipleChoice 正向方法，重写了 __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: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = 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 (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.num_labels)) — 分类得分（在 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 正向方法，覆盖 __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
< source >( config )
参数
- config (MegaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
MEGA 模型，顶部有一个跨度分类头部，用于提取式问答任务，例如 SQuAD（在隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般使用和行为相关的所有事宜。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional
参数
- 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 而不是普通元组。 - start_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度的开始位置（索引）的标签。位置被限制在序列的长度 (sequence_length)。序列之外的位置不计入损失计算。 - end_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度的结束位置（索引）的标签。位置被限制在序列的长度 (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.FloatTensor形状为(1,)，可选，在提供labels时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 跨度开始分数（在 SoftMax 之前）。 -
end_logits (
torch.FloatTensor形状为(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 后的注意力权重，用于计算自注意力头中的加权平均值。
The MegaForQuestionAnswering 正向方法覆盖了 __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