Transformer 文档

Transformer-XLM-RoBERTa

Hugging Face's logo
加入Hugging Face社区

并获取增强的文档体验

开始使用

XLM-RoBERTa

Models Spaces

概述

XLM-RoBERTa模型由Alexis Conneau、Kartikay Khandelwal、Naman Goyal、Vishrav Chaudhary、Guillaume Wenzek、Francisco Guzmán、Edouard Grave、Myle Ott、Luke Zettlemoyer和Veselin Stoyanov在《Scopus》上发表的论文《大规模的无监督跨语言表示学习》中提出。该模型基于Facebook于2019年发布的RoBERTa模型。它是一个大型多语言语言模型,训练了2.5TB的经过过滤的CommonCrawl数据。

论文的摘要如下

本文表明,在大规模上预先训练多语言语言模型能够显著提升跨语言迁移任务的性能。我们在100种语言上训练了一个基于Transformer的掩码语言模型,使用超过两PB的过滤后的CommonCrawl数据。我们的模型被命名为XLM-R,在多个跨语言基准测试中显著优于多语言BERT(mBERT),如XNLI的平均准确度提高13.8%,MLQA的平均F1得分提高12.3%,NER的平均F1得分提高2.1%。XLM-R在低资源语言上也表现优异,XNLI的Swahili准确度提高了11.8%,Urdu提高了9.2%。我们还详细评估了实现这些收益的关键因素,包括(1)正转移与能力稀释之间的权衡,(2)在高资源语言和低资源语言上的性能表现。最后,我们首次展示了在不牺牲每种语言的性能的情况下实现多语言建模的可能性;XLM-R在GLUE和XNLI基准测试中与强大的单语言模型竞争力很强。我们将公开XLM-R代码、数据和模型。

此模型由stefan-it贡献。原始代码可以在此处找到。

使用提示

  • XLM-RoBERTa是一个在100种不同语言上训练的多语言模型。与某些XLM多语言模型不同,它不需要lang张量来理解所使用的语言,并且应该能够从输入ids中确定正确的语言。
  • 在XLM方法中使用RoBERTa技巧,但不会使用翻译语言建模目标。它只对来自一种语言的句子使用掩码语言建模。

资源

一组官方Hugging Face和社区(用🌎表示)资源列表,帮助您开始使用XLM-RoBERTa。如果您有兴趣提交资源以在此处包含,请随时创建一个Pull Request,我们将审查它!理想情况下,资源应展示一些新奇之处,而不是重复现有的资源。

文本分类
标记分类
文本生成
填空-掩码
问答

多选题

🚀 部署

此实现与 RoBERTa 相同。有关用法示例以及输入和输出的相关信息,请参阅 RoBERTa 文档

XLMRobertaConfig

transformers.XLMRobertaConfig

< >

( 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' use_cache = True classifier_dropout = None **kwargs )

参数

  • vocab_size (整数, 可选,默认为30522) — XLM-RoBERTa模型的词汇表大小。定义了调用XLMRobertaModelTFXLMRobertaModelinputs_ids可以表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为768) — 编码层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为12) — Transformer编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为12) — Transformer编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选, 默认为3072) — Transformer编码器中“中间”层(通常称为前馈层)的维度。
  • hidden_actstrCallable,可选,默认为 "gelu") — 编码器和pooler中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""silu""gelu_new"
  • hidden_dropout_probfloat,可选,默认为 0.1) — 在嵌入层、编码器和pooler中的所有完全连接层的dropout概率。
  • attention_probs_dropout_probfloat,可选,默认为 0.1) — 注意力概率的dropout比率。
  • max_position_embeddingsint可选,默认值为512)— 该模型可能使用的最大序列长度。通常设置为较大的值以防万一(例如,512或1024或2048)。
  • type_vocab_sizeint可选,默认值为2)— 调用 XLMRobertaModelTFXLMRobertaModel 时传递的 token_type_ids 的词汇表大小。
  • initializer_rangefloat可选,默认值为0.02)— 初始化所有权重矩阵的截断正态分布初始化器的标准差。
  • layer_norm_epsfloat可选,默认值为1e-12)— 层归一化层的epsilon值。
  • position_embedding_type (str, 可选, 默认为 "absolute") — 位置嵌入的类型。选择 "absolute""relative_key""relative_key_query" 中的一个。对于位置嵌入请使用 "absolute"。关于 "relative_key" 的更多信息,请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。关于 "relative_key_query" 的更多信息,请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 方法 4
  • is_decoder (bool, 可选, 默认为 False) — 是否将模型用作解码器。如果为 False,则用作编码器。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后的关键字/值注意力(并非所有模型都使用)。只有当 config.is_decoder=True 时才相关。
  • classifier_dropout (float, 可选) — 分类头部的dropout比例。

这是存储XLMRobertaModel或TFXLMRobertaModel配置的配置类。它用于根据指定的参数实例化XLM-RoBERTa模型,定义模型架构。使用默认值实例化配置将生成与XLMRoBERTa FacebookAI/xlm-roberta-base架构相似配置。

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

示例

>>> from transformers import XLMRobertaConfig, XLMRobertaModel

>>> # Initializing a XLM-RoBERTa FacebookAI/xlm-roberta-base style configuration
>>> configuration = XLMRobertaConfig()

>>> # Initializing a model (with random weights) from the FacebookAI/xlm-roberta-base style configuration
>>> model = XLMRobertaModel(configuration)

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

XLMRobertaTokenizer

transformers.XLMRobertaTokenizer

< >

