Transformers文档

RemBERT

Hugging Face's logo
加入Hugging Face社区

并获取增强文档体验

开始使用

RemBERT

概览

RemBERT模型由Hyung Won Chung、Thibault Févry、Henry Tsai、Melvin Johnson、Sebastian Ruder在《在生产文本语言模型中重新思考嵌入耦合》(Rethinking Embedding Coupling in Pre-trained Language Models)论文中提出。

论文摘要如下

我们重新评估了在最新预训练语言模型中共享输入和输出嵌入权重标准做法。我们证明了解耦的嵌入提供了更高的建模灵活性,使我们能够显著提高多语言模型输入嵌入参数分配的效率。通过在Transformer层中重新分配输入嵌入参数,我们在微调期间使用相同数量的参数实现了在标准自然语言理解任务上的大幅度性能提升。我们还显示,向输出嵌入分配额外的容量有益于模型,这些好处在微调阶段持续存在,尽管输出嵌入在预训练后会被丢弃。我们的分析表明,更大的输出嵌入可以防止模型的最底层过度专门化到预训练任务,并鼓励Transformer表示更通用,更适合其他任务和语言。利用这些发现,我们能够在微调期间不增加参数数量的情况下,在XTREME基准上训练出表现强大的模型。

使用技巧

对于微调,RemBERT可以被视为一个类似ALBERT分解嵌入层的mBERT更大的版本。与BERT不同,其在预训练过程中没有将嵌入绑定,这使输入嵌入(在微调期间保留)可以更小,输出嵌入(在微调时丢弃)可以更大。分词器也类似于Albert的,而不是BERT的。

资源

RemBertConfig

transformers.RemBertConfig

< >

(

参数

  • vocab_size (int, 可选, 默认为 250300) — RemBERT 模型的词汇表大小。定义了通过 inputs_ids 在调用 RemBertModelTFRemBertModel 时的 inputs_ids 所能表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为 1152) — 解码器层和池化层的空间维度。
  • num_hidden_layers (int, 可选, 默认为 32) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为18) — 每个Transformer编码器注意力层的注意力头数。
  • input_embedding_size (int, 可选, 默认为256) — 输入嵌入的维度。
  • output_embedding_size (int, 可选, 默认为1664) — 输出嵌入的维度。
  • intermediate_size (int, 可选, 默认为4608) — Transformer编码器中“中间”层(即前馈层)的维度。
  • hidden_act (strfunction可选,默认为 "gelu") — 编码器和解码器中的非线性激活函数(函数或字符串)。如果为字符串,支持 "gelu""relu""selu""gelu_new"
  • hidden_dropout_prob (float可选,默认为 0) — 嵌入层、编码器和解码器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float可选,默认为 0) — 注意力概率的dropout比例。
  • classifier_dropout_prob (float, 可选,默认为0.1) — 微调时分类器层的dropout比率。
  • max_position_embeddings (int, 可选,默认为512) — 该模型可能用到的最大序列长度。通常设置为较大的值以备不时之需(例如,512或1024或2048)。
  • type_vocab_size (int, 可选,默认为2) — 当调用 RemBertModelTFRemBertModel 时传入的 token_type_ids 的词汇表大小。
  • initializer_range (float, 可选, 默认为 0.02) — 初始化所有权重矩阵所使用的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。
  • is_decoder (bool, 可选, 默认为 False) — 模型是否作为解码器使用。如果 False,则模型作为编码器使用。
  • use_cache (bool, optional, defaults to True) — 是否模型应该返回最后的键/值注意力(不是所有模型都使用)。只有当 config.is_decoder=True 时才相关。

这是一个存储 RemBertModel 配置的配置类。它用于根据指定的参数实例化一个 RemBERT 模型,定义模型架构。使用默认值实例化配置将产生与 RemBERT google/rembert 架构类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型的输出。有关更多信息,请参阅 PretrainedConfig 文档。

示例

>>> from transformers import RemBertModel, RemBertConfig

>>> # Initializing a RemBERT rembert style configuration
>>> configuration = RemBertConfig()

>>> # Initializing a model from the rembert style configuration
>>> model = RemBertModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

RemBertTokenizer

class transformers.RemBertTokenizer

< >

( vocab_file do_lower_case = False remove_space = True keep_accents = True bos_token = '[CLS]' eos_token = '[SEP]' unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' kwargs )

参数

  • vocab_file (str) — 包含创建分词器所需词汇表的 SentencePiece 文件(通常有 .spm 扩展名)。
  • bos_token (str, 可选, 默认为 "[CLS]") — 在预训练期间使用的序列起始标记。可以用作序列分类标记。

    在用特殊标记构建序列时,这不是用于序列起始的标记。使用的标记是 cls_token

  • eos_token (str, 可选, 默认为 "[SEP]") — 序列结束标记。

    在用特殊标记构建序列时,这不是用于序列结束的标记。使用的标记是 sep_token

  • unk_token (str, 可选, 默认为 "<unk>") — 未知标记。不在词汇表中的标记无法转换为ID,并将其设置为该标记。sep_tokenstr可选,默认为"[SEP]")——用于将多个序列构建为一个序列时的分隔符,例如在序列分类(将整个序列分类而非按单词分类)或问题回答(文本和问题)中使用。它还被用作由特殊令牌构建的序列的最后一个令牌。
  • pad_tokenstr可选,默认为"")——用于填充的令牌,例如在处理不同长度的序列批次时。
  • cls_tokenstr可选,默认为"[CLS]")——用于序列分类(整个序列的分类而非按词分类)的分类令牌。当用特殊令牌构建序列时,它是序列的第一个令牌。
  • mask_token (str, 可选, 默认为 "[MASK]") — 用于掩码值的标记。这是在用掩码语言建模训练模型时使用的标记。这是模型将尝试预测的标记。
  • sp_model (SentencePieceProcessor) — 用于每个转换(字符串、标记和ID)的 SentencePiece 处理器。

构建一个RemBERT标记器。基于SentencePiece

此标记器从PreTrainedTokenizer继承,其中包含大多数主要方法。用户应参考该超类以了解有关这些方法的更多信息。

build_inputs_with_special_tokens

< >

( token_ids_0: 列表 token_ids_1: 可选 = None ) 列表[int]

参数

  • token_ids_0 (代码列表[int]) — 特殊符号将添加到的ID列表。
  • token_ids_1 (代码列表[int], 可选) — 可选的第二个ID列表,用于序列对。

