Transformers 文档

RoBERTa-PreLayerNorm

Hugging Face's logo
加入 Hugging Face 社区

并获得增强版文档体验

开始使用

RoBERTa-PreLayerNorm

概述

RoBERTa-PreLayerNorm 模型由 Myle Ott、Sergey Edunov、Alexei Baevski、Angela Fan、Sam Gross、Nathan Ng、David Grangier、Michael Auli 在 fairseq:用于序列建模的快速、可扩展工具包 中提出。它与在 fairseq 中使用 `--encoder-normalize-before` 标志相同。

该论文的摘要如下:

fairseq 是一个开源序列建模工具包,允许研究人员和开发人员训练用于翻译、摘要、语言建模和其他文本生成任务的自定义模型。该工具包基于 PyTorch,并支持跨多个 GPU 和机器的分布式训练。我们还支持现代 GPU 上的快速混合精度训练和推理。

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

使用技巧

  • 该实现与 Roberta 相同,除了使用加法归一化而不是使用归一化加法加法归一化指的是 Attention Is All You Need 中描述的加法和层归一化。
  • 这与在 fairseq 中使用 `--encoder-normalize-before` 标志相同。

资源

RobertaPreLayerNormConfig

class transformers.RobertaPreLayerNormConfig

< >

( vocab_size = 50265 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 (int, 可选, 默认为 50265) — RoBERTa-PreLayerNorm 模型的词表大小。定义了调用 RobertaPreLayerNormModelTFRobertaPreLayerNormModel 时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”层(通常称为前馈层)的维度。
  • hidden_act (strCallable, 可选, 默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu", "relu", "silu""gelu_new"
  • hidden_dropout_prob (float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 注意力概率的丢弃率。
  • max_position_embeddings (int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一(例如,512 或 1024 或 2048)。
  • type_vocab_size (int, 可选, 默认为 2) — 调用 RobertaPreLayerNormModelTFRobertaPreLayerNormModel 时传递的 token_type_ids 的词表大小。
  • layer_norm_eps (float, optional, defaults to 1e-12) — 层归一化层的epsilon。
  • position_embedding_type (str, optional, defaults to "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, optional, defaults to False) — 模型是否用作解码器。如果为 False,则模型用作编码器。
  • use_cache (bool, optional, defaults to True) — 模型是否应该返回最后一个键/值注意力(并非所有模型都使用)。仅在 config.is_decoder=True 时相关。
  • classifier_dropout (float, optional) — 分类头的dropout率。

这是一个配置类,用于存储 RobertaPreLayerNormModelTFRobertaPreLayerNormModel 的配置。它用于根据指定的参数实例化一个 RoBERTa-PreLayerNorm 模型,定义模型架构。用默认值实例化一个配置将产生与 RoBERTa-PreLayerNorm andreasmadsen/efficient_mlm_m0.40 架构类似的配置。

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

示例

>>> from transformers import RobertaPreLayerNormConfig, RobertaPreLayerNormModel

>>> # Initializing a RoBERTa-PreLayerNorm configuration
>>> configuration = RobertaPreLayerNormConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = RobertaPreLayerNormModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config
Pytorch
隐藏 Pytorch 内容

RobertaPreLayerNormModel

class transformers.RobertaPreLayerNormModel

< >

( config add_pooling_layer = True )

参数

不带特定头部,输出原始隐藏状态的裸 RoBERTa-PreLayerNorm 模型转换器。

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

该模型可以充当编码器(仅有自注意力)以及解码器,在这种情况下,在自注意力层之间添加一个交叉注意力层,遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 *Attention is all you need*_ 中描述的架构。

要充当解码器,需要将模型初始化为 is_decoder 配置参数设置为 True。要在 Seq2Seq 模型中使用,该模型需要用 is_decoder 参数和 add_cross_attention 同时设置为 True 进行初始化;然后,在正向传递中需要一个 encoder_hidden_states 作为输入。

.. _*Attention is all you need*: https://arxiv.org/abs/1706.03762

正向传播

< >

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

参数

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

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

    什么是输入 ID?

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

    • 1 代表 未掩码 的词元
    • 0 代表 已掩码 的词元

    什么是注意力掩码?

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

    • 0 代表 句子 A 词元
    • 1 代表 句子 B 词元。此参数仅可在模型使用具有以下值的 type_vocab_size 参数初始化时使用:

      = 2. 此张量中的所有值应始终小于 type_vocab_size

    什么是词元类型 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 表示**屏蔽**的标记。
  • past_key_values (tuple(tuple(torch.FloatTensor)) 长度为 config.n_layers,每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含预计算的注意力块的键和值隐藏状态。可用于加速解码。

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

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

返回值

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置(RobertaPreLayerNormConfig)和输入的各种元素。

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

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

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

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

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

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选,在传递 use_cache=Trueconfig.use_cache=True 时返回) — tuple(torch.FloatTensor) 元组,长度为 config.n_layers,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,以及如果 config.is_encoder_decoder=True,则可选地包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

    包含预计算的隐藏状态(自注意力块中的键和值,以及如果 config.is_encoder_decoder=True,则可选地在交叉注意力块中),可用于(参见 past_key_values 输入)加速顺序解码。

RobertaPreLayerNormModel 正向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, RobertaPreLayerNormModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormModel.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

>>> last_hidden_states = outputs.last_hidden_state

RobertaPreLayerNormForCausalLM

class transformers.RobertaPreLayerNormForCausalLM

< >

( config )

参数

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

具有 语言建模 头部的 RoBERTa-PreLayerNorm 模型,用于 CLM 微调。

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None 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.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 掩码,避免对填充词元索引执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示 未掩码 的词元,
    • 0 表示 掩码 的词元。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 段词元索引,用于指示输入的第一部分和第二部分。索引在 [0,1] 中选择:

    • 0 对应于 句子 A 词元,
    • 1 对应于 句子 B 词元。此参数仅在模型使用 type_vocab_size 参数初始化且值等于 2 时才可以使用。此张量中的所有值应始终小于 type_vocab_size。

    什么是词元类型 ID?

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

    什么是位置 ID?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.FloatTensor可选) — 用于使自注意力模块中选定的头无效化的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示头未被掩码
    • 0 表示头被掩码
  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更多控制权,这将很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
  • encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 编码器最后一层的输出处的隐藏状态序列。如果模型配置为解码器,则在交叉注意力中使用。
  • encoder_attention_mask (形状为 (batch_size, sequence_length)torch.FloatTensor可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器,则此掩码在交叉注意力中使用。在 [0, 1] 中选择掩码值:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。
  • labels (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 用于计算从左到右的语言建模损失(下一个词预测)的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(请参阅 input_ids 文档字符串)索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。
  • past_key_values (长度为 config.n_layerstuple(tuple(torch.FloatTensor)),每个元组包含 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_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。

返回值

transformers.modeling_outputs.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

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

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

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

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

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

    交叉注意力 Softmax 后的权重,用于计算交叉注意力头的加权平均值。

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

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

RobertaPreLayerNormForCausalLM 前向方法覆盖了 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> config = AutoConfig.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> config.is_decoder = True
>>> model = RobertaPreLayerNormForCausalLM.from_pretrained("andreasmadsen/efficient_mlm_m0.40", config=config)

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

>>> prediction_logits = outputs.logits

RobertaPreLayerNormForMaskedLM

class transformers.RobertaPreLayerNormForMaskedLM

< >

( config )

参数

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

RoBERTa-PreLayerNorm 模型,顶部有一个 语言建模 头。

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

参数

  • 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 标记。该参数只能在模型使用 type_vocab_size 参数初始化时使用,该参数的值为

      = 2。此张量中的所有值应始终 < type_vocab_size。

    什么是标记类型 ID?

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

    什么是位置 ID?

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

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更多控制权,这将很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(参见 input_ids 文档字符串)索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记进行计算。
  • kwargs (Dict[str, any], 可选, 默认值 {}) — 用于隐藏已弃用的旧参数。

返回值

transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (RobertaPreLayerNormConfig) 和输入的各种元素。

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

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

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

The RobertaPreLayerNormForMaskedLM 正向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, RobertaPreLayerNormForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormForMaskedLM.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

RobertaPreLayerNormForSequenceClassification

transformers.RobertaPreLayerNormForSequenceClassification

< >

( config )

参数

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

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

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.SequenceClassifierOutputtuple(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 令牌。此参数仅在模型使用 type_vocab_size 参数初始化且值等于 2 时才可以使用。此张量中的所有值都应始终小于 type_vocab_size

    什么是令牌类型 ID?

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

    什么是位置 ID?

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

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您想要比模型的内部嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更多控制,这将很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool可选) — 是否返回一个 ModelOutput 而不是一个普通元组。
  • labels (torch.LongTensor 形状为 (batch_size,)可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回值

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

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

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

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

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

RobertaPreLayerNormForSequenceClassification 前向方法,覆盖 __call__ 特殊方法。

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

单标签分类的示例

>>> import torch
>>> from transformers import AutoTokenizer, RobertaPreLayerNormForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormForSequenceClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

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

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = RobertaPreLayerNormForSequenceClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40", num_labels=num_labels)

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

多标签分类的示例

>>> import torch
>>> from transformers import AutoTokenizer, RobertaPreLayerNormForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormForSequenceClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40", 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 = RobertaPreLayerNormForSequenceClassification.from_pretrained(
...     "andreasmadsen/efficient_mlm_m0.40", 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

RobertaPreLayerNormForMultipleChoice

class transformers.RobertaPreLayerNormForMultipleChoice

< >

( config )

参数

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

RobertaPreLayerNorm 模型,在其顶部有一个多项选择分类头(在池化输出之上是一个线性层和一个 softmax),例如用于 RocStories/SWAG 任务。

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

正向传播

< >

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

参数

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

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

    什么是输入 ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, num_choices, sequence_length), optional) — 用于避免对填充词元索引执行注意的掩码。 掩码值在 [0, 1] 中选择:

    • 1 表示未被掩码的词元
    • 0 表示被掩码的词元

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, num_choices, sequence_length), optional) — 用于指示输入的第一部分和第二部分的段落词元索引。 索引在 [0,1] 中选择:

    • 0 对应于句子 A 词元
    • 1 对应于句子 B 词元。 此参数仅当模型以具有以下值的 type_vocab_size 参数初始化时才可以使用:

      = 2。 此张量中的所有值应始终 < type_vocab_size。

    什么是词元类型 ID?

  • position_ids (torch.LongTensor of shape (batch_size, num_choices, sequence_length), optional) — 位置嵌入中每个输入序列词元位置的索引。 在 [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,而不是一个简单的元组。
  • labels (torch.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 时),包括取决于配置 (RobertaPreLayerNormConfig) 和输入的各种元素。

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

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

    分类分数(在 SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

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

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

示例

>>> from transformers import AutoTokenizer, RobertaPreLayerNormForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormForMultipleChoice.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

RobertaPreLayerNormForTokenClassification

class transformers.RobertaPreLayerNormForTokenClassification

< >

( config )

参数

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

RobertaPreLayerNorm 模型,顶部有一个令牌分类头(隐藏状态输出顶部的线性层),例如用于命名实体识别 (NER) 任务。

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

正向传播

< >

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

参数

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

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

    什么是输入 ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 避免在填充词元索引上执行注意力的掩码。在 [0, 1] 中选择掩码值:

    • 1 表示未屏蔽的词元,
    • 0 表示屏蔽的词元。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 段词元索引,用于指示输入的第一部分和第二部分。索引在 [0,1] 中选择:

    • 0 对应于句子 A 词元,
    • 1 对应于句子 B 词元。当模型使用 type_vocab_size 参数初始化,并且其值为

      = 2。此张量中的所有值应始终 < type_vocab_size。

      时,才能使用此参数。

    什么是词元类型 ID?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 输入序列词元在位置嵌入中的位置索引。在 [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 而不是普通元组。
  • labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 用于计算令牌分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。

返回值

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

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

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

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

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

The RobertaPreLayerNormForTokenClassification 正向方法,覆盖 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, RobertaPreLayerNormForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormForTokenClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

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

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

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

RobertaPreLayerNormForQuestionAnswering

class transformers.RobertaPreLayerNormForQuestionAnswering

< >

( config )

参数

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

RobertaPreLayerNorm 模型,顶部带有一个跨度分类头,用于提取式问答任务,例如 SQuAD(隐藏状态输出顶部的线性层,用于计算 跨度开始 logits跨度结束 logits)。

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

此模型也是 PyTorch torch.nn.Module 子类。将它用作普通的 PyTorch 模块,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(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 标记。此参数只能在模型使用 type_vocab_size 参数初始化且其值为

      = 2。此张量中的所有值始终应 < type_vocab_size。

      时使用。

    什么是标记类型 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 而不是普通元组。
  • end_positions (torch.LongTensor 形状为 (batch_size,)可选) — 用于计算标记分类损失的标记跨度结束位置的标签。位置被限制在序列长度(sequence_length)。序列外的位置不会被考虑用于计算损失。

返回值

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

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

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

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

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

  • hidden_states (tuple(torch.FloatTensor), 可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型有嵌入层,+ 一个用于每一层的输出)形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。

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

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

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

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

示例

>>> from transformers import AutoTokenizer, RobertaPreLayerNormForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = RobertaPreLayerNormForQuestionAnswering.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

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

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]

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

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

TFRobertaPreLayerNormModel

class transformers.TFRobertaPreLayerNormModel

< >

( config *inputs **kwargs )

参数

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

不带特定头部,输出原始隐藏状态的裸 RoBERTa-PreLayerNorm 模型转换器。

此模型继承自 TFPreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、裁剪头等)。

此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般用法和行为相关的任何事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用 model.fit() 之类的函数时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 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 或者 tuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。

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

    什么是输入 ID?

  • 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] 中选择:

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

    什么是词元类型 ID?

  • 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。此参数只能在急切模式下使用,在图模式下,将使用配置中的值。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关详细信息,请参见返回张量中的 hidden_states。此参数只能在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用,在图模式下,该值将始终设置为 True。
  • 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 (Tuple[Tuple[tf.Tensor]] 长度为 config.n_layers) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用 past_key_values,用户可以选择仅输入最后 decoder_input_ids(没有提供给此模型的过去键值状态的那些),形状为 (batch_size, 1),而不是所有 decoder_input_ids,形状为 (batch_size, sequence_length)
  • use_cache (bool, 可选, 默认值为 True) — 如果设置为 True,将返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。在训练期间设置为 False,在生成期间设置为 True

返回值

transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentionstuple(tf.Tensor)

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

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

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

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

  • past_key_values (List[tf.Tensor], 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — tf.Tensor 列表,长度为 config.n_layers,每个张量形状为 (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 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

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

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormModel.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

>>> last_hidden_states = outputs.last_hidden_state

TFRobertaPreLayerNormForCausalLM

class transformers.TFRobertaPreLayerNormForCausalLM

< >

( config: RobertaPreLayerNormConfig *inputs **kwargs )

调用

< >

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

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词表中的索引。

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

    什么是输入 ID?

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

    • 0 表示句子 A 词元,
    • 1 表示句子 B 词元。

    什么是词元类型 ID?

  • 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。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。
  • 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)可选) — 掩码以避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器,则此掩码用于交叉注意力。掩码值选择在 [0, 1] 中:

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

返回值

transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentionstuple(tf.Tensor)

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

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

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

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

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

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

  • past_key_values (List[tf.Tensor], 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — tf.Tensor 列表,长度为 config.n_layers,每个张量形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head)).

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

TFRobertaPreLayerNormForCausalLM 正向方法,覆盖 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormForCausalLM.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

TFRobertaPreLayerNormForMaskedLM

class transformers.TFRobertaPreLayerNormForMaskedLM

< >

( config *inputs **kwargs )

参数

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

RoBERTa-PreLayerNorm 模型,顶部有一个 语言建模 头。

此模型继承自 TFPreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、裁剪头等)。

此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般用法和行为相关的任何事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用 model.fit() 之类的函数时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量

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

请注意,在使用 子类化 创建模型和层时,你不需要担心任何这些问题,因为你可以像对任何其他 Python 函数一样传递输入!

调用

< >

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

参数

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

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

    什么是输入 ID?

  • attention_mask (Numpy arraytf.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码,用于避免对填充标记索引进行注意力计算。 掩码值选自 [0, 1] 中:

    • 1 表示未屏蔽的标记
    • 0 表示屏蔽的标记

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

  • 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), 可选) — 掩码,用于使自注意力模块的选定头部无效。 掩码值选自 [0, 1] 中:

    • 1 表示未屏蔽的头部
    • 0 表示屏蔽的头部
  • inputs_embeds (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量有更多控制权,而不是模型的内部嵌入查找矩阵,这将很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参见返回张量中的 attentions。此参数仅在急切模式下可用,在图形模式下,将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参见返回张量中的 hidden_states。此参数仅在急切模式下可用,在图形模式下,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用,在图形模式下,该值始终设置为 True。
  • training (bool, 可选,默认值为 False) — 是否在训练模式下使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(参见 input_ids 文档字符串)索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算

返回值

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFMaskedLMOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (RobertaPreLayerNormConfig) 和输入而变化的各种元素。

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

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

The TFRobertaPreLayerNormForMaskedLM 正向方法,覆盖 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormForMaskedLM.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

TFRobertaPreLayerNormForSequenceClassification

class transformers.TFRobertaPreLayerNormForSequenceClassification

< >

( config *inputs **kwargs )

参数

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

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

此模型继承自 TFPreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、裁剪头等)。

此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般用法和行为相关的任何事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用 model.fit() 之类的函数时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 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.TFSequenceClassifierOutputtuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

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

    什么是输入 ID?

  • 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] 中选择:

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

    什么是标记类型 ID?

  • 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 。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的hidden_states。此参数仅可在 eager 模式下使用,在 graph 模式下,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 eager 模式下使用,在 graph 模式下,值将始终设置为 True。
  • training (bool, 可选,默认为 False) — 是否以训练模式使用模型(某些模块,例如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensor 形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方误差损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回值

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

A transformers.modeling_tf_outputs.TFSequenceClassifierOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置(RobertaPreLayerNormConfig)和输入的不同元素。

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

  • logits (tf.Tensor 形状为 (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 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

TFRobertaPreLayerNormForSequenceClassification 正向方法,覆盖了 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormForSequenceClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = TFRobertaPreLayerNormForSequenceClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40", num_labels=num_labels)

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

TFRobertaPreLayerNormForMultipleChoice

class transformers.TFRobertaPreLayerNormForMultipleChoice

< >

( config *inputs **kwargs )

参数

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

RobertaPreLayerNorm 模型,在其顶部有一个多项选择分类头(在池化输出之上是一个线性层和一个 softmax),例如用于 RocStories/SWAG 任务。

此模型继承自 TFPreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、裁剪头等)。

此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般用法和行为相关的任何事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用 model.fit() 之类的函数时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 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.TFMultipleChoiceModelOutputtuple(tf.Tensor)

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID?

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

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

  • position_ids (Numpy 数组tf.Tensor 形状为 (batch_size, num_choices, 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, num_choices, sequence_length, hidden_size)可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更详细地控制如何将 input_ids 索引转换为关联的向量,这将很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的 attentions。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用,在图模式下,该值始终设置为 True。
  • training (bool, 可选, 默认值为 False) — 是否以训练模式使用模型(某些模块,如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensor 形状为 (batch_size,), 可选) — 用于计算多选分类损失的标签。索引应在 [0, ..., num_choices] 中,其中 num_choices 是输入张量第二维的大小。(参见上面的 input_ids

返回值

transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutputtf.Tensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含根据配置(RobertaPreLayerNormConfig)和输入而变化的各种元素。

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

  • logits (tf.Tensor 形状为 (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 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The TFRobertaPreLayerNormForMultipleChoice 正向方法,覆盖 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormForMultipleChoice.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

TFRobertaPreLayerNormForTokenClassification

class transformers.TFRobertaPreLayerNormForTokenClassification

< >

( config *inputs **kwargs )

参数

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

RoBERTa-PreLayerNorm 模型,顶部带有一个令牌分类头(隐藏状态输出顶部的线性层),例如用于命名实体识别 (NER) 任务。

此模型继承自 TFPreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、裁剪头等)。

此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般用法和行为相关的任何事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用 model.fit() 之类的函数时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 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 (NumPy 数组tf.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择:

    • 1 表示未屏蔽的标记,
    • 0 表示屏蔽的标记。

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

  • 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 (布尔值, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的 attentions。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • output_hidden_states (布尔值, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的 hidden_states。此参数仅可在急切模式下使用,在图模式下,将使用配置中的值。
  • return_dict (布尔值, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在急切模式下使用,在图模式下,该值将始终设置为 True。
  • training (bool, 可选,默认值为 False) — 是否以训练模式使用模型(某些模块,例如 dropout 模块,在训练和评估之间具有不同的行为)。
  • labels (tf.Tensor 形状为 (batch_size, sequence_length)可选) — 用于计算标记分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。

返回值

transformers.modeling_tf_outputs.TFTokenClassifierOutputtuple(tf.Tensor)

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

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

  • logits (tf.Tensor 形状为 (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 时返回) — tf.Tensor 元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

TFRobertaPreLayerNormForTokenClassification 正向方法,覆盖 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormForTokenClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t] for t in predicted_token_class_ids[0].numpy().tolist()]
>>> labels = predicted_token_class_ids
>>> loss = tf.math.reduce_mean(model(**inputs, labels=labels).loss)

TFRobertaPreLayerNormForQuestionAnswering

class transformers.TFRobertaPreLayerNormForQuestionAnswering

< >

( config *inputs **kwargs )

参数

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

RoBERTa-PreLayerNorm 模型,顶部带有跨度分类头,用于提取式问答任务,例如 SQuAD(隐藏状态输出顶部的线性层,用于计算 span start logitsspan end logits)。

此模型继承自 TFPreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、裁剪头等)。

此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解与一般用法和行为相关的任何事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,在使用 model.fit() 之类的函数时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递你的输入和标签即可!但是,如果你想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,你可以使用三种可能性来收集第一个位置参数中的所有输入张量

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

请注意,在使用 子类化 创建模型和层时,你不需要担心任何这些问题,因为你可以像对任何其他 Python 函数一样传递输入!

调用

< >

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

参数

  • input_ids (Numpy 数组tf.Tensor 形状为 (batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。

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

    什么是输入 ID?

  • 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] 中:

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

    什么是标记类型 ID?

  • 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 (布尔值可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的 attentions。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。
  • output_hidden_states (布尔值可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states。此参数只能在急切模式下使用,在图形模式下,将使用配置中的值。
  • return_dict (布尔值可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可以在急切模式下使用,在图形模式下,值将始终设置为 True。
  • training (布尔值可选,默认为 False) — 是否在训练模式下使用模型(某些模块,例如 dropout 模块,在训练和评估之间具有不同的行为)。
  • end_positions (tf.Tensor 形状为 (batch_size,), 可选) — 用于计算令牌分类损失的标记跨度的结束位置(索引)标签。位置被限制在序列长度(sequence_length)内。序列之外的位置不会被考虑用于计算损失。

返回值

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

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

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

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

The TFRobertaPreLayerNormForQuestionAnswering 正向方法,覆盖了 __call__ 特殊方法。

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

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = TFRobertaPreLayerNormForQuestionAnswering.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

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

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

>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = tf.math.reduce_mean(outputs.loss)
JAX
隐藏 JAX 内容

FlaxRobertaPreLayerNormModel

class transformers.FlaxRobertaPreLayerNormModel

< >

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

参数

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

不带特定头部,输出原始隐藏状态的裸 RoBERTa-PreLayerNorm 模型转换器。

此模型继承自 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 标记。

    什么是标记类型 ID?

  • 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可选) — 是否返回 ModelOutput 而不是普通元组。

返回值

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtorch.FloatTensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (RobertaPreLayerNormConfig) 和输入的各种元素。

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

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

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormModel

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormModel.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

>>> last_hidden_states = outputs.last_hidden_state

FlaxRobertaPreLayerNormForCausalLM

class transformers.FlaxRobertaPreLayerNormForCausalLM

< >

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

参数

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

RobertaPreLayerNorm 模型,在其之上有一个语言建模头(隐藏状态输出之上的线性层),例如用于自回归任务。

此模型继承自 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.FlaxCausalLMOutputWithCrossAttentionstuple(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 (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 输入序列 token 在位置嵌入中的位置索引。选择在范围 [0, config.max_position_embeddings - 1] 内。
  • head_mask (numpy.ndarray 形状为 (batch_size, sequence_length)可选) — 掩码,用于使注意力模块的选定头部无效。掩码值选择在 [0, 1] 中:

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

返回值

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

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

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

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(jnp.ndarray), 可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    交叉注意力 Softmax 后的权重,用于计算交叉注意力头的加权平均值。

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

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormForCausalLM.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

FlaxRobertaPreLayerNormForMaskedLM

class transformers.FlaxRobertaPreLayerNormForMaskedLM

< >

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

参数

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

RoBERTa-PreLayerNorm 模型,顶部有一个 语言建模 头。

此模型继承自 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 标记。

    什么是标记类型 ID?

  • 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, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回值

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPoolingtorch.FloatTensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (RobertaPreLayerNormConfig) 和输入的各种元素。

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

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

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormForMaskedLM

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormForMaskedLM.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

FlaxRobertaPreLayerNormForSequenceClassification

class transformers.FlaxRobertaPreLayerNormForSequenceClassification

< >

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

参数

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

带有序列分类/回归头的 RobertaPreLayerNorm 模型转换器(在池化输出之上有一个线性层),例如用于 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.FlaxSequenceClassifierOutputtuple(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* 标记。

    什么是标记类型 ID?

  • 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, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回值

transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或者 tuple(torch.FloatTensor)

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

  • logits (jnp.ndarray 形状为 (batch_size, config.num_labels)) — 分类(或回归,如果 config.num_labels==1)分数(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormForSequenceClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

FlaxRobertaPreLayerNormForMultipleChoice

class transformers.FlaxRobertaPreLayerNormForMultipleChoice

< >

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

参数

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

RobertaPreLayerNorm 模型,在其顶部有一个多项选择分类头(在池化输出之上是一个线性层和一个 softmax),例如用于 RocStories/SWAG 任务。

此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法(例如下载、保存和从 PyTorch 模型转换权重)。

此模型也是 flax.linen.Module 子类。将其用作常规的 Flax linen 模块,并参考 Flax 文档以了解有关一般用法和行为的所有事项。

最后,此模型支持 JAX 的固有特性,例如

__call__

< >

( 输入 ID 注意力掩码 = None 词语类型 ID = None 位置 ID = None 头部掩码 = None 编码器隐藏状态 = None 编码器注意力掩码 = None 参数: dict = None dropout 随机数生成器密钥: PRNGKey = None 训练: bool = False 输出注意力: Optional = None 输出隐藏状态: Optional = None

参数

  • input_ids (numpy.ndarray of shape (batch_size, sequence_length)) — Indices of input sequence tokens in the vocabulary.

    Indices can be obtained using AutoTokenizer. See PreTrainedTokenizer.encode() and PreTrainedTokenizer.call() for details.

    What are input IDs?

  • attention_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:

    • 1 for tokens that are not masked,
    • 0 for tokens that are masked.

    What are attention masks?

  • token_type_ids (numpy.ndarray of shape (batch_size, sequence_length), optional) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in [0, 1]:

    • 0 corresponds to a sentence A token,
    • 1 corresponds to a sentence B token.

    What are token type IDs?

  • position_ids (numpy.ndarray of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.max_position_embeddings - 1].
  • head_mask (numpy.ndarray of shape (batch_size, sequence_length), optional) -- Mask to nullify selected heads of the attention modules. Mask values selected in [0, 1]`:

    • 1 indicates the head is not masked,
    • 0 indicates the head is masked.
  • return_dict (bool, optional) — Whether or not to return a ModelOutput instead of a plain tuple.

返回值

transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or tuple(torch.FloatTensor)

A transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (RobertaPreLayerNormConfig) and inputs.

  • logits (jnp.ndarray of shape (batch_size, sequence_length, config.num_labels)) — Classification scores (before SoftMax).

    分类分数(在 SoftMax 之前)。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormForMultipleChoice

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormForMultipleChoice.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

FlaxRobertaPreLayerNormForTokenClassification

class transformers.FlaxRobertaPreLayerNormForTokenClassification

< >

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

参数

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

RobertaPreLayerNorm 模型,顶部有一个令牌分类头(隐藏状态输出顶部的线性层),例如用于命名实体识别 (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.FlaxTokenClassifierOutputtuple(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 词元。

    什么是词元类型 ID?

  • 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, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。

返回值

transformers.modeling_flax_outputs.FlaxTokenClassifierOutputtuple(torch.FloatTensor)

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

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

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormForTokenClassification

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormForTokenClassification.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

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

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

FlaxRobertaPreLayerNormForQuestionAnswering

class transformers.FlaxRobertaPreLayerNormForQuestionAnswering

< >

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

参数

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

RobertaPreLayerNorm 模型,顶部带有一个跨度分类头,用于提取式问答任务,例如 SQuAD(隐藏状态输出顶部的线性层,用于计算 跨度开始 logits跨度结束 logits)。

此模型继承自 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 形状为 (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 标记。

    什么是 token type ID?

  • 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, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。

返回值

transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutputtuple(torch.FloatTensor)

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

  • start_logits (jnp.ndarray 形状为 (batch_size, sequence_length)) — 跨度开始分数(在 SoftMax 之前)。

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

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入输出 + 一个用于每一层输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态加上初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxRobertaPreLayerNormPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxRobertaPreLayerNormForQuestionAnswering

>>> tokenizer = AutoTokenizer.from_pretrained("andreasmadsen/efficient_mlm_m0.40")
>>> model = FlaxRobertaPreLayerNormForQuestionAnswering.from_pretrained("andreasmadsen/efficient_mlm_m0.40")

>>> 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 上更新