( vocab_file bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' sp_model_kwargs: Optional = None **kwargs )

参数

  • vocab_file (str) — 词汇文件的路径。
  • bos_token (str, 可选, 默认为 "<s>") — 预训练期间使用的句子起始标记。可以作为序列分类标记使用。

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

  • eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。

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

  • sep_token (str, 可选, 默认为 "</s>") — 分隔符标记,用于从多个序列构建序列时,例如,用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。
  • cls_token (str, 可选, 默认为 "<s>") — 用于序列分类(整个序列的分类而不是逐词分类)的分类标记。当使用特殊标记构建序列时,它是序列的第一个标记。
  • unk_token (str, 可选, 默认为 "") — 未知标记。不在词汇表中的标记不能转换为ID,并将被设置为该标记。
  • pad_token (str, 可选, 默认为 "") — 用于填充的标记,例如在批量不同长度的序列时。
  • mask_token (str, 可选, 默认为 "") — 用于遮蔽值的标记。这是在训练带有掩码语言建模的模型时使用的标记,这是模型将尝试预测的标记。
  • sp_model_kwargs (dict, 可选) — 将传递给 SentencePieceProcessor.__init__() 方法。除了其他用途外,可以使用 SentencePiece 的 Python 封装设置:
    • enable_sampling: 启用子词正则化。

    • nbest_size: 单词采样的参数。对 BPE-Dropout 无效。

      • nbest_size = {0,1}: 不进行采样。
      • nbest_size > 1: 从 nbest_size 结果中采样。
      • nbest_size < 0: 假设 nbest_size 是无限的,并使用前向过滤和反向采样算法从所有假设(图)中采样。
    • alpha: 单词采样平滑参数,以及 BPE-dropout 合并操作的 dropout 概率。

  • sp_model (SentencePieceProcessor) — 用于每个转换(字符串、标记和 ID)的 SentencePiece 处理器。

改编自 RobertaTokenizerXLNetTokenizer。基于 SentencePiece

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

build_inputs_with_special_tokens

< >

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

参数

  • token_ids_0 (List[int]) — 将添加特殊标记的ID列表。
  • token_ids_1 (List[int], 可选) — 可选的第二组序列的ID列表。

返回值

List[int]

带上适当特殊标记的输入ID列表。

通过拼接和添加特殊标记来构建模型输入,用于序列分类任务,格式如下

  • 单个序列:<s> X </s>
  • 序列对:<s> A </s></s> B </s>

get_special_tokens_mask

< >

( token_ids_0: 列表 token_ids_1: 可选 = None already_has_special_tokens: 布尔型 = False ) 列表[int]

参数

  • token_ids_0 (列表[int]) — ID列表。
  • token_ids_1 (列表[int], 可选) — 可选的第二组ID列表,用于句子对。
  • already_has_special_tokens (bool, 可选,默认为 False) — 表示令牌列表是否已经以特殊标记格式化。

返回值

List[int]

一个范围在 [0, 1] 之间的整数列表:1 为特殊令牌,0 为序列令牌。

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

create_token_type_ids_from_sequences

< >

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

参数

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

返回值

List[int]

全零列表。

从提供的两个序列创建掩码,用于序列对分类任务。XLM-RoBERTa 不使用标记类型 ID,因此返回一个全零列表。

保存词汇表

< >

( save_directory: str filename_prefix: Optional = None )

XLMRobertaTokenizerFast

transformers.XLMRobertaTokenizerFast

< >

( vocab_file = None tokenizer_file = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' **kwargs )

参数

  • vocab_file (str) — 词汇文件路径。
  • bos_token (str, 可选, 默认为 "<s>") — 在预训练过程中使用的序列开始标记。可以作为序列分类标记使用。
  • eos_token (str, 可选, 默认为 "</s>") — 序列结束标记。
  • sep_token (str, 可选, 默认为 "</s>") — 分隔标记,当从多个序列构建序列时使用,例如两个序列用于序列分类或用于问题回答中的文本和问题。它还用作使用特殊标记构建的序列的最后一个标记。
  • cls_token (str, 可选,默认为 "<s>") — 用来进行序列分类(整体序列分类而非逐词分类)的分类标记。在添加特殊标记时,它是序列的第一个标记。
  • unk_token (str, 可选,默认为 "<unk>") — 未知标记。不在词汇表中的标记不能转换为ID,并设置为该标记。
  • pad_token (str, 可选,默认为 "<pad>") — 用于填充的标记,例如在处理不同长度的序列时使用。
  • mask_token (str, 可选,默认为 "<mask>") — 用于掩码值的标记。这是在用掩码语言建模训练此模型时使用的标记。这是模型会尝试预测的标记。
  • additional_special_tokens (List[str], 可选,默认为 ["<s>NOTUSED", "</s>NOTUSED"]) — 词汇器使用的额外特殊标记。

构建一个“快速”的XLM-RoBERTa词汇器(由HuggingFace的tokenizers库支持)。基于RobertaTokenizerXLNetTokenizer改编。基于BPE

此词汇器继承自PreTrainedTokenizerFast,其中包含大多数主要方法。用户应查阅这个超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

< >

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

参数

  • token_ids_0 (整数列表) — 要添加特殊标记的ID列表。
  • token_ids_1 (整数列表, 可选) — 可选的序列对第二ID列表。

返回值

List[int]

带上适当特殊标记的输入ID列表。

通过拼接和添加特殊标记来构建模型输入,用于序列分类任务,格式如下

  • 单个序列:<s> X </s>
  • 序列对:<s> A </s></s> B </s>

create_token_type_ids_from_sequences

< >

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

参数

  • token_ids_0 (整数列表) — ID列表。
  • token_ids_1 (列表[int]可选) — 可选的第二序列对ID列表。

返回值

List[int]

全零列表。

从提供的两个序列创建掩码,用于序列对分类任务。XLM-RoBERTa 不使用标记类型 ID,因此返回一个全零列表。

Pytorch
隐藏Pytorch内容

XLMRobertaModel

transformers.XLMRobertaModel

< >

( config add_pooling_layer = True )

参数

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

该模型是一个仅输出原始隐藏状态而不在顶部添加任何特定层的裸XLM-RoBERTa模型转型器。

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

该模型可以表现为一个编码器(只使用自我注意力)以及一个解码器,在这种情况下,在自我注意力层之间添加一个交叉注意力层,遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在《只需检索注意力》中描述的架构。

要作为解码器运行,该模型需要使用配置的 is_decoder 参数初始化为 True。要在 Seq2Seq 模型中使用,需要将 is_decoder 参数和 add_cross_attention 都设置为 True;正向传递输入需要 encoder_hidden_states

.. _只需注意力: https://arxiv.org/abs/1706.03762

forward

< >

input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None past_key_values: 可选 = None use_cache: 可选 = None transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor) transformers.modeling_output.BaseModelOutputWithPoolingAndCrossAttentions 或者 torch.FloatTensor 的元组

参数

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

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

    什么是输入ID?

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

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

    什么是注意力掩码?

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

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

    什么是标记类型ID?

  • position_ids (形状为(batch_size, sequence_length)torch.LongTensor可选)— 每个输入序列标记在位置嵌入中的位置索引。选择范围为[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, sequence_length, hidden_size), optional) — 可选地,您可以直接传递嵌入表示,而不是传递 input_ids。当您希望对如何将 input_ids 索引转换为相关向量有更多控制时,这很有用,而不是使用模型内部的嵌入查找矩阵。
  • output_attentions (bool, optional) — 是否返回所有注意力的张量。有关更多详细信息,请参阅返回的控件下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详情见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是普通的元组。
  • encoder_hidden_states (torch.FloatTensor 形状 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层的隐藏状态序列。当模型配置为解码器时用于交叉注意力。
  • encoder_attention_mask (torch.FloatTensor 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),而不仅仅是一切 decoder_input_ids 的形状为 (batch_size, sequence_length)

  • use_cache (bool, optional) — 如果设置为 True,将返回 past_key_values 键值状态,并可用于加速解码(参见 past_key_values)。

返回值

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)

一个transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions,或者是一个torch.FloatTensor的元组(如果传入return_dict=False,或者当config.return_dict=False时),根据配置(如XLMRobertaConfig)和输入包含不同元素。

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

  • pooler_output(形状为(batch_size, hidden_size)torch.FloatTensor)—— 经过用于辅助预训练任务(例如BERT系列模型)的层进一步处理后的序列的第一个标记(分类标记)的最后一层隐藏状态。例如,对于BERT系列模型,这返回分类标记在通过一个线性层和tanh激活函数处理之后的结果。线性层的权重来自于预训练期间的下句预测(分类)的目标。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

    解码器交叉注意力层的注意力权重,在注意力软化后用于在交叉注意力头中进行加权平均。

  • past_key_valuestuple(tuple(torch.FloatTensor)),可选,当传入use_cache=True或当config.use_cache=True时返回)—— 长度为config.n_layerstuple(torch.FloatTensor)的元组,每个元组包含2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量,如果config.is_encoder_decoder=True,还可以有2个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。

    包含预计算的隐藏状态(自注意力块中的键和值,以及在config.is_encoder_decoder=True下的跨注意力块中可选),这些状态可以用来(见past_key_values输入)加速序列解析。

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

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

