DeBERTa
概述
DeBERTa 模型由彭成、刘晓东、高建峰、陈伟洲 在 DeBERTa:具有解耦注意力的解码增强 BERT 中提出。它基于 Google 在 2018 年发布的 BERT 模型和 Facebook 在 2019 年发布的 RoBERTa 模型。
它在 RoBERTa 的基础上构建,使用解耦注意力机制和增强的掩码解码器训练,训练数据为 RoBERTa 的一半。
论文摘要如下:
预训练的神经语言模型的最新进展显著提高了许多自然语言处理 (NLP) 任务的性能。在本文中,我们提出了一种新的模型架构 DeBERTa(具有解耦注意力的解码增强 BERT),它使用两种新技术改进 BERT 和 RoBERTa 模型。第一个是解耦注意力机制,其中每个词使用两个向量分别编码其内容和位置,而词之间的注意力权重使用它们内容和相对位置上的解耦矩阵来计算。其次,使用增强的掩码解码器来替换输出 softmax 层,以预测模型预训练的掩码标记。我们证明了这两种技术显著提高了模型预训练的效率和下游任务的性能。与 RoBERTa-Large 相比,在训练数据一半上训练的 DeBERTa 模型在各种 NLP 任务上始终表现更好,在 MNLI 上取得了 +0.9%(90.2% 对 91.1%)的改进,在 SQuAD v2.0 上取得了 +2.3%(88.4% 对 90.7%)的改进,在 RACE 上取得了 +3.6%(83.2% 对 86.8%)的改进。DeBERTa 代码和预训练模型将在 https://github.com/microsoft/DeBERTa 上公开发布。
该模型由 DeBERTa 贡献。该模型 TF 2.0 实现由 kamalkraj 贡献。原始代码可以在这里找到 这里.
资源
以下是官方 Hugging Face 和社区(🌎 表示)资源列表,可帮助您开始使用 DeBERTa。如果您有兴趣提交要包含在这里的资源,请随时打开一个拉取请求,我们会审查它!理想情况下,该资源应该展示新的内容,而不是重复现有的资源。
- 一篇关于如何使用 DeBERTa 使用 DeepSpeed 加速大型模型训练 的博文。
- 一篇关于 使用机器学习增强客户服务 的博文,其中使用了 DeBERTa。
- DebertaForSequenceClassification 受此 示例脚本 和 笔记本 支持。
- TFDebertaForSequenceClassification 受此 示例脚本 和 笔记本 支持。
- 文本分类任务指南
- DebertaForTokenClassification 受此 示例脚本 和 笔记本 支持。
- TFDebertaForTokenClassification 受此 示例脚本 和 笔记本 支持。
- 标记分类 是 🤗 Hugging Face 课程的第 7 章。
- 字节对编码分词 是 🤗 Hugging Face 课程的第 6 章。
- 标记分类任务指南
- DebertaForMaskedLM 受此 示例脚本 和 笔记本 支持。
- TFDebertaForMaskedLM 受此 示例脚本 和 笔记本 支持。
- 掩码语言建模 是 🤗 Hugging Face 课程的第 7 章。
- 掩码语言建模任务指南
- DebertaForQuestionAnswering 受此 示例脚本 和 笔记本 支持。
- TFDebertaForQuestionAnswering 受此 示例脚本 和 笔记本 支持。
- 问答 是 🤗 Hugging Face 课程的第 7 章。
- 问答任务指南
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' **kwargs )
参数
- vocab_size (
int
, 可选, 默认值 30522) — DeBERTa 模型的词汇量。定义调用 DebertaModel 或 TFDebertaModel 时,可由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 (
str
或Callable
, 可选, 默认值"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
, 可选, 默认值 2) — 调用 DebertaModel 或 TFDebertaModel 时传递的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。
这是用于存储 DebertaModel 或 TFDebertaModel 配置的配置类。 它用于根据指定的参数实例化 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
, optional, defaults to"[PAD]"
) — 用于填充的标记,例如在对不同长度的序列进行批处理时。 - mask_token (
str
, optional, defaults to"[MASK]"
) — 用于掩盖值的标记。这是在使用掩盖语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - add_prefix_space (
bool
, optional, defaults toFalse
) — 是否在输入的开头添加空格。这允许将第一个词语与其他词语一样对待。(Deberta 词汇器通过前面的空格来识别词语的开头。) - add_bos_token (
bool
, optional, defaults toFalse
) — 是否在输入的开头添加 <|endoftext|>。这允许将第一个词语与其他词语一样对待。
构建一个 DeBERTa 词汇器。基于字节级的字节对编码。
这个词汇器经过训练,将空格视为标记的一部分(有点像 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
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接和添加特殊标记,从用于序列分类任务的单个序列或一对序列构建模型输入。DeBERTa 序列具有以下格式
- 单个序列: [CLS] X [SEP]
- 序列对: [CLS] A [SEP] B [SEP]
get_special_tokens_mask
< source >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊令牌的令牌列表中检索序列 ID。当使用分词器 prepare_for_model
或 encode_plus
方法添加特殊令牌时,会调用此方法。
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
从传递的两个序列中创建一个掩码,用于序列对分类任务。DeBERTa
如果 token_ids_1
为 None
,则此方法只返回掩码的第一部分(0)。
DebertaTokenizerFast
类 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]"
) — 用于填充的标记,例如在对不同长度的序列进行批处理时。
构建一个“快速”DeBERTa 分词器(由 HuggingFace 的 tokenizers 库支持)。基于字节级字节对编码。
这个词汇器经过训练,将空格视为标记的一部分(有点像 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: Optional = None ) → List[int]
通过连接和添加特殊标记,从用于序列分类任务的单个序列或一对序列构建模型输入。DeBERTa 序列具有以下格式
- 单个序列: [CLS] X [SEP]
- 序列对: [CLS] A [SEP] B [SEP]
DebertaModel
类 transformers.DebertaModel
< 源代码 >( config )
DebertaPreTrainedModel
一个抽象类,用于处理权重初始化以及下载和加载预训练模型的简单接口。
DebertaForMaskedLM
class transformers.DebertaForMaskedLM
< 源代码 >( config )
参数
- config (DebertaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
DeBERTa 模型,顶部带有一个 语言建模
头。DeBERTa 模型在 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出,作者是 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen。它基于 BERT/RoBERTa,并进行了两项改进,即解耦注意力和增强掩码解码器。通过这两项改进,它在大多数任务上都超过了 BERT/RoBERTa,使用了 80GB 的预训练数据。
此模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解有关一般用法和行为的所有事项。
forward
< 源代码 > ( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 标记。
- position_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 位置嵌入中每个输入序列标记位置的索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - 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]
中的标记计算损失。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor
元组(如果传递了 return_dict=False
或 config.return_dict=False
时),其中包含根据配置 (DebertaConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选,在提供labels
时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor
形状为(batch_size, sequence_length, config.vocab_size)
) — 语言建模头的预测分数(SoftMax 之前的每个词汇标记的分数)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 在传递了output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
元组 (一个用于嵌入层的输出, 如果模型具有嵌入层, 以及一个用于每一层的输出) 形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 在传递了output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组 (每一层一个) 形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均。
DebertaForMaskedLM 的 正向方法 覆盖了 __call__
特殊方法。
尽管前向传递的配方需要在此函数中定义,但应该随后调用 Module
实例而不是它,因为前者负责运行预处理和后处理步骤,而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DebertaForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("lsanochkin/deberta-large-feedback")
>>> model = DebertaForMaskedLM.from_pretrained("lsanochkin/deberta-large-feedback")
>>> 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.54
DebertaForSequenceClassification
class transformers.DebertaForSequenceClassification
< 源代码 >( config )
参数
- config (DebertaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
带有序列分类/回归头的 DeBERTa 模型转换器(在池化输出之上添加线性层),例如用于 GLUE 任务。
DeBERTa 模型由彭程、刘晓冬、高建峰、陈伟珠在 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它在 BERT/RoBERTa 之上构建,有两个改进,即解耦注意和增强掩码解码器。通过这两个改进,它在使用 80GB 预训练数据的多数任务中,性能优于 BERT/RoBERTa。
此模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解有关一般用法和行为的所有事项。
forward
< 源代码 > ( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- 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 标记。
- position_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
,可选) — 位置嵌入中每个输入序列标记的位置索引。选择在[0, config.max_position_embeddings - 1]
范围内。 - inputs_embeds (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
,可选) — 可选地,您可以选择直接传递嵌入式表示,而不是传递input_ids
。如果您想要更多地控制如何将 input_ids 索引转换为关联向量(而不是模型的内部嵌入查找矩阵),这将很有用。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量中的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的hidden_states
。 - return_dict (
bool
,可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
torch.LongTensor
形状为(batch_size,)
,可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
中。如果config.num_labels == 1
,则计算回归损失(均方损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (DebertaConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor
形状为(1,)
,可选,在提供labels
时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。 -
logits (
torch.FloatTensor
形状为(batch_size, config.num_labels)
) — 分类(或如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 在传递了output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
元组 (一个用于嵌入层的输出, 如果模型具有嵌入层, 以及一个用于每一层的输出) 形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 在传递了output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组 (每一层一个) 形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均。
DebertaForSequenceClassification 正向方法覆盖了 __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()
>>> # 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
多标签分类示例
>>> 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
< source >( config )
参数
- config (DebertaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。
DeBERTa 模型,顶部带有令牌分类头(隐藏状态输出顶部的线性层),例如用于命名实体识别 (NER) 任务。
DeBERTa 模型由彭程、刘晓冬、高建峰、陈伟珠在 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它在 BERT/RoBERTa 之上构建,有两个改进,即解耦注意和增强掩码解码器。通过这两个改进,它在使用 80GB 预训练数据的多数任务中,性能优于 BERT/RoBERTa。
此模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解有关一般用法和行为的所有事项。
forward
< source > ( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 输入序列标记在词汇表中的索引。索引可以通过 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 标记。
- position_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 输入序列标记在位置嵌入中的位置索引。选择在[0, config.max_position_embeddings - 1]
范围内。 - 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)
, 可选) —
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含取决于配置 (DebertaConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor
形状为(1,)
,可选,在提供labels
时返回) — 分类损失。 -
logits (
torch.FloatTensor
形状为(batch_size, sequence_length, config.num_labels)
) — 分类分数(在 SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 在传递了output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
元组 (一个用于嵌入层的输出, 如果模型具有嵌入层, 以及一个用于每一层的输出) 形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 在传递了output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组 (每一层一个) 形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均。
The DebertaForTokenClassification 正向方法,覆盖了 __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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
DebertaForQuestionAnswering
class transformers.DebertaForQuestionAnswering
< source >( config )
参数
- config (DebertaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法加载模型权重。
DeBERTa 模型,顶部有一个跨度分类头,用于提取式问答任务,例如 SQuAD(在隐藏状态输出的顶部添加线性层来计算 span start logits
和 span end logits
)。
DeBERTa 模型由彭程、刘晓冬、高建峰、陈伟珠在 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出。它在 BERT/RoBERTa 之上构建,有两个改进,即解耦注意和增强掩码解码器。通过这两个改进,它在使用 80GB 预训练数据的多数任务中,性能优于 BERT/RoBERTa。
此模型也是 PyTorch 的 torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解有关一般用法和行为的所有事项。
forward
< source > ( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。
- attention_mask (
torch.FloatTensor
形状为(batch_size, sequence_length)
,可选) — 掩码,以避免对填充标记索引执行注意力。在[0, 1]
中选择掩码值:- 1 表示**未掩码**的标记
- 0 表示**掩码**的标记
- token_type_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
,可选) — 段标记索引,指示输入的第一部分和第二部分。索引在[0, 1]
中选择:- 0 对应于句子 A 标记
- 1 对应于句子 B 标记
- position_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
,可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - inputs_embeds (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
, 可选) — 可选地,您可以选择直接传递嵌入表示而不是传递input_ids
。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制,而不是模型内部的嵌入查找矩阵,这将很有用。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - start_positions (
torch.LongTensor
形状为(batch_size,)
, 可选) — 用于计算标记分类损失的标记跨度开始位置(索引)的标签。位置被限制在序列长度 (sequence_length
) 内。序列之外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor
形状为(batch_size,)
, 可选) — 用于计算标记分类损失的标记跨度结束位置(索引)的标签。位置被限制在序列长度 (sequence_length
) 内。序列之外的位置不会被考虑用于计算损失。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或者 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或者一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (DebertaConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选,当提供labels
时返回) — 总的跨度提取损失是开始和结束位置交叉熵的总和。 -
start_logits (
torch.FloatTensor
形状为(batch_size, sequence_length)
) — 跨度开始得分(在 SoftMax 之前)。 -
end_logits (
torch.FloatTensor
形状为(batch_size, sequence_length)
) — 跨度结束得分(在 SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 在传递了output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
元组 (一个用于嵌入层的输出, 如果模型具有嵌入层, 以及一个用于每一层的输出) 形状为(batch_size, sequence_length, hidden_size)
。模型在每一层输出处的隐藏状态,加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 在传递了output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组 (每一层一个) 形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均。
DebertaForQuestionAnswering 的 forward 方法,覆盖了 __call__
特殊方法。
尽管前向传递的配方需要在此函数中定义,但应该随后调用 Module
实例而不是它,因为前者负责运行预处理和后处理步骤,而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, DebertaForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("Palak/microsoft_deberta-large_squad")
>>> model = DebertaForQuestionAnswering.from_pretrained("Palak/microsoft_deberta-large_squad")
>>> 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)
' a nice puppet'
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([12])
>>> target_end_index = torch.tensor([14])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
0.14
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 的基础上进行改进,包括解耦注意力机制和增强掩码解码器。通过这两项改进,它在大多数任务上都优于 BERT/RoBERTa,并使用了 80GB 的预训练数据。
该模型也是一个 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.TFBaseModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
`Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,每个示例必须具有形状(batch_size, sequence_length)
) — 输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
np.ndarray
或tf.Tensor
,形状为(batch_size, sequence_length)
,可选) — 掩码,用于避免对填充标记索引执行注意力。掩码值选自[0, 1]
中:- 1 表示未被掩码的标记,
- 0 表示被掩码的标记。
- token_type_ids (
np.ndarray
或tf.Tensor
,形状为(batch_size, sequence_length)
,可选) — 段标记索引,用于指示输入的第一部分和第二部分。索引选自[0, 1]
中:- 0 表示句子 A 标记,
- 1 表示句子 B 标记。
- position_ids (
np.ndarray
或tf.Tensor
,形状为(batch_size, sequence_length)
,可选) — 每个输入序列标记在位置嵌入中的位置索引。选自[0, config.max_position_embeddings - 1]
范围内。 - inputs_embeds (
np.ndarray
或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
, 可选) — 是否返回 [`~utils.ModelOutput“] 而不是普通元组。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或 tf.Tensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包括根据配置 (DebertaConfig) 和输入的不同元素。
-
last_hidden_state (
tf.Tensor
形状为(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
一个抽象类,用于处理权重初始化以及下载和加载预训练模型的简单接口。
在新的输入上调用模型并返回输出作为张量。
在这种情况下,call()
只是将图中的所有操作重新应用于新的输入(例如,从提供的输入构建新的计算图)。
注意:不应直接调用此方法。它只用于在子类化 tf.keras.Model
时被覆盖。要在输入上调用模型,始终使用 __call__()
方法,即 model(inputs)
,它依赖于底层的 call()
方法。
TFDebertaForMaskedLM
class transformers.TFDebertaForMaskedLM
< 源代码 >( config: DebertaConfig *inputs **kwargs )
参数
- config (DebertaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法来加载模型权重。
DeBERTa 模型,顶部带有一个 语言建模
头。DeBERTa 模型在 DeBERTa: Decoding-enhanced BERT with Disentangled Attention 中提出,作者是 Pengcheng He、Xiaodong Liu、Jianfeng Gao 和 Weizhu Chen。它基于 BERT/RoBERTa,并进行了两项改进,即解耦注意力和增强掩码解码器。通过这两项改进,它在大多数任务上都超过了 BERT/RoBERTa,使用了 80GB 的预训练数据。
该模型也是一个 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 函数一样传递输入!
调用
< source > ( 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.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
`Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,每个示例必须具有形状(batch_size, sequence_length)
) — 输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (形状为
(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选) — 掩码,以避免对填充标记索引执行注意力。在[0, 1]
中选择掩码值:- 1 代表未掩码的标记,
- 0 代表掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选) — 段标记索引,指示输入的第一部分和第二部分。在[0, 1]
中选择索引:- 0 代表句子 A 标记,
- 1 代表句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选) — 输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的np.ndarray
或tf.Tensor
,可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想对如何将input_ids 索引转换为关联的向量进行比模型内部嵌入查找矩阵更多的控制,这将很有用。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 [`~utils.ModelOutput“] 而不是一个普通元组。 - labels (
tf.Tensor
或np.ndarray
形状为(batch_size, sequence_length)
, 可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]
中(参见input_ids
文档字符串) 索引设置为-100
的令牌将被忽略(掩码),损失仅针对标签在[0, ..., config.vocab_size]
中的令牌计算
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 tf.Tensor
元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (DebertaConfig) 和输入的不同元素。
-
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 之后的注意力权重,用于计算自注意力头中的加权平均。
该 TFDebertaForMaskedLM 正向方法覆盖了 __call__
特殊方法。
尽管前向传递的配方需要在此函数中定义,但应该随后调用 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)
TFDebertaForSequenceClassification
class transformers.TFDebertaForSequenceClassification
< 源代码 >( config: DebertaConfig *inputs **kwargs )
参数
- config (DebertaConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法加载模型权重。
带有序列分类/回归头的 DeBERTa 模型转换器(在池化输出之上添加线性层),例如用于 GLUE 任务。
DeBERTa 模型由彭程、刘晓冬、高建峰、陈伟珠在 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.TFSequenceClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
`Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
且每个样本的形状必须为(batch_size, sequence_length)
) — 输入序列词元在词表的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- attention_mask (形状为
(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选) — 掩码以避免对填充词元索引执行注意力操作。掩码值在[0, 1]
中选择:- 1 表示**未被掩码**的词元,
- 0 表示**被掩码**的词元。
- token_type_ids (形状为
(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选) — 段词元索引,用于指示输入的第一部分和第二部分。索引在[0, 1]
中选择:- 0 对应于句子 A 词元,
- 1 对应于句子 B 词元。
- position_ids (形状为
(batch_size, sequence_length)
的np.ndarray
或tf.Tensor
,可选) — 输入序列词元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]
范围内选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的np.ndarray
或tf.Tensor
,可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想要对如何将input_ids 索引转换为关联的向量(而不是模型的内部嵌入查找矩阵)进行更多控制,这将非常有用。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回张量中的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回张量中的hidden_states
。 - return_dict (
bool
,可选) — 是否返回 [`~utils.ModelOutput“] 而不是普通元组。 - labels (
tf.Tensor
或np.ndarray
形状为(batch_size,)
, 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
内。如果config.num_labels == 1
,则计算回归损失(均方误差损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(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 之后的注意力权重,用于计算自注意力头中的加权平均。
The TFDebertaForSequenceClassification forward method, overrides the __call__
special method.
尽管前向传递的配方需要在此函数中定义,但应该随后调用 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 模型由彭程、刘晓冬、高建峰、陈伟珠在 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.TFTokenClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
`Dict[str, tf.Tensor]
或Dict[str, np.ndarray]
,并且每个示例必须具有形状(batch_size, sequence_length)
) — 输入序列词元的词汇索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
np.ndarray
或tf.Tensor
形状为(batch_size, sequence_length)
, 可选) — 掩码以避免对填充词元索引执行注意力。掩码值在[0, 1]
内选择:- 1 表示 未掩码 的词元,
- 0 表示 掩码 的词元。
- token_type_ids (
np.ndarray
或tf.Tensor
形状为(batch_size, sequence_length)
,可选) — 分段标记索引,用于指示输入的第一部分和第二部分。索引在[0, 1]
中选择:- 0 对应于 句子 A 标记
- 1 对应于 句子 B 标记
- position_ids (
np.ndarray
或tf.Tensor
形状为(batch_size, sequence_length)
,可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]
中选择。 - inputs_embeds (
np.ndarray
或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
,可选) — 是否返回 [`~utils.ModelOutput“] 而不是普通元组。 - labels (
tf.Tensor
或np.ndarray
形状为(batch_size, sequence_length)
,可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]
中。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tf.Tensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包括根据配置 (DebertaConfig) 和输入的不同元素。
-
loss (
tf.Tensor
形状为(n,)
,可选,当提供labels
时返回,其中 n 是未屏蔽标签的数量) — 分类损失。 -
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()]
TFDebertaForQuestionAnswering
class transformers.TFDebertaForQuestionAnswering
< 源代码 >( config: DebertaConfig *inputs **kwargs )