Transformers 文档
Splinter
并获得增强的文档体验
开始使用
此模型于 2021-01-02 发布,并于 2021-08-17 添加到 Hugging Face Transformers。
Splinter
概述
Splinter 模型由 Ori Ram、Yuval Kirstain、Jonathan Berant、Amir Globerson、Omer Levy 在 Few-Shot Question Answering by Pretraining Span Selection 中提出。Splinter 是一种仅编码器 transformer(类似于 BERT),它使用在包含 Wikipedia 和 Toronto Book Corpus 的大型语料库上进行的循环跨度选择任务进行预训练。
论文摘要如下:
在几个问答基准测试中,预训练模型通过在约 100,000 个带注释的问题和答案上进行微调,达到了人类水平。我们探索了更现实的少样本设置,在这种设置中,只有几百个训练示例可用,并观察到标准模型的表现不佳,这突显了当前预训练目标与问答之间的差异。我们提出了一种为问答量身定制的新预训练方案:循环跨度选择。给定一个包含多个循环跨度集的段落,我们在每个集中屏蔽除一个之外的所有循环跨度,并要求模型为每个被屏蔽的跨度选择段落中的正确跨度。被屏蔽的跨度被替换为一个特殊标记,该标记被视为问题表示,稍后在微调期间用于选择答案跨度。结果模型在多个基准测试上取得了惊人的好成绩(例如,在 SQuAD 上使用仅 128 个训练示例时 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
class 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 pad_token_id = 0 bos_token_id = None eos_token_id = None question_token_id = 104 **kwargs )
参数
- vocab_size (
int, optional, 默认为 30522) — Splinter 模型词汇表大小。定义调用 SplinterModel 时,inputs_ids可以表示的不同 token 的数量。 - hidden_size (
int, optional, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, optional, 默认为 12) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, optional, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int, optional, 默认为 3072) — Transformer 编码器中“中间”(即前馈)层的大小。 - hidden_act (
str或function, optional, 默认为"gelu") — 编码器和池化层中的非线性激活函数(函数或字符串)。如果是字符串,支持"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout_prob (
float, optional, 默认为 0.1) — 嵌入层、编码器和池化层中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, optional, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, optional, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值(例如 512、1024 或 2048)。 - type_vocab_size (
int, optional, 默认为 2) — 调用 SplinterModel 时传递的token_type_ids的词汇表大小。 - initializer_range (
float, optional, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - question_token_id (
int, optional, 默认为 104) —[QUESTION]标记的 id。
这是用于存储 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
class transformers.SplinterTokenizer
< 源代码 >( vocab: str | dict[str, int] | None = None do_lower_case: bool = True unk_token: str = '[UNK]' 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 | None = None **kwargs )
参数
- vocab_file (
str, optional) — 词汇表文件的路径。 - tokenizer_file (
str, optional) — 包含分词器序列化的分词器 JSON 文件的路径。 - do_lower_case (
bool, optional, 默认为True) — 在分词时是否将输入小写。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知标记。词汇表中不存在的标记将无法转换为 ID,而是设置为此标记。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔标记,在构建由多个序列组成的序列时使用。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的标记,例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类标记,在进行序列分类时使用。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩码值(masking values)的标记。 - question_token (
str, 可选, 默认为"[QUESTION]") — 用于构建问题表示的标记。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。 - strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项,则由lowercase的值决定。 - vocab (
str,dict或list, 可选) — 自定义词汇表字典。如果未提供,则创建一个最小词汇表。
构造一个 Splinter 分词器(基于 HuggingFace 的 tokenizers 库)。基于 WordPiece。
此分词器继承自 TokenizersBackend,其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
get_special_tokens_mask
< source >( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表
Retrieve sequence ids from a token list that has no special tokens added.
For fast tokenizers, data collators call this with already_has_special_tokens=True to build a mask over an already-formatted sequence. In that case, we compute the mask by checking membership in all_special_ids.
SplinterTokenizerFast
class transformers.SplinterTokenizer
< 源代码 >( vocab: str | dict[str, int] | None = None do_lower_case: bool = True unk_token: str = '[UNK]' 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 | None = None **kwargs )
参数
- vocab_file (
str, optional) — 词汇表文件的路径。 - tokenizer_file (
str, optional) — 包含分词器序列化的分词器 JSON 文件的路径。 - do_lower_case (
bool, optional, 默认为True) — 在分词时是否将输入小写。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知标记。词汇表中不存在的标记将无法转换为 ID,而是设置为此标记。 - sep_token (
str, 可选, 默认为"[SEP]") — 分隔标记,在构建由多个序列组成的序列时使用。 - pad_token (
str, 可选, 默认为"[PAD]") — 用于填充的标记,例如在批处理不同长度的序列时。 - cls_token (
str, 可选, 默认为"[CLS]") — 分类标记,在进行序列分类时使用。 - mask_token (
str, 可选, 默认为"[MASK]") — 用于掩码值(masking values)的标记。 - question_token (
str, 可选, 默认为"[QUESTION]") — 用于构建问题表示的标记。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。 - strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项,则由lowercase的值决定。 - vocab (
str,dict或list, 可选) — 自定义词汇表字典。如果未提供,则创建一个最小词汇表。
构造一个 Splinter 分词器(基于 HuggingFace 的 tokenizers 库)。基于 WordPiece。
此分词器继承自 TokenizersBackend,其中包含大部分主要方法。用户应参考此父类了解有关这些方法的更多信息。
SplinterModel
class transformers.SplinterModel
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (SplinterModel) — 模型配置类,包含模型的全部参数。使用配置文件初始化不加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法以加载模型权重。
输出原始隐藏状态(hidden-states)的纯 Splinter 模型,顶部没有特定的头(head)。
此模型继承自 PreTrainedModel。查看其父类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 输入序列标记的索引。默认忽略填充。可以使用 AutoTokenizer 获得索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(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]中。 - inputs_embeds (
torch.Tensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以直接传入嵌入表示,而不是传入input_ids。这在您希望比模型的内部嵌入查找矩阵对如何将input_ids索引转换为相关向量有更多控制时很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。更多细节见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。更多细节见返回张量下的hidden_states。 - return_dict (
bool, optional) — 如果为True,则返回一个 ModelOutput 对象,否则返回一个包含各种元素的元组。
返回
transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),其中包含的元素取决于配置(SplinterConfig)和输入。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
SplinterModel 的前向传播方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。
SplinterForQuestionAnswering
class transformers.SplinterForQuestionAnswering
< 源代码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (SplinterForQuestionAnswering) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
Splinter transformer 带有在顶部的跨度分类头,用于提取式问答任务,如 SQuAD(在线性层之上计算 span start logits 和 span end logits)。
此模型继承自 PreTrainedModel。查看其父类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None question_positions: torch.LongTensor | None = None **kwargs ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor, 形状(batch_size, sequence_length), optional) — 输入序列的词汇表索引。默认情况下会忽略填充。索引可以通过 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择:- 1 表示未被掩码的标记,
- 0 表示被掩码的标记。
- token_type_ids (
torch.LongTensor, 形状batch_size, sequence_length, optional) — 用于指示输入的第一个和第二个部分的段标记索引。索引在[0, 1]中选择:- 0 对应于一个句子 A 标记,
- 1 对应于一个句子 B 标记。
- position_ids (
torch.LongTensor, 形状batch_size, sequence_length, optional) — 输入序列中每个标记的位置索引。选择范围在[0, config.max_position_embeddings - 1]。 - inputs_embeds (
torch.Tensor, 形状(batch_size, sequence_length, hidden_size), optional) — 可选地,您可以直接传入嵌入表示,而不是传入input_ids。当您希望对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更多的控制时,这很有用。 - start_positions (
torch.LongTensor, 形状(batch_size,), optional) — 用于计算标记分类损失的标签(跨度起始位置的索引)。位置被限制在序列长度(sequence_length)内。计算损失时,序列外的任何位置都不会被考虑在内。 - end_positions (
torch.LongTensor, 形状(batch_size,), optional) — 用于计算标记分类损失的标签(跨度结束位置的索引)。位置被限制在序列长度(sequence_length)内。计算损失时,序列外的任何位置都不会被考虑在内。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。更多细节见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。更多细节见返回张量下的hidden_states。 - return_dict (
bool, optional) — 如果为True,则返回一个 ModelOutput 对象,否则返回一个包含各种元素的元组。 - question_positions (
torch.LongTensor, 形状(batch_size, num_questions), optional) — 所有问题标记的位置。如果提供了此参数,则 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.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数(SoftMax 之前)。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数(SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
SplinterForQuestionAnswering 的前向传播方法,覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
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]
>>> 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)
...SplinterForPreTraining
class transformers.SplinterForPreTraining
< 源代码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (SplinterForPreTraining) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
Splinter 模型用于在预训练期间执行的重复跨度选择任务。与 QA 任务的区别在于我们没有问题,而是有多个问题标记来替换重复跨度的出现位置。
此模型继承自 PreTrainedModel。查看其父类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头等)。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None question_positions: torch.LongTensor | None = None **kwargs ) → transformers.models.splinter.modeling_splinter.SplinterForPreTrainingOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, num_questions, sequence_length)) — 序列中标记的索引(在词汇表中)。索引可以通过 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中:- 1 表示未被掩码的标记,
- 0 表示被掩码的标记。
- token_type_ids (
torch.LongTensorof shapebatch_size, num_questions, sequence_length, optional) — 用于指示输入的第一个和第二个部分的段标记索引。索引选择在[0, 1]中:- 0 对应于句子 A 标记,
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensorof shapebatch_size, num_questions, sequence_length, optional) — 每个输入序列标记在位置嵌入中的索引。选择范围在[0, config.max_position_embeddings - 1]。 - inputs_embeds (
torch.FloatTensorof shape(batch_size, num_questions, sequence_length, hidden_size), optional) — 也可以直接传入嵌入表示,而不是传入 input_ids。如果你想对如何将 input_ids 索引转换为相关向量有更多的控制,而不是使用模型的内部嵌入查找矩阵,这会很有用。 - start_positions (
torch.LongTensorof shape(batch_size, num_questions), optional) — 用于计算标记分类损失的标记(索引)位置标签。位置被限制在序列长度(sequence_length)内。计算损失时,序列外的定位不被考虑在内。 - end_positions (
torch.LongTensorof shape(batch_size, num_questions), optional) — 用于计算标记分类损失的标记(索引)位置标签。位置被限制在序列长度(sequence_length)内。计算损失时,序列外的定位不被考虑在内。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 如果为 True,则返回一个 ModelOutput 而不是一个普通的元组。 - question_positions (
torch.LongTensorof shape(batch_size, num_questions), optional) — 所有问题标记的位置。如果提供了,start_logits 和 end_logits 的形状将是(batch_size, num_questions, sequence_length)。如果为 None,则仅计算批次中每个序列的第一个问题标记的 start_logits 和 end_logits,它们的形状将是(batch_size, sequence_length)。
返回
transformers.models.splinter.modeling_splinter.SplinterForPreTrainingOutput 或 tuple(torch.FloatTensor)
如果传递了 return_dict=False 或当 config.return_dict=False 时,是一个 transformers.models.splinter.modeling_splinter.SplinterForPreTrainingOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False),其中包含根据配置(SplinterConfig)和输入而变化的各种元素。
-
loss (
torch.FloatTensorof shape(1,), optional, 在提供开始和结束位置时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, num_questions, sequence_length)) — 跨度开始分数(在 SoftMax 之前)。 -
end_logits (
torch.FloatTensorof shape(batch_size, num_questions, sequence_length)) — 跨度结束分数(在 SoftMax 之前)。 -
hidden_states (
tuple[torch.FloatTensor] | None.hidden_states, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组(一个用于嵌入的输出,如果模型有嵌入层,+ 每个层的输出),形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple[torch.FloatTensor] | None.attentions, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
transformers.SplinterForPreTraining 前向方法,覆盖 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用
Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。