示例

>>> from transformers import AutoTokenizer, XLMRobertaModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaModel.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> last_hidden_states = outputs.last_hidden_state

XLMRobertaForCausalLM

transformers.XLMRobertaForCausalLM

< >

( config )

参数

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

XLM-RoBERTa 模型,顶部添加了代码模型微调用的代码建模头。

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None past_key_values: Tuple = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(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 而不是普通元组。
  • encoder_hidden_states (torch.FloatTensor 的形状 (batch_size, sequence_length, hidden_size),可选) — 编码器最后一层的隐藏状态的序列。如果模型配置为解码器,则用于交叉注意力。
  • encoder_attention_mask (torch.FloatTensor 的形状 (batch_size, sequence_length),可选) — 用于避免在编码器输入的填充标记索引处执行注意力的掩码。如果模型配置为解码器,则用于交叉注意力。选定的掩码值位于 [0, 1]

    • 用于 未掩码 的标记的值是 1,
    • 用于 掩码 的标记的值是 0。
  • labels (torch.LongTensor 的形状 (batch_size, sequence_length),可选) — 用于计算从左至右的语言建模损失(下一步词预测)的标签。索引应在 [-100, 0, ..., config.vocab_size] 范围内(请参阅 input_ids 文档字符串)设置索引为 -100 的标记将被忽略(掩码),仅对 [0, ..., config.vocab_size] 范围内的带有标签的标记计算损失。
  • past_key_valuestuple(tuple(torch.FloatTensor)) 长度为 config.n_layers,其中每个 tuple 包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量)—— 包含注意力块的预计算键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values,用户可以选择仅输入形状为 (batch_size, 1) 的最后 decoder_input_ids(这些输入没有向该模型给出过去的键值状态)而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

  • use_cachebool可选)—— 如果设置为 True,则返回 past_key_values 键值状态,并可用来加速解码(见 past_key_values)。

返回值

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

A transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 的 tuple(如果传递了 return_dict=False 或当 config.return_dict=False),包含根据配置(XLMRobertaConfig)和输入确定的各种元素。

  • losstorch.FloatTensor 形状为(1,),可选,当提供 labels 时返回)—— 语言建模损失(用于预测下一个标记)。

  • logitstorch.FloatTensor 形状为(batch_size, sequence_length, config.vocab_size))—— 语言建模头部的预测得分(SoftMax之前的每个词汇的得分)。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

  • cross_attentionstuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回)—— 每个层的一个 torch.FloatTensor 的 tuple 形状为(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 输入)以加速顺序解码。

XLMRobertaForCausalLM》的向前方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, XLMRobertaForCausalLM, AutoConfig
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> config = AutoConfig.from_pretrained("FacebookAI/roberta-base")
>>> config.is_decoder = True
>>> model = XLMRobertaForCausalLM.from_pretrained("FacebookAI/roberta-base", config=config)

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

>>> prediction_logits = outputs.logits

XLMRobertaForMaskedLM

transformers.XLMRobertaForMaskedLM

< >

( config )

参数

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

顶部有 语言建模 头的 XLM-RoBERTa 模型。

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None 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.MaskedLMOutput or 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]范围内:

    什么是标记类型ID?

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

    什么是位置ID?

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads)可选) - 为禁用自注意力模块中选定的头而设置的掩码。掩码值在 [0, 1] 范围内:
    • 1 表示头没有被 掩码
    • 0 表示头被 掩码
  • inputs_embeds (torch.FloatTensor of shape (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 with shape (batch_size, sequence_length), optional) — 用于计算带遮掩语言建模损失的语言标签。索引应在 [-100, 0, ..., config.vocab_size] (详见 input_ids 文档字符串) 范围内。索引设置为 -100 的标记将被忽略(遮掩),只对具有 [0, ..., config.vocab_size] 索引的标记计算损失
  • kwargs (Dict[str, any], optional, defaults to {}) — 用于隐藏已经弃用的旧参数。

返回值

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

It returns a transformers.modeling_outputs.MaskedLMOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) depending on the configuration (XLMRobertaConfig) and inputs.

  • 损失 (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 带遮掩语言建模 (MLM) 损失。

  • logitstorch.FloatTensor 形状为(batch_size, sequence_length, config.vocab_size))—— 语言建模头部的预测得分(SoftMax之前的每个词汇的得分)。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

这里重载了 XLMRobertaForMaskedLM 的 forward 方法。

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

示例

>>> from transformers import AutoTokenizer, XLMRobertaForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForMaskedLM.from_pretrained("FacebookAI/xlm-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)
>>> tokenizer.decode(predicted_token_id)
' Paris'

>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
0.1

XLMRobertaForSequenceClassification

class transformers.XLMRobertaForSequenceClassification

< >

( config )

参数

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

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

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

forward

< >

( input_ids: 可选 = 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 of shape (batch_size, sequence_length)) — 输入序列标记的索引,位于词表内。

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

    什么是输入ID?

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

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

    什么是注意力掩码?

  • token_type_ids (形状为(batch_size, sequence_length)torch.LongTensor,可选)— 标记索引以指示输入的两个部分。在[0, 1]之间选择索引:

    • 0对应于《a sentence A》标记,
    • 1对应于《a sentence B》标记。

    什么是标记类型ID?

  • position_ids (形状为(batch_size, sequence_length)torch.LongTensor,可选)— 每个输入序列标记在位置嵌入中的位置索引。在范围[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.SequenceClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.SequenceClassifierOutput 或一个包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),具体取决于配置(XLMRobertaConfig)和输入。

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

  • logits (torch.FloatTensor of shape (batch_size, config.num_labels)) — 分类(或当 config.num_labels==1 时为回归)的分数(在 SoftMax 之前)。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, XLMRobertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = XLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")

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

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

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'optimism'

>>> # 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 = XLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, XLMRobertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = XLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", 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 = XLMRobertaForSequenceClassification.from_pretrained(
...     "cardiffnlp/twitter-roberta-base-emotion", 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

XLMRobertaForMultipleChoice

class transformers.XLMRobertaForMultipleChoice

< >

( config )

参数

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

在顶部添加了多选择分类头的 XLM-RoBERTa 模型(一个位于池化输出之上的线性层和一个 softmax),例如用于 RocStories/SWAG 任务。

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

forward

< >

( 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

参数

  • 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 标记。

    什么是标记类型 ID?

  • position_ids (形式为 torch.LongTensor 的形状为 (batch_size, num_choices, 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, num_choices, sequence_length, hidden_size)可选)—— 可选,而不是传递 input_ids,您可以直接传递嵌入表示。如果想要比模型内部的嵌入查找矩阵有更多的控制权来将 input_ids 索引转换为关联向量,那么这很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息,请参阅返回张量部分的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息,请参阅返回张量部分的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
  • labelstorch.LongTensor 的形状:(batch_size,)可选)— 计算多选题分类损失的标签。索引应在 [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 时),这些元素根据配置(XLMRobertaConfig)和输入而有所不同。

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

  • logits (形状为 (batch_size, num_choices)torch.FloatTensor)— num_choices 是输入张量的第二维。

    分类分数(在 SoftMax 之前)。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

XLMRobertaForMultipleChoice 的 forward 方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, XLMRobertaForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = XLMRobertaForMultipleChoice.from_pretrained("FacebookAI/xlm-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

XLMRobertaForTokenClassification

transformers.XLMRobertaForTokenClassification

< >

( config )

参数

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

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

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

forward

< >

( input_ids: 可选 = 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.TokenClassifierOutputtuple(torch.FloatTensor)

参数

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

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

    什么是input IDs?

  • 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_masktorch.FloatTensor 的形状为(num_heads,)(num_layers, num_heads)可选)——用于取消选定头部自我注意力模块的掩码。掩码值在[0, 1]范围内选定:

    • 1 表示该头部未掩码,
    • 0 表示该头部被掩码。
  • inputs_embedstorch.FloatTensor 的形状为 (batch_size, sequence_length, hidden_size)可选)——可选择不直接传 input_ids,而选择直接传嵌入式表示。当你想要(model’s internal embedding lookup matrix)以外的方式控制将 input_ids 索引转换为关联向量的方式时,这非常有用。
  • output_attentionsbool可选)——是否返回所有注意力层的注意力张量。有关返回张量中 attentions 的更多详细信息,请参阅。
  • output_hidden_states (bool, 可选) —— 是否返回所有层的隐藏状态。更多详情请见返回张量中关于hidden_states的说明。
  • return_dict (bool, 可选) —— 是否返回ModelOutput而不是普通的元组。
  • labels (torch.LongTensor shape为(batch_size, sequence_length), 可选) —— 用于计算token分类损失的标签。索引应位于[0, ..., config.num_labels - 1]

