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