Transformers 文档

ErnieM

Hugging Face's logo
加入Hugging Face社区

获取增强型文档体验

开始操作

ErnieM

此模型目前仅在维护模式,我们不接受更改其代码的新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: 通过将单语语料库中的跨语言语义与单语语料库对齐来增强多语言表征一文中提出。

论文的摘要如下

最近的研究表明,预训练的跨语言模型在下游跨语言任务中取得了令人印象深刻的表现。这种改进得益于学习了大量单语和对应语料库。尽管人们普遍认为对应语料库对于提高模型性能至关重要,但现有的方法往往受限于对应语料库的大小,尤其是对于低资源语言。在本文中,我们提出了ERNIE-M,一种新的训练方法,它鼓励模型将多个语言的表示与单语语料库对齐,以克服对应语料库大小对模型性能的约束。我们的关键洞察是将其整合到预训练过程中。我们在单语语料库上生成伪对应句子对,以实现不同语言之间的语义对齐学习,从而增强了跨语言模型的语义建模。实验结果表明,ERNIE-M优于现有的跨语言模型,并在各种跨语言下游任务中实现了新的最先进的结果。此模型由提供。原始代码可在此处找到。

使用提示

  • Ernie-M是一种类似于BERT模型,因此它是一个堆叠的Transformer编码器。
  • 与BERT使用MaskedLM进行预训练不同,作者使用了两种新颖的技术:跨注意力掩码语言建模回译掩码语言建模。目前这两个LMHead目标尚未在此实现。
  • 它是一个多语言语言模型。
  • 在预训练过程中没有使用下一个句子预测。

资源

ErnieMConfig

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) — inputs_idsErnieMModel 中的词汇大小。也是token嵌入矩阵的词汇大小。定义了通过调用 ErnieMModel 传递的 inputs_ids 可以表示的不同token的数量。
  • 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) — 嵌入和编码器中所有全连接层的dropout概率。
  • attention_probs_dropout_prob (float, 可选, 默认为 0.1) — 在编码器层的 MultiHeadAttention 中,用于丢弃一些注意力目标的dropout概率。
  • max_position_embeddings (int, 可选, 默认为 514) — 位置编码维度的最大值,它决定了所支持输入序列的最大长度。
  • initializer_rangefloat可选,默认为0.02)— 所有权重矩阵初始化的正态分布标准差。填充token在token词汇表中的索引。
  • pad_token_idint可选,默认为1)— 填充token的ID。
  • layer_norm_epsfloat可选,默认为1e-05)— 层归一化层使用的epsilon值。
  • classifier_dropoutfloat可选)— 分类头部的dropout比率。
  • act_dropout (float, 可选, 默认值 0.0) — 在 ErnieMEncoderLayer 激活后使用的 dropout 概率。

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

配置对象继承自 PretrainedConfig 并可用于控制模型输出。更多信息请参阅 PretrainedConfig 文档。

normal_initializer 将权重矩阵初始化为正态分布。有关在 ErnieMModel 中如何初始化权重的详细信息,请参阅 ErnieMPretrainedModel._init_weights()

ErnieMTokenizer

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: Optional = None **kwargs )

参数

  • sentencepiece_model_file (str) — 句子片段模型文件的路径。
  • 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) — 是否已将模型特有的token添加到token列表中。

返回

List[int]

范围在 [0, 1] 的整数列表:1 表示特定token,0 表示序列token。

从没有新增特定token的token列表中检索token id。使用tokenizer的encode方法添加特定token时调用此方法。

从序列创建token类型id

< >

( token_ids_0: 列表 token_ids_1: 可选 = None ) 列表[int]

参数

  • token_ids_0 (列表[int]) — 第一个标记序列。
  • token_ids_1 (列表[int], 可选) — 第二个标记序列。

返回

List[int]

标记类型 ID。

创建与传入的序列相对应的标记类型 ID。 什么是标记类型 ID? 如果模型以特殊方式构建这些 ID,则应在子类中覆盖。

保存词汇

< >

