Transformers 文档

哪吒

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

哪吒

PyTorch

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

概述

哪吒模型由 Junqiu Wei 等人在《哪吒:用于中文语言理解的神经上下文表示》中提出。

论文摘要如下:

预训练语言模型由于其在大规模语料库上预训练以捕获文本中深层上下文信息的能力,在各种自然语言理解 (NLU) 任务中取得了巨大成功。在本技术报告中,我们介绍了在中文语料库上预训练名为 NEZHA(NEural contextualiZed representation for CHinese lAnguage understanding,哪吒)的语言模型,并针对中文 NLU 任务进行微调的实践。哪吒的当前版本基于 BERT,并结合了经验证的改进,包括作为有效位置编码方案的功能相对位置编码、全词掩码策略、混合精度训练和用于训练模型的 LAMB 优化器。实验结果表明,哪吒在几个代表性的中文任务中进行微调时,取得了最先进的性能,这些任务包括命名实体识别(人民日报命名实体识别)、句子匹配(LCQMC)、中文情感分类(ChnSenti)和自然语言推理(XNLI)。

该模型由sijunhe贡献。原始代码可以在此处找到。

资源

NezhaConfig

class transformers.NezhaConfig

< >

( vocab_size = 21128 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 max_relative_position = 64 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 classifier_dropout = 0.1 pad_token_id = 0 bos_token_id = 2 eos_token_id = 3 use_cache = True **kwargs )

参数

  • vocab_size (int, 可选,默认为 21128) — NEZHA 模型的词汇表大小。定义了可以通过传递给 NezhaModel 的 forward 方法的 inputs_ids 表示的不同 token。
  • hidden_size (int, 可选,默认为 768) — 编码器层和池化层的维度。
  • num_hidden_layers (int, 可选,默认为 12) — Transformer 编码器中的隐藏层数量。
  • num_attention_heads (int, 可选,默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选,默认为 3072) — Transformer 编码器中“中间”(即前馈)层的维度。
  • hidden_act (strfunction, 可选,默认为 "gelu") — 编码器和池化器中的非线性激活函数(函数或字符串)。
  • hidden_dropout_prob (float, 可选,默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。
  • attention_probs_dropout_prob (float, 可选,默认为 0.1) — 注意力概率的 dropout 比率。
  • max_position_embeddings (int, 可选,默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值(例如 512 或 1024 或 2048)。
  • type_vocab_size (int, 可选,默认为 2) — 传递给 NezhaModeltoken_type_ids 的词汇表大小。
  • initializer_range (float, 可选,默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float, 可选,默认为 1e-12) — 层归一化层使用的 epsilon。
  • classifier_dropout (float, 可选,默认为 0.1) — 附加分类器的 dropout 比率。
  • is_decoder (bool, 可选, 默认为 False) — 模型是否用作解码器。如果为 False,则模型用作编码器。

这是用于存储 NezhaModel 配置的配置类。它用于根据指定参数实例化 Nezha 模型,定义模型架构。使用默认值实例化配置将生成与 Nezha sijunhe/nezha-cn-base 架构类似的配置。

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

示例

>>> from transformers import NezhaConfig, NezhaModel

>>> # Initializing an Nezha configuration
>>> configuration = NezhaConfig()

>>> # Initializing a model (with random weights) from the Nezha-base style configuration model
>>> model = NezhaModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

NezhaModel

class transformers.NezhaModel

< >

( config add_pooling_layer = True )

参数

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

裸哪吒模型 Transformer 输出原始隐藏状态,顶部没有任何特定头部。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

该模型既可以作为编码器(仅具有自注意力)也可以作为解码器,在这种情况下,在自注意力层之间添加了一层交叉注意力,遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez 和 Illia Polosukhin 的 Attention is all you need 中描述的架构。

要作为解码器使用,模型需要使用配置的 is_decoder 参数设置为 True 进行初始化。要在 Seq2Seq 模型中使用,模型需要同时使用 is_decoder 参数和 add_cross_attention 设置为 True 进行初始化;此时期望 encoder_hidden_states 作为前向传递的输入。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstuple(torch.FloatTensor)

参数

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

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.__call__()

    什么是 input ID?

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

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择:

    • 0 对应 句子 A 的 token,
    • 1 对应 句子 B 的 token。

    什么是 token type 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 而不是普通元组。
  • encoder_hidden_states (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器,则用于交叉注意力。
  • encoder_attention_mask (torch.FloatTensor,形状为 (batch_size, sequence_length), 可选) — 用于避免对编码器输入填充 token 索引执行注意力的掩码。如果模型被配置为解码器,则此掩码用于交叉注意力。掩码值在 [0, 1] 中选择:

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。
  • past_key_values (tuple(tuple(torch.FloatTensor)),长度为 config.n_layers,每个元组包含 4 个形状为 (batch_size, num_heads, sequence_length - 1, embed_size_per_head) 的张量) — 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。

    如果使用 past_key_values,用户可以选择只输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids(那些没有将其过去的键值状态提供给此模型的),而不是所有形状为 (batch_size, sequence_length)decoder_input_ids

  • use_cache (bool, 可选) — 如果设置为 True,则返回 past_key_values 键值状态,可用于加速解码(参见 past_key_values)。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),其中包含各种元素,具体取决于配置 (NezhaConfig) 和输入。

  • 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), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

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

    解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均。

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

    包含预先计算的隐藏状态(自注意力块中的键和值,如果 config.is_encoder_decoder=True,则可选地包含交叉注意力块中的键和值),可用于(参见 past_key_values 输入)加速序列解码。

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

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaModel.from_pretrained("sijunhe/nezha-cn-base")

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

>>> last_hidden_states = outputs.last_hidden_state

NezhaForPreTraining

class transformers.NezhaForPreTraining

< >

( config )

参数

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

Nezha 模型,顶部有两个头部,如预训练时所做:一个 掩码语言建模 头部和一个 下一句预测 (分类) 头部。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_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 next_sentence_label: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) transformers.models.deprecated.nezha.modeling_nezha.NezhaForPreTrainingOutputtuple(torch.FloatTensor)

