Transformers 文档

Reformer

Transformers

加入 Hugging Face 社区

并获得增强型文档体验

协作模型、数据集和空间

使用加速推理的更快的示例

在文档主题之间切换

开始使用

Reformer

概述

Reformer 模型是在 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 发表的论文 Reformer: The Efficient Transformer 中提出的。

论文的摘要如下

大型 Transformer 模型在许多任务中通常都能取得最先进的结果，但训练这些模型的成本可能高得令人望而却步，尤其是在长序列上。我们介绍了两种技术来提高 Transformer 的效率。首先，我们将点积注意力替换为使用局部敏感哈希的注意力，将其复杂度从 O(L^2) 更改为 O(Llog(L))，其中 L 是序列的长度。此外，我们使用可逆残差层而不是标准残差，这允许在训练过程中只存储一次激活，而不是 N 次，其中 N 是层的数量。生成的模型 Reformer 的性能与 Transformer 模型相当，但内存效率更高，在长序列上的速度也更快。

此模型由 patrickvonplaten 贡献。作者的代码可以在这里找到 here。

使用技巧

由于 PyTorch 中的一个错误，Reformer 不能与 torch.nn.DataParallel 一起使用，请参见 issue #36035。
使用轴向位置编码（有关更多详细信息，请参见下文）。这是一种通过将位置编码矩阵分解成更小的矩阵来避免拥有大型位置编码矩阵（当序列长度非常大时）的机制。
将传统注意力替换为 LSH（局部敏感哈希）注意力（有关更多详细信息，请参见下文）。这是一种在注意力层中避免计算完整产品查询键的技术。
通过使用可逆 Transformer 层来避免存储每一层的中间结果，从而在反向传播过程中获得它们（从下一层的输入中减去残差可以将其恢复）或重新计算给定层内的结果（效率低于存储它们，但节省内存）。
按块计算前馈操作，而不是在整个批次上计算。

轴向位置编码

轴向位置编码首次在 Google 的 trax 库中实现，由该模型论文的作者开发。在处理非常长的输入序列的模型中，传统的位置 ID 编码会为每个位置存储大小为 $d$ 的嵌入向量，其中 config.hidden_size 用于每个位置 $i, \ldots, n_s$ ，其中 $n_s$ 为 config.max_embedding_size。这意味着拥有序列长度为 $n_s = 2^{19} \approx 0.5M$ 和 config.hidden_size 为 $d = 2^{10} \approx 1000$ 将导致位置编码矩阵 $X_{i,j}, \text{ with } i \in \left[1,\ldots, d\right] \text{ and } j \in \left[1,\ldots, n_s\right]$

，它本身就需要存储超过 5 亿个参数。轴向位置编码将 $X_{i,j}$ 分解成两个矩阵 $X^{1}_{i,j}, \text{ with } i \in \left[1,\ldots, d^1\right] \text{ and } j \in \left[1,\ldots, n_s^1\right]$

和 $X^{2}_{i,j}, \text{ with } i \in \left[1,\ldots, d^2\right] \text{ and } j \in \left[1,\ldots, n_s^2\right]$

其中 $d = d^1 + d^2 \text{ and } n_s = n_s^1 \times n_s^2 .$

因此，以下关系成立 $X_{i,j} = \begin{cases} X^{1}_{i, k}, & \text{if }\ i < d^1 \text{ with } k = j \mod n_s^1 \\ X^{2}_{i - d^1, l}, & \text{if } i \ge d^1 \text{ with } l = \lfloor\frac{j}{n_s^1}\rfloor \end{cases}$

直观地来说，这意味着一个位置嵌入向量 $x_j \in \mathbb{R}^{d}$ 现在是两个因子化的嵌入向量的组合 $x^1_{k, l} + x^2_{l, k}$ ，其中，随着 `config.max_embedding_size` 维度 $j$ 被分解成 $k \text{ and } l$ 。这种设计确保每个位置嵌入向量 $x_j$ 都是唯一的。