( save_directory: str filename_prefix Span: Optional = None )

ErnieMModel

transformers.ErnieMModel

< >

( config Span add_pooling_layer Span = True )

参数

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

仅输出原始隐藏状态的裸ErnieM模型转换器,没有在顶部添加任何特定头。

此模型继承自 PreTrainedModel。请查看超级类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入尺寸、修剪头部等)。

此模型是 PyTorch torch.nn.Module 子类。将其作为普通 PyTorch 模块使用,并参考 PyTorch 文档了解所有有关通用使用和行为的相关问题。

前进

< >

( input_ids: 可选 = None position_ids: 可选 = None attention_mask: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None past_key_values: 可选 = None use_cache: 可选 = None output_hidden_states: 可选 = None output_attentions: 可选 = None return_dict: 可选 = None ) transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (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 的 shape 形状为 (batch_size, sequence_length, hidden_size)可选) — 除非传入 input_ids ,否则您可以选择直接传入嵌入表示。如果想要比模型的内部嵌入查找矩阵转换输入索引关联的向量有更多控制权,这将非常有用。
  • output_attentions (bool可选) — 是否返回所有注意力层的注意力张量。有关返回张量中的 attentions 的更多信息,请参阅详细说明。
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关返回张量中的 hidden_states 的更多信息,请参阅详细说明。
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

A transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或当 return_dict=False 被传递时或当 config.return_dict=False 时,包含各种元素的 torch.FloatTensor 元组(取决于配置和输入)。

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

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

  • past_key_values (形状为 tuple(tuple(torch.FloatTensor))tuple(torch.FloatTensor)可选,当传递 use_cache=True 时或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 的元组,每个元组包含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 输入)以加快序列解码的速度。

  • hidden_states (形状为 tuple(torch.FloatTensor)torch.FloatTensor可选,当传递 output_hidden_states=True 时或当 config.output_hidden_states=True 时返回) — 包含 (如果模型有嵌入层,则包括嵌入层的输出)每个层的输出形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组。

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

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

    在自我关注头中使用注意力softmax后的注意力权重,用于在自我关注头中计算加权的平均值。

  • cross_attentions (形状为 tuple(torch.FloatTensor)torch.FloatTensor可选,当传递 output_attentions=Trueconfig.add_cross_attention=True 时或当 config.output_attentions=True 时返回) — 每层的一个形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组。

    解码器的跨关注层的注意力权重,在注意力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

transformers.ErnieMForSequenceClassification

< >

( config )

参数

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

ErnieM 模型变压器,仅在顶部添加了一个序列分类/回归头(位于池化输出之上的线性层),例如用于 GLUE 任务。

此模型继承自 PreTrainedModel。请查看超级类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入尺寸、修剪头部等)。

此模型是 PyTorch torch.nn.Module 子类。将其作为普通 PyTorch 模块使用,并参考 PyTorch 文档了解所有有关通用使用和行为的相关问题。

前进

< >

( input_ids: 可选项 = None attention_mask: 可选项 = None position_ids: 可选项 = None head_mask: 可选项 = None inputs_embeds: 可选项 = None past_key_values: 可选项 = None use_cache: 可选项 = None output_hidden_states: 可选项 = None output_attentions: 可选项 = None return_dict: 可选项 = True labels: 可选项 = None ) transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

  • attention_mask (torch BustyFloatTensor of shape (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.SequenceClassifierOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutput 或包含 torch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False),其包含各种元素,具体取决于配置(ErnieMConfig)和输入。

  • loss (torch.FloatTensor 形状为 (1,), 可选,当提供 labels 时返回) — 分类(或者如果 config.num_labels==1,则回归)损失。

  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类(或者如果 config.num_labels==1,则回归)分数(在 SoftMax 之前)。

  • hidden_states (形状为 tuple(torch.FloatTensor)torch.FloatTensor可选,当传递 output_hidden_states=True 时或当 config.output_hidden_states=True 时返回) — 包含 (如果模型有嵌入层,则包括嵌入层的输出)每个层的输出形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组。

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

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

    在自我关注头中使用注意力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

类名 transformers.ErnieMForMultipleChoice

< >

( config )

参数

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

带有多个选择分类头部的ErnieM模型(在池化输出上叠加一个线性层和softmax),例如RocStories/SWAG任务。

此模型继承自 PreTrainedModel。请查看超级类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入尺寸、修剪头部等)。

此模型是 PyTorch torch.nn.Module 子类。将其作为普通 PyTorch 模块使用,并参考 PyTorch 文档了解所有有关通用使用和行为的相关问题。

前进

< >

( input_ids: Optional = None attention_mask: 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 = True ) transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

参数

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

    索引可以通过 ErnieMTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入ID?

  • attention_mask (形状为 (batch_size, num_choices, sequence_length)torch.FloatTensor,可选)— 用于避免在填充token索引上执行注意力的掩码。选中的掩码值在 [0, 1] 的范围内:

    • 1 表示 未掩码 的token,
    • 0 表示 掩码 的token。

    什么是attention_mask?

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

    什么是位置ID?

  • head_mask (形状为 (num_heads,)(num_layers, num_heads)torch.FloatTensor,可选)— 用于屏蔽自注意力模块中选定的头的掩码。选中的掩码值在 [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

返回

  • 分类得分(在SoftMax之前)。

  • hidden_states (形状为 tuple(torch.FloatTensor)torch.FloatTensor可选,当传递 output_hidden_states=True 时或当 config.output_hidden_states=True 时返回) — 包含 (如果模型有嵌入层,则包括嵌入层的输出)每个层的输出形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组。

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

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

    在自我关注头中使用注意力softmax后的注意力权重,用于在自我关注头中计算加权的平均值。

尽管正向传播的公式需要在该函数内定义,但应在之后调用 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

< >

( config )

参数

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

ErnieM模型顶部是带标记分类头(在隐藏状态输出之上有一层线性层),例如用于命名实体识别(NER)任务。

此模型继承自 PreTrainedModel。请查看超级类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入尺寸、修剪头部等)。

此模型是 PyTorch torch.nn.Module 子类。将其作为普通 PyTorch 模块使用,并参考 PyTorch 文档了解所有有关通用使用和行为的相关问题。

前进

< >

( input_ids: 可选 = None attention_mask: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None past_key_values: 可选 = None output_hidden_states: 可选 = None output_attentions: 可选 = None return_dict: 可选 = True labels: 可选 = None ) transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), 可选) — 用于避免对填充token的索引执行注意力的掩码。选定的掩码值范围为 [0, 1]
    • 1 表示 未掩码的token,
    • 0 表示 掩码的token。

    什么是注意力掩码?

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

    什么是位置ID?

  • head_mask (torch.FloatTensor of shape (num_heads,) or (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而非普通tuple。
  • labels (torch.LongTensor尺寸为(batch_size, sequence_length), 可选) —— 计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]内。

返回

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

A transformers.modeling_outputs.TokenClassifierOutput或一个torch.FloatTensor的元组(如果传递了return_dict=False或当config.return_dict=False时),其包含各种元素,这取决于配置(ErnieMConfig)和输入。

  • loss (torch.FloatTensor尺寸为(1,), 可选, 当提供labels时返回) —— 分类损失。

  • logits (torch.FloatTensor尺寸为(batch_size, sequence_length, config.num_labels)) —— 分类得分(在SoftMax之前)。

  • hidden_states (形状为 tuple(torch.FloatTensor)torch.FloatTensor可选,当传递 output_hidden_states=True 时或当 config.output_hidden_states=True 时返回) — 包含 (如果模型有嵌入层,则包括嵌入层的输出)每个层的输出形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组。

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

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

    在自我关注头中使用注意力softmax后的注意力权重,用于在自我关注头中计算加权的平均值。

ErnieMForTokenClassification的前向方法,覆盖了__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

transformers.ErnieMForQuestionAnswering

< >

( config )

参数

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

ErnieM 模型,顶部带有 span 分类头,用于 SQuAD 类似的问题回答任务(在隐藏状态输出上添加线性层,以计算 span start logitsspan end logits)。

此模型继承自 PreTrainedModel。请查看超级类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入尺寸、修剪头部等)。