参数

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

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()什么是 input ID?

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

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择:

    • 0 对应 句子 A 的 token,
    • 1 对应 句子 B 的 token。

    什么是 token type 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, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(参见 input_ids 文档字符串)。索引设置为 -100 的 token 将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的 token 计算。
  • next_sentence_label (torch.LongTensor,形状为 (batch_size,), 可选) — 用于计算下一序列预测(分类)损失的标签。输入应为序列对(参见 input_ids 文档字符串)。索引应在 [0, 1] 中选择:

    • 0 表示序列 B 是序列 A 的延续,
    • 1 表示序列 B 是随机序列。
  • kwargs (dict[str, any], 可选,默认为 {}) — 用于隐藏已弃用的旧参数。

返回

transformers.models.deprecated.nezha.modeling_nezha.NezhaForPreTrainingOutputtuple(torch.FloatTensor)

一个 transformers.models.deprecated.nezha.modeling_nezha.NezhaForPreTrainingOutput 或一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),其中包含各种元素,具体取决于配置 (NezhaConfig) 和输入。

  • 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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出,加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每个层输出的隐藏状态加上初始嵌入输出。

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

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

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

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaForPreTraining
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForPreTraining.from_pretrained("sijunhe/nezha-cn-base")

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

NezhaForMaskedLM

class transformers.NezhaForMaskedLM

< >

( config )

参数

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

Nezha 模型,顶部带有一个 语言建模 头部。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: 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] = None ) transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

参数

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

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()什么是 input ID?

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

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择:

    • 0 对应 句子 A 的 token,
    • 1 对应 句子 B 的 token。

    什么是 token type 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, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在 [-100, 0, ..., config.vocab_size] 中(参见 input_ids 文档字符串)。索引设置为 -100 的 token 将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的 token 计算。

返回

transformers.modeling_outputs.MaskedLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组(如果传递 return_dict=Falseconfig.return_dict=False),其中包含各种元素,具体取决于配置 (NezhaConfig) 和输入。

  • loss (形状为 (1,)torch.FloatTensor可选,当提供 labels 时返回) — 掩码语言建模 (MLM) 损失。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言建模头部的预测分数(SoftMax 之前的每个词汇标记的分数)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

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

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForMaskedLM.from_pretrained("sijunhe/nezha-cn-base")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")

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

>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]

>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)

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

NezhaForNextSentencePrediction

class transformers.NezhaForNextSentencePrediction

< >

( config )

参数

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

Nezha 模型,顶部带有一个 下一句预测 (分类) 头部。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_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] = None **kwargs ) transformers.modeling_outputs.NextSentencePredictorOutputtuple(torch.FloatTensor)

参数

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

    可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode()什么是 input ID?

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

    • 1 表示 未被掩盖 的 token,
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择:

    • 0 对应 句子 A 的 token,
    • 1 对应 句子 B 的 token。

    什么是 token type 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 (形状为(batch_size,)torch.LongTensor可选) — 用于计算下一个句子预测(分类)损失的标签。输入应该是一对序列(参见input_ids文档字符串)。索引应在[0, 1]之间:

    • 0表示序列B是序列A的延续,
    • 1表示序列B是一个随机序列。

返回

transformers.modeling_outputs.NextSentencePredictorOutputtuple(torch.FloatTensor)

一个transformers.modeling_outputs.NextSentencePredictorOutput或一个torch.FloatTensor的元组(如果传入return_dict=Falseconfig.return_dict=False),包含根据配置(NezhaConfig)和输入的不同元素。

  • loss (torch.FloatTensor,形状为 (1,)可选,当提供 next_sentence_label 时返回) — 下一个序列预测(分类)损失。

  • logits (torch.FloatTensor,形状为 (batch_size, 2)) — 下一个序列预测(分类)头的预测分数(SoftMax 之前的真/假延续分数)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

NezhaForNextSentencePrediction 的 forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaForNextSentencePrediction
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForNextSentencePrediction.from_pretrained("sijunhe/nezha-cn-base")

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

NezhaForSequenceClassification

class transformers.NezhaForSequenceClassification

< >

( config )

参数

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

Nezha 模型 Transformer,顶部带有一个序列分类/回归头(在池化输出顶部的一个线性层),例如用于 GLUE 任务。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_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] = None ) transformers.modeling_outputs.SequenceClassifierOutputtuple(torch.FloatTensor)

参数

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

    索引可以使用AutoTokenizer获得。详情请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.__call__()

    什么是输入ID?

  • attention_mask (形状为(batch_size, sequence_length)torch.FloatTensor可选) — 遮罩,用于避免对填充标记索引执行注意力。遮罩值在[0, 1]中选择:

    • 1表示未被遮罩的标记,
    • 0表示被遮罩的标记。

    什么是注意力遮罩?

  • token_type_ids (形状为(batch_size, sequence_length)torch.LongTensor可选) — 分段标记索引,用于指示输入的第一个和第二个部分。索引在[0, 1]中选择:

    • 0对应于句子A标记,
    • 1对应于句子B标记。

    什么是标记类型ID?

  • head_mask (形状为(num_heads,)(num_layers, num_heads)torch.FloatTensor可选) — 遮罩,用于取消自注意力模块的选定头部。遮罩值在[0, 1]中选择:

    • 1表示头部未被遮罩
    • 0表示头部被遮罩
  • inputs_embeds (形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量比模型的内部嵌入查找矩阵有更多的控制,这将很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput而非普通元组。
  • labels (形状为(batch_size,)torch.LongTensor可选) — 用于计算序列分类/回归损失的标签。索引应在[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=Falseconfig.return_dict=False),包含根据配置(NezhaConfig)和输入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

NezhaForSequenceClassification 的 forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, NezhaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForSequenceClassification.from_pretrained("sijunhe/nezha-cn-base")

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

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

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

>>> # 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 = NezhaForSequenceClassification.from_pretrained("sijunhe/nezha-cn-base", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, NezhaForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForSequenceClassification.from_pretrained("sijunhe/nezha-cn-base", problem_type="multi_label_classification")

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

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

>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = NezhaForSequenceClassification.from_pretrained(
...     "sijunhe/nezha-cn-base", num_labels=num_labels, problem_type="multi_label_classification"
... )

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

NezhaForMultipleChoice

class transformers.NezhaForMultipleChoice

< >

( config )

参数

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

Nezha 模型,顶部带有多项选择分类头(在池化输出顶部的一个线性层和一个 softmax),例如用于 RocStories/SWAG 任务。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_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] = None ) transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

参数

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

    索引可以使用AutoTokenizer获得。详情请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.__call__()

    什么是输入ID?

  • attention_mask (形状为(batch_size, num_choices, sequence_length)torch.FloatTensor可选) — 遮罩,用于避免对填充标记索引执行注意力。遮罩值在[0, 1]中选择:

    • 1表示未被遮罩的标记,
    • 0表示被遮罩的标记。

    什么是注意力遮罩?

  • token_type_ids (形状为(batch_size, num_choices, sequence_length)torch.LongTensor可选) — 分段标记索引,用于指示输入的第一个和第二个部分。索引在[0, 1]中选择:

    • 0对应于句子A标记,
    • 1对应于句子B标记。

    什么是标记类型ID?

  • head_mask (形状为(num_heads,)(num_layers, num_heads)torch.FloatTensor可选) — 遮罩,用于取消自注意力模块的选定头部。遮罩值在[0, 1]中选择:

    • 1表示头部未被遮罩
    • 0表示头部被遮罩
  • inputs_embeds (形状为(batch_size, num_choices, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量比模型的内部嵌入查找矩阵有更多的控制,这将很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput而非普通元组。
  • labels (形状为(batch_size,)torch.LongTensor可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]之间,其中num_choices是输入张量第二维的大小。(参见上面的input_ids

返回

transformers.modeling_outputs.MultipleChoiceModelOutputtuple(torch.FloatTensor)

一个transformers.modeling_outputs.MultipleChoiceModelOutput或一个torch.FloatTensor的元组(如果传入return_dict=Falseconfig.return_dict=False),包含根据配置(NezhaConfig)和输入的不同元素。

  • 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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

NezhaForMultipleChoice 的 forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForMultipleChoice.from_pretrained("sijunhe/nezha-cn-base")

>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0)  # choice0 is correct (according to Wikipedia ;)), batch size 1

>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels)  # batch size is 1

>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logits

NezhaForTokenClassification

class transformers.NezhaForTokenClassification

< >

( config )

参数

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

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

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_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] = None ) transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