再次使用上面的例子，轴向位置编码与 $d^1 = 2^9, d^2 = 2^9, n_s^1 = 2^9, n_s^2 = 2^{10}$ 可以大幅减少参数数量，从 5 亿减少到 $2^{18} + 2^{19} \approx 780 000$ 个参数，这意味着内存使用量减少了 85%。

在实践中，参数 config.axial_pos_embds_dim 设置为元组 $(d^1, d^2)$ 其总和必须等于 config.hidden_size，并且 config.axial_pos_shape 设置为元组 $(n_s^1, n_s^2)$ 其乘积必须等于 config.max_embedding_size，在训练期间必须等于 input_ids 的 序列长度。

局部敏感哈希自注意力

在局部敏感哈希 (LSH) 自注意力中，键和查询投影权重是绑定的。因此，键查询嵌入向量也是绑定的。LSH 自注意力使用在 Practical and Optimal LSH for Angular Distance 中提出的局部敏感哈希机制，将每个绑定的键查询嵌入向量分配到 config.num_buckets 个可能的桶中。前提是，键查询嵌入向量彼此越“相似”（就余弦相似度而言），它们被分配到同一个桶的可能性就越大。

通过增加 config.num_hashes 或直接增加前向函数的参数 num_hashes 可以提高 LSH 机制的准确性，以便 LSH 自注意力的输出更好地近似于“正常”的完全自注意力的输出。然后对桶进行排序并分成长度为 config.lsh_chunk_length 的查询键嵌入向量块。对于每个块，查询嵌入向量会关注其键向量（与其自身绑定），以及 config.lsh_num_chunks_before 个之前的相邻块和 config.lsh_num_chunks_after 个之后的相邻块的键嵌入向量。

有关更多信息，请参阅原始论文或这篇很棒的博客文章。

请注意，config.num_buckets 也可以分解成一个列表 $(n_{\text{buckets}}^1, n_{\text{buckets}}^2)$ . 这样，查询键嵌入向量不是被分配到 $(1,\ldots, n_{\text{buckets}})$ 而是被分配到 $(1-1,\ldots, n_{\text{buckets}}^1-1, \ldots, 1-n_{\text{buckets}}^2, \ldots, n_{\text{buckets}}^1-n_{\text{buckets}}^2)$ . 这对于非常长的序列来说至关重要，可以节省内存。

从头开始训练模型时，建议保留 config.num_buckets=None，这样根据序列长度，可以动态计算 num_buckets 的最佳值。此值将自动保存在配置中，并应在推理时重复使用。

使用 LSH 自注意力，查询-键矩阵乘法的内存和时间复杂度可以从 $\mathcal{O}(n_s \times n_s)$ 降低到 $\mathcal{O}(n_s \times \log(n_s))$ , 这通常代表了 Transformer 模型中的内存和时间瓶颈，其中 $n_s$ 是序列长度。

局部自注意力

局部自注意力本质上是一个具有键、查询和值投影的“普通”自注意力层，但它被分块，因此在每个长度为 config.local_chunk_length 的块中，查询嵌入向量仅关注其块中的键嵌入向量以及 config.local_num_chunks_before 个先前相邻块和 config.local_num_chunks_after 个后续相邻块中的键嵌入向量。

使用局部自注意力，查询-键矩阵乘法的内存和时间复杂度可以从 $\mathcal{O}(n_s \times n_s)$ 降低到 $\mathcal{O}(n_s \times \log(n_s))$ , 这通常代表了 Transformer 模型中的内存和时间瓶颈，其中 $n_s$ 是序列长度。

训练

在训练期间，我们必须确保序列长度设置为可以被 config.lsh_chunk_length 和 config.local_chunk_length 的最小公倍数整除的值，并且轴向位置编码的参数应如上所述正确设置。Reformer 非常节约内存，因此模型可以轻松地针对长达 64000 个标记的序列进行训练。

