Transformers 文档

Reformer

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

协作处理模型、数据集和 Spaces

通过加速推理获得更快的示例

切换文档主题

开始使用

Reformer

概述

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

该论文的摘要如下：

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

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

使用技巧

由于 PyTorch 中的一个错误，Reformer 不适用于 torch.nn.DataParallel，请参阅 issue #36035。
使用轴向位置编码（详见下文）。这是一种通过将其分解为更小的矩阵来避免使用巨大的位置编码矩阵（当序列长度非常大时）的机制。
用 LSH（局部敏感哈希）注意力替换传统注意力（详见下文）。这是一种避免在注意力层中计算完整乘积 query-key 的技术。
通过使用可逆 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}$ 可以大幅减少参数数量，从 500 000 000 减少到 $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，在训练期间，它必须等于 sequence length 的 input_ids。

LSH 自注意力机制

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

可以通过增加 config.num_hashes 或直接增加 forward 函数的参数 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 自注意力机制，查询-键 matmul 操作的内存和时间复杂度可以从 $\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 个后续相邻块的键嵌入向量。

使用局部自注意力机制，查询-键 matmul 操作的内存和时间复杂度可以从 $\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 个 token 的序列上进行训练。

对于训练，应按如下方式使用 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

< 源代码 >

( 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, optional, defaults to 64) — 投影的键、查询和值向量的维度 (int, 可选, 默认为 64)
attn_layers (List[str], optional, defaults to ["local", "lsh", "local", "lsh", "local", "lsh"]) — 升序排列的注意力层类型列表 (List[str], 可选, 默认为 ["local", "lsh", "local", "lsh", "local", "lsh"])。它可以是 LSHSelfAttention 层 ("lsh") 或 LocalSelfAttention 层 ("local")。

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

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

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

有关前馈分块的更多信息，请参阅前馈分块如何工作？。
eos_token_id (int, optional, defaults to 2) — 句子结束符 token 的 id (int, 可选, 默认为 2)。
feed_forward_size (int, optional, defaults to 512) — 残差注意力块中前馈层的维度 (int, 可选, 默认为 512)。
hash_seed (int, optional) — 可用于使 LSHSelfAttention 中的局部敏感哈希确定化的种子 (int, 可选)。这仅应为测试目的而设置。对于评估和训练目的，hash_seed 应保留为 None，以确保局部敏感哈希方案中的完全随机旋转。
hidden_act (str or Callable, optional, defaults to "relu") — 残差注意力块中前馈层的非线性激活函数（函数或字符串） (str 或 Callable, 可选, 默认为 "relu")。如果为字符串，则支持 "gelu", "relu", "silu" 和 "gelu_new" 。
hidden_dropout_prob (float, optional, defaults to 0.05) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率 (float, 可选, 默认为 0.05)。
hidden_size (int, optional, defaults to 256) — 残差注意力块的输出隐藏状态的维度 (int, 可选, 默认为 256)。
initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差 (float, 可选, 默认为 0.02)。
is_decoder (bool, optional, defaults to False) — 是否在传递给 ReformerModel 的 attention_mask 之外使用因果掩码 (bool, 可选, 默认为 False)。当使用 Reformer 进行因果语言建模时，应将此参数设置为 True。
layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层使用的 epsilon 值 (float, 可选, 默认为 1e-12)。
local_chunk_length (int, optional, defaults to 64) — 在 LocalSelfAttention 中，chunk 自行注意的长度 (int, 可选, 默认为 64)。分块将内存复杂度从序列长度 x 序列长度（自注意力）降低到 chunk 长度 x chunk 长度 x 序列长度 / chunk 长度（分块自注意力）。
local_num_chunks_before (int, optional, defaults to 1) — 在 LocalSelfAttention 层中，要关注其自身的前面相邻 chunk 的数量 (int, 可选, 默认为 1)。
local_num_chunks_after (int, optional, defaults to 0) — 在 LocalSelfAttention 层中，除了自身之外，还要关注的后续相邻 chunk 的数量 (int, 可选, 默认为 0)。
local_attention_probs_dropout_prob (float, optional, defaults to 0.1) — LocalSelfAttention 中注意力概率的 dropout 比率 (float, 可选, 默认为 0.1)。
lsh_attn_chunk_length (int, optional, defaults to 64) — 在 LSHSelfAttention 中，chunk 自行注意的长度 (int, 可选, 默认为 64)。分块将内存复杂度从序列长度 x 序列长度（自注意力）降低到 chunk 长度 x chunk 长度 x 序列长度 / chunk 长度（分块自注意力）。
lsh_num_chunks_before (int, optional, defaults to 1) — 在 LSHSelfAttention 层中，要关注其自身的前面相邻 chunk 的数量 (int, 可选, 默认为 1)。
lsh_num_chunks_after (int, optional, defaults to 0) — 在 LSHSelfAttention 层中，除了自身之外，还要关注的后续相邻 chunk 的数量 (int, 可选, 默认为 0)。
lsh_attention_probs_dropout_prob (float, optional, defaults to 0.1) — LSHSelfAttention 中注意力概率的 dropout 比率 (float, 可选, 默认为 0.1)。
max_position_embeddings (int, optional, defaults to 4096) — 此模型可能使用的最大序列长度 (int, 可选, 默认为 4096)。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
num_attention_heads (int, optional, defaults to 12) — Transformer 编码器中每个注意力层的注意力头的数量。
num_buckets (int 或 List[int], 可选) — bucket 的数量，键查询向量可以使用局部敏感哈希方案“哈希到”这些 bucket 中。每个查询键向量被哈希到 1, ..., num_buckets 中的一个哈希值。bucket 的数量也可以分解为一个列表，以提高内存复杂性。在这种情况下，如果 num_buckets 分解为两个因子，则每个查询键向量将被哈希到 1-1, 1-2, ..., num_buckets[0]-1, ..., num_buckets[0]-num_buckets[1] 中的一个哈希值。bucket 的数量（或因子的乘积）应大致等于序列长度 / lsh_chunk_length。如果未设置 num_buckets，则会动态计算一个合适的值。
num_hashes (int, 可选, 默认为 1) — 局部敏感哈希方案中的哈希轮数（例如，随机旋转的次数）。num_hashes 越高，LSHSelfAttention 就越准确，但哈希过程也越占用内存和时间。
pad_token_id (int, 可选, 默认为 0) — padding token 的 token id。
vocab_size (int, 可选, 默认为 320) — Reformer 模型的词汇表大小。定义了调用 ReformerModel 时传递的 inputs_ids 可以表示的不同 token 的数量。
tie_word_embeddings (bool, 可选, 默认为 False) — 是否绑定输入和输出 embeddings。
use_cache (bool, 可选, 默认为 True) — 模型是否应返回最后的 key/values attentions (并非所有模型都使用)。
classifier_dropout (float, 可选) — 分类头的 dropout 比率。

