Hugging Face 的徽标

Transformers 文档

I-BERT

Hugging Face's logo
加入Hugging Face社区

并获得增强型文档体验

开始使用

I-BERT

概述

I-BERT 模型由 Sehoon Kim、Amir Gholami、Zhewei Yao、Michael W. Mahoney 和 Kurt Keutzer 在I-BERT：纯整数 BERT 量化 中提出。它是一个量化的 RoBERTa 版本，推理速度提高了四倍。

论文中的摘要如下：

基于 Transformer 的模型，如 BERT 和 RoBERTa，在许多自然语言处理任务中取得了最先进的结果。但是，它们的内存占用、推理延迟和功耗对于边缘的有效推理来说是禁止的，即使是在数据中心也是如此。虽然量化可以作为该问题的可行解决方案，但之前关于量化基于 Transformer 的模型的工作在推理过程中使用浮点运算，这不能有效地利用仅整数逻辑单元，例如最近的 Turing Tensor Cores 或传统的仅整数 ARM 处理器。在这项工作中，我们提出了 I-BERT，一种用于基于 Transformer 的模型的新型量化方案，它使用仅整数运算对整个推理进行量化。基于非线性操作的轻量级仅整数近似方法，例如 GELU、Softmax 和层归一化，I-BERT 执行端到端的仅整数 BERT 推理，无需任何浮点计算。我们使用 RoBERTa-Base/Large 在 GLUE 下游任务上评估了我们的方法。我们表明，在这两种情况下，与全精度基线相比，I-BERT 都能实现相似（略高）的精度。此外，我们对 I-BERT 的初步实现显示，与 FP32 推理相比，在 T4 GPU 系统上进行 INT8 推理的加速比为 2.4 - 4.0 倍。该框架是在 PyTorch 中开发的，并已开源。

此模型由kssteven 贡献。原始代码可以在这里找到here。

资源

IBertConfig

class transformers.IBertConfig

< >

( 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 = 1 bos_token_id = 0 eos_token_id = 2 position_embedding_type = 'absolute' quant_mode = False force_dequant = 'none' **kwargs )

参数

  • vocab_size (int, optional, defaults to 30522) — I-BERT 模型的词汇量。定义了调用 IBertModel 时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, optional, defaults to 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, optional, defaults to 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, optional, defaults to 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) — 调用 IBertModel 时传递的 token_type_ids 的词汇量
  • initializer_range (float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态初始化的标准差。
  • layer_norm_eps (float, 可选, 默认值为 1e-12) — 层归一化层使用的 epsilon。
  • position_embedding_type (str, 可选, 默认值为 "absolute") — 位置嵌入的类型。 选择 "absolute"、"relative_key"、"relative_key_query" 之一。 对于位置嵌入，使用 "absolute"。 有关 "relative_key" 的更多信息，请参阅 带有相对位置表示的自注意力（Shaw 等人）。 有关 "relative_key_query" 的更多信息，请参阅 使用更好的相对位置嵌入改进 Transformer 模型（Huang 等人） 中的方法 4。
  • quant_mode (bool, 可选, 默认值为 False) — 是否对模型进行量化。
  • force_dequant (str, 可选, 默认值为 "none") — 强制量化特定非线性层。然后将量化后的层以全精度执行。 支持 "none"、"gelu"、"softmax"、"layernorm" 和 "nonlinear"。 作为默认值，它被设置为 "none"，它不量化任何层。 请指定 "gelu"、"softmax" 或 "layernorm" 分别对 GELU、Softmax 或 LayerNorm 进行量化。 "nonlinear" 将量化所有非线性层，即 GELU、Softmax 和 LayerNorm。

这是存储 IBertModel 配置的配置类。 它用于根据指定的参数实例化 I-BERT 模型，定义模型架构。 使用默认值实例化配置将产生与 IBERT kssteven/ibert-roberta-base 架构类似的配置。

配置对象继承自 PretrainedConfig 并可用于控制模型输出。 阅读 PretrainedConfig 的文档以了解更多信息。

IBertModel

类 transformers.IBertModel

< >

( config add_pooling_layer = True )

参数

  • config (IBertConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重，只会加载配置。 查看 from_pretrained() 方法以加载模型权重。

不带 I-BERT 模型变压器的输出，输出原始隐藏状态，没有顶部的特定头部。

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

此模型也是 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 中描述的架构。

前向

< >

( 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 output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID?

  • 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 令牌。

    什么是令牌类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID？

  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 掩码以使自注意力模块的选定头部无效。掩码值在 [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.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（IBertConfig）和输入的各种元素。

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

  • 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 之后，用于计算交叉注意力头中的加权平均值。

  • past_key_values (tuple(tuple(torch.FloatTensor))，可选，在传递了 use_cache=True 或当 config.use_cache=True 时返回) — tuple(torch.FloatTensor) 元组，长度为 config.n_layers，每个元组具有 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 输入）加速顺序解码。

The IBertModel 正向方法，重写 __call__ 特殊方法。

尽管正向传递的配方需要在这个函数中定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, IBertModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertModel.from_pretrained("kssteven/ibert-roberta-base")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

IBertForMaskedLM

class transformers.IBertForMaskedLM

< >

( config )

参数

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

带有 语言建模 头部的 I-BERT 模型。

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

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

前向

< >

( 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 labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或者 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词元的词汇索引。

    可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取更多信息。

    什么是输入 ID？

  • 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 词元。

    什么是词元类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列词元位置的索引。 选择在 [0, config.max_position_embeddings - 1] 范围内。

    什么是位置 ID？

  • 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，而不是一个简单的元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 用于计算掩蔽语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中（参见 input_ids 文档字符串）。索引设置为 -100 的标记被忽略（掩蔽），损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。
  • kwargs (Dict[str, any]，可选，默认为 {}) — 用于隐藏已弃用的旧版参数。

返回

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

一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含根据配置（IBertConfig）和输入而有所不同的各种元素。

  • loss (torch.FloatTensor 形状为 (1,)，可选，在提供 labels 时返回) — 掩蔽语言建模 (MLM) 损失。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。

The IBertForMaskedLM 前向方法，覆盖 __call__ 特殊方法。

尽管正向传递的配方需要在这个函数中定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, IBertForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertForMaskedLM.from_pretrained("kssteven/ibert-roberta-base")

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

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

IBertForSequenceClassification

class transformers.IBertForSequenceClassification

< >

( config )

参数

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

I-BERT 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。

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

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

前向

( 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 labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词语在词汇表中的索引。

    索引可以通过 AutoTokenizer 获取。有关详情，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 ID？

  • 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 词语。

    什么是词语类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 每个输入序列词语在位置嵌入中的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。

    什么是位置 ID？

  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于将自注意力模块中选定的头部设为零的掩码。掩码值选择在 [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 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵）。

返回

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

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（IBertConfig）和输入的各种元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选，在提供 labels 时返回) — 分类（如果 config.num_labels==1 则为回归）损失。

  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类（如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。

  • hidden_states (tuple(torch.FloatTensor)，可选，在传递了 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组（一个用于嵌入的输出，如果模型具有嵌入层，+ 每个层的输出一个），形状为 (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 后的注意力权重，用于计算自注意力头中的加权平均值。

The IBertForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。

尽管正向传递的配方需要在这个函数中定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, IBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertForSequenceClassification.from_pretrained("kssteven/ibert-roberta-base")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()

>>> # 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 = IBertForSequenceClassification.from_pretrained("kssteven/ibert-roberta-base", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, IBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertForSequenceClassification.from_pretrained("kssteven/ibert-roberta-base", 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 = IBertForSequenceClassification.from_pretrained(
...     "kssteven/ibert-roberta-base", 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).loss

IBertForMultipleChoice

class transformers.IBertForMultipleChoice

< >

( config )

参数

  • config (IBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。

I-BERT 模型，顶部是多选分类头（池化输出顶部的线性层和 softmax），例如用于 RocStories/SWAG 任务。

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

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

前向

< >

( input_ids: Optional = None token_type_ids: Optional = None attention_mask: Optional = None labels: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length)) — 输入序列标记在词汇表中的索引。

    可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID？

  • attention_mask (torch.FloatTensor 形状为 (batch_size, num_choices, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值：

    • 1 表示未掩码的标记，
    • 0 表示掩码的标记。

    什么是注意力掩码？

  • token_type_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length)，可选) — 用于指示输入的第一个和第二个部分的段标记索引。索引在 [0, 1] 中选择：

    • 0 对应于 句子 A 标记，
    • 1 对应于 句子 B 标记。

    什么是 token type IDs？

  • position_ids (torch.LongTensor 形状为 (batch_size, num_choices, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是 position IDs？

  • head_mask (torch.FloatTensor 形状为 (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 索引转换为关联的向量有更多控制权，这将很有用。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的 hidden_states。
  • return_dict (bool，可选) — 是否返回一个 ModelOutput，而不是一个简单的元组。
  • labels (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在 [0, ..., num_choices-1] 中，其中 num_choices 是输入张量的第二维的大小。（参见上面的 input_ids）

返回

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

一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包括根据配置 (IBertConfig) 和输入而变化的各种元素。

  • loss (torch.FloatTensor 形状为 (1,)，可选，在提供 labels 时返回) — 分类损失。

  • logits (torch.FloatTensor 形状为 (batch_size, num_choices)) — 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 后的注意力权重，用于计算自注意力头中的加权平均值。

The IBertForMultipleChoice 正向方法，覆盖了 __call__ 特殊方法。

尽管正向传递的配方需要在这个函数中定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, IBertForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertForMultipleChoice.from_pretrained("kssteven/ibert-roberta-base")

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

IBertForTokenClassification

class transformers.IBertForTokenClassification

  • config (IBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法来加载模型权重。

I-BERT 模型，在顶部有一个令牌分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别（NER）任务。

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

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

前向

< >

( 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 labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。

    索引可以通过 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

    什么是输入 ID？

  • 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 令牌。

    什么是令牌类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列令牌在位置嵌入中的位置索引。选择在 [0, config.max_position_embeddings - 1] 范围内。

    什么是位置 ID？

  • head_mask (torch.FloatTensor 形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 掩码以使自注意力模块的选定头部无效。掩码值选择在 [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 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算令牌分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。

返回

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

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含根据配置（IBertConfig）和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,), 可选, 当提供 labels 时返回) — 分类损失。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.num_labels)) — 分类分数（在 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 后的注意力权重，用于计算自注意力头中的加权平均值。

The IBertForTokenClassification 正向方法，覆盖了 __call__ 特殊方法。

尽管正向传递的配方需要在这个函数中定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, IBertForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertForTokenClassification.from_pretrained("kssteven/ibert-roberta-base")

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

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss

IBertForQuestionAnswering

class transformers.IBertForQuestionAnswering

< >

( config )

参数

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

I-BERT 模型，顶部有一个跨度分类头，用于提取式问答任务，如 SQuAD（在隐藏状态输出之上添加线性层，以计算 span start logits 和 span end logits）。

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

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

前向

< >

( 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 ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。

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

    什么是输入 ID？

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免对填充 token 索引执行注意力。掩码值在 [0, 1] 中选择：

    • 1 表示未掩码的 token，
    • 0 表示掩码的 token。

    什么是注意力掩码？

  • token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 段 token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：

    • 0 对应于句子 A token，
    • 1 对应于句子 B token。

    什么是 token 类型 ID？

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 位置的索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID？

  • 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,)，可选) — 用于计算 token 分类损失的标记跨度开始位置（索引）的标签。位置被钳制到序列的长度（sequence_length）。序列外的位置不会被考虑用于计算损失。
  • end_positions (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算令牌分类损失的标记跨度的结束位置（索引）的标签。 位置被钳制到序列的长度（sequence_length）。 序列之外的位置不会被考虑用于计算损失。

返回

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

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

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

The IBertForQuestionAnswering 正向方法，重写了 __call__ 特殊方法。

尽管正向传递的配方需要在这个函数中定义，但应该随后调用 Module 实例，而不是这个函数，因为前者负责运行前处理和后处理步骤，而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, IBertForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("kssteven/ibert-roberta-base")
>>> model = IBertForQuestionAnswering.from_pretrained("kssteven/ibert-roberta-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.loss
< > Update on GitHub

←HerBERT Jamba→