对于训练，应使用 ReformerModelWithLMHead，如下所示

input_ids = tokenizer.encode("This is a sentence from the training data", return_tensors="pt")
loss = model(input_ids, labels=input_ids)[0]

资源

ReformerConfig

class transformers.ReformerConfig

< source >

( attention_head_size = 64 attn_layers = ['local', 'lsh', 'local', 'lsh', 'local', 'lsh'] axial_norm_std = 1.0 axial_pos_embds = True axial_pos_shape = [64, 64] axial_pos_embds_dim = [64, 192] chunk_size_lm_head = 0 eos_token_id = 2 feed_forward_size = 512 hash_seed = None hidden_act = 'relu' hidden_dropout_prob = 0.05 hidden_size = 256 initializer_range = 0.02 is_decoder = False layer_norm_eps = 1e-12 local_num_chunks_before = 1 local_num_chunks_after = 0 local_attention_probs_dropout_prob = 0.05 local_attn_chunk_length = 64 lsh_attn_chunk_length = 64 lsh_attention_probs_dropout_prob = 0.0 lsh_num_chunks_before = 1 lsh_num_chunks_after = 0 max_position_embeddings = 4096 num_attention_heads = 12 num_buckets = None num_hashes = 1 pad_token_id = 0 vocab_size = 320 tie_word_embeddings = False use_cache = True classifier_dropout = None **kwargs )

参数

attention_head_size (int, 可选, 默认值 64) — 投影键、查询和值向量的维度
attn_layers (List[str], 可选, 默认值 ["local", "lsh", "local", "lsh", "local", "lsh"]) — 按升序排列的注意力层类型列表。可以选择 LSHSelfAttention 层 ("lsh") 和 LocalSelfAttention 层 ("local")。

有关 LSHSelfAttention 层的更多信息，请参见 LSH 自注意力。有关 LocalSelfAttention 层的更多信息，请参见局部自注意力。
axial_pos_embds (bool, 可选, 默认值 True) — 是否使用轴向位置嵌入。有关轴向位置嵌入如何工作的更多信息，请参见轴向位置编码。
axial_norm_std (float, 可选, 默认值 1.0) — 初始化轴向位置编码的权重矩阵的 normal_initializer 的标准差。
axial_pos_shape (List[int], 可选, 默认值 [64, 64]) — 轴向位置编码的位置维度。在训练期间，位置维度的乘积必须等于序列长度。

有关轴向位置嵌入如何工作的更多信息，请参见轴向位置编码。
axial_pos_embds_dim (List[int], 可选, 默认为 [64, 192]) — 轴向位置编码的嵌入维度。嵌入维度的总和必须等于隐藏大小。

有关轴向位置嵌入工作原理的更多信息，请参阅轴向位置编码。
chunk_size_lm_head (int, 可选, 默认为 0) — 最终语言模型前馈头层的块大小。块大小为 0 表示前馈层未分块。块大小为 n 表示前馈层一次处理 n < sequence_length 个嵌入。

有关前馈分块的更多信息，请参阅前馈分块的工作原理？。
eos_token_id (int, 可选, 默认为 2) — 句子结束标记的令牌 ID。
feed_forward_size (int, 可选, 默认为 512) — 残差注意力块中前馈层的维度。
hash_seed (int, 可选) — 可用于使 LSHSelfAttention 中的局部敏感哈希确定性的种子。这仅应在测试目的设置。对于评估和训练目的，hash_seed 应保留为 None 以确保局部敏感哈希方案中完全随机的旋转。
hidden_act (str 或 Callable, 可选, 默认为 "relu") — 残差注意力块中前馈层中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
hidden_dropout_prob (float, 可选, 默认为 0.05) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
hidden_size (int, 可选, 默认为 256) — 残差注意力块的输出隐藏状态的维度。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
is_decoder (bool, 可选, 默认为 False) — 是否在传递给 ReformerModel 的 attention_mask 之外使用因果掩码。在将 Reformer 用于因果语言建模时，此参数应设置为 True。
local_chunk_length (int, 可选, 默认值为 64) — LocalSelfAttention 中自注意力块的长度。分块将内存复杂度从序列长度 x 序列长度（自注意力）降低到块长度 x 块长度 x 序列长度 / 块长度（分块自注意力）。
local_num_chunks_before (int, 可选, 默认值为 1) — LocalSelfAttention 层中对自身进行注意力的前一个相邻块的数量。
local_num_chunks_after (int, 可选, 默认值为 0) — LocalSelfAttention 层中对自身进行注意力的下一个相邻块的数量。
local_attention_probs_dropout_prob (float, 可选, 默认值为 0.1) — LocalSelfAttention 中注意力概率的丢弃率。
lsh_attn_chunk_length (int, 可选, 默认值为 64) — LSHSelfAttention 中自注意力块的长度。分块将内存复杂度从序列长度 x 序列长度（自注意力）降低到块长度 x 块长度 x 序列长度 / 块长度（分块自注意力）。
lsh_num_chunks_before (int, 可选, 默认值为 1) — LSHSelfAttention 层中对自身进行注意力的前一个相邻块的数量。
lsh_num_chunks_after (int, 可选, 默认值为 0) — LSHSelfAttention 层中对自身进行注意力的下一个相邻块的数量。
lsh_attention_probs_dropout_prob (float, 可选, 默认值为 0.1) — LSHSelfAttention 中注意力概率的丢弃率。
max_position_embeddings (int, 可选, 默认值为 4096) — 模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。
num_attention_heads (int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头的数量。
num_hashes (int, 可选, 默认值为 1) — 本地敏感哈希方案中的哈希轮数（例如，随机旋转次数）。num_hashes 越高，LSHSelfAttention 的准确性越高，但哈希也会占用更多内存和时间。
pad_token_id (int, 可选, 默认值为 0) — 填充标记的标记 ID。
vocab_size (int, 可选, 默认值为 320) —\ Reformer 模型的词汇量大小。定义调用 ReformerModel 时可以由 inputs_ids 表示的不同标记的数量。
tie_word_embeddings (bool, 可选, 默认值为 False) — 是否绑定输入和输出嵌入。
use_cache (bool, 可选, 默认值为 True) — 模型是否应该返回最后键/值注意力（并非所有模型都使用）。
classifier_dropout (float, 可选) — 分类头的丢弃率。

这是用于存储 ReformerModel 配置的配置类。它用于根据指定的参数实例化 Reformer 模型，定义模型架构。使用默认值实例化配置将生成与 ReFormer google/reformer-crime-and-punishment 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import ReformerConfig, ReformerModel

>>> # Initializing a Reformer configuration
>>> configuration = ReformerConfig()

>>> # Initializing a Reformer model (with random weights)
>>> model = ReformerModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ReformerTokenizer

class transformers.ReformerTokenizer

< source >

( vocab_file eos_token = '</s>' unk_token = '<unk>' additional_special_tokens = [] sp_model_kwargs: Optional = None **kwargs )

参数

vocab_file (str) — SentencePiece 文件（通常具有 .spm 扩展名），其中包含实例化标记器所需的词汇表。
unk_token (str, 可选, 默认值为 "<unk>") — 未知词元。不在词汇表中的词元无法转换为 ID，并将其设置为此词元。
additional_special_tokens (List[str], 可选, 默认值为 []) — 分词器使用的其他特殊词元。
sp_model_kwargs (dict, 可选) — 将传递给 SentencePieceProcessor.__init__() 方法。 SentencePiece 的 Python 包装器可以用于设置以下内容：
- enable_sampling: 启用子词正则化。
- nbest_size: 一元模型采样参数。对于 BPE-Dropout 无效。
  - nbest_size = {0,1}: 不执行采样。
  - nbest_size > 1: 从 nbest_size 结果中采样。
  - nbest_size < 0: 假设 nbest_size 为无穷大，并使用前向过滤和后向采样算法从所有假设（格）中采样。
- alpha: 一元采样的平滑参数，以及 BPE-Dropout 合并操作的丢弃概率。

构建 Reformer 分词器。基于 SentencePiece 。

此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< 源代码 >

( save_directory: str filename_prefix: Optional = None )

ReformerTokenizerFast

class transformers.ReformerTokenizerFast

< 源代码 >

( vocab_file = None tokenizer_file = None eos_token = '</s>' unk_token = '<unk>' additional_special_tokens = [] **kwargs )

参数

vocab_file (str) — SentencePiece 文件（通常具有 .spm 扩展名），其中包含实例化分词器所需的词汇表。
eos_token (str, 可选, 默认值为 "</s>") — 序列结束词元。

在使用特殊词元构建序列时，这不是用于序列结束的词元。使用的词元是 sep_token。
unk_token (str, 可选, 默认值为 "<unk>") — 未知词元。不在词汇表中的词元无法转换为 ID，并将其设置为此词元。
pad_token (str, 可选, 默认值："<pad>") — 用于填充的标记，例如对不同长度的序列进行批处理时。
additional_special_tokens (List[str], 可选) — 分词器使用的其他特殊标记。

构建一个“快速” Reformer 分词器（由 HuggingFace 的tokenizers 库支持）。基于 Unigram。

此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

ReformerModel

class transformers.ReformerModel

< 源代码 >

( config )

参数

config (ReformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

裸 Reformer 模型 transformer 输出原始隐藏状态，没有任何特定的头部。Reformer 由 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 在 Reformer：高效的 Transformer 中提出。

此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。

forward

< 源代码 >

( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None num_hashes: Optional = None past_buckets_states: Optional = None use_cache: Optional = None output_hidden_states: Optional = None output_attentions: Optional = None return_dict: Optional = None ) → transformers.models.reformer.modeling_reformer.ReformerModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。在训练过程中，input_ids 的 sequence_length 必须是相关模型的块长度的倍数（lsh、local 或两者）。在评估期间，索引会自动填充为块长度的倍数。

可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。

什么是 input IDs?
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意的掩码。掩码值在 [0, 1] 中选择：
- 1 用于未屏蔽的标记，
- 0 用于屏蔽的标记。
什么是 attention masks?
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列中每个词元在位置嵌入中的索引。选择范围在 [0, config.max_position_embeddings - 1] 之间。

什么是位置 ID？
head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于使自注意力模块中选定头部无效的掩码。掩码值选择在 [0, 1] 之间：
- 1 表示头部 未被掩码,
- 0 表示头部 被掩码.
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为相关的向量比模型的内部嵌入查找矩阵有更多控制，这将非常有用。
num_hashes (int, 可选) — 在分组期间应执行的哈希轮数。设置此参数将覆盖在 config.num_hashes 中定义的默认值。

有关更多信息，请参阅 ReformerConfig 中的 num_hashes.
past_buckets_states (List[Tuple(torch.LongTensor, torch.FloatTensor)], 可选) — 长度为 config.n_layers 的 Tuple(torch.LongTensor, torch.FloatTensor 列表，第一个元素是之前的 buckets，形状为 (batch_size, num_heads, num_hashes, sequence_length)，第二个元素是之前的 hidden_states，形状为 (batch_size, sequence_length, hidden_size)。

包含预先计算的隐藏状态和 buckets（仅与 LSH 自注意力相关）。可以用于加快顺序解码速度。
use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput，而不是普通元组。

返回值

transformers.models.reformer.modeling_reformer.ReformerModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.reformer.modeling_reformer.ReformerModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (ReformerConfig) 和输入的不同元素。

last_hidden_state (torch.FloatTensor 形状为 (batch_size, num_predict, hidden_size)) — 模型最后一层的隐藏状态序列。

num_predict 对应于 target_mapping.shape[1]。如果 target_mapping 为 None，则 num_predict 对应于 sequence_length。
past_buckets_states (List[Tuple(torch.LongTensor, torch.FloatTensor)], 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 Tuple(torch.LongTensor, torch.FloatTensor 列表，第一个元素是之前的 buckets，形状为 (batch_size, num_heads, num_hashes, sequence_length)，第二个元素是之前的 hidden_states，形状为 (batch_size, sequence_length, hidden_size)。

包含预先计算的 buckets 和隐藏状态，可用于（请参阅 past_buckets_states 输入）加快顺序解码速度。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

ReformerModel 正向方法覆盖了 __call__ 特殊方法。

虽然前向传播的配方需要在此函数中定义，但之后应该调用Module实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默忽略它们。

示例

>>> from transformers import AutoTokenizer, ReformerModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerModel.from_pretrained("google/reformer-crime-and-punishment")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

ReformerModelWithLMHead

class transformers.ReformerModelWithLMHead

< 源代码 >

( config )

参数

config (ReformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看from_pretrained()方法来加载模型权重。

Reformer 模型，在其顶部有一个语言建模头。 Reformer 由 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出。

此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。

forward

< 源代码 >

( input_ids: Optional = None position_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None num_hashes: Optional = None past_buckets_states: Optional = None use_cache: Optional = None output_hidden_states: Optional = None output_attentions: Optional = None return_dict: Optional = None labels: Optional = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。在训练期间，输入 id 序列长度必须是相关模型的块长度（lsh、local 或两者）的倍数。在评估期间，索引将自动填充为块长度的倍数。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID?
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中:
- 1 表示标记未被掩码，
- 0 表示标记被掩码。
什么是注意力掩码?
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围在 [0, config.max_position_embeddings - 1] 中。

什么是位置 ID?
head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于使自注意力模块的选定头无效的掩码。掩码值选择在 [0, 1] 中:
- 1 表示头未被掩码，
- 0 表示头被掩码。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入 input_ids。如果您想要对如何将 input_ids 索引转换为关联的向量（而不是模型的内部嵌入查找矩阵）进行更多控制，这将很有用。
num_hashes (int, 可选) — 在分桶过程中应执行的哈希轮数。设置此参数将覆盖在 config.num_hashes 中定义的默认值。

有关更多信息，请参见 ReformerConfig 中的 num_hashes。
past_buckets_states (List[Tuple(torch.LongTensor, torch.FloatTensor)], 可选) — 长度为 config.n_layers 的 Tuple(torch.LongTensor, torch.FloatTensor 列表，其中第一个元素是先前形状为 (batch_size, num_heads, num_hashes, sequence_length) 的桶，第二个元素是先前形状为 (batch_size, sequence_length, hidden_size) 的隐藏状态。

包含预先计算的隐藏状态和桶（仅与 LSH 自注意力相关）。可用于加快顺序解码。
use_cache (bool, 可选) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（请参见 past_key_values）。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的 hidden_states。
return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
labels (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 中。所有设置为 -100 的标签将被忽略（屏蔽），损失仅针对 [0, ..., config.vocab_size] 中的标签进行计算

返回值

transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含根据配置 (ReformerConfig) 和输入的不同元素。

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 后的注意力权重，用于计算自注意力头中的加权平均值。

The ReformerModelWithLMHead 正向方法覆盖了 __call__ 特殊方法。

虽然前向传播的配方需要在此函数中定义，但之后应该调用Module实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默忽略它们。

示例

>>> import torch
>>> from transformers import AutoTokenizer, ReformerModelWithLMHead

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerModelWithLMHead.from_pretrained("google/reformer-crime-and-punishment")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

ReformerForMaskedLM

class transformers.ReformerForMaskedLM

( config )

参数

config (ReformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法来加载模型权重。

Reformer 模型，在其顶部有一个语言建模头。 Reformer 由 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出。

此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。

forward

< source >

( input_ids: Optional = None position_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None num_hashes: Optional = None labels: Optional = None output_hidden_states: Optional = None output_attentions: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。在训练期间，输入的 id 序列长度必须是相关模型的块长度的倍数（lsh、local 或两者）。在评估期间，索引会自动填充为块长度的倍数。

索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 避免在填充标记索引上执行注意力的掩码。在 [0, 1] 中选择掩码值：
- 1 表示未掩码的标记。
- 0 表示被掩码的标记。
什么是注意力掩码？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。在 [0, 1] 中选择掩码值：
- 1 表示头部未被掩码。
- 0 表示头部被掩码。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联的向量有更多控制，这将很有用。
num_hashes (int, 可选) — 在分桶期间应执行的哈希轮数。设置此参数会覆盖 config.num_hashes 中定义的默认值。

有关更多信息，请参阅 ReformerConfig 中的 num_hashes。
past_buckets_states (List[Tuple(torch.LongTensor, torch.FloatTensor)], optional) — 长度为 config.n_layers 的 Tuple(torch.LongTensor, torch.FloatTensor 列表，第一个元素是形状为 (batch_size, num_heads, num_hashes, sequence_length) 的先前 buckets，第二个元素是形状为 (batch_size, sequence_length, hidden_size) 的先前 hidden_states。

包含预先计算的隐藏状态和 buckets（仅与 LSH 自注意力相关）。可用于加速顺序解码。
use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
labels (torch.LongTensor 形状为 (batch_size, sequence_length)，optional) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中（参见 input_ids 文档字符串）索引设置为 -100 的标记将被忽略（掩码），损失仅针对带有标签的标记计算

返回值

transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含取决于配置 (ReformerConfig) 和输入的各种元素。

loss (torch.FloatTensor 形状为 (1,)，optional，在提供 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 ReformerForMaskedLM forward method, overrides the __call__ special method.

虽然前向传播的配方需要在此函数中定义，但之后应该调用Module实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默忽略它们。

此示例使用错误的检查点，因为我们没有为 Reformer 架构的掩码语言建模任务提供任何可用的预训练模型。

示例

>>> import torch
>>> from transformers import AutoTokenizer, ReformerForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("hf-internal-testing/tiny-random-reformer")
>>> model = ReformerForMaskedLM.from_pretrained("hf-internal-testing/tiny-random-reformer")

>>> # add mask_token
>>> tokenizer.add_special_tokens({"mask_token": "[MASK]"})
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")

>>> # resize model's embedding matrix
>>> model.resize_token_embeddings(new_num_tokens=model.config.vocab_size + 1)
>>> 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)
>>> predicted_token = tokenizer.decode(predicted_token_id)

>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = torch.where(
...     inputs.input_ids == tokenizer.mask_token_id, labels[:, : inputs["input_ids"].shape[-1]], -100
... )

>>> outputs = model(**inputs, labels=labels)
>>> loss = round(outputs.loss.item(), 2)

ReformerForSequenceClassification

class transformers.ReformerForSequenceClassification

< source >

( config )

参数

config (ReformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

Reformer 模型 transformer，顶部有一个序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。

Reformer 在 Reformer: The Efficient Transformer 中被提出，作者是 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya。

此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。

forward

( input_ids: 可选 = None position_ids: 可选 = None attention_mask: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None num_hashes: 可选 = None labels: 可选 = None output_hidden_states: 可选 = None output_attentions: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。在训练期间，input_ids 序列长度必须是相关模型的块长度（lsh、local 或两者）的倍数。在评估期间，索引会自动填充为块长度的倍数。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码，以避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择：
- 1 表示未掩码的标记，
- 0 表示掩码的标记。
什么是注意力掩码？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码，以使自注意力模块的选定头无效。掩码值在 [0, 1] 中选择：
- 1 表示未掩码的头，
- 0 表示掩码的头。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示而不是传递 input_ids。如果您想比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为相关向量，这很有用。
num_hashes (int, 可选) — 在分桶期间应执行的哈希轮数。设置此参数会覆盖在 config.num_hashes 中定义的默认值。

有关更多信息，请参阅 ReformerConfig 中的 num_hashes。
past_buckets_states (List[Tuple(torch.LongTensor, torch.FloatTensor)], 可选) — 长度为 config.n_layers 的 Tuple(torch.LongTensor, torch.FloatTensor 列表，其中第一个元素是形状为 (batch_size, num_heads, num_hashes, sequence_length) 的上一个桶，第二个元素是形状为 (batch_size, sequence_length, hidden_size) 的上一个隐藏状态。

包含预先计算的隐藏状态和桶（仅与 LSH 自注意力相关）。可用于加速顺序解码。
use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
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），包含取决于配置 (ReformerConfig) 和输入的各种元素。

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 ReformerForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。

虽然前向传播的配方需要在此函数中定义，但之后应该调用Module实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默忽略它们。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, ReformerForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerForSequenceClassification.from_pretrained("google/reformer-crime-and-punishment")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> label = model.config.id2label[predicted_class_id]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = ReformerForSequenceClassification.from_pretrained(
...     "google/reformer-crime-and-punishment", num_labels=num_labels
... )

>>> labels = torch.tensor(1)
>>> loss = model(**inputs, labels=labels).loss

ReformerForQuestionAnswering

class transformers.ReformerForQuestionAnswering

< source >

( config )

参数

config (ReformerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。

在顶部具有跨度分类头的 Reformer 模型，用于诸如 SQuAD / TriviaQA 的抽取式问答任务（在隐藏状态输出的顶部有一个线性层，用于计算 span start logits 和 span end logits）。

Reformer 在 Reformer: The Efficient Transformer 中被提出，作者是 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya。

此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、剪枝头部等）。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。

forward

< source >

( input_ids: Optional = None position_ids: Optional = None attention_mask: Optional = None head_mask: Optional = None inputs_embeds: Optional = None num_hashes: Optional = None start_positions: Optional = None end_positions: Optional = None output_hidden_states: Optional = None output_attentions: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。在训练期间，input_ids 的 sequence_length 必须是相关模型的 chunk 长度的倍数（lsh、local 或两者）。在评估期间，索引会自动填充为 chunk 长度的倍数。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
什么是注意掩码？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块中选择的头部失效的掩码。在 [0, 1] 中选择的掩码值：
- 1 表示未屏蔽的头部，
- 0 表示屏蔽的头部。
inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制，这将很有用，而不是模型内部的嵌入查找矩阵。
num_hashes (int，可选) — 在分桶期间应执行的哈希轮数。设置此参数将覆盖在 config.num_hashes 中定义的默认值。

有关更多信息，请参见 ReformerConfig 中的 num_hashes。
past_buckets_states (List[Tuple(torch.LongTensor, torch.FloatTensor)]，可选) — 长度为 config.n_layers 的 Tuple(torch.LongTensor, torch.FloatTensor 列表，其中第一个元素是形状为 (batch_size, num_heads, num_hashes, sequence_length) 的前一个桶，第二个元素是形状为 (batch_size, sequence_length, hidden_size) 的前一个隐藏状态。

包含预先计算的隐藏状态和桶（仅与 LSH 自注意力相关）。可用于加速顺序解码。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（请参见 past_key_values）。
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）包含取决于配置 (ReformerConfig) 和输入的各种元素。

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 ReformerForQuestionAnswering 前向方法，覆盖 __call__ 特殊方法。

虽然前向传播的配方需要在此函数中定义，但之后应该调用Module实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默忽略它们。

示例

>>> from transformers import AutoTokenizer, ReformerForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/reformer-crime-and-punishment")
>>> model = ReformerForQuestionAnswering.from_pretrained("google/reformer-crime-and-punishment")

>>> 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

< > 在 GitHub 上更新

←RecurrentGemma RemBERT→