这是用于存储 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: typing.Optional[typing.Dict[str, typing.Any]] = None **kwargs )

参数

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

当使用特殊 token 构建序列时，这不是用于序列结尾的 token。使用的 token 是 sep_token。
unk_token (str, 可选, 默认为 "<unk>") — 未知 token。词汇表中没有的 token 无法转换为 ID，而是设置为此 token。
additional_special_tokens (List[str], 可选, 默认为 []) — tokenizer 使用的其他特殊 token。
sp_model_kwargs (dict, 可选) — 将传递给 SentencePieceProcessor.__init__() 方法。 SentencePiece 的 Python 封装器可用于设置以下内容：
- enable_sampling: 启用子词正则化。
- nbest_size: unigram 的采样参数。对 BPE-Dropout 无效。
  - nbest_size = {0,1}: 不执行采样。
  - nbest_size > 1: 从 nbest_size 结果中采样。
  - nbest_size < 0: 假设 nbest_size 是无限的，并使用前向过滤和后向采样算法从所有假设（lattice）中采样。
- alpha: 用于 unigram 采样的平滑参数，以及 BPE-dropout 的合并操作的 dropout 概率。

构建 Reformer tokenizer。基于 SentencePiece 。

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

save_vocabulary

< source >

( save_directory: str filename_prefix: typing.Optional[str] = None )

ReformerTokenizerFast

class transformers.ReformerTokenizerFast

< source >

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

参数

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

当使用特殊 token 构建序列时，这不是用于序列结尾的 token。使用的 token 是 sep_token。
unk_token (str, 可选, 默认为 "<unk>") — 未知 token。词汇表中没有的 token 无法转换为 ID，而是设置为此 token。
pad_token (str, 可选, 默认为 "<pad>") — 用于 padding 的 token，例如在对不同长度的序列进行 batch 处理时。
additional_special_tokens (List[str], 可选) — tokenizer 使用的其他特殊 token。

构建 “fast” Reformer tokenizer（由 HuggingFace 的 tokenizers 库支持）。基于 Unigram。

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

