Transformers

( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 30522 hidden_size: int = 768 num_hidden_layers: int = 12 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: str = 'gelu' hidden_dropout_prob: float | int = 0.1 attention_probs_dropout_prob: float | int = 0.1 max_position_embeddings: int = 512 type_vocab_size: int = 2 task_type_vocab_size: int = 3 use_task_id: bool = False initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 pad_token_id: int | None = 0 use_cache: bool = True classifier_dropout: float | int | None = None is_decoder: bool = False add_cross_attention: bool = False bos_token_id: int | None = None eos_token_id: int | list[int] | None = None tie_word_embeddings: bool = True )

参数

vocab_size (int，可选，默认为 30522) — 模型的词汇表大小。定义了 input_ids 可以表示的不同标记的数量。
hidden_size (int，可选，默认为 768) — 隐藏层表示的维度。
num_hidden_layers (int，可选，默认为 12) — Transformer 解码器中的隐藏层数量。
num_attention_heads (int，可选，默认为 12) — Transformer 解码器中每个注意力层的注意力头数量。
intermediate_size (int，可选，默认为 3072) — MLP 表示的维度。
hidden_act (str，可选，默认为 gelu) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu" 等。
hidden_dropout_prob (Union[float, int]，可选，默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。
attention_probs_dropout_prob (Union[float, int]，可选，默认为 0.1) — 注意力概率的丢弃比例。
max_position_embeddings (int，可选，默认为 512) — 该模型可能使用的最大序列长度。
type_vocab_size (int，可选，默认为 2) — 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 值。
pad_token_id (int，可选，默认为 0) — 词汇表中用于填充的标记 ID。
use_cache (bool，可选，默认为 True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅在 config.is_decoder=True 或模型是仅解码器生成模型时相关。
classifier_dropout (Union[float, int]，可选) — 分类器的丢弃比例。
is_decoder (bool，可选，默认为 False) — 模型是否用作解码器。如果为 False，则模型用作编码器。
add_cross_attention (bool，可选，默认为 False) — 是否应向模型添加交叉注意力层。
bos_token_id (int，可选) — 词汇表中用于流开始的标记 ID。
eos_token_id (Union[int, list[int]]，可选) — 词汇表中用于流结束的标记 ID。
tie_word_embeddings (bool，可选，默认为 True) — 是否根据模型的 tied_weights_keys 映射来绑定权重嵌入。

这是用于存储 ErnieModel 配置的配置类。它用于根据指定的参数实例化 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.config

Ernie 特定输出

class transformers.models.ernie.modeling_ernie.ErnieForPreTrainingOutput

参数

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 之前真/假接续的得分）。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。
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 之前真/假接续的得分）。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

ErnieForPreTraining 的输出类型。

ErnieModel

class transformers.ErnieModel

( config add_pooling_layer = True )

参数

config (ErnieModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
add_pooling_layer (bool，可选，默认为 True) — 是否添加池化层

该模型可以作为编码器（仅包含自注意力）或解码器，在这种情况下，会在自注意力层之间添加一个交叉注意力层，遵循 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 作为输入。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None task_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 ID？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 避免对填充标记索引执行注意力的掩码。掩码值选自 [0, 1]：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
什么是注意力掩码？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引选自 [0, 1]：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型 ID？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，且 task_type_id 的范围在 `[0, config.task_type_vocab_size-1]
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 位置嵌入中每个输入序列标记的位置索引。选值范围在 [0, config.n_positions - 1]。

什么是位置 ID？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更直接地控制如何将 input_ids 索引转换为相关向量，这将非常有用。
encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。
encoder_attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，则该掩码用于交叉注意力。掩码值选自 [0, 1]：
- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
past_key_values (~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在解码前一阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果没有传递 past_key_values，默认将初始化 DynamicCache。

模型将输出与输入相同的缓存格式。

如果使用 past_key_values，用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids（即那些尚未将其过去键值状态提供给此模型的标记），而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。

BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)

一个 BaseModelOutputWithPoolingAndCrossAttentions 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置 (ErnieConfig) 和输入的各种元素。

ErnieModel 的前向传播方法，覆盖了 __call__ 特殊方法。

last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。
pooler_output (torch.FloatTensor，形状为 (batch_size, hidden_size)) — 序列第一个 token（分类 token）在进一步通过用于辅助预训练任务的层后的最后一个隐藏状态。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层的权重是通过预训练期间的下一句预测（分类）目标来训练的。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True and config.add_cross_attention=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
past_key_values (Cache，*可选*，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。

Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) to speed up sequential decoding.

ErnieForPreTraining

class transformers.ErnieForPreTraining

( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )

参数

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

Ernie 模型，顶部带有两个头，正如在预训练期间所做的那样：一个 掩码语言建模 (masked language modeling) 头和一个 下一句预测 (next sentence prediction) (分类) 头。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None task_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None next_sentence_label: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → ErnieForPreTrainingOutput 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 ID？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 代表未被遮盖的标记，
- 0 代表被遮盖的标记。
什么是注意力遮罩？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选在 [0, 1] 之间：
- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
什么是标记类型 ID？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，该 task_type_id 在 [0, config.task_type_vocab_size-1] 范围内。
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选在 [0, config.n_positions - 1] 范围内。

什么是位置 ID？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望比模型内部的嵌入查找矩阵更受控地将 input_ids 索引转换为相关向量，这将非常有用。
labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 之间（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩盖），损失仅对标签在 [0, ..., config.vocab_size] 之间的标记进行计算。
next_sentence_label (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算下一序列预测（分类）损失的标签。输入应为序列对（参见 input_ids 文档字符串）。索引应在 [0, 1] 之间：
- 0 表示序列 B 是序列 A 的续接，
- 1 表示序列 B 是随机序列。

ErnieForPreTrainingOutput 或 tuple(torch.FloatTensor)

一个 ErnieForPreTrainingOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (ErnieConfig) 和输入而定的各种元素。

ErnieForPreTraining 的前向传播（forward）方法，重写了 __call__ 特殊方法。

loss (*可选*, 当提供 labels 时返回, torch.FloatTensor, 形状为 (1,)) — 总损失，是掩码语言建模损失和下一句预测（分类）损失的总和。
prediction_logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇 token 的分数）。
seq_relationship_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 后的注意力权重，用于计算自注意力头中的加权平均值。

示例

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

ErnieForCausalLM

class transformers.ErnieForCausalLM

参数

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

Ernie 模型，顶部带有一个 语言建模 头，用于因果语言模型（CLM）微调。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None task_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None labels: torch.Tensor | None = None past_key_values: list[torch.Tensor] | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 ID？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 代表未被遮盖的标记，
- 0 代表被遮盖的标记。
什么是注意力遮罩？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选在 [0, 1] 之间：
- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
什么是标记类型 ID？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，该 task_type_id 在 [0, config.task_type_vocab_size-1] 范围内。
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选在 [0, config.n_positions - 1] 范围内。

什么是位置 ID？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望比模型内部的嵌入查找矩阵更受控地将 input_ids 索引转换为相关向量，这将非常有用。
encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。
encoder_attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，以避免对编码器输入的填充标记索引执行注意力操作。如果模型配置为解码器，则该遮罩用于交叉注意力。遮罩值选在 [0, 1] 之间：
- 1 代表未被遮盖的标记，
- 0 代表被遮盖的标记。
labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 用于计算从左到右语言建模损失（下一词预测）的标签。索引应在 [-100, 0, ..., config.vocab_size] 之间（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩盖），损失仅对标签在 [0, ..., config.vocab_size] 之间的标记进行计算。
past_key_values (list[torch.Tensor]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

仅允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果没有传递 past_key_values，默认情况下将初始化 DynamicCache。

模型将输出与输入相同格式的缓存。

如果使用了 past_key_values，用户应仅输入未处理的 input_ids（即那些没有将过去键值状态提供给此模型的标记），形状为 (batch_size, unprocessed_length)，而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
use_cache (bool，可选) — 如果设置为 True，将返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
logits_to_keep (Union[int, torch.Tensor]，可选，默认为 0) — 如果是 int，则计算最后 logits_to_keep 个标记的 logits。如果是 0，则计算所有 input_ids 的 logits（特殊情况）。生成时仅需要最后一个标记的 logits，仅为该标记计算它们可以节省内存，这对于长序列或大词表来说非常显著。如果是 torch.Tensor，则必须是 1D 的，对应于要在序列长度维度中保留的索引。这在传递 packed tensor 格式（批次和序列长度共用单维度）时很有用。

CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (ErnieConfig) 和输入而定的各种元素。

ErnieForCausalLM 的前向传播（forward）方法，重写了 __call__ 特殊方法。

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), optional, returned when output_attentions=True is passed or when config.output_attentions=True) — Tuple of torch.FloatTensor (one for each layer) of shape (batch_size, num_heads, sequence_length, sequence_length).

注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
past_key_values (Cache，*可选*，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。

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

示例

ErnieForMaskedLM

class transformers.ErnieForMaskedLM

参数

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

顶部带有 语言建模 头的 Ernie 模型。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None task_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MaskedLMOutput 或 tuple(torch.FloatTensor)

参数

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

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

什么是输入 ID？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 代表未被遮盖的标记，
- 0 代表被遮盖的标记。
什么是注意力遮罩？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选在 [0, 1] 之间：
- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
什么是标记类型 ID？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，该 task_type_id 在 [0, config.task_type_vocab_size-1] 范围内。
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选在 [0, config.n_positions - 1] 范围内。

什么是位置 ID？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望比模型内部的嵌入查找矩阵更受控地将 input_ids 索引转换为相关向量，这将非常有用。
encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。
encoder_attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，以避免对编码器输入的填充标记索引执行注意力操作。如果模型配置为解码器，则该遮罩用于交叉注意力。遮罩值选在 [0, 1] 之间：
- 1 代表未被遮盖的标记，
- 0 代表被遮盖的标记。
labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 之间（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩盖），损失仅对标签在 [0, ..., config.vocab_size] 之间的标记进行计算。

MaskedLMOutput 或 tuple(torch.FloatTensor)

一个 MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (ErnieConfig) 和输入而定的各种元素。

ErnieForMaskedLM 的前向传播（forward）方法，重写了 __call__ 特殊方法。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 掩码语言建模 (MLM) 损失。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

示例

>>> from transformers import AutoTokenizer, ErnieForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-3.0-base-zh")
>>> model = ErnieForMaskedLM.from_pretrained("nghuyong/ernie-3.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)
...

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

ErnieForNextSentencePrediction

class transformers.ErnieForNextSentencePrediction

参数

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

顶部带有 下一句预测（分类） 头的 Ernie 模型。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

参数

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

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

什么是输入 ID？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，以避免对填充标记索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 代表未被遮盖的标记，
- 0 代表被遮盖的标记。
什么是注意力遮罩？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选在 [0, 1] 之间：
- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
什么是标记类型 ID？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，该 task_type_id 在 [0, config.task_type_vocab_size-1] 范围内。
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 每个输入序列 token 在位置嵌入（position embeddings）中的位置索引。选值范围在 [0, config.n_positions - 1] 内。

什么是位置 ID（position IDs）？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选参数。你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望更多地控制如何将 input_ids 索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算下一序列预测（分类）损失的标签。输入应为一个序列对（参见 input_ids 文档字符串）。索引应在 [0, 1] 范围内：
- 0 表示序列 B 是序列 A 的后续，
- 1 表示序列 B 是一个随机序列。

NextSentencePredictorOutput 或 tuple(torch.FloatTensor)

一个 NextSentencePredictorOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (ErnieConfig) 和输入而确定的各种元素。

ErnieForNextSentencePrediction 的 forward 方法，重写了 __call__ 特殊方法。

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 next_sentence_label 时返回) — 下一个序列预测（分类）损失。
logits (torch.FloatTensor，形状为 (batch_size, 2)) — 下一个序列预测（分类）头的预测分数（SoftMax 之前的真/假延续分数）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

示例

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

ErnieForSequenceClassification

class transformers.ErnieForSequenceClassification

参数

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

Ernie 模型 Transformer，顶部带有一个序列分类/回归头（池化输出之上的线性层），例如用于 GLUE 任务。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

参数

input_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 输入序列 token 在词表中的索引。默认情况下将忽略填充（Padding）。

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

什么是输入 ID（input IDs）？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩（Mask），用于避免对填充 token 索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 表示 未被遮盖 的 token，
- 0 表示 已被遮盖 的 token。
什么是注意力遮罩（attention masks）？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 段（Segment）token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
什么是 token 类型 ID（token type IDs）？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入（Task type embedding）是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，其范围在 [0, config.task_type_vocab_size-1] 内。
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选值范围在 [0, config.n_positions - 1] 内。

什么是位置 ID（position IDs）？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选参数。你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望更多地控制如何将 input_ids 索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方误差），如果 config.num_labels > 1，则计算分类损失（交叉熵）。

SequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (ErnieConfig) 和输入而确定的各种元素。

ErnieForSequenceClassification 的 forward 方法，重写了 __call__ 特殊方法。

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), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, ErnieForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-3.0-base-zh")
>>> model = ErnieForSequenceClassification.from_pretrained("nghuyong/ernie-3.0-base-zh")

>>> 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 = ErnieForSequenceClassification.from_pretrained("nghuyong/ernie-3.0-base-zh", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, ErnieForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-3.0-base-zh")
>>> model = ErnieForSequenceClassification.from_pretrained("nghuyong/ernie-3.0-base-zh", 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 = ErnieForSequenceClassification.from_pretrained(
...     "nghuyong/ernie-3.0-base-zh", num_labels=num_labels, problem_type="multi_label_classification"
... )

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

ErnieForMultipleChoice

class transformers.ErnieForMultipleChoice

参数

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

Ernie 模型，顶部带有一个多项选择分类头（池化输出之上的线性层和 softmax），例如用于 RocStories/SWAG 任务。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

参数

input_ids (形状为 (batch_size, num_choices, sequence_length) 的 torch.LongTensor) — 输入序列 token 在词表中的索引。

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

什么是输入 ID（input IDs）？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩（Mask），用于避免对填充 token 索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 表示 未被遮盖 的 token，
- 0 表示 已被遮盖 的 token。
什么是注意力遮罩（attention masks）？
token_type_ids (形状为 (batch_size, num_choices, sequence_length) 的 torch.LongTensor，可选) — 段（Segment）token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
什么是 token 类型 ID（token type IDs）？
task_type_ids (形状为 (batch_size, num_choices, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，其范围在 [0, config.task_type_vocab_size-1] 内。
position_ids (形状为 (batch_size, num_choices, sequence_length) 的 torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选值范围在 [0, config.max_position_embeddings - 1] 内。

什么是位置 ID（position IDs）？
inputs_embeds (形状为 (batch_size, num_choices, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 可选参数。你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望更多地控制如何将 input_ids 索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算多项选择分类损失的标签。索引应在 [0, ..., num_choices-1] 范围内，其中 num_choices 是输入张量第二维的大小。（请参阅上方的 input_ids）

MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

一个 MultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (ErnieConfig) 和输入而确定的各种元素。

ErnieForMultipleChoice 的 forward 方法，重写了 __call__ 特殊方法。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失。
logits (形状为 (batch_size, num_choices) 的 torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。

分类分数（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

示例

>>> from transformers import AutoTokenizer, ErnieForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-3.0-base-zh")
>>> model = ErnieForMultipleChoice.from_pretrained("nghuyong/ernie-3.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.logits

ErnieForTokenClassification

class transformers.ErnieForTokenClassification

参数

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

Ernie Transformer，顶部带有一个 token 分类头（隐藏状态输出之上的线性层），例如用于命名实体识别（NER）任务。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

参数

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

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

什么是输入 ID（input IDs）？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 遮罩，用于避免对填充 token 索引执行注意力操作。遮罩值选在 [0, 1] 之间：
- 1 表示 未被遮盖 的 token，
- 0 表示 已被遮盖 的 token。
什么是注意力遮罩（attention masks）？
token_type_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 段 token 索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
什么是 token 类型 ID（token type IDs）？
task_type_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 任务类型嵌入是一种特殊的嵌入，用于表示不同任务的特征，例如词感知预训练任务、结构感知预训练任务和语义感知预训练任务。我们为每个任务分配一个 task_type_id，其范围在 [0, config.task_type_vocab_size-1] 内。
position_ids (形状为 (batch_size, sequence_length) 的 torch.Tensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选值范围在 [0, config.n_positions - 1] 内。

什么是位置 ID（position IDs）？
inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.Tensor，可选) — 可选参数。你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你希望更多地控制如何将 input_ids 索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。
labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 用于计算 token 分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。

TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (ErnieConfig) 和输入而确定的各种元素。

ErnieForTokenClassification 的 forward 方法，重写了 __call__ 特殊方法。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失。
logits (形状为 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分类分数（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 的元组（每个层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

示例

>>> from transformers import AutoTokenizer, ErnieForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("nghuyong/ernie-3.0-base-zh")
>>> model = ErnieForTokenClassification.from_pretrained("nghuyong/ernie-3.0-base-zh")

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

ErnieForQuestionAnswering

class transformers.ErnieForQuestionAnswering

参数

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

Ernie Transformer，顶部带有一个片段分类头，用于 extractive 问答任务，如 SQuAD（隐藏状态输出之上的线性层，用于计算 span start logits 和 span end logits）。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward