Transformers 文档
MPNet
并获得增强的文档体验
开始使用
MPNet
概述
MPNet 模型由 Kaitao Song、Xu Tan、Tao Qin、Jianfeng Lu 和 Tie-Yan Liu 在论文 《MPNet: Masked and Permuted Pre-training for Language Understanding》 中提出。
MPNet 采用了一种新颖的预训练方法，名为掩码和置换语言建模，以继承掩码语言建模和置换语言建模的优点，用于自然语言理解。
论文摘要如下：
BERT 采用掩码语言建模（MLM）进行预训练，是最成功的预训练模型之一。由于 BERT 忽略了预测词元之间的依赖关系，XLNet 引入了置换语言建模（PLM）进行预训练以解决此问题。然而，XLNet 未能利用句子的完整位置信息，因此在预训练和微调之间存在位置差异。在本文中，我们提出了 MPNet，这是一种新颖的预训练方法，继承了 BERT 和 XLNet 的优点，并避免了它们的局限性。MPNet 通过置换语言建模（相对于 BERT 中的 MLM）利用预测词元之间的依赖关系，并输入辅助位置信息，使模型能看到完整的句子，从而减少位置差异（相对于 XLNet 中的 PLM）。我们在大规模数据集（超过 160GB 文本语料库）上预训练 MPNet，并在各种下游任务（GLUE、SQuAD 等）上进行微调。实验结果表明，MPNet 的性能明显优于 MLM 和 PLM，并且在相同模型设置下，与之前的最先进预训练方法（例如 BERT、XLNet、RoBERTa）相比，在这些任务上取得了更好的结果。
原始代码可以在这里找到。
使用技巧
MPNet 没有 token_type_ids，您不需要指明哪个词元属于哪个片段。只需使用分隔词元 tokenizer.sep_token（或 [sep]）分隔您的片段即可。
资源
MPNetConfig
class transformers.MPNetConfig
< 来源 >( vocab_size = 30527 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 initializer_range = 0.02 layer_norm_eps = 1e-12 relative_attention_num_buckets = 32 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30527) — MPNet 模型的词汇表大小。定义了在调用 MPNetModel 或 TFMPNetModel 时，可以通过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_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.1) — 嵌入层、编码器和池化层中所有全连接层的丢弃概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — 注意力概率的丢弃率。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以备不时之需（例如 512、1024 或 2048）。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - relative_attention_num_buckets (
int, 可选, 默认为 32) — 每个注意力层使用的桶的数量。
这是用于存储 MPNetModel 或 TFMPNetModel 配置的配置类。它用于根据指定的参数实例化一个 MPNet 模型，定义模型架构。使用默认值实例化配置将产生与 MPNet microsoft/mpnet-base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。更多信息请参阅 PretrainedConfig 的文档。
示例
>>> from transformers import MPNetModel, MPNetConfig
>>> # Initializing a MPNet mpnet-base style configuration
>>> configuration = MPNetConfig()
>>> # Initializing a model from the mpnet-base style configuration
>>> model = MPNetModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMPNetTokenizer
class transformers.MPNetTokenizer
< 来源 >( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '[UNK]' pad_token = '<pad>' mask_token = '<mask>' tokenize_chinese_chars = True strip_accents = None clean_up_tokenization_spaces = True **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - do_lower_case (
bool, 可选, 默认为True) — 是否在分词时将输入转换为小写。 - do_basic_tokenize (
bool, 可选, 默认为True) — 是否在 WordPiece 之前进行基本分词。 - never_split (
Iterable, 可选) — 永远不会在分词过程中被分割的词元集合。仅在do_basic_tokenize=True时有效。 - bos_token (
str, 可选, 默认为"<s>") — 在预训练期间使用的序列开始词元。可以用作序列分类器词元。当使用特殊词元构建序列时，这不是用于序列开始的词元。使用的词元是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束词元。当使用特殊词元构建序列时，这不是用于序列结束的词元。使用的词元是
sep_token。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符词元，用于从多个序列构建一个序列，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作使用特殊词元构建的序列的最后一个词元。 - cls_token (
str, 可选, 默认为"<s>") — 分类器词元，用于序列分类（对整个序列而不是每个词元进行分类）。当使用特殊词元构建时，它是序列的第一个词元。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知词元。不在词汇表中的词元无法转换为 ID，将被设置为此词元。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的词元，例如在批处理不同长度的序列时使用。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩盖值的词元。这是在使用掩码语言建模训练此模型时使用的词元。这是模型将尝试预测的词元。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，这可能应该停用（请参阅此问题）。
- strip_accents (
bool, 可选) — 是否移除所有重音符号。如果未指定此选项，则将由 `lowercase` 的值决定（与原始 BERT 中一样）。 - clean_up_tokenization_spaces (
bool, 可选, 默认为True) — 是否在解码后清理空格，清理操作包括移除可能产生的额外空格等多余符号。
此分词器继承自 BertTokenizer，其中包含了大部分方法。用户应参考超类以获取有关方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
通过拼接和添加特殊标记，从单个序列或序列对为序列分类任务构建模型输入。MPNet 序列具有以下格式：
- 单个序列：
<s> X </s> - 序列对：
<s> A </s></s> B </s>
get_special_tokens_mask
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]
从一个没有添加特殊标记的标记列表中检索序列 ID。当使用分词器的 `prepare_for_model` 方法添加特殊标记时，会调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
从传入的两个序列中创建一个掩码，用于序列对分类任务。MPNet 不使用标记类型 ID，因此返回一个全零列表。
MPNetTokenizerFast
class transformers.MPNetTokenizerFast
< source >( vocab_file = None tokenizer_file = None do_lower_case = True bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '[UNK]' pad_token = '<pad>' mask_token = '<mask>' tokenize_chinese_chars = True strip_accents = None **kwargs )
参数
- vocab_file (
str) — 包含词汇表的文件。 - do_lower_case (
bool, 可选, 默认为True) — 是否在分词时将输入转换为小写。 - bos_token (
str, 可选, 默认为"<s>") — 预训练期间使用的序列开始标记。可用作序列分类器标记。在使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是 `cls_token`。
- eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。在使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是 `sep_token`。
- sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，用于从多个序列构建一个序列，例如用于序列分类的两个序列，或用于问答的文本和问题。它也用作带有特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认为"<s>") — 分类器标记，在进行序列分类（对整个序列而不是逐个标记进行分类）时使用。当使用特殊标记构建序列时，它是序列的第一个标记。 - unk_token (
str, 可选, 默认为"[UNK]") — 未知标记。词汇表中不存在的标记无法转换为 ID，将被设置为此标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在批处理不同长度的序列时使用。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩盖值的标记。这是在使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - tokenize_chinese_chars (
bool, 可选, 默认为True) — 是否对中文字符进行分词。对于日语，此选项可能需要停用（参见此问题）。 - strip_accents (
bool, 可选) — 是否移除所有重音符号。如果未指定此选项，则将由 `lowercase` 的值决定（与原始 BERT 中一样）。
构建一个“快速”的 MPNet 分词器（由 HuggingFace 的 *tokenizers* 库支持）。基于 WordPiece。
此分词器继承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
create_token_type_ids_from_sequences
< source >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
从传入的两个序列中创建一个掩码，用于序列对分类任务。MPNet 不使用标记类型 ID，因此返回一个全零列表。
MPNetModel
class transformers.MPNetModel
< source >( config add_pooling_layer = True )
参数
- config (MPNetModel) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, 可选, 默认为True) — 是否添加一个池化层。
裸 Mpnet 模型，输出原始的隐藏状态，顶部没有任何特定的头。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：- 1 表示标记未被掩码,
- 0 表示标记被掩码。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 `[0, config.n_positions - 1]` 范围内选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 掩码，用于将自注意力模块的选定头部置零。掩码值在 `[0, 1]` 中选择：- 1 表示头部未被掩码,
- 0 表示头部被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型的内部嵌入查找矩阵更多地控制如何将 `input_ids` 索引转换为相关向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPooling 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含各种元素，具体取决于配置（MPNetConfig）和输入。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过用于辅助预训练任务的层进一步处理。例如，对于 BERT 家族模型，这将返回经过线性层和 tanh 激活函数处理后的分类标记。线性层权重是在预训练期间从下一句预测（分类）目标中训练的。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
MPNetModel 的 forward 方法覆盖了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
MPNetForMaskedLM
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：- 1 表示标记未被掩码,
- 0 表示标记被掩码。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。在 `[0, config.n_positions - 1]` 范围内选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的取值范围为[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递一个嵌入式表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵有更多控制权，以便将input_ids索引转换为相关向量，这将非常有用。 - 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.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置 (MPNetConfig) 和输入，包含不同的元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
MPNetForMaskedLM 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MPNetForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = MPNetForMaskedLM.from_pretrained("microsoft/mpnet-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)
...MPNetForSequenceClassification
class transformers.MPNetForSequenceClassification
< 源 >( config )
参数
- config (MPNetForSequenceClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个序列分类/回归头的 MPNet Transformer 模型（在池化输出之上有一个线性层），例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = 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 表示词元被遮盖。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。取值范围为[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的取值范围为[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递一个嵌入式表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵有更多控制权，以便将input_ids索引转换为相关向量，这将非常有用。 - 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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置 (MPNetConfig) 和输入，包含不同的元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
MPNetForSequenceClassification 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, MPNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = MPNetForSequenceClassification.from_pretrained("microsoft/mpnet-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 = MPNetForSequenceClassification.from_pretrained("microsoft/mpnet-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, MPNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = MPNetForSequenceClassification.from_pretrained("microsoft/mpnet-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 = MPNetForSequenceClassification.from_pretrained(
... "microsoft/mpnet-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).lossMPNetForMultipleChoice
class transformers.MPNetForMultipleChoice
< 源 >( config )
参数
- config (MPNetForMultipleChoice) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有多项选择分类头的 Mpnet 模型（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值的取值范围为[0, 1]：- 1 表示词元未被遮盖，
- 0 表示词元被遮盖。
- position_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。取值范围为[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的取值范围为[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递一个嵌入式表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵有更多控制权，以便将 input_ids 索引转换为相关向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量第二个维度的大小。（参见上面的input_ids） - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置 (MPNetConfig) 和输入，包含不同的元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型有嵌入层，+ 每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
MPNetForMultipleChoice 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MPNetForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = MPNetForMultipleChoice.from_pretrained("microsoft/mpnet-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsMPNetForTokenClassification
class transformers.MPNetForTokenClassification
< 源 >( config )
参数
- config (MPNetForTokenClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个词元分类头的 Mpnet Transformer 模型（在隐藏状态输出之上有一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = 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 表示词元被遮盖。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。取值范围为[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的取值范围为[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递一个嵌入式表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵有更多控制权，以便将input_ids索引转换为相关向量，这将非常有用。 - 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.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置 (MPNetConfig) 和输入，包含不同的元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
MPNetForTokenClassification 的前向方法，覆盖了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MPNetForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = MPNetForTokenClassification.from_pretrained("microsoft/mpnet-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)
...MPNetForQuestionAnswering
class transformers.MPNetForQuestionAnswering
< 源 >( config )
参数
- config (MPNetForQuestionAnswering) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个片段分类头的 Mpnet Transformer 模型，用于抽取式问答任务，如 SQuAD（在隐藏状态输出之上有一个线性层，用于计算 `span start logits` 和 `span end logits`）。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = 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 表示令牌已被屏蔽。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 或者，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关向量，这会很有用。 - start_positions (
torch.LongTensor，形状为(batch_size,), 可选) — 标记范围开始位置（索引）的标签，用于计算令牌分类损失。位置被限制在序列长度（`sequence_length`）内。序列之外的位置不计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,), 可选) — 标记范围结束位置（索引）的标签，用于计算令牌分类损失。位置被限制在序列长度（`sequence_length`）内。序列之外的位置不计入损失计算。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或者当 `config.return_dict=False` 时），根据配置 (MPNetConfig) 和输入包含不同的元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof 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 后的注意力权重，用于计算自注意力头中的加权平均值。
MPNetForQuestionAnswering 的前向方法，重写了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MPNetForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = MPNetForQuestionAnswering.from_pretrained("microsoft/mpnet-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)
...TFMPNetModel
class transformers.TFMPNetModel
< 来源 >( config *inputs **kwargs )
参数
- config (MPNetConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
原始的 MPNet Transformer 模型，输出原始的隐藏状态，没有任何特定的头部。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 keras.Model 子类。可以像常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该能“正常工作”——只需以 `model.fit()` 支持的任何格式传递你的输入和标签！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: Optional[Union[np.array, tf.Tensor]] = None position_ids: Optional[Union[np.array, tf.Tensor]] = None head_mask: Optional[Union[np.array, tf.Tensor]] = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`) — 词汇表中输入序列令牌的索引。
索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 用于避免对填充令牌索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示令牌未被屏蔽，
- 0 表示令牌已被屏蔽。
- position_ids (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在 `[0, config.max_position_embeddings - 1]` 范围内选择。
- head_mask (`Numpy 数组` 或 `tf.Tensor`，形状为 `(num_heads,)` 或 `(num_layers, num_heads)`, 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- inputs_embeds (`tf.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`, 可选) — 或者，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关向量，这会很有用。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否以训练模式使用模型（一些模块如 dropout 模块在训练和评估之间有不同的行为）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 `tf.Tensor` 的元组（如果传递了 `return_dict=False` 或者当 `config.return_dict=False` 时），根据配置 (MPNetConfig) 和输入包含不同的元素。
-
last_hidden_state (
tf.Tensorof 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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFMPNetModel 的前向方法，重写了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMPNetModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetModel.from_pretrained("microsoft/mpnet-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFMPNetForMaskedLM
class transformers.TFMPNetForMaskedLM
< 来源 >( config *inputs **kwargs )
参数
- config (MPNetConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
MPNet 模型，顶部带有一个 `语言建模` 头。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 keras.Model 子类。可以像常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该能“正常工作”——只需以 `model.fit()` 支持的任何格式传递你的输入和标签！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`) — 词汇表中输入序列令牌的索引。
索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 用于避免对填充令牌索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示令牌未被屏蔽，
- 0 表示令牌已被屏蔽。
- position_ids (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在 `[0, config.max_position_embeddings - 1]` 范围内选择。
- head_mask (`Numpy 数组` 或 `tf.Tensor`，形状为 `(num_heads,)` 或 `(num_layers, num_heads)`, 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- inputs_embeds (`tf.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`, 可选) — 或者，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关向量，这会很有用。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否以训练模式使用模型（一些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (`tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 用于计算掩码语言建模损失的标签。索引应在 `[-100, 0, ..., config.vocab_size]` 范围内（参见 `input_ids` 文档字符串）。索引设置为 `-100` 的令牌被忽略（被屏蔽），损失仅对标签在 `[0, ..., config.vocab_size]` 范围内的令牌计算。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或一个 `tf.Tensor` 的元组（如果传递了 `return_dict=False` 或者当 `config.return_dict=False` 时），根据配置 (MPNetConfig) 和输入包含不同的元素。
-
loss (
tf.Tensorof shape(n,), 可选, 其中 n 是非掩码标签的数量，当提供labels时返回) — 掩码语言模型 (MLM) 损失。 -
logits (
tf.Tensorof 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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFMPNetForMaskedLM 的前向方法，重写了 `__call__` 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMPNetForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForMaskedLM.from_pretrained("microsoft/mpnet-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)TFMPNetForSequenceClassification
class transformers.TFMPNetForSequenceClassification
< 来源 >( config *inputs **kwargs )
参数
- config (MPNetConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个序列分类/回归头的 MPNet Transformer 模型（在池化输出之上有一个线性层），例如用于 GLUE 任务。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 keras.Model 子类。可以像常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该能“正常工作”——只需以 `model.fit()` 支持的任何格式传递你的输入和标签！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< 来源 >( input_ids: TFModelInputType | None = None attention_mask: Optional[Union[np.array, tf.Tensor]] = None position_ids: Optional[Union[np.array, tf.Tensor]] = None head_mask: Optional[Union[np.array, tf.Tensor]] = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`) — 词汇表中输入序列令牌的索引。
索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 用于避免对填充令牌索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示令牌未被屏蔽，
- 0 表示令牌已被屏蔽。
- position_ids (`Numpy 数组` 或 `tf.Tensor`，形状为 `(batch_size, sequence_length)`, 可选) — 每个输入序列令牌在位置嵌入中的位置索引。在 `[0, config.max_position_embeddings - 1]` 范围内选择。
- head_mask (`Numpy 数组` 或 `tf.Tensor`，形状为 `(num_heads,)` 或 `(num_layers, num_heads)`, 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在 `[0, 1]` 中选择：
- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- inputs_embeds (`tf.Tensor`，形状为 `(batch_size, sequence_length, hidden_size)`, 可选) — 或者，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关向量，这会很有用。
- output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块如 dropout 在训练和评估模式下有不同的行为）。 - labels (
tf.Tensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[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 时），根据配置（MPNetConfig）和输入包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFMPNetForSequenceClassification 的前向方法，重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMPNetForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForSequenceClassification.from_pretrained("microsoft/mpnet-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 = TFMPNetForSequenceClassification.from_pretrained("microsoft/mpnet-base", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFMPNetForMultipleChoice
class transformers.TFMPNetForMultipleChoice
< source >( config *inputs **kwargs )
参数
- config (MPNetConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
MPNet 模型，其顶部带有一个多项选择分类头（在池化输出之上是一个线性层和一个 softmax 层），例如用于 RocStories/SWAG 任务。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 keras.Model 子类。可以像常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该能“正常工作”——只需以 `model.fit()` 支持的任何格式传递你的输入和标签！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- position_ids (
Numpy arrayortf.Tensorof shape(batch_size, num_choices, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy arrayortf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
tf.Tensorof shape(batch_size, num_choices, sequence_length, hidden_size), optional) — 可选地，你可以不传递input_ids，而是直接传递一个嵌入表示。如果你想比模型内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这会很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块如 dropout 在训练和评估模式下有不同的行为）。 - labels (
tf.Tensorof shape(batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices]范围内，其中num_choices是输入张量第二维的大小。（参见上面的input_ids）
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（MPNetConfig）和输入包含各种元素。
-
loss (
tf.Tensor，形状为 (batch_size, )，可选，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor，形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (`tuple(tf.Tensor)`，可选，当 `output_hidden_states=True` 被传递或当 `config.output_hidden_states=True` 时返回) — `tf.Tensor` 的元组（一个用于嵌入的输出 + 一个用于每层的输出），形状为 `(batch_size, sequence_length, hidden_size)`。
模型在每个层输出的隐藏状态加上初始嵌入输出。
-
attentions (`tuple(tf.Tensor)`，可选，当 `output_attentions=True` 被传递或当 `config.output_attentions=True` 时返回) — `tf.Tensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFMPNetForMultipleChoice 的前向方法，重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMPNetForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForMultipleChoice.from_pretrained("microsoft/mpnet-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFMPNetForTokenClassification
class transformers.TFMPNetForTokenClassification
< source >( config *inputs **kwargs )
参数
- config (MPNetConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
MPNet 模型，其顶部带有一个标记分类头（在隐藏状态输出之上是一个线性层），例如用于命名实体识别（NER）任务。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 keras.Model 子类。可以像常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该能“正常工作”——只需以 `model.fit()` 支持的任何格式传递你的输入和标签！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: tf.Tensor | None = None training: bool = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- position_ids (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy arrayortf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以不传递input_ids，而是直接传递一个嵌入表示。如果你想比模型内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这会很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块如 dropout 在训练和评估模式下有不同的行为）。 - labels (
tf.Tensorof shape(batch_size, sequence_length), optional) — 用于计算标记分类损失的标签。索引应在[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 时），根据配置（MPNetConfig）和输入包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFMPNetForTokenClassification 的前向方法，重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMPNetForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForTokenClassification.from_pretrained("microsoft/mpnet-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()]TFMPNetForQuestionAnswering
class transformers.TFMPNetForQuestionAnswering
< source >( config *inputs **kwargs )
参数
- config (MPNetConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
MPNet 模型，其顶部带有一个片段分类头，用于像 SQuAD 这样的抽取式问答任务（在隐藏状态输出之上是一个线性层，用于计算 `span start logits` 和 `span end logits`）。
该模型继承自 TFPreTrainedModel。请查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 keras.Model 子类。可以像常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入作为关键字参数（如 PyTorch 模型），或
- 所有输入作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是，Keras 方法在向模型和层传递输入时更喜欢这种格式。由于这种支持，当使用像 `model.fit()` 这样的方法时，事情应该能“正常工作”——只需以 `model.fit()` 支持的任何格式传递你的输入和标签！然而，如果你想在 Keras 方法（如 `fit()` 和 `predict()`）之外使用第二种格式，例如在使用 Keras `Functional` API 创建自己的层或模型时，有三种可能性可以用来将所有输入张量收集到第一个位置参数中。
- 只有一个
input_ids的单个张量，没有其他：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，按文档字符串中给出的顺序：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称关联的输入张量：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像调用任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: Optional[Union[np.array, tf.Tensor]] = None position_ids: Optional[Union[np.array, tf.Tensor]] = None head_mask: Optional[Union[np.array, tf.Tensor]] = None inputs_embeds: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: tf.Tensor | None = None end_positions: tf.Tensor | None = None training: bool = False **kwargs ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput or tuple(tf.Tensor)
参数
- input_ids (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- position_ids (
Numpy arrayortf.Tensorof shape(batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy arrayortf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于使自注意力模块的选定头无效的掩码。掩码值选自[0, 1]：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
tf.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，你可以不传递input_ids，而是直接传递一个嵌入表示。如果你想比模型内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这会很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, defaults toFalse) — 是否在训练模式下使用模型（某些模块如 dropout 在训练和评估模式下有不同的行为）。 - start_positions (
tf.Tensorof shape(batch_size,), optional) — 用于计算标记分类损失的带标签片段的起始位置（索引）。位置被限制在序列长度（`sequence_length`）内。序列之外的位置在计算损失时不会被考虑。 - end_positions (
tf.Tensorof shape(batch_size,), optional) — 用于计算标记分类损失的带标签片段的结束位置（索引）。位置被限制在序列长度（`sequence_length`）内。序列之外的位置在计算损失时不会被考虑。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（MPNetConfig）和输入包含各种元素。
-
loss (
tf.Tensorof shape(batch_size, ), optional, returned whenstart_positionsandend_positionsare provided) — 总的片段抽取损失是起始位置和结束位置的交叉熵损失之和。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFMPNetForQuestionAnswering 的前向方法，重写了 __call__ 特殊方法。
虽然前向传播的流程需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理前处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFMPNetForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/mpnet-base")
>>> model = TFMPNetForQuestionAnswering.from_pretrained("microsoft/mpnet-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]