Splinter
概述
Splinter 模型由 Ori Ram、Yuval Kirstain、Jonathan Berant、Amir Globerson 和 Omer Levy 在其论文 Few-Shot Question Answering by Pretraining Span Selection 中提出。Splinter 是一种仅编码器的 Transformer（类似于 BERT），它使用在包含维基百科和多伦多图书语料库的大型语料库上的重复跨度选择任务进行预训练。
论文摘要如下：
在多个问答基准测试中，预训练模型通过在约 100,000 个带注释的问题和答案上进行微调，达到了人类水平。我们探索了更现实的小样本设置，其中只有几百个训练样本可用，并观察到标准模型的性能很差，突出了当前预训练目标与问答之间的差异。我们提出了一种针对问答量身定制的新型预训练方案：重复跨度选择。给定一段包含多组重复跨度的文本，我们对每组中除了一个之外的所有重复跨度进行掩码，并要求模型为每个掩码跨度在文本中选择正确的跨度。掩码跨度被替换为一个特殊标记，作为问题表示，稍后在微调期间用于选择答案跨度。所得模型在多个基准测试中获得了令人惊讶的良好结果（例如，在仅使用 128 个训练样本的情况下，SQuAD 上的 F1 得分为 72.7），同时在资源丰富的环境中保持了竞争力。
此模型由 yuvalkirstain 和 oriram 贡献。原始代码可以在这里找到 这里。
使用技巧
- Splinter 经过训练可以根据特殊的 [QUESTION] 标记预测答案跨度。这些标记与问题表示相关联，用于预测答案。此层称为 QASS，是 SplinterForQuestionAnswering 类中的默认行为。因此
- 使用 SplinterTokenizer（而不是 BertTokenizer），因为它已经包含了这个特殊标记。此外，当给出两个序列时（例如，在 run_qa.py 脚本中），它的默认行为是使用此标记。
- 如果您计划在 run_qa.py 之外使用 Splinter，请记住问题标记 - 它可能对模型的成功至关重要，尤其是在小样本设置中。
- 请注意，每个 Splinter 大小都有两个不同的检查点。两者基本上相同，只是其中一个还具有 QASS 层的预训练权重（tau/splinter-base-qass 和 tau/splinter-large-qass），而另一个没有（tau/splinter-base 和 tau/splinter-large）。这样做是为了支持在微调时随机初始化此层，因为论文表明在某些情况下这样做可以产生更好的结果。
资源
SplinterConfig
类 transformers.SplinterConfig
< 源代码 >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 use_cache = True pad_token_id = 0 question_token_id = 104 **kwargs )
参数
- vocab_size (
int, 可选，默认为 30522) — Splinter 模型的词汇量大小。定义了调用 SplinterModel 时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选，默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选，默认为 12) — Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, 可选，默认为 12) — Transformer 编码器中每个注意力层的注意力头的数量。 - intermediate_size (
int, 可选，默认为 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - hidden_act (
str或function, 可选，默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选，默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选，默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, 可选，默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int, 可选，默认为 2) — 调用 SplinterModel 时传递的token_type_ids的词汇量大小。 - initializer_range (
float, 可选，默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选，默认为 1e-12) — 层归一化层使用的 epsilon。
这是一个用于存储 SplinterModel 配置的类。它用于根据指定的参数实例化 Splinter 模型，定义模型架构。使用默认值实例化配置将产生与 Splinter tau/splinter-base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。请参阅 PretrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import SplinterModel, SplinterConfig
>>> # Initializing a Splinter tau/splinter-base style configuration
>>> configuration = SplinterConfig()
>>> # Initializing a model from the tau/splinter-base style configuration
>>> model = SplinterModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configSplinterTokenizer
类 transformers.SplinterTokenizer
< 源代码 >( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' question_token = '[QUESTION]' tokenize_chinese_chars = True strip_accents = None **kwargs )
参数
- vocab_file (
str) — 包含词汇表的的文件。 - do_lower_case (
bool，可选，默认为True) — 在分词时是否将输入转换为小写。 - do_basic_tokenize (
bool，可选，默认为True) — 是否在 WordPiece 之前进行基本分词。 - never_split (
Iterable，可选) — 在分词过程中永远不会被拆分的标记集合。仅当do_basic_tokenize=True时有效。 - unk_token (
str，可选，默认为"[UNK]") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。 - sep_token (
str，可选，默认为"[SEP]") — 分隔符标记，用于从多个序列构建序列，例如序列分类的两个序列或问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类器标记，用于执行序列分类（对整个序列进行分类，而不是对每个标记进行分类）。它是使用特殊标记构建序列时的第一个标记。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩盖值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - question_token (
str, 可选, 默认为"[QUESTION]") — 用于构建问题表示的标记。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对汉字进行分词。对于日语，这可能应该被禁用（参见此 问题）。
- strip_accents (
bool, 可选) — 是否去除所有变音符号。如果未指定此选项，则将由lowercase的值确定（与原始 BERT 中一样）。
构建 Splinter 分词器。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
参数
- token_ids_0 (
List[int]) — 如果 pad_on_right 为真，则为问题标记 ID，否则为上下文标记 ID - token_ids_1 (
List[int], 可选) — 如果 pad_on_right 为真，则为上下文标记 ID，否则为问题标记 ID
返回
List[int]
具有适当特殊标记的 输入 ID 列表。
通过连接和添加特殊标记，为问答任务构建一对序列的模型输入。Splinter 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 问答的一对序列：
[CLS] question_tokens [QUESTION] . [SEP] context_tokens [SEP]
get_special_tokens_mask
( token_ids_0: 列表 token_ids_1: 可选 = None already_has_special_tokens: 布尔 = False ) →List[int] 从未添加特殊令牌的令牌列表中检索序列 ID。当使用分词器 prepare_for_model 方法添加特殊令牌时，会调用此方法。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
创建对应于传递序列的令牌类型 ID。 什么是令牌类型 ID？
如果模型有构建这些 ID 的特殊方法，则应在子类中重写。
SplinterTokenizerFast
类 transformers.SplinterTokenizerFast
< 源代码 >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' question_token = '[QUESTION]' tokenize_chinese_chars = True strip_accents = None **kwargs )
参数
- vocab_file (
str) — 包含词汇表的 文件。 - do_lower_case (
bool, 可选, 默认为True) — 在分词时是否将输入转换为小写。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知词元。词汇表中不存在的词元无法转换为 ID，而是设置为此词元。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔符词元，用于从多个序列构建序列时，例如序列分类的两个序列或问答的文本和问题。它也用作使用特殊词元构建的序列的最后一个词元。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的词元，例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类器词元，用于执行序列分类（整个序列的分类，而不是每个词元的分类）。它是使用特殊词元构建的序列的第一个词元。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩蔽值的词元。使用掩蔽语言建模训练此模型时使用的词元。这是模型将尝试预测的词元。 - question_token (
str, 可选, 默认为"[QUESTION]") — 用于构建问题表示的词元。 - clean_text (
bool, 可选, 默认为True) — 在分词之前是否通过删除任何控制字符并将所有空格替换为经典空格来清理文本。 - wordpieces_prefix (
str，可选，默认为"##") — 子词的前缀。
构建一个“快速”的Splinter分词器（由HuggingFace的tokenizers库支持）。基于WordPiece。
此分词器继承自PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
参数
- token_ids_0 (
List[int]) — 如果pad_on_right，则为问题token ID，否则为上下文token ID - token_ids_1 (
List[int]，可选) — 如果pad_on_right，则为上下文token ID，否则为问题token ID
返回
List[int]
具有适当特殊标记的 输入 ID 列表。
通过连接和添加特殊标记，为问答任务构建一对序列的模型输入。Splinter 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 问答的一对序列：
[CLS] question_tokens [QUESTION] . [SEP] context_tokens [SEP]
SplinterModel
类 transformers.SplinterModel
< 源代码 >( config )
参数
- config (SplinterConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。查看from_pretrained()方法以加载模型权重。
基本的Splinter模型转换器，输出原始隐藏状态，没有任何特定的头部。此模型是PyTorch torch.nn.Module 的子类。将其用作常规的PyTorch模块，并参考PyTorch文档以了解与一般用法和行为相关的所有事项。
该模型是一个编码器（仅具有自注意力），遵循Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser和Illia Polosukhin在Attention is all you need中描述的架构。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为batch_size, sequence_length，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值从[0, 1]中选择：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (
torch.LongTensor形状为batch_size, sequence_length，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引从[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为batch_size, sequence_length，可选) — 每个输入序列标记在位置嵌入中的位置索引。从[0, config.max_position_embeddings - 1]范围内选择。 - 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 索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值选择在[0, 1]中：- 1 表示未被掩盖的标记，
- 0 表示被掩盖的标记。
- past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（其过去键值状态未提供给此模型），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（SplinterConfig）和输入的各种元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，并且如果config.is_encoder_decoder=True，则可选地包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预计算的隐藏状态（自注意力块中的键和值，以及如果
config.is_encoder_decoder=True，则可选地在交叉注意力块中），可用于（参见past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（一个用于嵌入的输出，如果模型具有嵌入层，则加一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True和config.add_cross_attention=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
SplinterModel 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, SplinterModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("tau/splinter-base")
>>> model = SplinterModel.from_pretrained("tau/splinter-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateSplinterForQuestionAnswering
类 transformers.SplinterForQuestionAnswering
< 源代码 >( config )
参数
- config (SplinterConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
Splinter 模型，在其顶部添加了一个跨度分类头，用于提取式问答任务，例如 SQuAD（在隐藏状态输出的顶部添加线性层来计算跨度开始 logits 和跨度结束 logits）。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None question_positions: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为batch_size, sequence_length，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (
torch.LongTensor形状为batch_size, sequence_length，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为batch_size, sequence_length，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围在[0, config.max_position_embeddings - 1]中。 - 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 索引转换为关联向量，这将非常有用。 - 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）内。序列之外的位置不会被考虑用于计算损失。 - question_positions (
torch.LongTensor形状为(batch_size, num_questions), 可选) — 所有问题标记的位置。如果给出，则start_logits和end_logits的形状将为(batch_size, num_questions, sequence_length)。如果为None，则批次中每个序列中的第一个问题标记将是唯一一个计算start_logits和end_logits的标记，它们的形状将为(batch_size, sequence_length)。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个torch.FloatTensor的元组（如果传递了return_dict=False或当config.return_dict=False时），包含根据配置(SplinterConfig)和输入而变化的各种元素。
-
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
SplinterForQuestionAnswering 的前向方法重写了__call__特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, SplinterForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("tau/splinter-base")
>>> model = SplinterForQuestionAnswering.from_pretrained("tau/splinter-base")
>>> 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.lossSplinterForPreTraining
类 transformers.SplinterForPreTraining
< 源代码 >( config )
参数
- config (SplinterConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看from_pretrained()方法以加载模型权重。
用于预训练期间执行的重复跨度选择任务的Splinter模型。与QA任务的区别在于，我们没有问题，而是使用多个问题标记来替换重复跨度的出现。
此模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None question_positions: Optional = None )
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_questions, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为batch_size, num_questions, sequence_length，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (
torch.LongTensor形状为batch_size, num_questions, sequence_length，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为batch_size, num_questions, sequence_length，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]中：- 1 表示头部未掩码，
- 0 表示头部掩码。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, num_questions, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids 索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - start_positions (
torch.LongTensor形状为(batch_size, num_questions), 可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size, num_questions), 可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列长度（sequence_length）内。序列外的位置不会被考虑用于计算损失。 - question_positions (
torch.LongTensor形状为(batch_size, num_questions), 可选) — 所有问题标记的位置。如果给出，start_logits 和 end_logits 的形状将为(batch_size, num_questions, sequence_length)。如果为 None，则批次中每个序列中的第一个问题标记将是唯一计算 start_logits 和 end_logits 的标记，它们的形状将为(batch_size, sequence_length)。
SplinterForPreTraining 的 forward 方法重写了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应调用 Module 实例，而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。