ReformerModel

类 transformers.ReformerModel

< 源码 >

( config )

参数

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

Reformer 模型 Transformer，输出原始的 hidden-states，顶部没有任何特定的 head。 Reformer 是 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出的。

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

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

forward

< 源码 >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None past_buckets_states: typing.Optional[typing.List[typing.Tuple[torch.Tensor]]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.reformer.modeling_reformer.ReformerModelOutput 或 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)，可选) — 用于避免在 padding 标记索引上执行 attention 的 mask。Mask 值在 [0, 1] 中选择：
- 1 表示标记未被 mask，
- 0 表示标记已被 mask。
什么是 attention mask？
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)，可选) — 用于 nullify self-attention 模块中选定 head 的 mask。Mask 值在 [0, 1] 中选择：
- 1 表示 head 未被 mask，
- 0 表示 head 已被 mask。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
num_hashes (int，可选) — 在 bucketing 期间应执行的哈希轮数。设置此参数会覆盖 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) 的先前 buckets，第二个元素是形状为 (batch_size, sequence_length, hidden_size) 的先前 hidden_states）。

包含预先计算的 hidden-states 和 buckets（仅与 LSH Self-Attention 相关）。可用于加速顺序解码。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
output_attentions (bool，可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回 tensors 下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回 tensors 下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。

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

一个 transformers.models.reformer.modeling_reformer.ReformerModelOutput 或一个 torch.FloatTensor tuple（如果传递 return_dict=False 或 config.return_dict=False），其中包含各种元素，具体取决于配置 (ReformerConfig) 和输入。

last_hidden_state (torch.FloatTensor，形状为 (batch_size, num_predict, hidden_size)) — 模型最后一层的 hidden-states 序列。

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 列表，其中第一个元素是形状为 (batch_size, num_heads, num_hashes, sequence_length) 的先前 buckets，第二个元素是形状为 (batch_size, sequence_length, hidden_size) 的先前 hidden_states）。

包含预先计算的 buckets 和 hidden-states，可用于（请参阅 past_buckets_states 输入）加速顺序解码。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor tuple（每个层的输出一个，以及初始嵌入输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每一层输出端的 Hidden-states，加上初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。

ReformerModel forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward pass 的配方需要在该函数中定义，但应该在之后调用 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

类 transformers.ReformerModelWithLMHead

< 源码 >

( config )

参数

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

Reformer 模型，顶部带有 language modeling head。 Reformer 是 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出的。

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

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

forward

< 源码 >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None past_buckets_states: typing.Optional[typing.List[typing.Tuple[torch.Tensor]]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 IDs？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在 [0, 1] 中选择：
- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
什么是 attention masks？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列 tokens 在位置 embeddings 中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是位置 IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在 [0, 1] 中选择：
- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部 embedding lookup matrix 更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
num_hashes (int，可选) — bucketing 期间应执行的哈希轮数。设置此参数将覆盖 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)) 的先前 buckets，第二个元素是形状为 (batch_size, sequence_length, hidden_size)) 的先前 hidden_states。

包含预计算的 hidden-states 和 buckets（仅与 LSH Self-Attention 相关）。可用于加速顺序解码。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参阅返回的 tensors 下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的 tensors 下的 hidden_states。
return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。
labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [-100, 0, ..., config.vocab_size - 1] 中。所有设置为 -100 的标签都将被忽略（masked），损失仅针对 [0, ..., config.vocab_size] 中的标签计算

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

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

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出 + 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每层输出以及可选的初始 embedding 输出处的 Hidden-states。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。

ReformerModelWithLMHead forward 方法，覆盖了 __call__ 特殊方法。

示例

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

< source >

( config )

参数

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

Reformer 模型，顶部带有 language modeling head。 Reformer 是 Nikita Kitaev、Łukasz Kaiser 和 Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出的。

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

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

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None output_attentions: 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)) — 词汇表中输入序列 tokens 的索引。在训练期间，input_ids 序列长度必须是相关模型 chunk 长度（lsh、local 或两者）的倍数。在评估期间，索引会自动填充为 chunk 长度的倍数。

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

什么是输入 IDs？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在 [0, 1] 中选择：
- 1 表示 tokens 未被 Mask，
- 0 表示 tokens 已被 Mask。
什么是 attention masks？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列 tokens 在位置 embeddings 中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