此模型是 PyTorch torch.nn.Module 子类。将其作为普通 PyTorch 模块使用,并参考 PyTorch 文档了解所有有关通用使用和行为的相关问题。

前进

< >

( input_ids: 可选 = None attention_mask: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None start_positions: 可选 = None end_positions: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = True ) transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)可选) — 用于避免在填充标记索引上执行注意力的遮蔽(mask)。遮蔽值选用 [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 而不是纯元组。
  • start_positions (torch.LongTensor of shape (batch_size,), 可选) — 用于计算分类损失的标记开始位置的标签。位置约束到序列长度(sequence_length)。序列外的位置不会在计算损失时考虑。
  • end_positions (torch.LongTensor of shape (batch_size,), 可选) — 用于计算分类损失的标记结束位置的标签。位置约束到序列长度(sequence_length)。序列外的位置不会在计算损失时考虑。

返回

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

transformers.modeling_outputs.QuestionAnsweringModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False 时),根据配置(例如 ErnieMConfig)和输入包含各种元素。

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

  • start_logits(《torch.FloatTensor》形状为(batch_size, sequence_length))— Span 起始的分数(SoftMax 之前)。

  • end_logits(《torch.FloatTensor》形状为(batch_size, sequence_length))— Span 结束的分数(SoftMax 之前)。

  • hidden_states (形状为 tuple(torch.FloatTensor)torch.FloatTensor可选,当传递 output_hidden_states=True 时或当 config.output_hidden_states=True 时返回) — 包含 (如果模型有嵌入层,则包括嵌入层的输出)每个层的输出形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor 元组。

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

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

    在自我关注头中使用注意力softmax后的注意力权重,用于在自我关注头中计算加权的平均值。

ErnieMForQuestionAnswering 的前向方法,覆盖了特殊方法 __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

transformers.ErnieMForInformationExtraction

< >

( config )

参数

  • config(《ErnieMConfig》)— 包含模型所有参数的模型配置类。用配置文件初始化不会加载模型关联的权重,只加载配置。检查 from_pretrained() 方法以加载模型权重。

ErnieMForInformationExtraction 是 Ernie-M 模型,对隐藏状态输出添加两个线性层来计算 start_probend_prob,旨在用于通用信息提取。

此模型继承自 PreTrainedModel。请查看超级类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入尺寸、修剪头部等)。

此模型是 PyTorch torch.nn.Module 子类。将其作为普通 PyTorch 模块使用,并参考 PyTorch 文档了解所有有关通用使用和行为的相关问题。

前进

参数

  • attention_mask (形状为(batch_size, num_choices, sequence_length)torch.FloatTensor可选) — 用于避免在填充token索引上执行注意力的掩码。掩码值选取于[0, 1]

    • 1 表示未掩码的token,
    • 0 表示掩码的token。

    什么是attention_mask?

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

    什么是位置ID?

  • head_mask (形状为(num_heads,)(num_layers, num_heads)torch.FloatTensor可选) — 用于使self-attention模块中选定的head无效的掩码。掩码值选取于[0, 1]

    • 1 表示head未掩码
    • 0 表示head掩码
  • 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, optional) — 是否返回ModelOutput而不是普通元组。
  • start_positions (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算start_positions损失的起始位置的标签。序列之外的位置不计入损失计算。
  • end_positions (torch.LongTensor of shape (batch_size,), optional) — 用于计算end_positions损失的结束位置的标签。序列之外的位置不计入损失计算。

ErnieMForInformationExtraction的前向方法,覆盖了特殊方法__call__

尽管正向传播的公式需要在该函数内定义,但应在之后调用 Module 实例而不是它,因为前者会负责运行预处理和后处理步骤,而后者则会默默地忽略这些步骤。

< > 在GitHub上更新