Transformers 文档

DeBERTa

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

DeBERTa

PyTorch TensorFlow

概述

DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在论文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基于谷歌于 2018 年发布的 BERT 模型和 Facebook 于 2019 年发布的 RoBERTa 模型。

它在 RoBERTa 的基础上,增加了解耦注意力机制和增强的掩码解码器,并使用 RoBERTa 一半的数据进行训练。

论文摘要如下:

预训练神经语言模型的最新进展显著提高了许多自然语言处理 (NLP) 任务的性能。在本文中,我们提出了一种新的模型架构 DeBERTa (Decoding-enhanced BERT with disentangled attention),它通过两种新颖的技术改进了 BERT 和 RoBERTa 模型。第一种是解耦注意力机制,其中每个词都由两个向量表示,分别编码其内容和位置,词之间的注意力权重是使用其内容和相对位置上的解耦矩阵计算的。第二种是使用增强型掩码解码器来替换输出的 softmax 层,以预测被掩盖的词元进行模型预训练。我们证明了这两种技术显著提高了模型预训练的效率和下游任务的性能。与 RoBERTa-Large 相比,使用一半训练数据训练的 DeBERTa 模型在一系列 NLP 任务上始终表现更优,在 MNLI 上提升了 0.9% (90.2% vs. 91.1%),在 SQuAD v2.0 上提升了 2.3% (88.4% vs. 90.7%),在 RACE 上提升了 3.6% (83.2% vs. 86.8%)。DeBERTa 的代码和预训练模型将在 https://github.com/microsoft/DeBERTa 上公开发布。

该模型由 DeBERTa 贡献。该模型的 TF 2.0 实现由 kamalkraj 贡献。原始代码可以在这里找到。

资源

一份 Hugging Face 官方和社区(以 🌎 标识)的资源列表,帮助您开始使用 DeBERTa。如果您有兴趣提交资源以包含在此处,请随时发起 Pull Request,我们将进行审核!资源最好能展示一些新东西,而不是重复现有资源。

文本分类
Token 分类
填充掩码
问答

DebertaConfig

class transformers.DebertaConfig

< >

( 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 = 0 initializer_range = 0.02 layer_norm_eps = 1e-07 relative_attention = False max_relative_positions = -1 pad_token_id = 0 position_biased_input = True pos_att_type = None pooler_dropout = 0 pooler_hidden_act = 'gelu' legacy = True **kwargs )

参数

  • vocab_size (int, 可选, 默认为 50265) — DeBERTa 模型的词汇表大小。定义了在调用 DebertaModelTFDebertaModel 时传入的 `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", "tanh", "gelu_fast", "mish", "linear", "sigmoid""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, 可选, 默认为 0) — 调用 DebertaModelTFDebertaModel 时传入的 `token_type_ids` 的词汇表大小。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。
  • relative_attention (bool, 可选, 默认为 False) — 是否使用相对位置编码。
  • max_relative_positions (int, 可选, 默认为 1) — 相对位置的范围 `[-max_position_embeddings, max_position_embeddings]`。使用与 `max_position_embeddings` 相同的值。
  • pad_token_id (int, 可选, 默认为 0) — 用于填充 input_ids 的值。
  • position_biased_input (bool, 可选, 默认为 True) — 是否将绝对位置嵌入添加到内容嵌入中。
  • pos_att_type (list[str], 可选) — 相对位置注意力的类型,可以是 ["p2c", "c2p"] 的组合,例如 ["p2c"]["p2c", "c2p"]
  • layer_norm_eps (float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。
  • legacy (bool, 可选, 默认为 True) — 模型是否应使用传统的 `LegacyDebertaOnlyMLMHead`,该头部在掩码填充任务中无法正常工作。

这是用于存储 DebertaModelTFDebertaModel 配置的配置类。它用于根据指定的参数实例化一个 DeBERTa 模型,定义模型架构。使用默认值实例化配置将产生与 DeBERTa microsoft/deberta-base 架构类似的配置。

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

示例

>>> from transformers import DebertaConfig, DebertaModel

>>> # Initializing a DeBERTa microsoft/deberta-base style configuration
>>> configuration = DebertaConfig()

>>> # Initializing a model (with random weights) from the microsoft/deberta-base style configuration
>>> model = DebertaModel(configuration)

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

DebertaTokenizer

class transformers.DebertaTokenizer

< >

( vocab_file merges_file errors = 'replace' bos_token = '[CLS]' eos_token = '[SEP]' sep_token = '[SEP]' cls_token = '[CLS]' unk_token = '[UNK]' pad_token = '[PAD]' mask_token = '[MASK]' add_prefix_space = False add_bos_token = False **kwargs )

参数

  • vocab_file (str) — 词汇表文件的路径。
  • merges_file (str) — 合并文件的路径。
  • errors (str, 可选, 默认为 "replace") — 将字节解码为 UTF-8 时遵循的范式。有关更多信息,请参阅 bytes.decode
  • bos_token (str, 可选, 默认为 "[CLS]") — 序列开始的词元。
  • eos_token (str, 可选, 默认为 "[SEP]") — 序列结束的词元。
  • sep_token (str, 可选, 默认为 "[SEP]") — 分隔符标记,当从多个序列构建一个序列时使用,例如用于序列分类的两个序列,或用于问答任务的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。
  • cls_token (str, 可选, 默认为 "[CLS]") — 分类符标记,用于序列分类(对整个序列进行分类,而不是对每个标记进行分类)。当使用特殊标记构建序列时,它是序列的第一个标记。
  • unk_token (str, 可选, 默认为 "[UNK]") — 未知标记。不在词汇表中的标记无法转换为 ID,将被设置为此标记。
  • pad_token (str, 可选, 默认为 "[PAD]") — 用于填充的标记,例如在批处理不同长度的序列时。
  • mask_token (str, 可选, 默认为 "[MASK]") — 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。
  • add_prefix_space (bool, 可选, 默认为 False) — 是否在输入前添加一个初始空格。这允许将开头的单词像其他任何单词一样处理。(Deberta 分词器通过前面的空格检测单词的开头)。
  • add_bos_token (bool, 可选, 默认为 False) — 是否在输入前添加一个初始的 <|endoftext|>。这允许将开头的单词像其他任何单词一样处理。

构建一个 DeBERTa 分词器。基于字节级的字节对编码(Byte-Pair-Encoding)。

这个分词器经过训练,将空格视为词元的一部分(有点像 sentencepiece),所以一个词会

无论是否在句子开头(无空格),编码方式都会不同

>>> from transformers import DebertaTokenizer

>>> tokenizer = DebertaTokenizer.from_pretrained("microsoft/deberta-base")
>>> tokenizer("Hello world")["input_ids"]
[1, 31414, 232, 2]

>>> tokenizer(" Hello world")["input_ids"]
[1, 20920, 232, 2]

您可以通过在实例化此分词器时或在对某些文本调用它时传递 add_prefix_space=True 来绕过此行为,但由于模型并非以这种方式进行预训练,这可能会导致性能下降。

当与 is_split_into_words=True 一起使用时,此分词器会在每个词(甚至是第一个词)之前添加一个空格。

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

build_inputs_with_special_tokens

< >

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

参数

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

返回

List[int]

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

通过连接和添加特殊标记,从一个序列或一对序列为序列分类任务构建模型输入。DeBERTa 序列具有以下格式:

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

get_special_tokens_mask

< >

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

参数

  • token_ids_0 (List[int]) — ID 列表。
  • token_ids_1 (List[int], 可选) — 用于序列对的可选的第二个 ID 列表。
  • already_has_special_tokens (bool, 可选, 默认为 False) — 标记列表是否已经为模型格式化了特殊标记。

返回

List[int]

一个范围为 [0, 1] 的整数列表:1 表示特殊标记,0 表示序列标记。

从未添加特殊令牌的令牌列表中检索序列 ID。使用分词器 prepare_for_modelencode_plus 方法添加特殊令牌时会调用此方法。

create_token_type_ids_from_sequences

< >

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) list[int]

参数

  • token_ids_0 (list[int]) — 第一个分词后的序列。
  • token_ids_1 (list[int], 可选) — 第二个分词后的序列。

返回

list[int]

标记类型 ID。

创建与传入序列对应的标记类型 ID。什么是标记类型 ID?

如果模型有特殊的构建方式,应在子类中重写此方法。

save_vocabulary

< >

( save_directory: str filename_prefix: typing.Optional[str] = None )

DebertaTokenizerFast

class transformers.DebertaTokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None errors = 'replace' bos_token = '[CLS]' eos_token = '[SEP]' sep_token = '[SEP]' cls_token = '[CLS]' unk_token = '[UNK]' pad_token = '[PAD]' mask_token = '[MASK]' add_prefix_space = False **kwargs )

参数

  • vocab_file (str, 可选) — 词汇表文件的路径。
  • merges_file (str, 可选) — 合并文件的路径。
  • tokenizer_file (str, 可选) — 要使用的分词器文件的路径,而不是词汇表文件。
  • errors (str, 可选, 默认为 "replace") — 解码字节为 UTF-8 时遵循的范式。有关更多信息,请参阅 bytes.decode
  • bos_token (str, 可选, 默认为 "[CLS]") — 序列开始标记。
  • eos_token (str, 可选, 默认为 "[SEP]") — 序列结束标记。
  • sep_token (str, 可选, 默认为 "[SEP]") — 分隔符标记,当从多个序列构建一个序列时使用,例如用于序列分类的两个序列,或用于问答任务的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。
  • cls_token (str, 可选, 默认为 "[CLS]") — 分类符标记,用于序列分类(对整个序列进行分类,而不是对每个标记进行分类)。当使用特殊标记构建序列时,它是序列的第一个标记。
  • unk_token (str, 可选, 默认为 "[UNK]") — 未知标记。不在词汇表中的标记无法转换为 ID,将被设置为此标记。
  • pad_token (str, 可选, 默认为 "[PAD]") — 用于填充的标记,例如在批处理不同长度的序列时。
  • mask_token (str, 可选, 默认为 "[MASK]") — 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。
  • add_prefix_space (bool, 可选, 默认为 False) — 是否在输入前添加一个初始空格。这允许将开头的单词像其他任何单词一样处理。(Deberta 分词器通过前面的空格检测单词的开头)。

构建一个“快速”的 DeBERTa 分词器(由 HuggingFace 的 *tokenizers* 库支持)。基于字节级的字节对编码(Byte-Pair-Encoding)。

这个分词器经过训练,将空格视为词元的一部分(有点像 sentencepiece),所以一个词会

无论是否在句子开头(无空格),编码方式都会不同

>>> from transformers import DebertaTokenizerFast

>>> tokenizer = DebertaTokenizerFast.from_pretrained("microsoft/deberta-base")
>>> tokenizer("Hello world")["input_ids"]
[1, 31414, 232, 2]

>>> tokenizer(" Hello world")["input_ids"]
[1, 20920, 232, 2]

您可以通过在实例化此分词器时传递 add_prefix_space=True 来绕过此行为,但由于模型并非以此方式进行预训练,这可能会导致性能下降。

当与 is_split_into_words=True 一起使用时,此分词器需要以 add_prefix_space=True 进行实例化。

该分词器继承自 PreTrainedTokenizerFast,其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

< >

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

参数

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

返回

List[int]

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

通过连接和添加特殊标记,从一个序列或一对序列为序列分类任务构建模型输入。DeBERTa 序列具有以下格式:

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

create_token_type_ids_from_sequences

< >

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) list[int]

参数

  • token_ids_0 (list[int]) — 第一个分词后的序列。
  • token_ids_1 (list[int], 可选) — 第二个分词后的序列。

返回

list[int]

标记类型 ID。

创建与传入序列对应的标记类型 ID。什么是标记类型 ID?

如果模型有特殊的构建方式,应在子类中重写此方法。

Pytorch
隐藏 Pytorch 内容

DebertaModel

class transformers.DebertaModel

< >

( config )

参数

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

原始的 Deberta 模型,输出原始的隐藏状态,顶部没有任何特定的头。

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

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.Tensor,形状为 (batch_size, sequence_length)可选) — 词汇表中输入序列标记的索引。默认情况下,填充将被忽略。

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

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记被掩码

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (torch.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 而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputtuple(torch.FloatTensor)

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

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

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

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

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

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

DebertaModel 的 forward 方法重写了 `__call__` 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

DebertaPreTrainedModel

class transformers.DebertaPreTrainedModel

< >

( config: PretrainedConfig *inputs **kwargs )

参数

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

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

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

DebertaForMaskedLM

class transformers.DebertaForMaskedLM

< >

( config )

参数

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

带有 `language modeling` 头的 Deberta 模型。

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

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 词汇表中输入序列标记的索引。默认情况下,填充将被忽略。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自 `[0, 1]`:

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

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

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

返回

transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MaskedLMOutput 或一个 `torch.FloatTensor` 的元组(如果传入 `return_dict=False` 或 `config.return_dict=False`),包含各种元素,具体取决于配置 (DebertaConfig) 和输入。

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

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

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

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

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

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

DebertaForMaskedLM 的 forward 方法重写了 `__call__` 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, DebertaForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForMaskedLM.from_pretrained("microsoft/deberta-base")

>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")

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

>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]

>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
...

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

DebertaForSequenceClassification

class transformers.DebertaForSequenceClassification

< >

( config )

参数

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

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

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 词汇表中输入序列标记的索引。默认情况下,填充将被忽略。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自 `[0, 1]`:

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

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

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

返回

transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 `torch.FloatTensor` 的元组(如果传入 `return_dict=False` 或 `config.return_dict=False`),包含各种元素,具体取决于配置 (DebertaConfig) 和输入。

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

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

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

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

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

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

DebertaForSequenceClassification 的 forward 方法重写了 `__call__` 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, DebertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForSequenceClassification.from_pretrained("microsoft/deberta-base")

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

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

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

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = DebertaForSequenceClassification.from_pretrained("microsoft/deberta-base", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, DebertaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForSequenceClassification.from_pretrained("microsoft/deberta-base", problem_type="multi_label_classification")

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

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

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = DebertaForSequenceClassification.from_pretrained(
...     "microsoft/deberta-base", num_labels=num_labels, problem_type="multi_label_classification"
... )

>>> labels = torch.sum(
...     torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss

DebertaForTokenClassification

class transformers.DebertaForTokenClassification

< >

( config )

参数

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

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

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

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 词汇表中输入序列标记的索引。默认情况下,填充将被忽略。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自 `[0, 1]`:

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

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (torch.Tensor,形状为 `(batch_size, sequence_length, hidden_size)`,可选) — (可选)你可以选择直接传递嵌入表示,而不是传递 `input_ids`。如果你希望比模型内部的嵌入查找矩阵更能控制如何将 `input_ids` 索引转换为相关向量,这会很有用。
  • labels (torch.LongTensor,形状为 `(batch_size, sequence_length)`,可选) — 用于计算标记分类损失的标签。索引应在 `[0, ..., config.num_labels - 1]` 范围内。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的 `attentions`。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的 `hidden_states`。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 `torch.FloatTensor` 的元组(如果传入 `return_dict=False` 或 `config.return_dict=False`),包含各种元素,具体取决于配置 (DebertaConfig) 和输入。

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

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

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

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

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

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

DebertaForTokenClassification 的 forward 方法重写了 `__call__` 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, DebertaForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForTokenClassification.from_pretrained("microsoft/deberta-base")

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

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

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

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

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

DebertaForQuestionAnswering

class transformers.DebertaForQuestionAnswering

< >

( config )

参数

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

带有片段分类头的 Deberta transformer,用于抽取式问答任务,如 SQuAD(一个在隐藏状态输出之上的线性层,用于计算 `span start logits` 和 `span end logits`)。

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

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它,并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 词汇表中输入序列标记的索引。默认情况下,填充将被忽略。

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

    什么是输入 ID?

  • attention_mask (torch.Tensor,形状为 `(batch_size, sequence_length)`,可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值选自 `[0, 1]`:

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

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (torch.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关联的向量,这很有用。
  • start_positions (torch.Tensor,形状为 (batch_size,)可选) — 标记范围开始位置(索引)的标签,用于计算标记分类损失。位置被限制在序列长度(sequence_length)之内。序列之外的位置在计算损失时不予考虑。
  • end_positions (torch.Tensor,形状为 (batch_size,)可选) — 标记范围结束位置(索引)的标签,用于计算标记分类损失。位置被限制在序列长度(sequence_length)之内。序列之外的位置在计算损失时不予考虑。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回的张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回的张量下的 hidden_states
  • return_dict (bool可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数(SoftMax 之前)。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围结束分数(SoftMax 之前)。

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

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

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

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

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

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, DebertaForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/deberta-base")
>>> model = DebertaForQuestionAnswering.from_pretrained("microsoft/deberta-base")

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

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

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

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

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

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

TFDebertaModel

class transformers.TFDebertaModel

< >

( config: DebertaConfig *inputs **kwargs )

参数

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

基础的 DeBERTa 模型 Transformer,输出原始的隐藏状态,没有任何特定的头部。DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在论文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它建立在 BERT/RoBERTa 之上,有两项改进,即解耦注意力和增强的掩码解码器。通过这两项改进,它在大多数任务上以 80GB 的预训练数据超越了 BERT/RoBERTa。

该模型也是一个 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 inputs_embeds: np.ndarray | tf.Tensor | None = 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.TFBaseModelOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarraytf.Tensorlist[tf.Tensor]dict[str, tf.Tensor]dict[str, np.ndarray],每个样本的形状必须为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    可以使用 AutoTokenizer 获得索引。详情请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记被掩码

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关联的向量,这很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回的张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回的张量下的 hidden_states
  • return_dict (bool可选) — 是否返回一个 [`~utils.ModelOutput`] 而不是一个普通的元组。

返回

transformers.modeling_tf_outputs.TFBaseModelOutputtuple(tf.Tensor)

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

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

  • hidden_states (tuple(tf.FloatTensor)可选,当传递 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 后的注意力权重,用于计算自注意力头中的加权平均值。

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

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaModel.from_pretrained("kamalkraj/deberta-base")

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

>>> last_hidden_states = outputs.last_hidden_state

TFDebertaPreTrainedModel

class transformers.TFDebertaPreTrainedModel

< >

( *args **kwargs )

一个用于处理权重初始化以及提供下载和加载预训练模型的简单接口的抽象类。

调用

< >

( inputs training = None mask = None )

参数

  • inputs — 输入张量,或输入张量的 dict/list/tuple。
  • training — 布尔值或布尔标量张量,指示是以训练模式还是推理模式运行 Network
  • mask — 一个掩码或掩码列表。掩码可以是一个布尔张量或 None(无掩码)。有关更多详细信息,请查看此处的指南。

在新输入上调用模型并以张量形式返回输出。

在这种情况下,call() 只是将图中所有的操作重新应用到新的输入上(例如,从提供的输入构建一个新的计算图)。

注意:不应直接调用此方法。它仅用于在子类化 tf.keras.Model 时进行重写。要在一个输入上调用模型,请始终使用 __call__() 方法,即 model(inputs),它依赖于底层的 call() 方法。

TFDebertaForMaskedLM

class transformers.TFDebertaForMaskedLM

< >

( config: DebertaConfig *inputs **kwargs )

参数

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

DeBERTa 模型,顶部带有 语言建模 头部。DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao、Weizhu Chen 在论文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它建立在 BERT/RoBERTa 之上,有两项改进,即解耦注意力和增强的掩码解码器。通过这两项改进,它在大多数任务上以 80GB 的预训练数据超越了 BERT/RoBERTa。

该模型也是一个 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 inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarraytf.Tensorlist[tf.Tensor]dict[str, tf.Tensor]dict[str, np.ndarray],每个样本的形状必须为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    可以使用 AutoTokenizer 获得索引。详情请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记被掩码

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size)可选) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关联的向量,这很有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回的张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回的张量下的 hidden_states
  • return_dict (bool可选) — 是否返回一个 [`~utils.ModelOutput`] 而不是一个普通的元组。
  • labels (tf.Tensornp.ndarray,形状为 (batch_size, sequence_length)可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 范围内(请参阅 input_ids 文档字符串)索引设置为 -100 的标记将被忽略(掩码),损失仅对标签在 [0, ..., config.vocab_size] 范围内的标记进行计算

返回

transformers.modeling_tf_outputs.TFMaskedLMOutputtuple(tf.Tensor)

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

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

  • logits (tf.Tensor of shape (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 TFDebertaForMaskedLM forward method, overrides the __call__ special method.

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForMaskedLM.from_pretrained("kamalkraj/deberta-base")

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

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

>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)
>>> 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)

TFDebertaForSequenceClassification

class transformers.TFDebertaForSequenceClassification

< >

( config: DebertaConfig *inputs **kwargs )

参数

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

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

DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在论文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基于 BERT/RoBERTa 构建,并进行了两项改进:解耦注意力(disentangled attention)和增强型掩码解码器(enhanced mask decoder)。凭借这两项改进,它在使用 80GB 预训练数据的情况下,在大多数任务上的表现优于 BERT/RoBERTa。

该模型也是一个 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 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 (np.ndarray, tf.Tensor, list[tf.Tensor]、`dict[str, tf.Tensor]dict[str, np.ndarray],每个样本的形状必须为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    索引可以使用 AutoTokenizer 获得。更多细节请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记已被掩码

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,你可以不传递 input_ids,而是直接传递嵌入表示。如果你想对如何将 input_ids 索引转换为相关向量进行更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 [`~utils.ModelOutput`] 而不是一个普通的元组。
  • labels (tf.Tensornp.ndarray,形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1,则计算回归损失(均方损失);如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

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

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

TFDebertaForSequenceClassification 的前向方法会覆盖 __call__ 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForSequenceClassification.from_pretrained("kamalkraj/deberta-base")

>>> 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 = TFDebertaForSequenceClassification.from_pretrained("kamalkraj/deberta-base", num_labels=num_labels)

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

TFDebertaForTokenClassification

class transformers.TFDebertaForTokenClassification

< >

( config: DebertaConfig *inputs **kwargs )

参数

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

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

DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在论文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基于 BERT/RoBERTa 构建,并进行了两项改进:解耦注意力(disentangled attention)和增强型掩码解码器(enhanced mask decoder)。凭借这两项改进,它在使用 80GB 预训练数据的情况下,在大多数任务上的表现优于 BERT/RoBERTa。

该模型也是一个 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 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.TFTokenClassifierOutputtuple(tf.Tensor)

参数

  • input_ids (np.ndarray, tf.Tensor, list[tf.Tensor]、`dict[str, tf.Tensor]dict[str, np.ndarray],每个样本的形状必须为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    索引可以使用 AutoTokenizer 获得。更多细节请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记已被掩码

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,你可以不传递 input_ids,而是直接传递嵌入表示。如果你想对如何将 input_ids 索引转换为相关向量进行更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 [`~utils.ModelOutput`] 而不是一个普通的元组。
  • labels (tf.Tensornp.ndarray,形状为 (batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。

返回

transformers.modeling_tf_outputs.TFTokenClassifierOutputtuple(tf.Tensor)

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

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

TFDebertaForTokenClassification 的前向方法会覆盖 __call__ 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForTokenClassification.from_pretrained("kamalkraj/deberta-base")

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

TFDebertaForQuestionAnswering

class transformers.TFDebertaForQuestionAnswering

< >

( config: DebertaConfig *inputs **kwargs )

参数

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

顶部带有片段分类头的 DeBERTa 模型,用于像 SQuAD 这样的抽取式问答任务(在隐藏状态输出之上有一系列线性层,用于计算片段开始 logits片段结束 logits)。

DeBERTa 模型由 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen 在论文 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它基于 BERT/RoBERTa 构建,并进行了两项改进:解耦注意力(disentangled attention)和增强型掩码解码器(enhanced mask decoder)。凭借这两项改进,它在使用 80GB 预训练数据的情况下,在大多数任务上的表现优于 BERT/RoBERTa。

该模型也是一个 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 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 (np.ndarray, tf.Tensor, list[tf.Tensor]、`dict[str, tf.Tensor]dict[str, np.ndarray],每个样本的形状必须为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

    索引可以使用 AutoTokenizer 获得。更多细节请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

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

    • 1 表示标记未被掩码
    • 0 表示标记已被掩码

    什么是注意力掩码?

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

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

    什么是标记类型 ID?

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

    什么是位置 ID?

  • inputs_embeds (np.ndarraytf.Tensor,形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,你可以不传递 input_ids,而是直接传递嵌入表示。如果你想对如何将 input_ids 索引转换为相关向量进行更多控制,而不是使用模型的内部嵌入查找矩阵,这将非常有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回一个 [`~utils.ModelOutput`] 而不是一个普通的元组。
  • start_positions (tf.Tensornp.ndarray,形状为 (batch_size,), 可选) — 用于计算标记分类损失的标注片段起始位置(索引)的标签。位置被限制在序列长度(sequence_length)之内。超出序列的位置在计算损失时不会被考虑。
  • end_positions (tf.Tensornp.ndarray,形状为 (batch_size,), 可选) — 用于计算标记分类损失的标注片段结束位置(索引)的标签。位置被限制在序列长度(sequence_length)之内。超出序列的位置在计算损失时不会被考虑。

返回

transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutputtuple(tf.Tensor)

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

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

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

  • end_logits (形状为 (batch_size, sequence_length)tf.Tensor) — 跨度结束分数(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 后的注意力权重,用于计算自注意力头中的加权平均值。

TFDebertaForQuestionAnswering 的前向方法会覆盖 __call__ 特殊方法。

尽管前向传播的流程需要在此函数中定义,但之后应调用 `Module` 实例而不是此函数,因为前者会处理前处理和后处理步骤,而后者则会静默地忽略它们。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("kamalkraj/deberta-base")
>>> model = TFDebertaForQuestionAnswering.from_pretrained("kamalkraj/deberta-base")

>>> 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)
< > 在 GitHub 上更新