参数

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

    索引可以使用AutoTokenizer获得。详情请参阅PreTrainedTokenizer.encode()PreTrainedTokenizer.__call__()

    什么是输入ID?

  • attention_mask (形状为(batch_size, sequence_length)torch.FloatTensor可选) — 遮罩,用于避免对填充标记索引执行注意力。遮罩值在[0, 1]中选择:

    • 1表示未被遮罩的标记,
    • 0表示被遮罩的标记。

    什么是注意力遮罩?

  • token_type_ids (形状为(batch_size, sequence_length)torch.LongTensor可选) — 分段标记索引,用于指示输入的第一个和第二个部分。索引在[0, 1]中选择:

    • 0对应于句子A标记,
    • 1对应于句子B标记。

    什么是标记类型ID?

  • head_mask (形状为(num_heads,)(num_layers, num_heads)torch.FloatTensor可选) — 遮罩,用于取消自注意力模块的选定头部。遮罩值在[0, 1]中选择:

    • 1表示头部未被遮罩
    • 0表示头部被遮罩
  • inputs_embeds (形状为(batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量比模型的内部嵌入查找矩阵有更多的控制,这将很有用。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states
  • return_dict (bool, 可选) — 是否返回ModelOutput而非普通元组。
  • labels (形状为(batch_size, sequence_length)torch.LongTensor可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]之间。

返回

transformers.modeling_outputs.TokenClassifierOutputtuple(torch.FloatTensor)

一个transformers.modeling_outputs.TokenClassifierOutput或一个torch.FloatTensor的元组(如果传入return_dict=Falseconfig.return_dict=False),包含根据配置(NezhaConfig)和输入的不同元素。

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

  • logits (形状为 (batch_size, sequence_length, config.num_labels)torch.FloatTensor) — 分类分数(SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

NezhaForTokenClassification 的 forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForTokenClassification.from_pretrained("sijunhe/nezha-cn-base")

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

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

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

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

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

NezhaForQuestionAnswering

class transformers.NezhaForQuestionAnswering

< >

( config )

参数

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

Nezha 模型,顶部带有一个用于抽取式问答任务(如 SQuAD)的跨度分类头(在隐藏状态输出顶部用于计算跨度起始 logits跨度结束 logits的线性层)。

该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的一般方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。

此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。

前向传播

< >

( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_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] = None ) transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID?

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

    • 1 表示 未被遮蔽 的 token,
    • 0 表示 被遮蔽 的 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor,形状为 (batch_size, sequence_length), 可选) — 分段 token 索引,用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择:

    • 0 对应于 句子 A token,
    • 1 对应于 句子 B token。

    什么是 token 类型 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,形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标注 span 起始位置(索引)的标签。位置将被限制在序列长度(sequence_length)范围内。序列以外的位置不计入损失计算。
  • end_positions (torch.LongTensor,形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标注 span 结束位置(索引)的标签。位置将被限制在序列长度(sequence_length)范围内。序列以外的位置不计入损失计算。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),其中包含根据配置 (NezhaConfig) 和输入而定的各种元素。

  • 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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层输出(如果模型有嵌入层),加上每个层的一个输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

NezhaForQuestionAnswering 的 forward 方法,覆盖了 __call__ 特殊方法。

虽然前向传播的实现需要在该函数中定义,但之后应该调用 Module 实例,而不是该函数,因为前者负责运行预处理和后处理步骤,而后者则会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, NezhaForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("sijunhe/nezha-cn-base")
>>> model = NezhaForQuestionAnswering.from_pretrained("sijunhe/nezha-cn-base")

>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"

>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()

>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]

>>> # 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
< > 在 GitHub 上更新