Hugging Face 的 LOGO

Transformers 文档

ErnieM

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

ErnieM

PyTorch

此模型仅处于维护模式，我们不接受任何更改其代码的新 PR。如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最后一个版本：v4.40.2。您可以通过运行以下命令来执行此操作：pip install -U transformers==4.40.2。

概述

ErnieM 模型由 Xuan Ouyang、Shuohuan Wang、Chao Pang、Yu Sun、Hao Tian、Hua Wu、Haifeng Wang 在论文 ERNIE-M: Enhanced Multilingual Representation by Aligning Cross-lingual Semantics with Monolingual Corpora 中提出。

论文摘要如下：

最近的研究表明，预训练的跨语言模型在下游跨语言任务中取得了令人印象深刻的性能。这种改进得益于学习大量的单语和并行语料库。尽管人们普遍承认并行语料库对于提高模型性能至关重要，但现有方法通常受限于并行语料库的大小，特别是对于低资源语言。在本文中，我们提出了 ERNIE-M，一种新的训练方法，鼓励模型将多种语言的表示与单语语料库对齐，以克服并行语料库大小对模型性能的限制。我们的关键见解是将反向翻译集成到预训练过程中。我们在单语语料库上生成伪并行句子对，以实现不同语言之间语义对齐的学习，从而增强跨语言模型的语义建模。实验结果表明，ERNIE-M 优于现有的跨语言模型，并在各种跨语言下游任务中取得了新的最先进成果。 此模型由 Susnato Dhar 贡献。原始代码可以在这里找到。

使用技巧

  • Ernie-M 是一个类似 BERT 的模型，因此它是一个堆叠的 Transformer 编码器。
  • 作者没有使用 MaskedLM 进行预训练（像 BERT 那样），而是使用了两种新技术：`Cross-attention Masked Language Modeling` 和 `Back-translation Masked Language Modeling`。目前，这两种语言模型头目标尚未在此处实现。
  • 它是一个多语言模型。
  • 在预训练过程中未使用下一句预测。

资源

ErnieMConfig

class transformers.ErnieMConfig

< >

( vocab_size: int = 250002 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 = 0.1 attention_probs_dropout_prob: float = 0.1 max_position_embeddings: int = 514 initializer_range: float = 0.02 pad_token_id: int = 1 layer_norm_eps: float = 1e-05 classifier_dropout = None act_dropout = 0.0 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 250002) — ErnieMModel 中 inputs_ids 的词汇表大小。同时也是词嵌入矩阵的词汇表大小。定义了在调用 ErnieMModel 时传递的 inputs_ids 可以表示的不同词元的数量。
  • hidden_size (int, 可选, 默认为 768) — 嵌入层、编码器层和池化层的维度。
  • num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选, 默认为 3072) — 编码器中前馈（ff）层的维度。输入到前馈层的张量首先从 hidden_size 投影到 intermediate_size，然后投影回 hidden_size。通常 intermediate_size 大于 hidden_size。
  • hidden_act (str, 可选, 默认为 "gelu") — 前馈层中的非线性激活函数。支持 "gelu"、"relu" 以及任何其他 torch 支持的激活函数。
  • hidden_dropout_prob (float, 可选, 默认为 0.1) — 嵌入层和编码器中所有全连接层的丢弃概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 在所有编码器层的 `MultiHeadAttention` 中使用的丢弃概率，用于丢弃一些注意力目标。
  • max_position_embeddings (int, 可选, 默认为 514) — 位置编码维度的最大值，决定了输入序列支持的最大长度。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的正态分布初始化器的标准差。词元词汇表中填充词元的索引。
  • pad_token_id (int, 可选, 默认为 1) — 填充词元 ID。
  • layer_norm_eps (float, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon 值。
  • classifier_dropout (float, 可选) — 分类头的丢弃率。
  • act_dropout (float, 可选, 默认为 0.0) — 此丢弃概率在 `ErnieMEncoderLayer` 的激活函数之后使用。

这是用于存储 ErnieMModel 配置的配置类。它用于根据指定的参数实例化一个 Ernie-M 模型，定义模型架构。使用默认值实例化配置将产生与 `Ernie-M` susnato/ernie-m-base_pytorch 架构相似的配置。

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

normal_initializer 将权重矩阵初始化为正态分布。有关如何在 `ErnieMModel` 中初始化权重，请参阅 `ErnieMPretrainedModel._init_weights()`。

ErnieMTokenizer

class transformers.ErnieMTokenizer

< >

( sentencepiece_model_ckpt vocab_file = None do_lower_case = False encoding = 'utf8' unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None **kwargs )

参数

  • sentencepiece_model_file (str) — sentencepiece 模型的路径。
  • vocab_file (str, 可选) — 词汇表文件的路径。
  • do_lower_case (str, 可选, 默认为 `True`) — 是否在分词时将输入转换为小写。
  • unk_token (str, 可选, 默认为 "[UNK]") — 表示 `未知（词汇表外）` 词元的特殊词元。未知词元被设置为 `unk_token` 以便转换为 ID。
  • sep_token (str, 可选, 默认为 "[SEP]") — 在同一输入中分隔两个不同句子的特殊词元。
  • pad_token (str, 可选, 默认为 "[PAD]") — 用于将词元数组填充到相同大小以进行批处理的特殊词元。
  • cls_token (str, 可选, 默认为 "[CLS]") — 用于序列分类的特殊词元。在使用特殊词元构建序列时，它是序列的最后一个词元。
  • mask_token (str, 可选, 默认为 "[MASK]") — 表示被掩码的词元的特殊词元。这是在掩码语言建模任务中使用的词元，模型会尝试预测原始未掩码的词元。

构建一个 Ernie-M 分词器。它使用 `sentencepiece` 工具将单词切分为子词。

build_inputs_with_special_tokens

< >

（ token_ids_0 token_ids_1 = None ） → list[int]

参数

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

返回

list[int]

带有相应特殊标记的 input_id 列表。

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

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

get_special_tokens_mask

< >

（ token_ids_0 token_ids_1 = None already_has_special_tokens = False ） → list[int]

参数

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

返回

list[int]

范围在 [0, 1] 内的整数列表：1 表示特殊标记，0 表示序列标记。

从未添加特殊标记的标记列表中检索序列 ID。在使用分词器的 `encode` 方法添加特殊标记时会调用此方法。

create_token_type_ids_from_sequences

< >

（ token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ） → list[int]

参数

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

返回

list[int]

标记类型 ID。

创建与传入序列相对应的标记类型 ID。 什么是标记类型 ID？ 如果模型有特殊的构建方式，应在子类中覆盖此方法。

save_vocabulary

< >

（ save_directory: str filename_prefix: typing.Optional[str] = None ）

ErnieMModel

class transformers.ErnieMModel

< >

（ config add_pooling_layer = True ）

参数

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

基础的 ErnieM 模型 Transformer，输出原始的隐藏状态，顶部没有任何特定的头。

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

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

forward

< >

（ input_ids: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None position_ids: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None attention_mask: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None head_mask: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None inputs_embeds: typing.Optional[<built-in method tensor of type object at 0x7f00efef6f40>] = None past_key_values: typing.Optional[tuple[tuple[torch._VariableFunctionsClass.tensor]]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ） → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID？

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

    • 1 表示标记未被遮盖，
    • 0 表示标记被遮盖。

    什么是注意力掩码？

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

    什么是位置 ID？

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

返回

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ErnieMConfig）和输入，包含不同的元素。

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

    如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (Cache, 可选，在传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

    包含预先计算的隐藏状态（自注意力块中的键和值，以及如果 `config.is_encoder_decoder=True`，则在交叉注意力块中），可用于（参见 `past_key_values` 输入）加速顺序解码。

  • 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 之后，用于计算交叉注意力头中的加权平均。

ErnieMModel 的 forward 方法，覆盖了 `__call__` 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ErnieMModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMModel.from_pretrained("susnato/ernie-m-base_pytorch")

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

>>> last_hidden_states = outputs.last_hidden_state

ErnieMForSequenceClassification

class transformers.ErnieMForSequenceClassification

< >

（ config ）

参数

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

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

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

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

forward

< >

（ input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None use_cache: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True labels: typing.Optional[torch.Tensor] = None ） → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID？

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

    • 1 表示标记未被遮盖，
    • 0 表示标记被遮盖。

    什么是注意力掩码？

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

    什么是位置 ID？

  • 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`，则计算分类损失（交叉熵）。

返回

transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ErnieMConfig）和输入，包含不同的元素。

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

ErnieMForSequenceClassification 的 forward 方法，覆盖了 `__call__` 特殊方法。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, ErnieMForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForSequenceClassification.from_pretrained("susnato/ernie-m-base_pytorch")

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

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

>>> predicted_class_id = logits.argmax().item()

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = ErnieMForSequenceClassification.from_pretrained("susnato/ernie-m-base_pytorch", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, ErnieMForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForSequenceClassification.from_pretrained("susnato/ernie-m-base_pytorch", 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 = ErnieMForSequenceClassification.from_pretrained(
...     "susnato/ernie-m-base_pytorch", 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

ErnieMForMultipleChoice

class transformers.ErnieMForMultipleChoice

< >

（ config ）

参数

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

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

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

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

forward

< >

（ input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True ） → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。

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

    什么是输入 ID？

  • attention_mask (torch.FloatTensor，形状为 (batch_size, num_choices, sequence_length), 可选) — 避免对填充标记索引执行注意力的掩码。掩码值在 `[0, 1]` 中选择：

    • 1 表示标记未被遮盖，
    • 0 表示标记被遮盖。

    什么是注意力掩码？

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

    什么是位置 ID？

  • 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, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, optional) — 是返回一个 ModelOutput 而不是一个普通的元组。
  • labels (torch.LongTensor of shape (batch_size,), optional) — 用于计算多项选择分类损失的标签。索引应在 [0, ..., num_choices-1] 范围内，其中 num_choices 是输入张量第二维的大小。（请参阅上面的 input_ids）

返回

transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置（ErnieMConfig）和输入，包含各种元素。

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

ErnieMForMultipleChoice 的 forward 方法重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ErnieMForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForMultipleChoice.from_pretrained("susnato/ernie-m-base_pytorch")

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

ErnieMForTokenClassification

class transformers.ErnieMForTokenClassification

< >

（ config ）

参数

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

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

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None output_hidden_states: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。

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

    什么是输入 ID？

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示 token 未被屏蔽，
    • 0 表示 token 被屏蔽。

    什么是注意力掩码？

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID？

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于置零自注意力模块中选定头的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示头 未被屏蔽，
    • 0 表示头 被屏蔽。
  • inputs_embeds (torch.FloatTensor of 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 而不是一个普通的元组。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算 token 分类损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。

返回

transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置（ErnieMConfig）和输入，包含各种元素。

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

ErnieMForTokenClassification 的 forward 方法重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ErnieMForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForTokenClassification.from_pretrained("susnato/ernie-m-base_pytorch")

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

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

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

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

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

ErnieMForQuestionAnswering

class transformers.ErnieMForQuestionAnswering

< >

（ config ）

参数

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

ErnieM 模型，顶部带有一个 span 分类头，用于抽取式问答任务，如 SQuAD（即在隐藏状态输出之上加一个线性层来计算 `span start logits` 和 `span end logits`）。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。

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

    什么是输入 ID？

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示 token 未被屏蔽，
    • 0 表示 token 被屏蔽。

    什么是注意力掩码？

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID？

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于置零自注意力模块中选定头的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示头 未被屏蔽，
    • 0 表示头 被屏蔽。
  • inputs_embeds (torch.FloatTensor of 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 而不是一个普通的元组。
  • start_positions (torch.LongTensor of shape (batch_size,), optional) — 标记 span 开始位置（索引）的标签，用于计算 token 分类损失。位置被限制在序列长度（`sequence_length`）范围内。超出序列范围的位置在计算损失时不予考虑。
  • end_positions (torch.LongTensor of shape (batch_size,), optional) — 标记 span 结束位置（索引）的标签，用于计算 token 分类损失。位置被限制在序列长度（`sequence_length`）范围内。超出序列范围的位置在计算损失时不予考虑。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置（ErnieMConfig）和输入，包含各种元素。

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

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

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

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

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

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

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

ErnieMForQuestionAnswering 的 forward 方法重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, ErnieMForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("susnato/ernie-m-base_pytorch")
>>> model = ErnieMForQuestionAnswering.from_pretrained("susnato/ernie-m-base_pytorch")

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

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

ErnieMForInformationExtraction

class transformers.ErnieMForInformationExtraction

< >

（ config ）

参数

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

ErnieMForInformationExtraction 是一个 Ernie-M 模型，在隐藏状态输出之上带有两个线性层，用于计算 `start_prob` 和 `end_prob`，专为通用信息抽取而设计。

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

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

forward

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None start_positions: typing.Optional[torch.Tensor] = None end_positions: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = True )

参数

  • input_ids (torch.LongTensor of shape (batch_size, num_choices, sequence_length)) — 词汇表中输入序列 token 的索引。

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

    什么是输入 ID？

  • attention_mask (torch.FloatTensor of shape (batch_size, num_choices, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示 token 未被屏蔽，
    • 0 表示 token 被屏蔽。

    什么是注意力掩码？

  • position_ids (torch.LongTensor of shape (batch_size, num_choices, sequence_length), optional) — 每个输入序列 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

    什么是位置 ID？

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于置零自注意力模块中选定头的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示头 未被屏蔽，
    • 0 表示头 被屏蔽。
  • inputs_embeds (torch.FloatTensor of 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 而不是一个普通的元组。
  • start_positions (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算 start_positions 损失的位置（索引）标签。在计算损失时，不考虑序列之外的位置。
  • end_positions (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算 end_positions 损失的位置（索引）标签。在计算损失时，不考虑序列之外的位置。

ErnieMForInformationExtraction 的 forward 方法重写了 __call__ 特殊方法。

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

< > 在 GitHub 上更新

←ERNIE ESM→