什么是位置 IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定 heads 的 Mask。 Mask 值在 [0, 1] 中选择：
- 1 表示 head 未被 Mask，
- 0 表示 head 已被 Mask。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部 embedding lookup matrix 更好地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
num_hashes (int，可选) — bucketing 期间应执行的哈希轮数。设置此参数将覆盖 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)) 的先前 buckets，第二个元素是形状为 (batch_size, sequence_length, hidden_size)) 的先前 hidden_states。

包含预计算的 hidden-states 和 buckets（仅与 LSH Self-Attention 相关）。可用于加速顺序解码。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参阅返回的 tensors 下的 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)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出 + 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每层输出以及可选的初始 embedding 输出处的 Hidden-states。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。

ReformerForMaskedLM forward 方法，覆盖了 __call__ 特殊方法。

此示例使用了一个虚假的检查点，因为我们没有任何可用于 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 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。

Reformer 是由 Nikita Kitaev、Łukasz Kaiser、Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出的。

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

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

forward

< source >

( input_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None num_hashes: typing.Optional[int] = None labels: typing.Optional[torch.Tensor] = None output_hidden_states: typing.Optional[bool] = None output_attentions: 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)) — 词汇表中输入序列标记的索引。在训练期间，input_ids 序列长度必须是相关模型块长度（lsh、local 或两者）的倍数。在评估期间，索引会自动填充为块长度的倍数。

可以使用 AutoTokenizer 获取索引。参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。

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

什么是位置 IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，optional) — 用于使自注意力模块的选定头无效的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头未被掩蔽，
- 0 表示头被掩蔽。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，optional) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
num_hashes (int，optional) — 在分桶期间应执行的哈希轮数。设置此参数会覆盖 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)) 的先前桶，第二个元素是形状为 (batch_size, sequence_length, hidden_size)) 的先前hidden_states。

包含预先计算的隐藏状态和桶（仅与 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,)，optional) — 用于计算序列分类/回归损失的标签。索引应在 [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,)，optional，当提供 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 的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出 + 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每层输出以及可选的初始 embedding 输出处的 Hidden-states。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。

ReformerForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。

单标签分类示例

>>> 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 是由 Nikita Kitaev、Łukasz Kaiser、Anselm Levskaya 在 Reformer: The Efficient Transformer 中提出的。

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

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

forward

< source >

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

参数

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

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

什么是输入ID？
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length), optional) — 掩码，用于避免对 padding token 索引执行 attention。掩码值在 [0, 1] 中选择:
- `1` 表示 **未被掩码** 的 tokens，
- `0` 表示 **已被掩码** 的 tokens。
什么是 attention masks？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length), optional) — 每个输入序列 tokens 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是 position IDs？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads), optional) — 掩码，用于使 self-attention 模块的选定 heads 失效。掩码值在 [0, 1] 中选择:
- `1` 表示 head **未被掩码**，
- `0` 表示 head **已被掩码**。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), optional) — 可选地，除了传递 input_ids 之外，您可以选择直接传递嵌入表示。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
num_hashes (int, optional) — 在 bucketing 期间应执行的哈希轮数。设置此参数将覆盖 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*。

包含预先计算的 hidden-states 和 buckets（仅与 LSH Self-Attention 相关）。可用于加速顺序解码。
use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
output_attentions (bool, optional) — 是否返回所有 attention 层的 attentions tensors。有关更多详细信息，请参阅返回的 tensors 下的 attentions。
output_hidden_states (bool, optional) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的 tensors 下的 hidden_states。
return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通 tuple。
start_positions (torch.LongTensor，形状为 (batch_size,), optional) — 用于计算 token 分类损失的标记 span 起始位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列外部的位置不计入损失计算。
end_positions (torch.LongTensor，形状为 (batch_size,), optional) — 用于计算 token 分类损失的标记 span 结束位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列外部的位置不计入损失计算。

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

A transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的 tuple (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (ReformerConfig) 和输入。

loss (torch.FloatTensor，形状为 (1,), optional, 当提供 labels 时返回) — 总 span 提取损失是起始位置和结束位置的 Cross-Entropy 之和。
start_logits (torch.FloatTensor，形状为 (batch_size, sequence_length)) — Span-start 分数 (在 SoftMax 之前)。
end_logits (torch.FloatTensor，形状为 (batch_size, sequence_length)) — Span-end 分数 (在 SoftMax 之前)。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的 Tuple（如果模型具有 embedding 层，则为 embeddings 的输出 + 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

模型在每层输出以及可选的初始 embedding 输出处的 Hidden-states。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — torch.FloatTensor tuple（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。

ReformerForQuestionAnswering 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

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