Transformers 文档
SqueezeBERT
并获得增强的文档体验
开始使用
SqueezeBERT
概述
SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在论文 SqueezeBERT: What can computer vision teach NLP about efficient neural networks? 中提出。它是一个类似于BERT模型的双向Transformer。BERT架构和SqueezeBERT架构之间的关键区别在于，SqueezeBERT使用分组卷积来替代Q、K、V和FFN层中的全连接层。
论文摘要如下：
人类每天阅读和书写数千亿条信息。此外，由于大型数据集、大型计算系统和更好的神经网络模型的出现，自然语言处理（NLP）技术在理解、校对和组织这些信息方面取得了重大进展。因此，在众多应用中部署NLP，帮助网络用户、社交网络和企业，存在着巨大的机遇。我们特别将智能手机和其他移动设备视为大规模部署NLP模型的关键平台。然而，如今高精度的NLP神经网络模型（如BERT和RoBERTa）的计算成本极高，BERT-base在Pixel 3智能手机上对一段文本进行分类需要1.7秒。在这项工作中，我们观察到，分组卷积等方法已为计算机视觉网络带来了显著的速度提升，但许多这些技术尚未被NLP神经网络设计者采用。我们演示了如何用分组卷积替换自注意力层中的几个操作，并在一种名为SqueezeBERT的新型网络架构中使用了这项技术。SqueezeBERT在Pixel 3上的运行速度比BERT-base快4.3倍，同时在GLUE测试集上取得了有竞争力的准确率。SqueezeBERT的代码将会发布。
此模型由 forresti 贡献。
使用技巧
- SqueezeBERT是一个带有绝对位置嵌入的模型，因此通常建议在输入的右侧而不是左侧进行填充。
- SqueezeBERT类似于BERT，因此依赖于掩码语言建模（MLM）目标。因此，它在预测掩码词元和一般的自然语言理解（NLU）任务上效率很高，但对于文本生成任务并非最佳选择。使用因果语言建模（CLM）目标训练的模型在这方面表现更好。
- 为了在序列分类任务上进行微调时获得最佳结果，建议从 squeezebert/squeezebert-mnli-headless 检查点开始。
资源
SqueezeBertConfig
class transformers.SqueezeBertConfig
< 来源 >( 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 embedding_size = 768 q_groups = 4 k_groups = 4 v_groups = 4 post_attention_groups = 1 intermediate_groups = 4 output_groups = 4 **kwargs )
参数
- vocab_size (
int，可选，默认为 30522) — SqueezeBERT模型的词汇表大小。定义了在调用SqueezeBertModel时传入的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或Callable，可选，默认为"gelu") — 编码器和池化层中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float，可选，默认为 0.1) — 嵌入层、编码器和池化层中所有全连接层的丢弃概率。 - attention_probs_dropout_prob (
float，可选，默认为 0.1) — 注意力概率的丢弃率。 - max_position_embeddings (
int，可选，默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如，512、1024 或 2048）。 - type_vocab_size (
int，可选，默认为 2) — 在调用BertModel或TFBertModel时传入的token_type_ids的词汇表大小。 - initializer_range (
float，可选，默认为 0.02) — 用于初始化所有权重矩阵的truncated_normal_initializer的标准差。 - layer_norm_eps (
float，可选，默认为 1e-12) — - pad_token_id (
int，可选，默认为 0) — 词嵌入中用作填充的词元的 ID。 - embedding_size (
int，可选，默认为 768) — 词嵌入向量的维度。 - q_groups (
int，可选，默认为 4) — Q 层中的分组数。 - k_groups (
int，可选，默认为 4) — K 层中的分组数。 - v_groups (
int，可选，默认为 4) — V 层中的分组数。 - post_attention_groups (
int，可选，默认为 1) — 第一个前馈网络层中的分组数。 - intermediate_groups (
int，可选，默认为 4) — 第二个前馈网络层中的分组数。 - output_groups (
int，可选，默认为 4) — 第三个前馈网络层中的分组数。
这是一个配置类，用于存储SqueezeBertModel的配置。它用于根据指定的参数实例化一个SqueezeBERT模型，定义模型架构。使用默认值实例化配置将产生与SqueezeBERT squeezebert/squeezebert-uncased 架构类似的配置。
配置对象继承自PretrainedConfig，可用于控制模型输出。请阅读PretrainedConfig的文档以获取更多信息。
示例
>>> from transformers import SqueezeBertConfig, SqueezeBertModel
>>> # Initializing a SqueezeBERT configuration
>>> configuration = SqueezeBertConfig()
>>> # Initializing a model (with random weights) from the configuration above
>>> model = SqueezeBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configSqueezeBertTokenizer
class transformers.SqueezeBertTokenizer
< 来源 >( 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]' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **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]") — 用于掩码值的词元。这是在使用掩码语言建模训练此模型时使用的词元。这是模型将尝试预测的词元。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，这可能应该被禁用（请参阅此 问题）。
- strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值决定（与原始 SqueezeBERT 中一样）。 - clean_up_tokenization_spaces (
bool, 可选, 默认为True) — 是否在解码后清理空格，清理包括移除可能的多余空格等伪影。
构建一个 SqueezeBERT 分词器。基于 WordPiece。
此分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 源代码 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → List[int]
通过连接和添加特殊词元，从一个序列或一对序列为序列分类任务构建模型输入。一个 SqueezeBERT 序列具有以下格式：
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 源代码 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
创建与传入序列对应的标记类型 ID。什么是标记类型 ID？
如果模型有特殊的构建方式，应在子类中重写此方法。
SqueezeBertTokenizerFast
class transformers.SqueezeBertTokenizerFast
< 源代码 >( 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]' 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]") — 用于掩码值的词元。这是在使用掩码语言建模训练此模型时使用的词元。这是模型将尝试预测的词元。 - clean_text (
bool, 可选, 默认为True) — 是否在分词前通过移除任何控制字符并将所有空白替换为标准空格来清理文本。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，这可能应该被禁用（请参阅此问题）。 - strip_accents (
bool, 可选) — 是否去除所有重音符号。如果未指定此选项，则将由lowercase的值决定（与原始 SqueezeBERT 中一样）。 - wordpieces_prefix (
str, 可选, 默认为"##") — 子词的前缀。
构建一个“快速”的 SqueezeBERT 分词器（由 HuggingFace 的 tokenizers 库支持）。基于 WordPiece。
此分词器继承自 PreTrainedTokenizerFast，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
SqueezeBertModel
class transformers.SqueezeBertModel
< 源代码 >( config )
参数
- config (SqueezeBertModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
基础的 Squeezebert 模型，输出原始的隐藏状态，顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类的文档以了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 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.Tensor，形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于*句子 A*词元，
- 1 对应于*句子 B*词元。
- 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.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 而不是一个普通的元组。
返回
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），根据配置 (SqueezeBertConfig) 和输入包含不同的元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor，形状为(batch_size, hidden_size)) — 序列第一个词元（分类词元）的最后一层隐藏状态，经过用于辅助预训练任务的层的进一步处理。例如，对于 BERT 族模型，这返回经过线性层和 tanh 激活函数处理后的分类词元。线性层的权重是在预训练期间从下一句预测（分类）目标中训练的。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
SqueezeBertModel 的前向方法，重写了 `__call__` 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
SqueezeBertForMaskedLM
class transformers.SqueezeBertForMaskedLM
< 源代码 >( config )
参数
- config (SqueezeBertForMaskedLM) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
顶部带有一个语言建模头的 Squeezebert 模型。
该模型继承自 PreTrainedModel。请查看超类的文档以了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 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.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- 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` 索引转换为关联向量，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见 `input_ids` 文档字符串）。索引设置为 `-100` 的标记将被忽略（遮蔽），损失仅对标签在[0, ..., config.vocab_size]中的标记进行计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的 `hidden_states`。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），根据配置（SqueezeBertConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
SqueezeBertForMaskedLM 的前向方法会覆盖 `__call__` 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, SqueezeBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForMaskedLM.from_pretrained("squeezebert/squeezebert-uncased")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> 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)
>>> 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, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...SqueezeBertForSequenceClassification
class transformers.SqueezeBertForSequenceClassification
< 源代码 >( config )
参数
- config (SqueezeBertForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
SqueezeBERT 模型转换器，顶部带有一个序列分类/回归头（一个在池化输出之上的线性层），例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。请查看超类的文档以了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 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.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- 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` 索引转换为关联向量，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果 `config.num_labels == 1`，则计算回归损失（均方损失）；如果 `config.num_labels > 1`，则计算分类损失（交叉熵）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的 `hidden_states`。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），根据配置（SqueezeBertConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
SqueezeBertForSequenceClassification 的前向方法会覆盖 `__call__` 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, SqueezeBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForSequenceClassification.from_pretrained("squeezebert/squeezebert-uncased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> 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 = SqueezeBertForSequenceClassification.from_pretrained("squeezebert/squeezebert-uncased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, SqueezeBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForSequenceClassification.from_pretrained("squeezebert/squeezebert-uncased", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # 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 = SqueezeBertForSequenceClassification.from_pretrained(
... "squeezebert/squeezebert-uncased", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossSqueezeBertForMultipleChoice
class transformers.SqueezeBertForMultipleChoice
< 源代码 >( config )
参数
- config (SqueezeBertForMultipleChoice) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有选择题分类头的 Squeezebert 模型（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查看超类的文档以了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, 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, num_choices, sequence_length)，可选) — 用于指示输入的第一和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- position_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头未被遮蔽，
- 0 表示头被遮蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为关联向量，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]中，其中 *num_choices* 是输入张量第二维的大小。（参见上面的 *input_ids*） - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回的张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回的张量下的 `hidden_states`。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），根据配置（SqueezeBertConfig）和输入，包含各种元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
SqueezeBertForMultipleChoice 的前向方法会覆盖 `__call__` 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, SqueezeBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForMultipleChoice.from_pretrained("squeezebert/squeezebert-uncased")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsSqueezeBertForTokenClassification
class transformers.SqueezeBertForTokenClassification
< 源代码 >( config )
参数
- config (SqueezeBertForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有标记分类头的 Squeezebert 转换器（在隐藏状态输出之上有一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 PreTrainedModel。请查看超类的文档以了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 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.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- 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索引转换为相关向量，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算词元分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（SqueezeBertConfig）和输入，包含各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的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 后的注意力权重，用于计算自注意力头中的加权平均值。
SqueezeBertForTokenClassification 的 forward 方法会覆盖 __call__ 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, SqueezeBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForTokenClassification.from_pretrained("squeezebert/squeezebert-uncased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...SqueezeBertForQuestionAnswering
class transformers.SqueezeBertForQuestionAnswering
< 源代码 >( config )
参数
- config (SqueezeBertForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Squeezebert transformer，顶部带有一个用于抽取式问答任务（如SQuAD）的片段分类头（在隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。请查看超类的文档以了解该库为其所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪注意力头等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 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.Tensor，形状为(batch_size, sequence_length)，可选) — 分段词元索引，用于指示输入的第一部分和第二部分。索引的取值范围为[0, 1]：- 0 对应于 句子 A 的词元，
- 1 对应于 句子 B 的词元。
- 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索引转换为相关向量，这会很有用。 - start_positions (
torch.Tensor，形状为(batch_size,)，可选) — 用于计算词元分类损失的标记片段起始位置（索引）的标签。位置被限制在序列长度（sequence_length）内。超出序列范围的位置在计算损失时不予考虑。 - end_positions (
torch.Tensor，形状为(batch_size,)，可选) — 用于计算词元分类损失的标记片段结束位置（索引）的标签。位置被限制在序列长度（sequence_length）内。超出序列范围的位置在计算损失时不予考虑。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（SqueezeBertConfig）和输入，包含各种元素。
-
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), 可选, 当传递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 后的注意力权重，用于计算自注意力头中的加权平均值。
SqueezeBertForQuestionAnswering 的 forward 方法会覆盖 __call__ 特殊方法。
尽管前向传递的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理预处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, SqueezeBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForQuestionAnswering.from_pretrained("squeezebert/squeezebert-uncased")
>>> 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)
...