Transformers 文档
Reformer 模型
并获得增强的文档体验
开始使用
Reformer
概述
Reformer 模型由 Nikita Kitaev、Łukasz Kaiser、Anselm Levskaya 在论文 Reformer: 高效 Transformer 中提出。
论文摘要如下:
大型 Transformer 模型在多项任务上通常能达到最先进的结果,但训练这些模型的成本可能高得令人望而却步,尤其是在长序列上。我们引入了两种技术来提高 Transformer 的效率。首先,我们将点积注意力替换为使用局部敏感哈希的注意力,将其复杂度从 O(L^2) 改变为 O(Llog(L)),其中 L 是序列的长度。此外,我们使用可逆残差层而不是标准残差层,这使得在训练过程中只需存储一次激活(而不是 N 次,N 是层数)。由此产生的模型 Reformer 在性能上与 Transformer 模型相当,同时在长序列上更节省内存且速度更快。
此模型由 patrickvonplaten 贡献。作者的代码可以在 这里 找到。
使用技巧
- 由于 PyTorch 中的一个 bug,Reformer 不支持 torch.nn.DataParallel,参见 问题 #36035。
- 使用轴向位置编码(详见下文)。这是一种通过将巨大位置编码矩阵分解为较小矩阵来避免其过大(当序列长度非常大时)的机制。
- 用 LSH(局部敏感哈希)注意力替换传统注意力(详见下文)。这是一种避免在注意力层中计算完整查询-键乘积的技术。
- 通过使用可逆 Transformer 层,避免存储每个层的中间结果,从而在反向传播过程中获取它们(从下一层的输入中减去残差即可恢复它们)或重新计算给定层内部的结果(效率低于存储但节省内存)。
- 分块而不是对整个批次计算前馈操作。
轴向位置编码
轴向位置编码最初由 Google 的 trax 库 实现,并由该模型论文的作者开发。在处理非常长输入序列的模型中,传统的位置 ID 编码存储一个大小为的嵌入向量,其中 config.hidden_size
是每个位置的,其中是 config.max_embedding_size
。这意味着如果序列长度为,并且 config.hidden_size
为,将导致位置编码矩阵
,其本身就有超过 5 亿个参数需要存储。轴向位置编码将分解为两个矩阵
和
,其中
因此,以下成立:
直观地说,这意味着位置嵌入向量现在是两个分解嵌入向量的组合,其中 config.max_embedding_size
维度被分解为。这种设计确保了每个位置嵌入向量是唯一的。
再次使用上面的例子,轴向位置编码和可以将参数数量从 5 亿个大幅减少到个参数,这意味着内存使用量减少了 85%。
在实践中,参数 config.axial_pos_embds_dim
设置为元组其和必须等于 config.hidden_size
,config.axial_pos_shape
设置为元组其积必须等于 config.max_embedding_size
,在训练期间,它必须等于 input_ids
的序列长度。
LSH 自注意力
在局部敏感哈希 (LSH) 自注意力中,键和查询投影权重是绑定的。因此,键查询嵌入向量也是绑定的。LSH 自注意力使用 用于角度距离的实用最优 LSH 中提出的局部敏感哈希机制,将每个绑定的键查询嵌入向量分配到 config.num_buckets
个可能的桶中的一个。其前提是,“更相似”的键查询嵌入向量(就余弦相似度而言)彼此之间越相似,它们被分配到同一桶的可能性就越大。
LSH 机制的准确性可以通过增加 config.num_hashes
或直接增加前向函数的参数 num_hashes
来提高,从而使 LSH 自注意力的输出更好地近似“正常”完整自注意力的输出。然后对桶进行排序,并将其分块为长度为 config.lsh_chunk_length
的查询键嵌入向量块。对于每个块,查询嵌入向量关注其键向量(与自身绑定)以及 config.lsh_num_chunks_before
个先前相邻块和 config.lsh_num_chunks_after
个后续相邻块的键嵌入向量。
请注意,config.num_buckets
也可以分解为一个列表。这样,查询键嵌入向量就不会被分配到中的一个,而是被分配到中的一个。这对于节省超长序列的内存至关重要。
从头开始训练模型时,建议将 config.num_buckets
留空,以便根据序列长度动态计算一个好的 num_buckets
值。该值将自动保存在配置中,并应在推理时重复使用。
使用 LSH 自注意力,查询-键矩阵乘法操作的内存和时间复杂度可以从到降低,这通常是 Transformer 模型中的内存和时间瓶颈,其中是序列长度。
局部自注意力
局部自注意力本质上是“正常”的自注意力层,具有键、查询和值投影,但它被分块,以便在每个长度为 config.local_chunk_length
的块中,查询嵌入向量仅关注其块中的键嵌入向量以及 config.local_num_chunks_before
个先前相邻块和 config.local_num_chunks_after
个后续相邻块的键嵌入向量。
使用局部自注意力,查询-键矩阵乘法操作的内存和时间复杂度可以从到降低,这通常是 Transformer 模型中的内存和时间瓶颈,其中是序列长度。
训练
在训练过程中,我们必须确保序列长度设置为可以被 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
< 源代码 >( 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 < 序列长度的嵌入。有关前馈分块的更多信息,请参阅前馈分块如何工作?。
- eos_token_id (
int
, 可选, 默认为 2) — 句子结束标记的标记 ID。 - feed_forward_size (
int
, 可选, 默认为 512) — 残差注意力块中 feed_forward 层的维度。 - 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
。 - layer_norm_eps (
float
, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - 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
中注意力概率的 dropout 比率。 - 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
中注意力概率的 dropout 比率。 - max_position_embeddings (
int
, 可选, 默认为 4096) — 该模型可能使用的最大序列长度。通常为了以防万一会将其设置为一个较大的值(例如 512 或 1024 或 2048)。 - num_attention_heads (
int
, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - num_buckets (
int
或list[int]
, 可选) — 桶的数量,可以使用局部敏感哈希方案将键查询向量“哈希”到其中。每个查询键向量都被哈希到1, ..., num_buckets
中的一个哈希中。为了提高内存复杂度,桶的数量也可以分解为一个列表。在这种情况下,如果num_buckets
被分解为两个因子,则每个查询键向量都被哈希到1-1, 1-2, ..., num_buckets[0]-1, ..., num_buckets[0]-num_buckets[1]
中的一个哈希中。桶的数量(或因子的乘积)应大约等于序列长度 / lsh_chunk_length。如果未设置num_buckets
,则会动态计算一个好的值。 - 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
, 可选) — 分类头部的 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
< 源 >( vocab_file eos_token = '</s>' unk_token = '<unk>' additional_special_tokens = [] sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None **kwargs )
参数
- vocab_file (
str
) — SentencePiece 文件(通常具有 .spm 扩展名),其中包含实例化分词器所需的词汇表。 - eos_token (
str
, 可选, 默认为"</s>"
) — 序列结束符。当使用特殊令牌构建序列时,这不是用于序列结束的令牌。使用的令牌是
sep_token
。 - unk_token (
str
, 可选, 默认为"<unk>"
) — 未知令牌。不在词汇表中的令牌不能转换为 ID,而是设置为此令牌。 - additional_special_tokens (
list[str]
, 可选, 默认为[]
) — 分词器使用的其他特殊令牌。 - 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 是无限的,并使用前向过滤和后向采样算法从所有假设(格)中采样。
-
alpha
: Unigram 采样的平滑参数,以及 BPE-dropout 合并操作的 dropout 概率。
-
构建 Reformer 分词器。基于 SentencePiece。
此分词器继承自 PreTrainedTokenizer,其中包含大部分主要方法。用户应参阅此超类以获取有关这些方法的更多信息。
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 (ReformerModel) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
Reformer 模型输出原始隐藏状态,顶部没有任何特定头部。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
此模型也是 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[list[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 的序列长度必须是相关模型块长度(LSH 的、本地的或两者)的倍数。在评估期间,索引会自动填充为块长度的倍数。索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
形状为(batch_size, sequence_length)
, 可选) — 避免对填充令牌索引执行注意力的掩码。掩码值选择在[0, 1]
:- 1 表示令牌未被遮蔽,
- 0 表示令牌被遮蔽。
- position_ids (
torch.Tensor
形状为(batch_size, sequence_length)
, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (
torch.Tensor
形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 遮蔽自注意力模块选定头部的掩码。掩码值选择在[0, 1]
:- 1 表示头部未被遮蔽,
- 0 表示头部被遮蔽。
- inputs_embeds (
torch.Tensor
形状为(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)
的前一个 buckets,第二个元素为形状为(batch_size, sequence_length, hidden_size)
的前一个 hidden_states)。包含预先计算的隐藏状态和 buckets(仅与 LSH 自注意力相关)。可用于加速顺序解码。
- use_cache (
bool
, 可选) — 如果设置为True
,将返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - 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
列表,第一个元素为形状为(batch_size, num_heads, num_hashes, sequence_length)
的前一个 buckets,第二个元素为形状为(batch_size, sequence_length, hidden_size)
的前一个 hidden_states)。包含预先计算的 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 的 forward 方法,覆盖了 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但此后应调用 Module
实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
ReformerModelWithLMHead
class transformers.ReformerModelWithLMHead
< 源 >( config )
参数
- config (ReformerModelWithLMHead) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
带 语言建模
头部的 Reformer 模型。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
此模型也是 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[list[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)
) — 词汇表中输入序列令牌的索引。在训练期间,input_ids 的序列长度必须是相关模型块长度(LSH 的、本地的或两者)的倍数。在评估期间,索引会自动填充为块长度的倍数。索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (
torch.Tensor
形状为(batch_size, sequence_length)
, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - attention_mask (
torch.Tensor
形状为(batch_size, sequence_length)
, 可选) — 避免对填充令牌索引执行注意力的掩码。掩码值选择在[0, 1]
:- 1 表示令牌未被遮蔽,
- 0 表示令牌被遮蔽。
- head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]
之间:- 1 表示头部未被掩码,
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
,可选) — 可选地,您可以选择直接传入嵌入表示而不是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_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量下的attentions
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (形状为
(batch_size,)
的torch.LongTensor
,可选) — 用于计算序列分类/回归损失的标签。索引应在[-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
时返回) — 语言建模损失(用于下一个 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 后的注意力权重,用于计算自注意力头中的加权平均值。
ReformerModelWithLMHead 的 forward 方法,重写了 __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
< source >( config )
参数
- config (ReformerForMaskedLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有 语言建模
头的 Reformer 模型。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
此模型也是 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 (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 词汇表中输入序列标记的索引。训练期间,input_ids 的序列长度必须是相关模型块长度(lsh、局部或两者)的倍数。评估期间,索引会自动填充为块长度的倍数。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
,可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
,可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值选择在[0, 1]
之间:- 1 表示标记未被掩码,
- 0 表示标记被掩码。
- head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]
之间:- 1 表示头部未被掩码,
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
,可选) — 可选地,您可以选择直接传入嵌入表示而不是input_ids
。如果您想对input_ids
索引如何转换为相关向量有比模型内部嵌入查找矩阵更多的控制,这将非常有用。 - num_hashes (
int
, 可选) — 分桶期间应执行的哈希轮数。设置此参数会覆盖config.num_hashes
中定义的默认值。更多信息请参见 ReformerConfig 中的
num_hashes
。 - labels (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]
之间(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(掩码),损失仅针对带有标签的标记计算此示例使用了一个虚假检查点,因为我们没有 Reformer 架构的掩码语言建模任务的任何可用预训练模型。
- output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量下的attentions
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor
的元组(如果传入 return_dict=False
或 config.return_dict=False
),包含根据配置 (ReformerConfig) 和输入的不同元素。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
ReformerForMaskedLM 的 forward 方法,重写了 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但此后应调用 Module
实例,而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> 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 (ReformerForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
Reformer 模型变换器,顶部带有一个序列分类/回归头(在池化输出之上有一个线性层),例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
此模型也是 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 (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 词汇表中输入序列标记的索引。训练期间,input_ids 的序列长度必须是相关模型块长度(lsh、局部或两者)的倍数。评估期间,索引会自动填充为块长度的倍数。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
,可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
,可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值选择在[0, 1]
之间:- 1 表示标记未被掩码,
- 0 表示标记被掩码。
- head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]
之间:- 1 表示头部未被掩码,
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
,可选) — 可选地,您可以选择直接传入嵌入表示而不是input_ids
。如果您想对input_ids
索引如何转换为相关向量有比模型内部嵌入查找矩阵更多的控制,这将非常有用。 - num_hashes (
int
, 可选) — 分桶期间应执行的哈希轮数。设置此参数会覆盖config.num_hashes
中定义的默认值。更多信息请参见 ReformerConfig 中的
num_hashes
。 - labels (形状为
(batch_size,)
的torch.LongTensor
,可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
之间。如果config.num_labels == 1
,则计算回归损失(均方损失);如果config.num_labels > 1
,则计算分类损失(交叉熵损失)。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量下的attentions
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor
的元组(如果传入 return_dict=False
或 config.return_dict=False
),包含根据配置 (ReformerConfig) 和输入的不同元素。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
ReformerForSequenceClassification 的 forward 方法,重写了 __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 (ReformerForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
Reformer 变换器,顶部带有一个用于抽取式问答任务(如 SQuAD)的跨度分类头(在隐藏状态输出之上有一个线性层,用于计算 span start logits
和 span end logits
)。
此模型继承自 PreTrainedModel。查阅超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
此模型也是 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 (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 词汇表中输入序列标记的索引。训练期间,input_ids 的序列长度必须是相关模型块长度(lsh、局部或两者)的倍数。评估期间,索引会自动填充为块长度的倍数。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- position_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
,可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
,可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值选择在[0, 1]
之间:- 1 表示标记未被掩码,
- 0 表示标记被掩码。
- head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]
之间:- 1 表示头部未被掩码,
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
,可选) — 可选地,您可以选择直接传入嵌入表示而不是input_ids
。如果您想对input_ids
索引如何转换为相关向量有比模型内部嵌入查找矩阵更多的控制,这将非常有用。 - num_hashes (
int
, 可选) — 分桶期间应执行的哈希轮数。设置此参数会覆盖config.num_hashes
中定义的默认值。更多信息请参见 ReformerConfig 中的
num_hashes
。 - start_positions (形状为
(batch_size,)
的torch.Tensor
,可选) — 用于计算标记分类损失的标签跨度起始位置(索引)。位置被限制在序列长度(sequence_length
)内。序列外的位置不计入损失计算。 - end_positions (形状为
(batch_size,)
的torch.Tensor
,可选) — 用于计算标记分类损失的标签跨度结束位置(索引)。位置被限制在序列长度(sequence_length
)内。序列外的位置不计入损失计算。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states
。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量下的attentions
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor
元组(如果传入 return_dict=False
或当 config.return_dict=False
时),其中包含根据配置 (ReformerConfig) 和输入而定的各种元素。
-
loss (
torch.FloatTensor
of shape(1,)
, 可选, 当提供labels
时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor
of shape(batch_size, sequence_length)
) — 范围起始分数(SoftMax 之前)。 -
end_logits (
torch.FloatTensor
of 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 后的注意力权重,用于计算自注意力头中的加权平均值。
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]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # 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
>>> round(loss.item(), 2)
...