返回值

代码列表[int]

包含适当特殊符号的输入ID的列表。

通过连接并添加特殊符号,从序列或序列对构建用于序列分类任务模型输入。一个REMBERT序列具有以下格式

  • 单个序列: [CLS] X [SEP]
  • 序列对: [CLS] A [SEP] B [SEP]

get_special_tokens_mask

< >

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) List[int]

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], 可选) — 可选的第二组 ID 列表用于序列对。
  • already_has_special_tokens (bool, 可选, 默认为 False) — token 列表是否有为模型预格式化的特殊 token。

返回值

代码列表[int]

范围内的整数列表 [0, 1]:1 代表特殊 token,0 代表序列 token。

从没有添加特殊标记的标记列表中检索序列ID。此方法在通过分词器 prepare_for_model 方法添加特殊标记时调用。

create_token_type_ids_from_sequences

< >

( token_ids_0: 列表 token_ids_1: 可选 = None ) 列表[int]

参数

  • token_ids_0 (List[int]) — ID列表。
  • token_ids_1 (List[int], optional) — 可选的第二个ID列表,用于序列对。

返回值

代码列表[int]

根据给定的序列(s)生成令牌类型ID列表。

创建一个掩码,用于在序列对分类任务中使用。在RemBERT

序列对掩码的格式如下

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1None,则此方法仅返回掩码的前一部分(0s)。

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

RemBertTokenizerFast

transformers.RemBertTokenizerFast

< >

( vocab_file = None tokenizer_file = None do_lower_case = True remove_space = True keep_accents = False bos_token = '[CLS]' eos_token = '[SEP]' unk_token = '<unk>' sep_token = '[SEP]' pad_token = '<pad>' cls_token = '[CLS]' mask_token = '[MASK]' **kwargs )

参数

  • vocab_file (str) — 含有生成分词器所需词汇表的 SentencePiece 文件(通常具有 .spm 扩展名)。
  • do_lower_case (bool, 可选, 默认为 True) — 是否在分词时将输入转换为小写。
  • remove_space (bool, 可选, 默认为 True) — 在分词时是否去除文本中的空格(去除字符串前后多余的空格)。
  • keep_accents (bool, 可选, 默认为 False) — 在分词时是否保留重音符号。
  • bos_token (str, 可选, 默认为 "[CLS]") — 预训练期间使用的序列起始标记。可以用作序列分类标记。

  • eos_token (str, 可选, 默认为 "[SEP]") — 序列结束标记。.. 注意:在构建使用特殊标记的序列时,这个标记不是用于序列结束的标记。使用的标记是 sep_token
  • unk_token (str, 可选, 默认为 "<unk>") — 未知标记。不在词汇表中的标记无法转换为ID,将设置为该标记。
  • sep_token (str, 可选, 默认为 "[SEP]") — 分隔符标记,用于将多个序列构建为一个序列时,例如用于序列分类的两个序列或用于问答的一个文本和一个问题。它也用作特殊标记构建的序列的最后标记。
  • pad_token (str, 可选,默认为 "<pad>") — 用于填充的标记,例如在使用不同长度的序列进行批处理时。
  • cls_token (str, 可选,默认为 "[CLS]") — 用于序列分类(对整个序列进行分类而不是对每个标记进行分类)的分类器标记。当使用特殊标记构建时,它是序列的第一个标记。
  • mask_token (str, 可选,默认为 "[MASK]") — 用于标记遮盖值的标记。这是在用遮盖语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。

构建一个“快速”的 RemBert 标记化器(由 HuggingFace 的 tokenizers 库支持)。基于 Unigram。此标记化器继承自 PreTrainedTokenizerFast,其中包含大部分主要方法。用户应参考这个超类来了解更多关于这些方法的信息。

build_inputs_with_special_tokens

< >

( token_ids_0: 列表 token_ids_1: 可选 = None ) 列表[int]

参数

  • token_ids_0 (列表[int]) — 将添加特殊标记的ID列表。
  • token_ids_1 (列表[int], 可选, 默认为 None) — 序列对的第二个ID列表(可选)。

返回值

代码列表[int]

添加适当特殊标记的输入ID列表。

通过连接并添加特殊标记,从序列或序列对构建模型输入,用于序列分类任务。RemBERT序列的格式如下

  • 单个序列: [CLS] X [SEP]
  • 序列对: [CLS] A [SEP] B [SEP]

get_special_tokens_mask

< >

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) List[int]

参数

  • token_ids_0 (List[int]) — IDs 的列表。
  • token_ids_1 (List[int], 可选, 默认为 None) — 序列对的第二个 ID 列表的可选项。
  • already_has_special_tokens (bool可选,默认为 False)—— 如果标记列表已经格式化了模型特殊标记,则将其设置为 True

返回值

代码列表[int]

范围内的整数列表 [0, 1]:1 代表特殊 token,0 代表序列 token。

从没有添加特殊标记的标记列表中检索序列 ID。当使用标记器 prepare_for_model 方法添加特殊标记时调用此方法。

create_token_type_ids_from_sequences

< >

( token_ids_0: 列表 token_ids_1: 可选 = None ) 列表[int]

参数

  • token_ids_0 (整数列表) — IDs 的列表。
  • token_ids_1 (List[int], 可选, 默认为 None) — 可选的用于序列对的第二个ID列表。

返回值

代码列表[int]

根据给定的序列(s)生成令牌类型ID列表。

从传递给序列对分类任务的两个序列中创建一个掩码。

序列对掩码的格式如下

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果token_ids_1为None,则仅返回掩码的第一部分(0s)。

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

Pytorch
隐藏 Pytorch 内容

RemBertModel

transformers.RemBertModel

< >

( config add_pooling_layer = True )

参数

  • config (RemBertConfig) — Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the from_pretrained() method to load the model weights.

裸露的 RemBERT 模型 transformer,输出原始隐藏状态,顶部没有特定头。这个模型是 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 中的架构。

要作为解码器行为,模型需要将配置的 is_decoder 参数设置为 True。要在 Seq2Seq 模型中使用,模型需要将 is_decoder 参数以及 add_cross_attention 设置为 True;在正向传递时还期望有 encoder_hidden_states 输入。

正向传递

< >