返回值

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.TokenClassifierOutput 或一个包含torch.FloatTensor的tuple(如果传递了return_dict=False或当config.return_dict=False),包含各种元素,这取决于配置(XLMRobertaConfig)和输入。

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

  • logits (torch.FloatTensor shape为(batch_size, sequence_length, config.num_labels)) —— 分类分数(在SoftMax之前)。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, XLMRobertaForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("Jean-Baptiste/roberta-large-ner-english")
>>> model = XLMRobertaForTokenClassification.from_pretrained("Jean-Baptiste/roberta-large-ner-english")

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

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

>>> predicted_token_class_ids = logits.argmax(-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
['O', 'ORG', 'ORG', 'O', 'O', 'O', 'O', 'O', 'LOC', 'O', 'LOC', 'LOC']

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.01

XLMRobertaForQuestionAnswering

transformers.XLMRobertaForQuestionAnswering

< >

( config )

参数

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

XLM-RoBERTa 模型,顶部带有段划分头,用于抽取式问答任务,如 SQuAD(在隐藏状态输出上添加线性层以计算 span start logitsspan end logits)。

该模型继承自 PreTrainedModel。查看上级文档,了解库为其所有模型(如下载或保存,调整输入嵌入大小,剪枝头部等)实现的一般方法。

该模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并查阅 PyTorch 文档了解所有相关问题,包括一般用途和行为。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

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

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

    什么是输入ID?

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

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

    什么是注意力掩码?

  • token_type_ids (形状为(batch_size, sequence_length)torch.LongTensor,可选) — 标记段索引,用于指示输入的前后部分。索引在[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 而不是纯元组。
  • start_positions (torch.LongTensor,形状为(batch_size,)可选) — 计算标记跨度起始位置的标签。位置被限制在序列的长度sequence_length内。序列之外的位置在计算损失时不会被考虑。
  • end_positions (torch.LongTensor,形状为(batch_size,)可选) — 计算标记跨度结束位置的标签。位置被限制在序列的长度sequence_length内。序列之外的的位置在计算损失时不被考虑。

返回值

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个包含各种元素的 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),这些元素取决于配置(XLMRobertaConfig)和输入。

  • losstorch.FloatTensor,形状为(1,)可选,当提供了labels时返回) — 总跨度提取损失是起始位置和结束位置交叉熵的总和。

  • start_logitstorch.FloatTensor,形状为(batch_size, sequence_length)) — 跨度起始分数(在SoftMax之前)。

  • end_logitstorch.FloatTensor,形状为(batch_size, sequence_length)) — 跨度结束分数(在SoftMax之前)。

  • hidden_statestuple(torch.FloatTensor),可选,当传入output_hidden_states=True或当config.output_hidden_states=True时返回)—— 形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor的元组(如果一个模型有嵌入层,则一个是嵌入层的输出,另一个是每层的输出)。

    每个层的模型输出以及可选的初始嵌入输出中的隐藏状态。

  • attentionstuple(torch.FloatTensor),可选,当传入output_attentions=True或当config.output_attentions=True时返回)—— 形状为(batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor的元组(每个层有一个)。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

XLMRobertaForQuestionAnswering 的 forward 方法覆盖了特殊方法 __call__

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

示例

>>> from transformers import AutoTokenizer, XLMRobertaForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("deepset/roberta-base-squad2")
>>> model = XLMRobertaForQuestionAnswering.from_pretrained("deepset/roberta-base-squad2")

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

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
' puppet'

>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
0.86
TensorFlow
隐藏 TensorFlow 内容

TFXLMRobertaModel

transformers.TFXLMRobertaModel

< >

( config *inputs **kwargs )

参数

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

一个裸XLM RoBERTa模型Transformer,输出原始隐藏状态,没有顶部的任何特定head

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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 (Numpy arraytf.Tensor,形状为 (批量大小, 序列长度)) — 输入序列标记在词汇表中的索引。索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()什么是输入ID?
  • attention_mask (Numpy数组tf.Tensor,形状为(batch_size, sequence_length)可选) — 避免在填充token索引上执行注意力操作的掩码。在[0, 1]范围内选择的掩码值:

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

  • position_ids (Numpy数组tf.Tensor,形状为(batch_size, sequence_length)可选) — 位置嵌入中每个输入序列token的位置索引。在范围[0, config.max_position_embeddings - 1]内选择。什么是位置ID?
  • head_mask (Numpy arraytf.Tensor形状为(num_heads,),(num_layers, num_heads)可选)— 用于取消自注意力模块中选定头的掩码。掩码值选择的范围在[0, 1]

    • 1表示头未掩码
    • 0表示头已掩码
  • inputs_embeds (tf.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模块在训练和评估模式下有不同的行为)。
  • encoder_hidden_states (tf.Tensor的形状为 (batch_size, sequence_length, hidden_size)可选) —— 编码器最后层的隐藏状态序列。如果模型配置为解码器,则用于交叉注意力。
  • encoder_attention_mask (tf.Tensor的形状为 (batch_size, sequence_length)可选) —— 用于避免在编码器输入的填充token索引上执行注意力操作的掩码。如果模型配置为解码器,则用于交叉注意力。掩码值选择在[0, 1]之间:

    • 1代表未掩码的token;
    • 0代表掩码的token。
  • past_key_values (Tuple[Tuple[tf.Tensor]]的长度为config.n_layers) —— 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用past_key_values,用户可以可选地输入只有最后一个decoder_input_ids(那些没有给出这个模型的过去键值状态的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 组合(取决于配置(XLMRobertaConfig)和输入

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

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

    此输出通常 不是 输入语义内容的好总结,平均或池化整个输入序列的隐藏状态序列通常更好。

  • past_key_values (可选,当 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 (tuple(tf.Tensor)可选,当 output_hidden_states=True 被传递或当 config.output_hidden_states=True 时返回) — 包含每个层的 tf.Tensor 的元组(一个用于嵌入输出 + 每个层的输出)的形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

    解码器交叉注意力层的注意力权重,在注意力软化后用于在交叉注意力头中进行加权平均。

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaModel.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> last_hidden_states = outputs.last_hidden_state

TFXLMRobertaForCausalLM

transformers.TFXLMRobertaForCausalLM

< >

( config: XLMRobertaConfig *inputs **kwargs )

参数

  • config (XLMRobertaConfig) — 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.

XLM-RoBERTa 模型,顶部添加了代码模型微调用的代码建模头。

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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.TFCausalLMOutputWithCrossAttentions or tuple(tf.Tensor)

参数

  • input_ids (Numpy数组tf.Tensor,形状为 (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。索引可以使用 AutoTokenizer 获得详见 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()。关于输入索引的详细信息,请参阅输入索引是什么?
  • attention_mask (Numpy数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选择在 [0, 1]
    • 1 代表 未掩码 的标记,
    • 0 代表 掩码 的标记。关于注意掩码的详细信息,请参阅 注意掩码是什么?
  • token_type_ids (Numpy数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 段标记索引,用于指示输入的先和后部分。索引选择在 [0, 1]
  • position_idsNumPy数组tf.Tensor形状为(batch_size, sequence_length)可选)——指定每个输入序列标记位置的嵌入的位置。在[0, config.max_position_embeddings - 1]范围内选定。什么是位置ID?
  • head_maskNumPy数组tf.Tensor形状为(num_heads,)(num_layers, num_heads)可选)——用于消除自注意力模块中选定头的掩码。掩码值在[0, 1]范围内选择:
    • 1 表示头部未被掩码,
    • 0 表示头部被掩码。
  • inputs_embedstf.Tensor形状为(batch_size, sequence_length, hidden_size)可选)——除了传递input_ids外,您还可以直接传递嵌入表示。如果您希望比模型内部的嵌入查找矩阵有更多控制权来转换input_ids索引到相关矢量,则非常有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的孩子张量。details,请see返回的tensor下的attentions。此参数只能用于eager模式,在图模式中,将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。details,请see返回的tensor下的hidden_states。此参数只能用于eager模式,在图模式中,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回ModelOutput而不是plain tuple。此参数可以用于eager模式,在图模式中,值始终设置为True。
  • training (bool, 可选, 默认为 False) — 是否使用模型在训练模式(一些模块如dropout模块在训练和评估之间有不同的行为)。
  • encoder_hidden_states (tf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 编码器最后一层的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。
  • encoder_attention_mask (tf.Tensor,形状为 (batch_size, sequence_length)可选) — 避免在编码器输入的填充标记索引上进行注意力操作的掩码。如果模型配置为解码器,则在交叉注意力中使用。掩码值选择在 [0, 1]

    • 1 表示未掩码的标记,
    • 0 表示掩码标记。
  • past_key_values (长度为 config.n_layersTuple[Tuple[tf.Tensor]]) — 包含注意力的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids(这些没有将过去键值状态传递给模型的)而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids
  • use_cachebool可选,默认为 True)—— 如果设置为 True,则返回 past_key_values 键值状态,并可用于加速解码(见 past_key_values)。在训练期间设置为 False,在生成期间设置为 True
  • labels (形状为 (batch_size, sequence_length)tf.Tensornp.ndarray可选)—— 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 范围内。

返回值

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个包含 tf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),它根据配置(XLMRobertaConfig)和输入包含各种元素。

  • loss (当提供 labels 时,返回形状为 (n,)tf.Tensor,其中 n 是未掩码标签的数量)—— 语言建模损失(用于下一个令牌预测)。

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

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

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

    解码器交叉注意力层的注意力权重,在注意力软化后用于在交叉注意力头中进行加权平均。

  • past_key_values (可选,当 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 输入)以加速顺序解码。

TFXLMRobertaForCausalLM 的前进方法,重写了 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaForCausalLM.from_pretrained("FacebookAI/xlm-roberta-base")

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

TFXLMRobertaForMaskedLM

transformers.TFXLMRobertaForMaskedLM

< >

( config *inputs **kwargs )

参数

  • config (XLMRobertaConfig) — 包含模型所有参数的模型配置类。通过配置文件初始化不加载与模型关联的权重,只加载配置。请参阅 from_pretrained() 方法来加载模型权重。

XLM RoBERTa 模型顶部具有一个 语言建模 头。

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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.TFMaskedLMOutput or tuple(tf.Tensor)

参数

  • input_idsNumpy 数组tf.Tensor,形状为 (batch_size, sequence_length)) — 输入序列中词元的词汇索引。可以通过使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()什么是输入 ID?
  • attention_maskNumpy 数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 用于避免对填充词元的索引执行注意力的掩码。在 [0, 1] 中选择的掩码值:

  • token_type_idsNumpy 数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 用来指示输入的第一部分和第二部分的词元类型索引。在 [0, 1] 中选择的索引:

  • position_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的索引。在 [0, config.max_position_embeddings - 1] 范围内选择。什么是位置 ID?
  • head_mask (Numpy 数组tf.Tensor 形状为 (num_heads,)(num_layers, num_heads)可选) — 用来屏蔽自注意力模块中选择的頭部的掩码。掩码值选择在 [0, 1] 范围内:
    • 1 表示头部未被屏蔽,
    • 0 表示头部被屏蔽。
  • inputs_embeds (tf.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模块在训练和评估之间有不同的行为)。
  • labels (tf.Tensor,形状为 (batch_size, sequence_length)可选) — 用于计算掩码语言模型损失的标签。索引应在 [-100, 0, ..., config.vocab_size] (见 input_ids 的文档字符串)中(tokens with indices set to -100 被忽略(掩码),只计算 [0, ..., config.vocab_size] 中的标签所对应的 tokens 的损失)

返回值

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

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

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

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

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

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaForMaskedLM.from_pretrained("FacebookAI/xlm-roberta-base")

>>> 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)
>>> tokenizer.decode(predicted_token_id)
' Paris'
>>> 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)
>>> round(float(outputs.loss), 2)
0.1

TFXLMRobertaForSequenceClassification

transformers.TFXLMRobertaForSequenceClassification

< >

( config *inputs **kwargs )

参数

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

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

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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 (Numpy数组tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列中词汇的标记索引。索引可以用AutoTokenizer获得。详情见PreTrainedTokenizer.call()PreTrainedTokenizer.encode()什么是输入ID?
  • attention_mask (Numpy arraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选择在 [0, 1] 内:

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

  • position_ids (Numpy arraytf.Tensor 形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的索引。选择在范围 [0, config.max_position_embeddings - 1] 内。 什么是位置 ID?
  • head_mask (Numpy arraytf.Tensor,形状为(num_heads,)(num_layers, num_heads)可选)— 取消选中self-attention模块的head。在[0, 1]范围内选取的mask值:

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

返回值

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个包含各种元素的 tf.Tensor 元组的对象(如果传递了 return_dict=False 或当 config.return_dict=False 时)。

  • loss (tf.Tensor of shape (batch_size, ), optional, 如果提供 labels 则返回) — 分类(或如果 config.num_labels == 1 则为回归)损失。

  • logits (tf.Tensor of shape (batch_size, config.num_labels)) — 分类(或如果 config.num_labels == 1 则为回归)分数(在 SoftMax 之前)。

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

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

TFXLMRobertaForSequenceClassification的forward方法,重写了__call__特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = TFXLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")

>>> 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])
>>> model.config.id2label[predicted_class_id]
'optimism'
>>> # 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 = TFXLMRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.08

TFXLMRobertaForMultipleChoice

transformers.TFXLMRobertaForMultipleChoice

< >

( config *inputs **kwargs )

参数

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

XLM Roberta 模型在顶部具有多选题分类的头部(在拼接输出层上方的线性层和 softmax),例如用于 RocStories/SWAG 任务。

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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 (Numpy array or tf.Tensor of shape (batch_size, num_choices, sequence_length)) —词汇中的输入序列标记索引。索引可以通过使用AutoTokenizer来获得。有关详细信息,请参阅PreTrainedTokenizer.call()PreTrainedTokenizer.encode()什么是输入ID?
  • attention_mask (numpy数组tf.Tensor 形状为 (批量大小, 选项数, 序列长度)可选) — 用于避免在填充标记索引上执行注意力的掩码。选中的掩码值在 [0, 1] 之间:

  • token_type_ids (numpy数组tf.Tensor 形状为 (批量大小, 选项数, 序列长度)可选) — 指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 之间选择:

  • position_ids (numpy数组tf.Tensor 形状为 (批量大小, 选项数, 序列长度)可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。什么是位置 ID?
  • head_mask (Numpy数组tf.Tensor,形状为(num_heads,)(num_layers, num_heads)可选) — 用于取消自注意力模块中选中头的掩码。掩码值在[0, 1]中选中:

    • 1 表示该头未被掩码。
    • 0 表示该头被掩码。
  • inputs_embeds (tf.Tensor,形状为(batch_size, num_choices, 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.Tensor of shape (batch_size,), optional) — 用于计算多选分类损失的标签。索引应在 [0, ..., num_choices] 范围内,其中 num_choices 是输入张量第二维的大小。(参见上面的 input_ids

返回值

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

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

  • loss (tf.Tensor of shape (batch_size, ), optional, returned when labels is provided) — 分类损失。

  • logits (tf.Tensor of shape (batch_size, num_choices)) — num_choices 是输入张量第二维大小。(参见上面的 input_ids

    分类分数(在 SoftMax 之前)。

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

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

TFXLMRobertaForMultipleChoice的forward方法重写了__call__特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = TFXLMRobertaForMultipleChoice.from_pretrained("FacebookAI/xlm-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."

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

TFXLMRobertaForTokenClassification

class transformers.TFXLMRobertaForTokenClassification

< >

( config *inputs **kwargs )

参数

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

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

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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.TFTokenClassifierOutput or tuple(tf.Tensor)

参数

  • input_ids (Numpy数组tf.Tensor,形状为 (batch_size, sequence_length)) — 在词汇表中的输入序列标记的索引。索引可以通过使用 AutoTokenizer 获取。有关详细说明,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()。关于什么是输入ID,请参阅 这里
  • attention_mask (形状为 (batch_size, sequence_length) 的 Numpy 数组或 tf.Tensor,可选) — 避免在填充 token 索引上执行注意力的掩码。掩码值在 [0, 1] 范围内选择:

  • token_type_ids (形状为 (batch_size, sequence_length) 的 Numpy 数组或 tf.Tensor,可选) — 标识输入的每个部分是第一段还是第二段的分段 token 索引。索引在 [0, 1] 范围内选择:

  • position_ids (形状为 (batch_size, sequence_length) 的 Numpy 数组或 tf.Tensor,可选) — 每个输入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。什么是位置 ID?
  • head_maskNumpy数组tf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选)— 用于取消选中自我注意力模块的头部的遮罩。遮罩值在 [0, 1] 之间选择:

    • 1 表示头部未遮罩,
    • 0 表示头部被遮罩。
  • inputs_embedstf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选)— 可选地,不传递 input_ids,可以选择直接传递嵌入表示。这在您想要比模型内部嵌入查找矩阵对 input_ids 索引转换为相关向量的转换有更多控制权时非常有用。
  • output_attentionsbool可选)— 是否返回所有注意力层的注意力张量。有关返回的张量中的 attentions 的更多信息,请参见。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool可选)—— 是否返回所有层的隐藏状态。有关返回张量下 hidden_states 的详细信息,请参阅。此参数只能在 eager 模式下使用,在 graph 模式下将使用配置中的值。
  • return_dict (bool可选)—— 是否返回 ModelOutput 而不是纯元组。此参数可以在 eager 模式下使用,在 graph 模式下将始终设置为 True。
  • training (bool可选,默认为 False)—— 是否以训练模式使用模型(某些模块如 dropout 模块在训练和评估之间有不同的行为)。
  • labels (tf.Tensor of shape (batch_size, sequence_length), optional) — 用于计算token分类损失的标签。索引应在 [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)根据配置(XLMRobertaConfig)和输入组成。

  • loss (tf.Tensor of shape (n,), optional, where n is the number of unmasked labels, returned when labels is provided) — 分类损失。

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

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

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-large-ner-english")
>>> model = TFXLMRobertaForTokenClassification.from_pretrained("ydshieh/roberta-large-ner-english")

>>> 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()]
>>> predicted_tokens_classes
['O', 'ORG', 'ORG', 'O', 'O', 'O', 'O', 'O', 'LOC', 'O', 'LOC', 'LOC']
>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)
>>> round(float(loss), 2)
0.01

TFXLMRobertaForQuestionAnswering

transformers.TFXLMRobertaForQuestionAnswering

< >

( config *inputs **kwargs )

参数

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

在顶部具有跨度分类头的XLM RoBERTa模型,用于如SQuAD(在隐藏状态输出之上添加线性层以计算跨度起始logits跨度结束logits)的抽取式问答任务。

此模型继承自 TFPreTrainedModel。有关库为所有模型(如下载或保存、调整输入嵌入层、修剪head等)实现的通用方法,请查阅超类文档。

此模型也是 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 函数一样传递输入!

调用

< >

( ) export const metadata = 'undefined';transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

参数

  • input_ids (Numpy arraytf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列符号在词汇表中的索引。索引可以通过使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.call()PreTrainedTokenizer.encode()什么是输入ID?
  • attention_mask (NumPy数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 避免在填充token索引上执行注意力操作的掩码。掩码值在 [0, 1] 中选择:

  • token_type_ids (NumPy数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 标识输入的前后部分的段标记索引。索引在 [0, 1] 中选择:

  • position_ids (NumPy数组tf.Tensor,形状为 (batch_size, sequence_length)可选) — 每个输入序列token在位置嵌入中的索引。取值范围为 [0, config.max_position_embeddings - 1]什么是位置ID?
  • head_maskNumpy数组tf.Tensor,形状为 (num_heads,)(num_layers, num_heads)可选) — 用于取消激活自注意力模块中选定头的掩码。掩码值选择在 [0, 1]

    • 1 表示该头 未被掩码
    • 0 表示该头被 掩码
  • inputs_embedstf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想在将 input_ids 索引转换为相关向量时比模型内部嵌入查找矩阵有更多控制权,这会有所帮助。
  • output_attentionsbool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 attentions。此参数仅在紧迫模式下可用,在图模式下将使用配置文件中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多信息请参阅返回的张量中的 hidden_states。此参数只能在即时模式中使用,在图模式中将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通元组。此参数可以在即时模式中使用,在图模式中此值始终设置为 True。
  • training (bool, 可选,默认为 False) — 是否使用模型进行训练模式(一些模块如 dropout 模块在不同模式和评估模式之间有不同的行为)。
  • start_positions (tf.Tensor 形状为 (batch_size,)可选) — 标记的跨度起始位置的标签,用于计算标记分类损失。位置被限制在序列长度(sequence_length)内。序列之外的位置在计算损失时不被考虑。
  • end_positions (tf.Tensor 形状为 (batch_size,)可选) — 标记的跨度结束位置的标签,用于计算标记分类损失。位置被限制在序列长度(sequence_length)内。序列之外的位置在计算损失时不被考虑。

返回值

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

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

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

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

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

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

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

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

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

TFXLMRobertaForQuestionAnswering 的 forward 方法,重写了 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-base-squad2")
>>> model = TFXLMRobertaForQuestionAnswering.from_pretrained("ydshieh/roberta-base-squad2")

>>> 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]
>>> tokenizer.decode(predict_answer_tokens)
' puppet'
>>> # 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)
>>> round(float(loss), 2)
0.86
JAX
隐藏 JAX 内容

FlaxXLMRobertaModel

transformers.FlaxXLMRobertaModel

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

一个裸XLM RoBERTa模型Transformer,输出原始隐藏状态,没有顶部的任何特定head

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (batch_size, sequence_length)) — 词汇中输入序列标记的索引。

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

    有关输入索引的更多信息,请参阅 什么是输入索引?

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

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

    什么是注意掩码?

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

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

    什么是标记类型 ID?

  • position_ids (numpy.ndarray 形状 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的索引。在范围 [0, config.max_position_embeddings – 1] 中选择。
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- 用于清空注意力模块选定头部的掩码。掩码在选择值[0, 1]`中选定:
    • 1 表示头部未掩码
    • 0 表示头部被掩码
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。

返回值

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个包含 torch.FloatTensor 的元组(如果在 return_dict=False 的情况下传递或者在 config.return_dict=False 情况下),根据配置(XLMRobertaConfig)和输入的不同而包含各种元素。

  • last_hidden_state (jnp.ndarray of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。

  • pooler_output (jnp.ndarray of shape (batch_size, hidden_size)) — 序列中第一个令牌(分类令牌)的最后一层隐藏状态,通过线性层和Tanh激活函数进一步处理后。线性层的权重在预训练期间通过下一个句子预测(分类)目标进行训练。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaModel

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaModel.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> last_hidden_states = outputs.last_hidden_state

FlaxXLMRobertaForCausalLM

transformers.FlaxXLMRobertaForCausalLM

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

Mixed Mandarin English Roberta Model,在隐藏状态输出上层具有语言模型头 (即线性层),例如用于自回归任务。

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray 形状 (batch_size, sequence_length)) — 词汇库中输入序列token的索引。

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

    什么是输入ID?

  • attention_mask (numpy.ndarray 形状 (batch_size, sequence_length),可选) — 用于避免在填充token索引上执行注意力的掩码。掩码值选择在 [0, 1]

    • 1 代表未掩码的token,
    • 0 代表已掩码的token。

    什么是注意力掩码?

  • token_type_ids (numpy.ndarray 形状 (batch_size, sequence_length),可选) — 用于指示输入的先后部分的段token索引。索引选择在 [0, 1]

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

    什么是token类型ID?

  • position_ids 是一个形状为 (batch_size, sequence_length)numpy.ndarray,表示每个输入序列标记的位置在位置嵌入中的索引。选择范围在 [0, config.max_position_embeddings - 1] 内。
  • head_mask 是一个形状为 (batch_size, sequence_length)numpy.ndarray,表示要屏蔽注意模块中选择的头部。屏蔽值选择范围在 [0, 1]
  • return_dict 是一个布尔值,表示是否返回一个 ModelOutput 而不是平坦的元组。

返回值

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或当传递 return_dict=False 或当 config.return_dict=False 时,一个包含各种元素的元组 torch.FloatTensor,具体取决于配置(XLMRobertaConfig)和输入。

  • logits (jnp.ndarray 形状 (batch_size, sequence_length, config.vocab_size)) —— 语言建模头部的预测分数(SoftMax之前的每个词汇的分数)。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

  • cross_attentions (tuple(jnp.ndarray)可选的,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) —— 都是形状为 (batch_size, num_heads, sequence_length, sequence_length)jnp.ndarray 的元组(每个层都有一个)。

    注意 softmax 之后的交叉注意力权重,用于在交叉注意力头部中计算加权的平均值。

  • past_key_values (tuple(tuple(jnp.ndarray))可选的,当传递 use_cache=True 或当 config.use_cache=True 时返回) —— 长度为 config.n_layersjnp.ndarray 元组的元组,每个元组包含用于编码器-解码器设置的模型的自注意力和交叉注意力的缓存的键、值状态。如果 config.is_decoder = True,则才相关。

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

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForCausalLM.from_pretrained("FacebookAI/xlm-roberta-base")

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

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]

FlaxXLMRobertaForMaskedLM

transformers.FlaxXLMRobertaForMaskedLM

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

XLM RoBERTa 模型顶部具有一个 语言建模 头。

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray,形状为 (batch_size, sequence_length)) — 词库中输入序列标记的索引。

    索引可以使用 AutoTokenizer 获取。详情请查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (numpy.ndarray,形状为 (batch_size, sequence_length)可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选在 [0, 1]

    • 1 对应于 非掩码 令牌,
    • 0 对应于 掩码 令牌。

    什么是注意力掩码?

  • token_type_ids (numpy.ndarray 格式,形状为 (batch_size, sequence_length)可选) — 段标记索引,用于指示输入的第一部分和第二部分。索引选择在 [0, 1]
    • 0 对应于 句子 A 标记,
    • 1 对应于 句子 B 标记。
  • position_ids (numpy.ndarray 格式,形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的索引。选择范围在 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray 格式,形状为 (batch_size, sequence_length)可选) -- 用于置零注意模块选中头的掩码。掩码值选择在 `[0, 1]`:
    • 1 表示头 未掩码
    • 0 表示头 已掩码
  • return_dict (bool, optional) — 是否返回一个 ModelOutput,而不是一个普通的元组。

返回值

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个包含 torch.FloatTensor 的元组(如果在 return_dict=False 的情况下传递或者在 config.return_dict=False 情况下),根据配置(XLMRobertaConfig)和输入的不同而包含各种元素。

  • last_hidden_state (jnp.ndarray of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的序列隐藏状态。

  • pooler_output (jnp.ndarray of shape (batch_size, hidden_size)) — 序列中第一个令牌(分类令牌)的最后一层隐藏状态,通过线性层和Tanh激活函数进一步处理后。线性层的权重在预训练期间通过下一个句子预测(分类)目标进行训练。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForMaskedLM.from_pretrained("FacebookAI/xlm-roberta-base")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")

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

FlaxXLMRobertaForSequenceClassification

transformers.FlaxXLMRobertaForSequenceClassification

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

带有序列分类/回归头(在池化输出之上的一层线性层)的XLM Roberta模型,例如用于GLUE任务。

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng : PRNGKey = None train : bool = False output_attentions : Optional = None output_hidden_states : Optional = None return_dict : Optional = None past_key_values : dict = None ) transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput or tuple(torch.FloatTensor)

参数

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

    索引可以通过AutoTokenizer 获取。更多细节请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

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

    • 1 对应 未掩码 的词
    • 0 对应 掩码 的词

    什么是注意掩码?

  • token_type_ids (形状为 (batch_size, sequence_length)numpy.ndarray可选) — 表示输入的两部分(句子 A 和句子 B)的段标记索引。索引选择在 [0, 1] 中:

    • 0 代表 句子 A 标记
    • 1 代表 句子 B 标记

    什么是标记类型 ID?

  • position_ids (形状为 (batch_size, sequence_length)numpy.ndarray可选) — 每个输入序列中词在位置嵌入中的位置索引。
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- 使注意模块中选定的头部失效的掩码。在[0, 1]中选取的掩码值:
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回值

transformers.modeling_flax_outputs.FlaxSequenceClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个包含torch.FloatTensor的元组(如果传递了return_dict=False或当config.return_dict=False时),其元素取决于配置(XLMRobertaConfig)和输入。

  • logits (jnp.ndarray of shape (batch_size, config.num_labels)) — 分类(或当 config.num_labels==1 时为回归)得分(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForSequenceClassification.from_pretrained("FacebookAI/xlm-roberta-base")

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

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

FlaxXLMRobertaForMultipleChoice

class transformers.FlaxXLMRobertaForMultipleChoice

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

XLM Roberta 模型在顶部具有多选题分类的头部(在拼接输出层上方的线性层和 softmax),例如用于 RocStories/SWAG 任务。

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput or tuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length)) — 输入序列单词在词汇表中的索引。

    索引可以通过 AutoTokenizer 得到。详见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (numpy.ndarray 形状为 (batch_size, num_choices, sequence_length)可选) — 用于避免在填充标记索引上进行注意力操作的掩码。掩码值选自 [0, 1]

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

    什么是注意力掩码?

  • token_type_ids (numpy.ndarray 形状为 (batch_size, num_choices, sequence_length)可选) — 段落标记索引,用于指示输入的首先是哪一部分:

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

    什么是标记类型 ID?

  • position_ids (numpy.ndarray 形状为 (batch_size, num_choices, sequence_length)可选) — 每个输入序列标记在位置嵌入中的索引。选择范围在 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 用于取消激活注意力模块中选定头的掩码。在 [0, 1]` 中选定的掩码值:

    • 1 表示头未被 掩码
    • 0 表示头被 掩码
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。

返回值

transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutputtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或包含各种元素的元组(取决于配置和输入)(if return_dict=False is passed or when config.return_dict=False),其中包括不同的元素,取决于配置(XLMRobertaConfig)和输入。

  • logits (jnp.ndarray of shape (batch_size, num_choices)) — num_choices 是输入张量的第二个维度(见上面的 input_ids)。

    分类分数(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForMultipleChoice

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForMultipleChoice.from_pretrained("FacebookAI/xlm-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."

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})

>>> logits = outputs.logits

FlaxXLMRobertaForTokenClassification

class transformers.FlaxXLMRobertaForTokenClassification

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

  • config (XLMRobertaConfig) — 模型配置类,包含所有模型参数。通过配置文件初始化时,不会加载模型相关权重,仅加载配置。请查看from_pretrained() 方法来加载模型权重。

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

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or tuple(torch.FloatTensor)

参数

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

    可以通过 AutoTokenizer 获取索引。详见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择:
    • 对于 未掩码 的标记:值为 1,
    • 对于 掩码 的标记:值为 0。
  • token_type_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 用于指示输入的第一部分和第二部分的标记类型索引。索引在 [0, 1] 中选择:
    • 0:对应于句子 A 的标记,
    • 1:对应于句子 B 的标记。
  • position_ids (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 输入序列中每个标记的位置索引。位置索引在 [0, config.max_position_embeddings - 1] 的范围内。
  • head_mask (形状为 (batch_size, sequence_length)numpy.ndarray,可选)-- 用于注销注意力模块中选定的头的掩码。在[0, 1]` 中选定的掩码值:

    • 1 表示头未被 掩码
    • 0 表示头已被 掩码
  • return_dictbool,可选)— 是否返回 ModelOutput 而不是普通的元组。

返回值

transformers.modeling_flax_outputs.FlaxTokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一个包含各种元素的 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False),具体取决于配置(XLMRobertaConfig)和输入。

  • logits (形状为 (batch_size, sequence_length, config.num_labels)jnp.ndarray)— 分类得分(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForTokenClassification

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForTokenClassification.from_pretrained("FacebookAI/xlm-roberta-base")

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

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

FlaxXLMRobertaForQuestionAnswering

class transformers.FlaxXLMRobertaForQuestionAnswering

< >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

XLM Roberta 模型,顶部添加跨度分类头用于提取式问答任务,如 SQuAD(隐藏状态输出之上线性层,用于计算 跨度起始对数跨度结束对数)。

此模型继承自 FlaxPreTrainedModel。检查超类文档,了解库为所有模型实现的原则方法(例如下载、保存和将PyTorch模型的权重转换为)。

该模型也是 flax.linen.Module 子类。将其用作普通的Flax linen模块,并参考Flax文档了解有关通用用法和行为的所有问题。

最后,此模型支持内建的JAX功能,例如:

__call__

< >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (numpy.ndarray of shape (batch_size, sequence_length)) — 输入序列Tokens的词汇索引。

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

    什么是输入ID?

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

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

    什么是注意掩码?

  • token_type_idsnumpy.ndarray 形状为 (batch_size, sequence_length)可选)— 标记类型索引,用于指示输入的第一和第二部分。索引在 [0, 1] 之间选择:

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

    什么是标记类型 ID?

  • position_idsnumpy.ndarray 形状为 (batch_size, sequence_length)可选)— 每个输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.max_position_embeddings - 1]
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- 用于取消激活注意模块选定头的掩码。掩码值在[0, 1]`范围内选择:

    • 1表示头未屏蔽
    • 0表示头被屏蔽
  • return_dict (bool, optional) — 是否返回ModelOutput代替普通元组。

返回值

transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutputtuple(torch.FloatTensor)

取决于配置(XLMRobertaConfig)和输入,由transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput或一个由torch.FloatTensor组成的元组组成(如果传递了return_dict=False,或者当config.return_dict=False时)。

  • start_logits (jnp.ndarray of shape (batch_size, sequence_length)) — Span的开始分数(在SoftMax之前)。

  • end_logits (jnp.ndarray of shape (batch_size, sequence_length)) — Span的结束分数(在SoftMax之前)。

  • hidden_states (tuple(jnp.ndarray), optional, returned when output_hidden_states=True is passed or when config.output_hidden_states=True)— jnp.ndarray 的元组(一个用于嵌入层的输出,一个用于每层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层的输出处的隐藏状态,以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray), optional, returned when output_attentions=True is passed or when config.output_attentions=True)— 包含每个层的 jnp.ndarray 的元组(形状为 (batch_size, num_heads, sequence_length, sequence_length))。

    注意力软化的注意力权重,用于在自注意力头中进行加权平均。

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

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

示例

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForQuestionAnswering

>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/xlm-roberta-base")
>>> model = FlaxXLMRobertaForQuestionAnswering.from_pretrained("FacebookAI/xlm-roberta-base")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")

>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits
< > GitHub更新