ERNIE
概述
ERNIE 是百度提出的一系列强大的模型，特别是在中文任务中，包括 ERNIE1.0、ERNIE2.0、ERNIE3.0、ERNIE-Gram、ERNIE-health 等。
这些模型由 nghuyong 贡献，官方代码可在 PaddleNLP (在 PaddlePaddle 中) 找到。
使用示例
以 ernie-1.0-base-zh 为例
from transformers import AutoTokenizer, AutoModel
tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
model = AutoModel.from_pretrained("nghuyong/ernie-1.0-base-zh")模型检查点
| 模型名称 | 语言 | 描述 |
|---|---|---|
| ernie-1.0-base-zh | 中文 | 层数:12, 头数:12, 隐藏层大小:768 |
| ernie-2.0-base-en | 英文 | 层数:12, 头数:12, 隐藏层大小:768 |
| ernie-2.0-large-en | 英文 | 层数:24, 头数:16, 隐藏层大小:1024 |
| ernie-3.0-base-zh | 中文 | 层数:12, 头数:12, 隐藏层大小:768 |
| ernie-3.0-medium-zh | 中文 | 层数:6, 头数:12, 隐藏层大小:768 |
| ernie-3.0-mini-zh | 中文 | 层数:6, 头数:12, 隐藏层大小:384 |
| ernie-3.0-micro-zh | 中文 | 层数:4, 头数:12, 隐藏层大小:384 |
| ernie-3.0-nano-zh | 中文 | 层数:4, 头数:12, 隐藏层大小:312 |
| ernie-health-zh | 中文 | 层数:12, 头数:12, 隐藏层大小:768 |
| ernie-gram-zh | 中文 | 层数:12, 头数:12, 隐藏层大小:768 |
您可以在 huggingface 的模型中心找到所有支持的模型：huggingface.co/nghuyong，并在 paddle 的官方仓库中找到模型的详细信息：PaddleNLP 和 ERNIE。
资源
ErnieConfig
class transformers.ErnieConfig
< 源代码 >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 task_type_vocab_size = 3 use_task_id = False initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 30522) — ERNIE 模型的词汇量大小。定义了调用 ErnieModel 或TFErnieModel时传递的inputs_ids可以表示的不同标记数量。 - hidden_size (
int, 可选, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。 - hidden_act (
str或Callable, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。 如果是字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — 注意概率的 dropout 比例。 - max_position_embeddings (
int, 可选, 默认为 512) — 此模型可能使用的最大序列长度。 通常将其设置为一个较大的值，以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int, 可选, 默认为 2) — 调用 ErnieModel 或TFErnieModel时传递的token_type_ids的词汇量大小。 - task_type_vocab_size (
int, 可选, 默认为 3) — ERNIE2.0/ERNIE3.0 模型的task_type_ids的词汇量大小 - use_task_id (
bool, 可选, 默认为False) — 模型是否支持task_type_ids - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - use_cache (
bool, 可选, 默认为True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - classifier_dropout (
float, 可选) — 分类头部的丢弃率。
这是用于存储 ErnieModel 或 TFErnieModel 配置的配置类。它用于根据指定的参数实例化 ERNIE 模型，定义模型架构。使用默认值实例化配置将产生与 ERNIE nghuyong/ernie-3.0-base-zh 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 中的文档以了解更多信息。
示例
>>> from transformers import ErnieConfig, ErnieModel
>>> # Initializing a ERNIE nghuyong/ernie-3.0-base-zh style configuration
>>> configuration = ErnieConfig()
>>> # Initializing a model (with random weights) from the nghuyong/ernie-3.0-base-zh style configuration
>>> model = ErnieModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configERNIE 特定输出
class transformers.models.ernie.modeling_ernie.ErnieForPreTrainingOutput
< 源代码 >( loss: Optional = None prediction_logits: FloatTensor = None seq_relationship_logits: FloatTensor = None hidden_states: Optional = None attentions: Optional = None )
参数
- loss (可选, 当提供
labels时返回, 形状为(1,)的torch.FloatTensor) — 总损失，作为掩码语言建模损失和下一个序列预测（分类）损失的总和。 - prediction_logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头的预测分数（SoftMax 之前的每个词汇表标记的分数）。 - seq_relationship_logits (形状为
(batch_size, 2)的torch.FloatTensor) — 下一个序列预测（分类）头的预测分数（SoftMax 之前的 True/False 延续分数）。 - hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（一个用于嵌入的输出 + 一个用于每一层的输出）。模型在每一层输出处的隐藏状态加上初始嵌入输出。
- attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每个层一个）。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
ErnieForPreTraining 的输出类型。
ErnieModel
class transformers.ErnieModel
< source >( config add_pooling_layer = True )
参数
- config (ErnieConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
不带任何特定头的 Ernie 模型变压器，输出原始隐藏状态。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
该模型可以作为编码器（只有自注意力）以及解码器，在这种情况下，在自注意力层之间添加了一层交叉注意力，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。
要充当解码器，模型需要使用配置的 is_decoder 参数设置为 True 来初始化。要在 Seq2Seq 模型中使用，模型需要使用 is_decoder 参数和 add_cross_attention 设置为 True 初始化；然后，在正向传递中需要 encoder_hidden_states 作为输入。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码用于避免对填充 token 索引执行注意力。掩码值选择在[0, 1]中：- 1 代表 未掩码 的 token,
- 0 代表 掩码 的 token.
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 代表 句子 A token,
- 1 代表 句子 B token.
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 任务类型嵌入是用于表示不同任务特征的特殊嵌入，例如词语感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，task_type_id的范围为 `[0, config.task_type_vocab_size-1]` - position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[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, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要对如何将input_ids索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。 - encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]内:- 1 代表未掩码的标记，
- 0 代表掩码的标记。
- past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用
past_key_values，用户可以选择性地仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将其过去键值状态提供给此模型的）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（见past_key_values）。
返回值
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含根据配置（ErnieConfig）和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过用于辅助预训练任务的层的进一步处理。例如，对于 BERT 家族的模型，这将返回经过线性层和 tanh 激活函数处理后的分类标记。线性层权重是在预训练期间从下一个句子预测（分类）目标中训练得到的。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True和config.add_cross_attention=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每一层一个）形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，当传递use_cache=True或当config.use_cache=True时返回) —tuple(torch.FloatTensor)的元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及可选地，如果config.is_encoder_decoder=True，则包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的额外张量。包含预计算的隐藏状态（自注意力块中的键和值，以及可选地，如果
config.is_encoder_decoder=True，则包含交叉注意力块中的键和值），可用于（见past_key_values输入）加速顺序解码。
The ErnieModel 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ErnieModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> model = ErnieModel.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateErnieForPreTraining
class transformers.ErnieForPreTraining
< source >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
Ernie 模型，在顶部有两个头，如预训练期间所做的那样：一个 masked language modeling 头和一个 next sentence prediction (classification) 头。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None next_sentence_label: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.ernie.modeling_ernie.ErnieForPreTrainingOutput 或 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 词元。
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 任务类型嵌入是表示不同任务特征的特殊嵌入，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，并且task_type_id位于 `[0, config.task_type_vocab_size-1]` 范围内 - position_ids (
torch.LongTensor形状为(batch_size, 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, 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]中的标记进行计算 next_sentence_label (torch.LongTensor形状为(batch_size,), 可选): 用于计算下一个序列预测（分类）损失的标签。输入应该是一个序列对（参见input_ids文档字符串）索引应在[0, 1]中：- 0 表示序列 B 是序列 A 的延续，
- 1 表示序列 B 是一个随机序列。 kwargs (
Dict[str, any], 可选, 默认为{}): 用于隐藏已弃用的旧参数。
返回值
transformers.models.ernie.modeling_ernie.ErnieForPreTrainingOutput 或 tuple(torch.FloatTensor)
一个 transformers.models.ernie.modeling_ernie.ErnieForPreTrainingOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（ErnieConfig）和输入的不同元素。
-
loss (可选, 当提供
labels时返回,torch.FloatTensor形状为(1,)) — 总损失，作为掩码语言建模损失和下一个序列预测（分类）损失的总和。 -
prediction_logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
seq_relationship_logits (
torch.FloatTensor形状为(batch_size, 2)) — 下一个序列预测（分类）头的预测分数（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 ErnieForPreTraining 前向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ErnieForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> model = ErnieForPreTraining.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.prediction_logits
>>> seq_relationship_logits = outputs.seq_relationship_logitsErnieForCausalLM
class transformers.ErnieForCausalLM
< 源代码 >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
Ernie 模型，顶部有一个 语言建模 头，用于 CLM 微调。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 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 标记。
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 任务类型嵌入是用于表示不同任务特征的特殊嵌入，例如，单词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，task_type_id在范围 `[0, config.task_type_vocab_size-1]` 中。 - position_ids (
torch.LongTensor形状为(batch_size, 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, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 encoder_hidden_states (torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引进行注意力的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择在[0, 1]中:- 1 表示未掩码的标记,
- 0 表示掩码的标记.
- labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算从左到右的语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串） 索引设置为-100的标记将被忽略（掩码），损失仅针对标签 n[0, ..., config.vocab_size]中的标记计算。 - past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含预先计算的注意力块的关键和值隐藏状态。可用于加速解码。如果使用
past_key_values，用户可以选择仅输入最后decoder_input_ids（没有向此模型提供其过去键值状态的那些）形状为(batch_size, 1)，而不是所有decoder_input_ids形状为(batch_size, sequence_length)。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 torch.FloatTensor 的元组（如果传递 return_dict=False 或 config.return_dict=False 时），包含根据配置 (ErnieConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，在传递use_cache=True或config.use_cache=True时返回) —torch.FloatTensor元组的元组，长度为config.n_layers，每个元组包含自注意力和交叉注意力的缓存键、值状态（如果模型在编码器-解码器设置中使用）。仅在config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
__call__ 特殊方法覆盖了 ErnieForCausalLM 正向方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> import torch
>>> from transformers import AutoTokenizer, ErnieForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> model = ErnieForCausalLM.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logitsErnieForMaskedLM
class transformers.ErnieForMaskedLM
< 源代码 >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
带有 语言建模 头的 Ernie 模型。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 标记。
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 任务类型嵌入是用于表示不同任务特征的特殊嵌入，例如词语感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，并且task_type_id在范围 `[0, config.task_type_vocab_size-1]` 内 - position_ids (
torch.LongTensor形状为(batch_size, 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, 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 时），包含根据配置（ErnieConfig）和输入的不同元素。
-
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The ErnieForMaskedLM 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ErnieForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> model = ErnieForMaskedLM.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> 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.88ErnieForNextSentencePrediction
class transformers.ErnieForNextSentencePrediction
< 源代码 >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 下一句预测（分类） 头的 Ernie 模型。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None **kwargs ) → transformers.modeling_outputs.NextSentencePredictorOutput 或 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 标记。
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 任务类型嵌入是一个特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，并且task_type_id的范围在[0, config.task_type_vocab_size-1]内。 - position_ids (
torch.LongTensor形状为(batch_size, 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, 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,)，可选) — 用于计算下一个句子预测（分类）损失的标签。输入应为一个句子对（参见input_ids文档字符串）。索引应在[0, 1]内：- 0 表示句子 B 是句子 A 的延续，
- 1 表示句子 B 是一个随机句子。
返回值
transformers.modeling_outputs.NextSentencePredictorOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.NextSentencePredictorOutput 或者一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者 config.return_dict=False），包含取决于配置 (ErnieConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供next_sentence_label时返回) — 下一个句子预测（分类）损失。 -
logits (
torch.FloatTensor形状为(batch_size, 2)) — 下一个句子预测（分类）头的预测分数（在 SoftMax 之前的 True/False 延续分数）。 -
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
该 ErnieForNextSentencePrediction 前向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ErnieForNextSentencePrediction
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> model = ErnieForNextSentencePrediction.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> next_sentence = "The sky is blue due to the shorter wavelength of blue light."
>>> encoding = tokenizer(prompt, next_sentence, return_tensors="pt")
>>> outputs = model(**encoding, labels=torch.LongTensor([1]))
>>> logits = outputs.logits
>>> assert logits[0, 0] < logits[0, 1] # next sentence was randomErnieForSequenceClassification
class transformers.ErnieForSequenceClassification
< 源代码 >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Ernie 模型转换器，在顶部有一个序列分类/回归头（在池化输出之上有一个线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- 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 标记。
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 任务类型嵌入是表示不同任务特征的特殊嵌入，例如词语感知预训练任务、结构感知预训练任务和语义感知预训练任务。 我们为每个任务分配一个task_type_id，task_type_id在范围 `[0, config.task_type_vocab_size-1]` 内。 - position_ids (
torch.LongTensor形状为(batch_size, 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, 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，则计算分类损失（交叉熵）。
的 ErnieForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
ErnieForMultipleChoice
class transformers.ErnieForMultipleChoice
< 源代码 >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Ernie 模型，顶部带有用于多项选择分类的头部（在池化输出之上使用线性层和 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.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, num_choices, sequence_length), 可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值选择在[0, 1]中：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- token_type_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- task_type_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length), 可选) — 任务类型嵌入是表示不同任务特征的特殊嵌入，例如词语感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，并且task_type_id在 `[0, config.task_type_vocab_size-1]` 范围内 - 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索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]中，其中num_choices是输入张量的第二维的大小。（参见上面的input_ids）
返回值
transformers.modeling_outputs.MultipleChoiceModelOutput or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或者一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (ErnieConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为 (1,)，可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类分数（在 SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=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 ErnieForMultipleChoice 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, ErnieForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> model = ErnieForMultipleChoice.from_pretrained("nghuyong/ernie-1.0-base-zh")
>>> 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.logitsErnieForTokenClassification
class transformers.ErnieForTokenClassification
< source >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
Ernie 模型，在顶部有一个标记分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 段 token 索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如单词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，并且task_type_id在 `[0, config.task_type_vocab_size-1] 范围内 - position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 位置的索引。选择在范围[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, 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)，可选) — 用于计算 token 分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
该 ErnieForTokenClassification 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
ErnieForQuestionAnswering
class transformers.ErnieForQuestionAnswering
< 源代码 >( config )
参数
- config (ErnieConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法加载模型权重。
Ernie 模型，顶部带有一个跨度分类头，用于像 SQuAD 这样的抽取式问答任务（在隐藏状态输出的顶部添加线性层来计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的问题。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None task_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。 - attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意的掩码。掩码值选择在[0, 1]中： - token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中： - task_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 任务类型嵌入是用于表示不同任务特征的特殊嵌入，例如词语感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个task_type_id，并且task_type_id位于范围 `[0, config.task_type_vocab_size-1]` 内。 - position_ids (
torch.LongTensor形状为(batch_size, 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, 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）。序列之外的位置不会被考虑用于计算损失。
The ErnieForQuestionAnswering forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数内定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。