( input_ids: LongTensor = 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.BaseModelOutputWithPastAndCrossAttentionstuple(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), 可选) — 用于指示输入的两个部分(例如句子 A 和句子 B)的分段单词索引。所选索引为 [0, 1]:

    • 0 对应于 句子 A 的单词,
    • 1 对应于 句子 B 的单词。

    什么是单词类型 ID?

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

    什么是位置ID?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.FloatTensor可选) — 用于取消自注意力模块中选定头部的掩码。掩码值选取范围在 [0, 1]

    • 1 表示头部未被 屏蔽
    • 0 表示头部被 屏蔽。
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,你可以选择直接传递嵌入表示,而不是 input_ids。这在你想比模型内部的嵌入查找矩阵有更多控制权时很有用,即如何将 input_ids 的索引转换为相关的向量。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多信息,请参阅返回的张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多信息,请参阅返回的张量下的 hidden_states
  • return_dict (bool, 可选) — 是否以 ModelOutput 形式返回,而不是普通的元组。
  • encoder_hidden_states (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 最后一个编码层输出的隐藏状态序列。在模型配置为解码器时用于交叉注意力。
  • encoder_attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用于避免在编码器输入的填充token索引上执行注意力的掩码。在模型配置为解码器时用于交叉注意力。掩码值选择在[0, 1]
    • 1表示未掩码的token,
    • 0表示掩码的token。
  • past_key_values (tuple(tuple(torch.FloatTensor)) of length config.n_layers with each tuple having 4 tensors of shape (batch_size, num_heads, sequence_length - 1, embed_size_per_head)) — 包含注意力块的预计算的键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择只输入最后一个 decoder_input_ids(那些没有将过去键值状态提供给此模型的)的形状为 (batch_size, 1),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids
  • use_cache (bool, 可选) — 如果设置为 True,将返回 past_key_values 的 key value 状态,可用来加速解码(参见 past_key_values)。

返回值

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

A transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(《RemBertConfig》)和输入而变化的各个元素。

  • 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_layerstuple(torch.FloatTensor) 的元组,每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,可选地,如果 config.is_encoder_decoder=True,则还包含两个形状为 (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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

  • cross_attentions (tuple(torch.FloatTensor), 可选,在传递 output_attentions=Trueconfig.add_cross_attention=True 时返回或当 config.output_attentions=True 时) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    解码器交叉注意力层的注意力权重,经过注意力 softmax,用于计算交叉注意力头中的加权平均。

The RemBertModel forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, RemBertModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertModel.from_pretrained("google/rembert")

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

>>> last_hidden_states = outputs.last_hidden_state

RemBertForCausalLM

transformers.RemBertForCausalLM

< >

( config )

参数

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

RemBERT模型在一个用于CLM微调的语言模型头部之上。这是一个PyTorch torch.nn.Module子类。将其用作常规PyTorch模块,并参考PyTorch文档了解所有有关通用使用和行为的问题。

正向传递

< >

( input_ids: LongTensor = 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 labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

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

    通过 AutoTokenizer 获取索引。详细信息请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.FloatTensor shaped (batch_size, sequence_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在 [0, 1] 范围内:

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

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor shaped (batch_size, sequence_length), optional) — 段落标记索引,用于指示输入的第一部分和第二部分。索引选择在 [0, 1] 范围内:

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

    什么是标记类型 ID?

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

    什么是位置ID?

  • head_mask (形状为 (num_heads,) 或 (num_layers, num_heads),类型为 torch.FloatTensor可选) — 用于取消自我注意模块中选择头部的不良影响。在 [0, 1] 中选择掩码值:

    • 1表示头部未掩码
    • 0表示头部已掩码
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size),类型为 torch.FloatTensor可选) — 可以选择直接传递嵌入表示,而不仅仅是传递 input_ids。当你想要比模型的内部嵌入查找矩阵有更多控制权地转换 input_ids 索引到相关向量时,这很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多细节请参阅返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参阅返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 模型输出 而不是普通的元组。
  • 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 (长度为 config.n_layerstuple(tuple(torch.FloatTensor))),每个元组的形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head)) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择只输入最后一个 decoder_input_ids(那些没有将前一个键值状态提供给此模型的)(形状为 (batch_size, 1)),而不是所有 decoder_input_ids(形状为 (batch_size, sequence_length))。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), 可选) — 用于计算左到右语言建模损失的标签(下一词预测)。索引应该在 [-100, 0, ..., config.vocab_size](参见 input_ids 文档字符串)范围内。索引设置为 -100 的标记将被忽略(掩码),只对标签 n 在 [0, ..., config.vocab_size] 范围内的标记计算损失。
  • use_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 密钥价值状态,并可用来加速解码(参见 past_key_values)。

返回值

transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个由 torch.FloatTensor 组成的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置(RemBertConfig)和输入的不同元素。

  • loss (torch.FloatTensor of shape (1,), 可选,当提供 labels 时返回) — 语言建模损失(用于下一词预测)。

  • logits (torch.FloatTensor of shape (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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

  • cross_attentions (tuple(torch.FloatTensor), 可选,当传递 output_attentions=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 时返回) — 一个长度为 config.n_layerstorch.FloatTensor 元组的元组,每个元组包含自注意力和交叉注意力层缓存的密钥、值状态,如果模型用于编码器-解码器设置。仅当 config.is_decoder = True 时相关。

    包含预计算的隐藏状态(注意力块中的键和值),可用于(请参阅past_key_values输入)以加速顺序解码。

RemBertForCausalLM 前向方法,覆盖了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, RemBertForCausalLM, RemBertConfig
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> config = RemBertConfig.from_pretrained("google/rembert")
>>> config.is_decoder = True
>>> model = RemBertForCausalLM.from_pretrained("google/rembert", config=config)

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

>>> prediction_logits = outputs.logits

RemBertForMaskedLM

class transformers.RemBertForMaskedLM

< >

( config )

参数

  • config (RemBertConfig) — Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the from_pretrained() method to load the model weights.

最上端带有一个语言建模头的RemBERT模型。该模型是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块,并查阅PyTorch文档以了解所有与通用使用和行为相关的事项。

正向传递

< >

( input_ids: LongTensor = 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 labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

参数

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

    什么是位置ID?

  • head_masktorch.FloatTensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 用于取消激活自注意力模块中选中头的掩码。掩码值选择在 [0, 1]

    • 1 表示头未 屏蔽
    • 0 表示头已 屏蔽
  • inputs_embedstorch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 选择直接传递嵌入表示,而不是传递 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] 范围内的标签的标记计算损失。

返回值

transformers.modeling_outputs MaskedLMOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs MaskedLMOutput 或一个 torch.FloatTensor 的元组(如果传递 return_dict=False 或当 config.return_dict=False),包含的元素取决于配置(RemBertConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) - 遮蔽语言模型 (MLM) 损失。

  • logits (torch.FloatTensor of shape (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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

RemBertForMaskedLM 前向方法,重写了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, RemBertForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForMaskedLM.from_pretrained("google/rembert")

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

RemBertForSequenceClassification

transformers.RemBertForSequenceClassification

< >

( config )

参数

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

RemBERT 模型转换器,顶部带有序列分类/回归头(池化输出之上的线性层),例如用于 GLUE 任务。

此模型是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并查阅 PyTorch 文档了解有关通用使用和行为的所有相关内容。

正向传递

< >

( input_ids: FloatTensor = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (批量大小, 序列长度)) — 输入序列的词元在词汇表中的索引。

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

    什么是输入 ID?

  • attention_masktorch.FloatTensor,形状为 (batch_size, sequence_length)可选)— 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 之间选择:

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

    什么是注意力掩码?

  • token_type_idstorch.LongTensor,形状为 (batch_size, sequence_length)可选)— 段标记索引,表示输入的前一部分和后一部分。索引在 [0, 1] 之间选择:

    • 0 表示 句子A 标记,
    • 1 表示 句子B 标记。

    什么是标记类型ID?

  • position_idstorch.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,则计算分类损失(交叉熵)。 

返回值

C impunity.modeling_outputs.SequenceClassifierOutput

一个transformers.modeling_outputs.SequenceClassifierOutput或一个由torch.FloatTensor元组组成的对象(当传入return_dict=False或配置config.return_dict=False时),该元组包含各种元素,这些元素取决于配置(RemBertConfig)和输入。

  • losstorch.FloatTensor类型,形状为(1,)可选,当提供labels时返回)—— 分类(或当config.num_labels==1时的回归)损失。

  • logitstorch.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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

RemBertForSequenceClassification的前向方法覆盖了__call__特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

单标签分类的例子

>>> import torch
>>> from transformers import AutoTokenizer, RemBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForSequenceClassification.from_pretrained("google/rembert")

>>> 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 = RemBertForSequenceClassification.from_pretrained("google/rembert", num_labels=num_labels)

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

多标签分类的例子

>>> import torch
>>> from transformers import AutoTokenizer, RemBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForSequenceClassification.from_pretrained("google/rembert", 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 = RemBertForSequenceClassification.from_pretrained(
...     "google/rembert", 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

RemBertForMultipleChoice

transformers.RemBertForMultipleChoice

< >

( config )

参数

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

RemBERT 模型,顶部带有多选题分类头(在池化输出上方的线性层和softmax),例如用于RocStories/SWAG任务。

此模型是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并查阅 PyTorch 文档了解有关通用使用和行为的所有相关内容。

正向传递

< >

( input_ids: FloatTensor = None attention_mask: Optional = None token_type_ids: Optional = None : Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None : Optional = None : Optional = None : Optional = None ) transformers.modeling_outputs.MultipleChoiceModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, num_choices, sequenceLength)) — 输入序列的词汇索引。

    索引可以通过使用 AutoTokenizer 获取。更多详情请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call().

    什么是输入ID?

  • attention_mask (形状为 (batch_size, num_choices, sequence_length) 的 torch.FloatTensor,可选)— 避免在填充token索引上执行注意力的掩码。掩码值选择在 [0, 1] 内:

    • 1 对应未被掩码的token,
    • 0 对应被掩码的token。

    什么是注意力掩码?

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

    • 0 对应 句子 A token,
    • 1 对应 句子 B token。

    什么是token类型ID?

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

    什么是位置ID?

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于取消选择自注意力模块选中的头部的掩码。掩码值选择在 [0, 1]:

    • 1 表示头部未被 屏蔽,
    • 0 表示头部被 屏蔽.
  • inputs_embeds (torch.FloatTensor of shape (batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地,您可以直接传递内嵌表示,而不是传递 input_ids。这在您想要对如何将 input_ids 索引转换为相关向量比模型内部的嵌入查找矩阵有更多控制时非常有用。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。对于返回张量中的更多详细信息,请参阅 hidden_states
  • return_dict (bool, optional) — 是否返回而不是普通元组的 ModelOutput
  • labels (torch.LongTensor of shape (batch_size,), optional) — 为计算多个选择分类损失提供标签。索引应在 [0, ..., num_choices-1] 范围内,其中 num_choices 是输入张量的第二维大小。(参见上述 input_ids

返回值

transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

transformers.modeling_outputs.MultipleChoiceModelOutput 或一个由 torch.FloatTensor 组成的元组(当传递 return_dict=False 或当 config.return_dict=False 时),元素取决于配置(RemBertConfig)和输入。

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 分类损失。

  • logits (torch.FloatTensor of shape (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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

RemBertForMultipleChoice 的前向方法,重写了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, RemBertForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForMultipleChoice.from_pretrained("google/rembert")

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

RemBertForTokenClassification

transformers.RemBertForTokenClassification

< >

( config )

参数

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

RemBERT 模型带有顶部的标记分类头(在隐藏的状态输出之上的一层线性层),例如用于命名实体识别 (NER) 任务。

此模型是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并查阅 PyTorch 文档了解有关通用使用和行为的所有相关内容。

正向传递

< >

( input_ids: FloatTensor = 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.TokenClassifierOutputtuple(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 标记。

    什么是标记类型 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 of shape (batch_size, sequence_length), optional) — 计算token分类损失的标签。索引应位于[0, ..., config.num_labels - 1]之间。

返回值

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),包括根据配置(《RemBertConfig》)和输入各种元素。

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 分类损失。

  • logits (torch.FloatTensor of shape (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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

RemBertForTokenClassification 的forward方法,覆盖了特殊的 __call__ 方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, RemBertForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForTokenClassification.from_pretrained("google/rembert")

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

RemBertForQuestionAnswering

class transformers.RemBertForQuestionAnswering

< >

( config )

参数

  • config (RemBertConfig) — 模型的参数配置类。使用配置文件初始化不会加载模型权重,只有配置。请查看from_pretrained() 方法来加载模型权重。

RemBERT模型,顶部分类头用于基于SQuAD(例如)的抽取式问答任务(在隐藏状态输出上附加线性层来计算span开始logitsspan结束logits)。

此模型是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并查阅 PyTorch 文档了解有关通用使用和行为的所有相关内容。

正向传递

< >

( input_ids: FloatTensor = 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 or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列_token_在词汇表中的索引。

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

    输入ID是什么?

  • attention_mask (形状为 (batch_size, sequence_length)torch.FloatTensor可选) — 避免在填充token索引上执行注意力的掩码。选定的掩码值在 [0, 1] 之间:

    • 1 表示 未被掩码 的 token,
    • 0 表示 被掩码 的 token。

    什么是注意力掩码?

  • token_type_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 段token索引,用于指示输入的首先和第二部分。索引选在 [0, 1] 之间:

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

    什么是token类型ID?

  • position_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 每个输入序列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,), 非必须) — 标签化的span的起始位置(索引)的标签,用于计算标记分类损失。位置被限制在序列长度(sequence_length)内。序列外的位置不会用于计算损失。
  • end_positions (torch.LongTensor of shape (batch_size,), optional) — 标记指定跨度结束位置的索引标签,用于计算token分类损失。位置被限制在序列长度内(sequence_length)。序列之外的位置在损失计算中不考虑。

返回值

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个火炬的浮点数元组(如果传递了 return_dict=False 或当 config.return_dict=False)根据配置(RemBertConfig)和输入包含不同元素。

  • 损失 (torch.FloatTensor of shape (1,), optional, 返回当 labels 被提供时) — 总跨度提取损失是起始位置和结束位置的交叉熵的总和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — Span起始得分(在SoftMax之前)。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — Span结束得分(在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 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 的元组(每个层一个)。

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

The RemBertForQuestionAnswering 前向方法,覆盖了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, RemBertForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = RemBertForQuestionAnswering.from_pretrained("google/rembert")

>>> 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
TensorFlow
隐藏TensorFlow内容

TFRemBertModel

class transformers.TFRemBertModel

< >

( config: RemBertConfig *inputs **kwargs )

参数

  • config (RemBertConfig) — Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the from_pretrained() method to load the model weights.

裸露的RemBERT模型transformer输出未经任何特定头部处理的原始隐藏状态。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列词汇中的标记索引。

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

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行注意力的掩码。选定的掩码值在 [0, 1] 之间:

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

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 段标记索引以指示输入的第一部分和第二部分。选择的索引在 [0, 1] 之间:

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于取消配置自注意力模块中选定头部的掩码。掩码值置于 [0, 1] 中:

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可选,代替传递 input_ids,您可以选择直接传递嵌入表示。如果您想要比模型的内部嵌入查找矩阵有更多的控制来转换 input_ids 索引到关联的向量,这将很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更详细的信息,请参阅返回的张量中的 attentions。此参数只能在 eager 模式下使用,在图模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详情请参阅返回张量的 hidden_states。此参数仅在Eager模式中使用,在图模式中会使用配置中的值。
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通元组。此参数可以用于Eager模式,在图模式中该值始终设为True。
  • training (bool, 可选, 默认为`False`) — 是否以训练模式使用模型(一些模块如dropout模块在训练和评估之间有不同的行为)。
  • encoder_hidden_states (tf.Tensor of shape (batch_size, sequence_length, hidden_size), optional) — 编码器的最后一层输出的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。
  • encoder_attention_mask (tf.Tensor of shape (batch_size, sequence_length), optional) — 用于避免在编码器输入的填充标记索引上进行注意力的掩码。如果模型配置为解码器,则在交叉注意力中使用。掩码值选在[0, 1]

    • 1 对于未掩码的标记,
    • 0 对于掩码的标记。
  • past_key_values (Tuple[Tuple[tf.Tensor]] of length config.n_layers) — 包含注意机制块预计算的关键和值隐藏状态。可用于加速解码。如果使用past_key_values,则用户可以只输入最后 decoder_input_ids(不包含过去键值状态的)的形状为 (batch_size, 1) 的数据,而不是所有 decoder_input_ids 的形状为 (batch_size, sequence_length) 的数据。
  • use_cache (bool, 可选, 默认为True) — 如果设置为True,会返回past_key_values键值状态,这可以用来加速解码(参见past_key_values)。训练时设置为False,生成时设置为True

返回值

transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentionstuple(tf.Tensor)

A transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一个tf.Tensor的元组(如果传递了return_dict=False,或者在config.return_dict=False时),包含各种根据配置(RemBertConfig)和输入而定的元素。

  • last_hidden_state (tf.Tensor,形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  • pooler_output (tf.Tensor,形状为(batch_size, hidden_size)) — 序列中第一个标记(分类标记)的最后一层隐藏状态,进一步经过线性层和 Tanh 激活函数处理。线性层的权重是在预训练期间从下一个句子预测(分类)目标中训练得到的。

    这个输出通常是输入语义内容的一个很好的总结,您通常会比平均或池化整个输入序列的隐藏状态序列做得更好。

  • past_key_values (tf.Tensor列表,可选,在传递use_cache=True时返回或在config.use_cache=True时返回) — 长度为config.n_layerstf.Tensor列表,其中每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的隐藏状态(注意力块中的键和值),可用于(请参阅past_key_values输入)以加速顺序解码。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

  • cross_attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    解码器交叉注意力层的注意力权重,经过注意力 softmax,用于计算交叉注意力头中的加权平均。

TFRemBertModel的前向方法重写了__call__特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, TFRemBertModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertModel.from_pretrained("google/rembert")

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

>>> last_hidden_states = outputs.last_hidden_state

TFRemBertForMaskedLM

transformers.TFRemBertForMaskedLM

< >

( config: RemBertConfig *inputs **kwargs )

参数

  • 配置 (RemBertConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化将不会加载与模型相关的权重,仅加载配置。请参见 from_pretrained() 方法以加载模型权重。

RemBERT 模型顶部带有 语言建模 头。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray] 每个示例都必须具有形状 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入 ID?

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

    • 1 表示未遮挡的标记;
    • 0 表示遮挡的标记。

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor 的形状为 (batch_size, sequence_length)可选) —— 段标记索引,用于指示输入的第一和第二部分。索引选在 [0, 1] 中:

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

    什么是令牌类型 ID?

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

    什么是位置ID?

  • head_mask(类型:np.ndarraytf.Tensor,形状(num_heads,)(num_layers, num_heads)可选)——用于取消选择自注意力模块中的选定头部的掩码。掩码值选择范围在[0, 1]

    • 1 表示头部没有被掩码,
    • 0 表示头部被掩码。
  • inputs_embeds(类型:np.ndarraytf.Tensor,形状(batch_size, sequence_length, hidden_size)可选)——可选的,而不是传递 input_ids,您可以选择直接传递一个嵌入表示。当您想要比模型的内部嵌入查找矩阵有更多控制权如何将 input_ids 索引转换为相关向量时,这很有用。
  • output_attentions (布尔值, 可选) — 是否返回所有注意力层的注意力张量。有关返回张量中的更多信息,请参见 attentions。此参数只能在 eager 模式中使用,在 graph 模式中将使用配置中的值。
  • output_hidden_states (布尔值, 可选) — 是否返回所有层的隐藏状态。有关返回张量中的更多信息,请参见 hidden_states。此参数只能在 eager 模式中使用,在 graph 模式中将使用配置中的值。
  • return_dict (布尔值, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式中使用,在 graph 模式中始终将其设置为 True。
  • training (bool, 可选, 默认为 `False`) — 是否使用训练模式的模型(一些模块,如dropout模块,在训练和评估之间有不同的行为)。
  • labels (tf.Tensornp.ndarray 的形状是 (batch_size, sequence_length), 可选) — 用于计算骨架语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 范围内(参见 input_ids 的文档字符串)。索引设置为 -100 的标记将被忽略(被掩码),只计算标签在 [0, ..., config.vocab_size] 的标记的损失。

返回值

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),它包含各种元素,这些元素取决于配置(RemBertConfig)和输入。

  • loss (tf.Tensor 的形状为 (n,), 可选,其中 n 是非掩码标签的数量,当提供 labels 时返回) — 骨架语言建模(MLM)损失。

  • logits (tf.Tensor 的形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测分数(每个词汇表标记的分数在 SoftMax 之前)。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

TFRemBertForMaskedLM 的前进方法,覆盖了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, TFRemBertForMaskedLM
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForMaskedLM.from_pretrained("google/rembert")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits

>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)

>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="tf")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = tf.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

>>> outputs = model(**inputs, labels=labels)

TFRemBertForCausalLM

transformers.TFRemBertForCausalLM

< >

( config: RemBertConfig *inputs **kwargs )

参数

  • 配置 (RemBertConfig) — 用于存储模型所有参数的配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。请查看from_pretrained()方法以加载模型权重。

在CLM微调上具有顶层语言模型头部的RemBERT模型。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

返回值

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

一个transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions或者一个由tf.Tensor(如果在传递return_dict=False时或当config.return_dict=False时)组成的元组,其中包含根据配置(RemBertConfig)和输入的各个元素。

  • loss(形状为(n,)tf.Tensor可选,其中n是未屏蔽标签的数量,当提供labels时返回)——语言模型损失(用于下一标记预测)。

  • logits (tf.Tensor 的形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头部的预测分数(每个词汇表标记的分数在 SoftMax 之前)。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

  • cross_attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    解码器交叉注意力层的注意力权重,经过注意力 softmax,用于计算交叉注意力头中的加权平均。

  • past_key_values (tf.Tensor列表,可选,在传递use_cache=True时返回或在config.use_cache=True时返回) — 长度为config.n_layerstf.Tensor列表,其中每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)

    包含预计算的隐藏状态(注意力块中的键和值),可用于(请参阅past_key_values输入)以加速顺序解码。

encoder_hidden_states(形状为(batch_size, sequence_length, hidden_size)tf.Tensor可选):编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。encoder_attention_mask(形状为(batch_size, sequence_length)tf.Tensor可选):用于避免对编码器输入中填充标记索引执行注意力的掩码。如果模型配置为解码器,则使用此掩码。掩码值在[0, 1]之间选择。

  • 为未屏蔽的标记检索1,
  • 为屏蔽的标记检索0。

past_key_values(长度为config.n_layersTuple[Tuple[tf.Tensor]])包含注意力块预计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values,用户可以可选地只输入最后一个decoder_input_ids(那些没有将其过去键值状态给这个模型的)的形状为(batch_size, 1),而不是所有形状为(batch_size, sequence_length)decoder_input_ids。use_cache(bool可选,默认为True):如果设置为True,则返回past_key_values键值状态,可用于加快解码(见past_key_values)。训练期间设置为False,生成标签期间设置为True labels(tf.Tensor或形状为(batch_size, sequence_length)np.ndarray可选):用于计算交叉熵分类损失的标签。索引应在[0, ..., config.vocab_size - 1]之间。

示例

>>> from transformers import AutoTokenizer, TFRemBertForCausalLM
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForCausalLM.from_pretrained("google/rembert")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logits

TFRemBertForSequenceClassification

类名 transformers.TFRemBertForSequenceClassification

< >

( config: RemBertConfig *inputs **kwargs )

参数

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

RemBERT 模型转换器,上面添加了序列分类/回归头,例如用于 GLUE 任务。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列token在词汇表中的索引。

    可以使用AutoTokenizer获得索引。详见 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 内选择:

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

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length)可选) — 段标记索引,用于指示输入的第一和第二部分。索引在 [0, 1] 内选择:

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 取消自我注意力模块选择头部的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部未被 掩码
    • 0 表示头部被 掩码
  • inputs_embeds (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 选项性地,您可以选择直接传递嵌入表示而不是 input_ids。如果您想更精细地控制如何将 input_ids 索引转换为相关向量,这比模型内部的嵌入查找矩阵更有效。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions。此参数仅在 eager 模式下可以使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关返回张量下 hidden_states 的更多详细内容,请参见。此参数只能用于紧急模式,在图模式中,使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可用于紧急模式,在图模式中,该值始终设置为 True。
  • training (bool, 可选,默认为`False`) — 是否使用模型进行训练模式(一些模块如dropout模块在训练和评估之间有不同的行为)。
  • labels (tf.Tensornp.ndarray 形状为 (batch_size,)可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回值

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutputtf.Tensor 的元组(如果通过 return_dict=False 或当 config.return_dict=False 时),它根据配置(RemBertConfig)和输入包含各种元素。

  • loss (shape(batch_size, )tf.Tensor可选,当提供 labels 时返回) — 分类(或当 config.num_labels==1 时的回归)损失。

  • logits (shape(batch_size, config.num_labels)tf.Tensor) — 分类(或当 config.num_labels==1 的回归)分数(在 SoftMax 之前)。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

TFRemBertForSequenceClassification 的前向方法,重写了特殊的 __call__ 方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, TFRemBertForSequenceClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForSequenceClassification.from_pretrained("google/rembert")

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

>>> logits = model(**inputs).logits

>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])
>>> # 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 = TFRemBertForSequenceClassification.from_pretrained("google/rembert", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss

TFRemBertForMultipleChoice

transformers.TFRemBertForMultipleChoice

< >

( config: RemBertConfig *inputs **kwargs )

参数

  • config (RemBertConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化时不加载模型相关的权重,只加载配置。检查from_pretrained() 方法来加载模型权重。

RemBERT 模型,顶部带有多选题分类头(在池化输出上方的线性层和softmax),例如用于RocStories/SWAG任务。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, num_choices, sequence_length)) — 输入序列token在词汇表中的索引。

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

    什么是input IDs?

  • attention_mask (np.ndarraytf.Tensor 形状为 (batch_size, num_choices, sequence_length),可选) — 避免在填充标记索引上执行注意力操作的掩码。选择的掩码值在 [0, 1] 之间:

    • 1 对应于未遮罩的标记,
    • 0 对应于遮罩的标记。

    什么是注意力掩码?

  • token_type_ids (np.ndarraytf.Tensor 形状为 (batch_size, num_choices, sequence_length),可选) — 段标记索引以指明输入的第一个和第二个部分。选择的索引在 [0, 1] 之间:

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形状为 (num_heads,)(num_layers, num_heads)可选)——用来取消选定头部的自注意力模块的掩码。掩码值在 [0, 1] 之间选择:
    • 1 表示头部未 掩码
    • 0 表示头部已 掩码
  • inputs_embeds (np.ndarraytf.Tensor 形状为 (batch_size, num_choices, sequence_length, hidden_size)可选)——可以选择直接传递嵌入表示,而不是传递 input_ids。这在使用户想要比模型内部的嵌入查找矩阵有更多控制权的转换 input_ids 索引到相关向量时非常有用。
  • output_attentions (bool可选)——是否返回所有注意力层的注意力张量。详细信息请参考返回的张量中的 attentions。此参数仅在 eager 模式下可用,在 graph 模式下将使用配置中的值。
  • output_hidden_states布尔值可选)— 是否返回所有层的隐藏状态。更多详情请参阅返回张量下的 hidden_states。此参数仅在急切模式中使用,在图模式中将使用配置中的值。
  • return_dict布尔值可选)— 是否返回 ModelOutput 而不是一个普通的元组。此参数可以在急切模式中使用,在图模式中该值始终设置为 True。
  • training布尔值可选,默认为 `False`“)— 是否使用模型进行训练模式(某些模块,如 dropout 模块,在训练和评估之间的行为不同)。
  • labels (tf.Tensornp.ndarray 形状为 (batch_size,)可选) — 多选题分类损失的标签。索引应在 [0, ..., num_choices] 范围内,其中 num_choices 是输入张量第二维的大小。(见上文的 input_ids

返回值

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个包含 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时)由配置(RemBertConfig)和输入来确定。

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

  • logits (tf.Tensor 形状为 (batch_size, num_choices)) — num_choices 是输入张量的第二维。(见上文中的 input_ids

    分类得分(SoftMax 之前)。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

TFRemBertForMultipleChoice 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, TFRemBertForMultipleChoice
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForMultipleChoice.from_pretrained("google/rembert")

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

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs)  # batch size is 1

>>> # the linear classifier still needs to be trained
>>> logits = outputs.logits

TFRemBertForTokenClassification

transformers.TFRemBertForTokenClassification

< >

( config: RemBertConfig *inputs **kwargs )

参数

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

RemBERT 模型带有顶部的标记分类头(在隐藏的状态输出之上的一层线性层),例如用于命名实体识别 (NER) 任务。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TF模型输入类型 | None = None attention_mask: 即 numpy.ndarray | tensorflow.Tensor | None = None token_type_ids: numpy.ndarray | tensorflow.Tensor | None = None position_ids: numpy.ndarray | tensorflow.Tensor | None = None head_mask: numpy.ndarray | tensorflow.Tensor | None = None inputs_embeds: numpy.ndarray | tensorflow.Tensor | None = None output_attentions: 可选[布尔值] = None output_hidden_states: 可选[布尔值] = None return_dict: 可选[布尔值] = None labels: numpy.ndarray | tensorflow.Tensor | None = None training: 可选[布尔值] = False ) transformers.modeling_tf_outputs.TFTokenClassifierOutput or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tensorflow.Tensor, List[tensorflow.Tensor] `Dict[str, tensorflow.Tensor] or Dict[str, np.ndarray] and each example must have the shape (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

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

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 用于避免在填充token索引上执行注意力的掩码。在 [0, 1] 范围内选择的掩码值:

    • 1 表示不掩码的token,
    • 0 表示掩码的token。

    什么是attention掩码?

  • token_type_ids (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 段落token索引,用于指示输入的第一部分和第二部分。索引范围在 [0, 1] 内:

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

    什么是token类型ID?

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

    什么是位置ID?

  • head_mask (np.ndarraytf.Tensor 形状为 (num_heads,)(num_layers, num_heads),可选) - 用于取消选中自注意力模块的头部的掩码。掩码值在 [0, 1] 中选择:
    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • inputs_embeds (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length, hidden_size),可选) - 你可以选择直接传递嵌入表示,而不是传递 input_ids。当你想对如何将 input_ids 的索引转换成相关向量有更多控制权时,这很有用,比模型的内部嵌入查找矩阵转换更加灵活。
  • output_attentions (bool,可选) - 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 hidden_states。此参数只能在旷工模式下使用,在图形模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通元组。该参数可在旷工模式下使用,在图形模式下该值始终设置为True。
  • training (bool, 可选, 默认False) — 是否以训练模式使用该模型(一些模块,如dropout模块,在训练和评估之间有不同的行为)。
  • labelstf.Tensor 或 shape 为(batch_size, sequence_length)的 np.ndarray可选) — 用于计算标记分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。

返回值

transformers.modeling_tf_outputs.TFTokenClassifierOutputtuple(tf.Tensor)

A transformers.modeling_tf_outputs.TFTokenClassifierOutput 或是一个 tf.Tensor 的元组(如果 return_dict=False 被传递或当 config.return_dict=False 时),它包含各种元素,具体取决于配置(RemBertConfig)和输入。

  • loss (shape 为 (n,)tf.Tensor可选,其中 n 是未遮蔽标签的数量,当提供 labels 时返回) — 分类损失。

  • logits (shape 为 (batch_size, sequence_length, config.num_labels)tf.Tensor) — 分类得分(在 SoftMax 之前)。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

TFRemBertForTokenClassification 的前进方法覆盖了 __call__ 特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, TFRemBertForTokenClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForTokenClassification.from_pretrained("google/rembert")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )

>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-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] for t in predicted_token_class_ids[0].numpy().tolist()]
>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)

TFRemBertForQuestionAnswering

class transformers.TFRemBertForQuestionAnswering

< >

( config: RemBertConfig *inputs **kwargs )

参数

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

RemBERT 模型,顶部带有区间分类头,用于涉及 SQuAD 等任务(一个线性层位于隐藏状态输出之上,用于计算“区间开始 logit”和“区间结束 logit”)。

此模型继承自TFPreTrainedModel。检查其父类文档以了解库为所有模型实现的一些通用方法(如下载或保存、调整输入嵌入大小、剪枝头部等。)

此模型也是一个keras.Model的子类。将其作为常规TF 2.0 Keras模型使用,并参考TF 2.0文档以获取所有与通用用法和特性相关的事项。

Transformers中的TensorFlow模型和层接受两种输入格式

  • 将所有输入作为关键字参数(如PyTorch模型),或者
  • 将所有输入作为一个列表、元组或字典作为第一个位置参数。

第二种格式的支持原因在于Keras方法在向模型和层传递输入时更偏好该格式。正因为这种支持,当使用像model.fit()这样的方法时,一切应该“直接就绪”地对您来说——只需传入model.fit()所支持的任何格式的输入和标签即可!然而,如果您想在fit()predict()等Keras方法之外使用第二种格式,例如在用自己的层或模型通过Keras Functional API创建层时,您可以使用以下三种方式来收集所有第一个位置参数中的输入张量

  • 只含有input_ids的单个张量:model(input_ids)
  • 一个不同长度的列表,其中包含一个或多个输入张量,按照文档字符串中给出的顺序:model([input_ids, attention_mask])model([input_ids, attention_mask, token_type_ids])
  • 一个字典,包含一个或多个与文档字符串中给出的输入名称关联的输入张量:model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意,当使用子类化创建模型和层时,您无需担心这些,因为您可以将输入传递得就像向任何其他Python函数一样!

调用

< >

( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput or tuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray],每个示例的形状必须为 (batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。

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

    什么是输入ID?

  • attention_mask (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 避免在填充词索引上进行注意力的掩码。掩码值选择在 [0, 1]

    • 1 对应于未 掩码 的标记,
    • 0 对应于已 掩码 的标记。

    什么是 attention masks?

  • token_type_ids (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 段落标记索引,用以指示输入的第一、二部分。索引选择在 [0, 1]

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • head_mask (np.ndarraytf.Tensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 要取消选中自注意力模块选中的头部的掩码。掩码值在 [0, 1] 之间选择:

    • 1 表示头部未被 屏蔽
    • 0 表示头部被 屏蔽
  • inputs_embeds (np.ndarraytf.Tensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选,您可以选择直接传递嵌入式表示来代替传递 input_ids。如果您想要比模型内部嵌入查找矩阵能够更好地控制将 input_ids 索引转换为相关矢量的方式,这将很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更详细的信息,请参阅返回张量中的 attentions。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states。此参数只能在eager模式中使用,在graph模式下将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回ModelOutput对象而不是普通元组。此参数可以在eager模式中使用,在graph模式下将始终设置为True。
  • training (bool, 可选, 默认为 `False`) — 是否使用模型进行训练模式(某些模块(如dropout模块)在训练和评估之间的行为不同)。
  • start_positions (tf.Tensor 或者 np.ndarray,形状为 (batch_size,)可选) — 标注段开始位置的标签,用于计算标记得的跨度分类损失。位置被限制在序列长度(sequence_length)内。序列之外的位置在计算损失时不被考虑。
  • end_positions (tf.Tensor 或者 np.ndarray,形状为 (batch_size,)可选) — 标注段结束位置的标签,用于计算标记得的跨度分类损失。位置被限制在序列长度(sequence_length)内。序列之外的位置在计算损失时不被考虑。

返回值

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

一个transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput或者一个tf.Tensor的元组(如果传递了return_dict=False或者当config.return_dict=False时),包含了根据配置(RemBertConfig)和输入不同元素。

  • loss(当提供start_positionsend_positions时返回,形状为(batch_size, )tf.Tensor可选)—— 总跨度提取损失是开始和结束位置交叉熵的总和。

  • start_logits(形状为(batch_size, sequence_length)tf.Tensor)—— 跨度开始得分(在SoftMax之前)。

  • end_logits(形状为(batch_size, sequence_length)tf.Tensor)—— 跨度结束得分(在SoftMax之前)。

  • hidden_states (tf.Tensor元组,可选,在传递output_hidden_states=True时返回或在config.output_hidden_states=True时返回) — 包含tf.Tensor的元组(一个为嵌入输出,一个为每层的输出),形状为(batch_size, sequence_length, hidden_size)

    模型每层输出和初始嵌入输出的隐藏状态。

  • attentions (tf.Tensor元组,可选,在传递output_attentions=True时返回或在config.output_attentions=True时返回) — 包含每个层的tf.Tensor的元组,形状为(batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均。

TFRemBertForQuestionAnswering的前向方法覆盖了__call__特殊方法。

虽然前向传播的算法需要在函数中定义,但之后应调用Module实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默忽略它们。

示例

>>> from transformers import AutoTokenizer, TFRemBertForQuestionAnswering
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("google/rembert")
>>> model = TFRemBertForQuestionAnswering.from_pretrained("google/rembert")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)

>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> # target is "nice puppet"
>>> target_start_index = tf.constant([14])
>>> target_end_index = tf.constant([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = tf.math.reduce_mean(outputs.loss)
<></span>在GitHub上更新>