Transformers 文档
RoCBert
并获得增强的文档体验
开始使用
RoCBert
RoCBert 是一个预训练的中文 BERT 模型,旨在对抗错别字和同义词等对抗性攻击。它通过对比学习目标进行预训练,以对齐正常和对抗性文本示例。这些示例包括中文的不同语义、语音和视觉特征。这使得 RoCBert 对操作更具鲁棒性。
您可以在 weiweishi 配置文件下找到所有原始的 RoCBert 检查点。
此模型由 weiweishi 贡献。
点击右侧边栏中的 RoCBert 模型,查看如何将 RoCBert 应用于不同的中文语言任务的更多示例。
以下示例演示了如何使用 Pipeline、AutoModel 和命令行预测 [MASK] 标记。
import torch
from transformers import pipeline
pipeline = pipeline(
task="fill-mask",
model="weiweishi/roc-bert-base-zh",
torch_dtype=torch.float16,
device=0
)
pipeline("這家餐廳的拉麵是我[MASK]過的最好的拉麵之")
RoCBertConfig
class transformers.RoCBertConfig
< 源 >( 词汇表大小 = 30522 隐藏层大小 = 768 隐藏层数量 = 12 注意力头数量 = 12 中间层大小 = 3072 隐藏层激活函数 = 'gelu' 隐藏层dropout概率 = 0.1 注意力概率dropout概率 = 0.1 最大位置嵌入 = 512 类型词汇表大小 = 2 初始化范围 = 0.02 层归一化epsilon = 1e-12 使用缓存 = True 填充标记ID = 0 位置嵌入类型 = 'absolute' 分类器dropout = None 启用发音 = True 启用形状 = True 发音嵌入维度 = 768 发音词汇表大小 = 910 形状嵌入维度 = 512 形状词汇表大小 = 24858 连接输入 = True **kwargs )
参数
- vocab_size (
int
, 可选, 默认为 30522) — RoCBert 模型的词汇表大小。定义了调用 RoCBertModel 时inputs_ids
可以表示的不同标记的数量。 - hidden_size (
int
, 可选, 默认为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int
, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int
, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int
, 可选, 默认为 3072) — Transformer 编码器中“中间”(即前馈)层的维度。 - hidden_act (
str
或function
, 可选, 默认为"gelu"
) — 编码器和池化器中的非线性激活函数(函数或字符串)。如果是字符串,支持"gelu"
、"relu"
、"selu"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float
, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int
, 可选, 默认为 512) — 该模型可能使用的最大序列长度。通常设置为一个较大的值,以防万一(例如,512、1024 或 2048)。 - type_vocab_size (
int
, 可选, 默认为 2) — 调用 RoCBertModel 时token_type_ids
的词汇表大小。 - initializer_range (
float
, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - layer_norm_eps (
float
, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon。 - is_decoder (
bool
, 可选, 默认为False
) — 模型是否用作解码器。如果为False
,则模型用作编码器。 - use_cache (
bool
, 可选, 默认为True
) — 模型是否应该返回最后一个键/值注意力(并非所有模型都使用)。仅当config.is_decoder=True
时相关。 - position_embedding_type (
str
, 可选, 默认为"absolute"
) — 位置嵌入的类型。选择"absolute"
、"relative_key"
、"relative_key_query"
之一。对于位置嵌入,请使用"absolute"
。有关"relative_key"
的更多信息,请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。有关"relative_key_query"
的更多信息,请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的方法 4。 - classifier_dropout (
float
, 可选) — 分类头部的 dropout 比率。 - enable_pronunciation (
bool
, 可选, 默认为True
) — 模型在训练时是否使用发音嵌入。 - enable_shape (
bool
, 可选, 默认为True
) — 模型在训练时是否使用形状嵌入。 - pronunciation_embed_dim (
int
, 可选, 默认为 768) — 发音嵌入的维度。 - pronunciation_vocab_size (
int
, 可选, 默认为 910) — RoCBert 模型的发音词汇表大小。定义了调用 RoCBertModel 时input_pronunciation_ids
可以表示的不同标记的数量。 - shape_embed_dim (
int
, 可选, 默认为 512) — shape_embed 的维度。 - shape_vocab_size (
int
, 可选, 默认为 24858) — RoCBert 模型的形状词汇量大小。定义了调用 RoCBertModel 时input_shape_ids
可以表示的不同标记的数量。 - concat_input (
bool
, 可选, 默认为True
) — 定义了合并 shape_embed、pronunciation_embed 和 word_embed 的方式,如果值为 true,则 output_embed = torch.cat((word_embed, shape_embed, pronunciation_embed), -1),否则 output_embed = (word_embed + shape_embed + pronunciation_embed) / 3 - 示例 —
这是一个配置类,用于存储 RoCBertModel 的配置。它用于根据指定的参数实例化 RoCBert 模型,定义模型架构。使用默认值实例化配置将产生类似于 RoCBert weiweishi/roc-bert-base-zh 架构的配置。
配置对象继承自 PretrainedConfig,可用于控制模型输出。有关更多信息,请参阅 PretrainedConfig 的文档。
>>> from transformers import RoCBertModel, RoCBertConfig
>>> # Initializing a RoCBert weiweishi/roc-bert-base-zh style configuration
>>> configuration = RoCBertConfig()
>>> # Initializing a model from the weiweishi/roc-bert-base-zh style configuration
>>> model = RoCBertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
RoCBertTokenizer
class transformers.RoCBertTokenizer
< 来源 >( vocab_file word_shape_file word_pronunciation_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )
参数
- 构建 RoCBert 分词器。基于 WordPiece。此分词器继承自 PreTrainedTokenizer,它 —
- 包含 大部分主要方法。用户应参阅此超类以获取有关这些方法的更多信息 —
- 方法。 — vocab_file (
str
): 包含词汇的文件。word_shape_file (str
): 包含词 => 形状信息的文件。word_pronunciation_file (str
): 包含词 => 发音信息的文件。do_lower_case (bool
, 可选, 默认为True
): 分词时是否将输入转换为小写。do_basic_tokenize (bool
, 可选, 默认为True
): 是否在 WordPiece 之前进行基本分词。never_split (Iterable
, 可选): 在分词期间永不分割的标记集合。仅当do_basic_tokenize=True
时有效。unk_token (str
, 可选, 默认为"[UNK]"
): 未知标记。不在词汇表中的标记不能转换为 ID,并被设置为此标记。sep_token (str
, 可选, 默认为"[SEP]"
): 分隔符标记,用于从多个序列构建序列时,例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。pad_token (str
, 可选, 默认为"[PAD]"
): 用于填充的标记,例如在批量处理不同长度的序列时。cls_token (str
, 可选, 默认为"[CLS]"
): 用于序列分类(对整个序列而非按标记分类)的分类器标记。它是使用特殊标记构建的序列的第一个标记。mask_token (str
, 可选, 默认为"[MASK]"
): 用于掩码值的标记。这是使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。tokenize_chinese_chars (bool
, 可选, 默认为True
): 是否对中文字符进行分词。对于日语,这可能应该禁用(参阅此 问题)。strip_accents (bool
, 可选): 是否去除所有重音。如果未指定此选项,则将由lowercase
的值决定(与原始 BERT 中一样)。
build_inputs_with_special_tokens
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None cls_token_id: typing.Optional[int] = None sep_token_id: typing.Optional[int] = None ) → List[int]
通过连接和添加特殊标记,从一个序列或一对序列构建用于序列分类任务的模型输入。BERT 序列的格式如下:
- 单个序列:
[CLS] X [SEP]
- 序列对:
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model
方法添加特殊标记时调用。
create_token_type_ids_from_sequences
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
创建与传入序列对应的标记类型 ID。什么是标记类型 ID?
如果模型有特殊的构建方式,应在子类中重写此方法。
RoCBertModel
class transformers.RoCBertModel
< 来源 >( config add_pooling_layer = True )
参数
- config (RoCBertModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不加载与模型关联的权重,仅加载配置。请查阅 from_pretrained() 方法以加载模型权重。
- add_pooling_layer (
bool
, 可选, 默认为True
) — 是否添加池化层
该模型既可以充当编码器(仅包含自注意力),也可以充当解码器,在这种情况下,在自注意力层之间添加了一层交叉注意力,遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。
为了充当解码器,模型需要使用配置中 is_decoder
参数设置为 True
进行初始化。要在 Seq2Seq 模型中使用,模型需要使用 is_decoder
和 add_cross_attention
都设置为 True
进行初始化;然后期望 encoder_hidden_states
作为前向传播的输入。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 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.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 词汇表中输入序列标记的索引。填充默认将被忽略。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 形状词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 发音词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]
:- 1 表示标记未被掩码,
- 0 表示标记已被掩码。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 片段标记索引,指示输入的第一个和第二个部分。索引选择在[0, 1]
:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
, 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]
:- 1 表示头部未被掩码,
- 0 表示头部已被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
, 可选) — 可选地,除了传递input_ids
,您还可以选择直接传递嵌入表示。如果您希望对input_ids
索引如何转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制,这很有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
, 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器,则用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 避免对编码器输入中的填充标记索引执行注意力的掩码。如果模型被配置为解码器,则此掩码用于交叉注意力。掩码值选择在[0, 1]
:- 1 表示标记未被掩码,
- 0 表示标记已被掩码。
- past_key_values (
list[torch.FloatTensor]
, 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码上一阶段返回的past_key_values
,当use_cache=True
或config.use_cache=True
时。允许两种格式:
- Cache 实例,请参阅我们的 kv 缓存指南;
- 长度为
config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量)。这也被称为传统缓存格式。
模型将输出与作为输入提供的缓存格式相同的缓存格式。如果没有传递
past_key_values
,则将返回传统缓存格式。如果使用
past_key_values
,用户可以选择仅输入形状为(batch_size, 1)
的最后一个input_ids
(那些没有将其过去的键值状态提供给此模型的)而不是形状为(batch_size, sequence_length)
的所有input_ids
。 - use_cache (
bool
, 可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor
元组(如果传递 return_dict=False
或当 config.return_dict=False
时),包含根据配置(RoCBertConfig)和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor
, 形状为(batch_size, sequence_length, hidden_size)
) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)
的torch.FloatTensor
) — 经过用于辅助预训练任务的层进一步处理后,序列第一个标记(分类标记)的最后一层隐藏状态。例如,对于 BERT 家族模型,这会在经过线性层和 tanh 激活函数处理后返回分类标记。线性层权重是在预训练期间通过下一句预测(分类)目标进行训练的。 -
hidden_states (
tuple(torch.FloatTensor)
, 可选, 当传递output_hidden_states=True
或当config.output_hidden_states=True
时返回) —torch.FloatTensor
元组(如果模型有嵌入层,则有一个用于嵌入层输出,加上每个层输出一个)的形状为(batch_size, sequence_length, hidden_size)
。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组(每个层一个)的形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的注意力权重,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)
, 可选, 当传递output_attentions=True
和config.add_cross_attention=True
或当config.output_attentions=True
时返回) —torch.FloatTensor
元组(每个层一个)的形状为(batch_size, num_heads, sequence_length, sequence_length)
。解码器交叉注意力层的注意力权重,在注意力 softmax 之后,用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache
, 可选, 当传递use_cache=True
或当config.use_cache=True
时返回) — 它是一个 Cache 实例。有关更多详细信息,请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态(自注意力块中的键和值,如果
config.is_encoder_decoder=True
,则可选地在交叉注意力块中),可用于(参见past_key_values
输入)加速顺序解码。
RoCBertModel 前向传播方法会覆盖 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
RoCBertForPreTraining
class transformers.RoCBertForPreTraining
< 源 >( 配置 )
参数
- config (RoCBertForPreTraining) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoCBert 模型,在预训练期间使用对比损失和 masked_lm_loss。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< 源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None attack_input_ids: typing.Optional[torch.Tensor] = None attack_input_shape_ids: typing.Optional[torch.Tensor] = None attack_input_pronunciation_ids: typing.Optional[torch.Tensor] = None attack_attention_mask: typing.Optional[torch.Tensor] = None attack_token_type_ids: 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_input_ids: typing.Optional[torch.Tensor] = None labels_input_shape_ids: typing.Optional[torch.Tensor] = None labels_input_pronunciation_ids: typing.Optional[torch.Tensor] = None labels_attention_mask: typing.Optional[torch.Tensor] = None labels_token_type_ids: 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.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 形状词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 发音词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]
:- 1 表示**未被掩码**的标记,
- 0 表示**被掩码**的标记。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 分段标记索引,指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于**句子 A** 标记,
- 1 对应于**句子 B** 标记。
- attack_input_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算对比损失的攻击样本 ID。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - attack_input_shape_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算对比损失的攻击样本形状 ID。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - attack_input_pronunciation_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算对比损失的攻击样本发音 ID。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - attack_attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
, 可选) — 避免对攻击样本的填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]
:1
表示未被掩码的标记,0
表示被掩码的标记。 - attack_token_type_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 分段标记索引,指示攻击输入的各个部分。索引选择范围为[0, 1]
:0
对应于句子 A 标记,1
对应于句子 B 标记。 - position_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 输入序列中每个标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
, 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
, 可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您希望对如何将input_ids
索引转换为相关向量有比模型内部嵌入查找矩阵更多的控制,这很有用。 - labels_input_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算对比损失和 masked_lm_loss 的目标 ID。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - labels_input_shape_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算对比损失和 masked_lm_loss 的目标形状 ID。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - labels_input_pronunciation_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算对比损失和 masked_lm_loss 的目标发音 ID。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - labels_attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
, 可选) — 避免对标签样本的填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]
:1
表示未被掩码的标记,0
表示被掩码的标记。 - labels_token_type_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 分段标记索引,指示标签输入的各个部分。索引选择范围为[0, 1]
:0
对应于句子 A 标记,1
对应于句子 B 标记。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
根据配置 (RoCBertConfig) 和输入,transformers.RoCBertForPreTraining 的前向方法,覆盖了 __call__
特殊方法,返回 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor
的元组(如果传入了 return_dict=False
或 config.return_dict=False
)。
-
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=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 后的注意力权重,用于计算自注意力头中的加权平均值。
RoCBertForPreTraining 的前向方法,覆盖了 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoCBertForPreTraining
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForPreTraining.from_pretrained("weiweishi/roc-bert-base-zh")
>>> inputs = tokenizer("你好,很高兴认识你", return_tensors="pt")
>>> attack_inputs = {}
>>> for key in list(inputs.keys()):
... attack_inputs[f"attack_{key}"] = inputs[key]
>>> label_inputs = {}
>>> for key in list(inputs.keys()):
... label_inputs[f"labels_{key}"] = inputs[key]
>>> inputs.update(label_inputs)
>>> inputs.update(attack_inputs)
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> logits.shape
torch.Size([1, 11, 21128])
RoCBertForCausalLM
类 transformers.RoCBertForCausalLM
< 源 >( 配置 )
参数
- config (RoCBertForCausalLM) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有 `语言建模` 头部用于 CLM 微调的 RoCBert 模型。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< 源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: 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 head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.Tensor]] = None labels: typing.Optional[torch.Tensor] = 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 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 形状词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 发音词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择范围为[0, 1]
:- 1 表示**未被掩码**的标记,
- 0 表示**被掩码**的标记。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 分段标记索引,指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于**句子 A** 标记,
- 1 对应于**句子 B** 标记。
- position_ids (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 输入序列中每个标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
, 可选) — 可选地,您可以选择直接传入嵌入表示,而不是传入input_ids
。如果您希望对如何将input_ids
索引转换为相关向量有比模型内部嵌入查找矩阵更多的控制,这很有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)
的torch.Tensor
, 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器,则在交叉注意力中使用。 - encoder_attention_mask (形状为
(batch_size, sequence_length)
的torch.Tensor
, 可选) — 避免对编码器输入的填充标记索引执行注意力操作的掩码。如果模型被配置为解码器,则在交叉注意力中使用此掩码。掩码值选择范围为[0, 1]
:- 1 表示**未被掩码**的标记,
- 0 表示**被掩码**的标记。
- head_mask (形状为
(num_heads,)
或(num_layers, num_heads)
的torch.Tensor
, 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]
:- 1 表示头部**未被掩码**,
- 0 表示头部**被掩码**。
- past_key_values (
list[torch.Tensor]
, 可选) — 预计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。这通常包括模型在解码前期返回的past_key_values
,当use_cache=True
或config.use_cache=True
时。允许两种格式:
- Cache 实例,请参阅我们的 kv 缓存指南;
- 长度为
config.n_layers
的tuple(torch.FloatTensor)
元组,每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量。这也称为旧版缓存格式。
模型将输出与作为输入提供的缓存格式相同的缓存格式。如果没有传入
past_key_values
,将返回旧版缓存格式。如果使用
past_key_values
,用户可以选择只输入形状为(batch_size, 1)
的最新input_ids
(那些没有将其过去的键值状态提供给此模型的)而不是形状为(batch_size, sequence_length)
的所有input_ids
。 - labels (形状为
(batch_size, sequence_length)
的torch.LongTensor
, 可选) — 用于计算从左到右语言建模损失(下一个词预测)的标签。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的标记将被忽略(被掩码),损失仅针对标签在[0, ..., config.vocab_size]
范围内的标记计算。 - use_cache (
bool
, 可选) — 如果设置为True
,则返回past_key_values
键值状态,可用于加速解码(参见past_key_values
)。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 对象而不是普通元组。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor
元组(如果传递 return_dict=False
或 config.return_dict=False
),包含根据配置(RoCBertConfig)和输入的不同元素。
-
loss (
torch.FloatTensor
形状为(1,)
,可选,当提供labels
时返回) — 语言建模损失(用于下一个 token 预测)。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)
的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 后的注意力权重,用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor)
, 可选,当传递output_attentions=True
或config.output_attentions=True
时返回) —torch.FloatTensor
元组(每层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 后的交叉注意力权重,用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache
, 可选, 当传递use_cache=True
或当config.use_cache=True
时返回) — 它是一个 Cache 实例。有关更多详细信息,请参阅我们的 kv 缓存指南。包含预先计算的隐藏状态(注意力块中的键和值),可用于(参见
past_key_values
输入)加速顺序解码。
RoCBertForCausalLM 的前向方法,覆盖 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoCBertForCausalLM, RoCBertConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> config = RoCBertConfig.from_pretrained("weiweishi/roc-bert-base-zh")
>>> config.is_decoder = True
>>> model = RoCBertForCausalLM.from_pretrained("weiweishi/roc-bert-base-zh", config=config)
>>> inputs = tokenizer("你好,很高兴认识你", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logits
RoCBertForMaskedLM
class transformers.RoCBertForMaskedLM
< source >( 配置 )
参数
- config (RoCBertForMaskedLM) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Roc Bert 模型,顶部带有 语言建模
头。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< source >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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 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.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 形状词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 发音词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择范围为[0, 1]
:- 1 表示 token 未被掩码,
- 0 表示 token 已被掩码。
- token_type_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于 句子 A token,
- 1 对应于 句子 B token。
- position_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]
:- 1 表示头部未被掩码,
- 0 表示头部已被掩码。
- inputs_embeds (
torch.Tensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想对如何将input_ids
索引转换为相关向量比模型内部嵌入查找矩阵有更多的控制,则此功能很有用。 - encoder_hidden_states (
torch.Tensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器,则用于交叉注意力。 - encoder_attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 用于避免对编码器输入中的填充 token 索引执行注意力的掩码。如果模型配置为解码器,则此掩码用于交叉注意力。掩码值选择范围为[0, 1]
:- 1 表示 token 未被掩码,
- 0 表示 token 已被掩码。
- labels (
torch.LongTensor
,形状为(batch_size, sequence_length)
,可选) — 用于计算掩码语言模型损失的标签。索引应在[-100, 0, ..., config.vocab_size]
范围内(参见input_ids
文档字符串)。索引设置为-100
的 token 将被忽略(掩码),损失只对标签在[0, ..., config.vocab_size]
范围内的 token 计算。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 对象而不是普通元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
根据配置 (RoCBertConfig) 和输入,transformers.RoCBertForPreTraining 的前向方法,覆盖了 __call__
特殊方法,返回 transformers.modeling_outputs.MaskedLMOutput 或 torch.FloatTensor
的元组(如果传入了 return_dict=False
或 config.return_dict=False
)。
-
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=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 后的注意力权重,用于计算自注意力头中的加权平均值。
RoCBertForMaskedLM 的前向方法,覆盖 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoCBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForMaskedLM.from_pretrained("weiweishi/roc-bert-base-zh")
>>> inputs = tokenizer("法国是首都[MASK].", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of {mask}
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
'.'
RoCBertForSequenceClassification
class transformers.RoCBertForSequenceClassification
< source >( 配置 )
参数
- config (RoCBertForSequenceClassification) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoCBert 模型转换器,顶部带有一个序列分类/回归头(在池化输出之上有一个线性层),例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< source >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 形状词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 发音词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择范围为[0, 1]
:- 1 表示 token 未被掩码,
- 0 表示 token 已被掩码。
- token_type_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于 句子 A token,
- 1 对应于 句子 B token。
- position_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]
:- 1 表示头部未被掩码,
- 0 表示头部已被掩码。
- inputs_embeds (
torch.Tensor
,形状为(batch_size, sequence_length, hidden_size)
,可选) — 可选地,您可以选择直接传递嵌入表示,而不是传递input_ids
。如果您想对如何将input_ids
索引转换为相关向量比模型内部嵌入查找矩阵有更多的控制,则此功能很有用。 - labels (
torch.LongTensor
,形状为(batch_size,)
,可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]
范围内。如果config.num_labels == 1
,则计算回归损失(均方误差损失);如果config.num_labels > 1
,则计算分类损失(交叉熵)。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 对象而不是普通元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor
元组(如果传递 return_dict=False
或 config.return_dict=False
),包含根据配置(RoCBertConfig)和输入的不同元素。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
RoCBertForSequenceClassification 的前向方法,覆盖 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, RoCBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForSequenceClassification.from_pretrained("weiweishi/roc-bert-base-zh")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = RoCBertForSequenceClassification.from_pretrained("weiweishi/roc-bert-base-zh", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...
多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, RoCBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForSequenceClassification.from_pretrained("weiweishi/roc-bert-base-zh", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = RoCBertForSequenceClassification.from_pretrained(
... "weiweishi/roc-bert-base-zh", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).loss
RoCBertForMultipleChoice
class transformers.RoCBertForMultipleChoice
< source >( 配置 )
参数
- config (RoCBertForMultipleChoice) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Roc Bert 模型,顶部带有一个多项选择分类头(在池化输出之上有一个线性层和一个 Softmax),例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< source >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
,形状为(batch_size, num_choices, sequence_length)
) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor
,形状为(batch_size, num_choices, sequence_length)
) — 形状词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor
,形状为(batch_size, num_choices, sequence_length)
) — 发音词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
,可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选择范围为[0, 1]
:- 1 表示 token 未被掩码,
- 0 表示 token 已被掩码。
- token_type_ids (
torch.LongTensor
,形状为(batch_size, num_choices, sequence_length)
,可选) — 分段 token 索引,用于指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于 句子 A token,
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor
,形状为(batch_size, num_choices, sequence_length)
, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]
。 - head_mask (
torch.Tensor
,形状为(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 索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权,这将非常有用。 - labels (
torch.LongTensor
,形状为(batch_size,)
, 可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]
范围内,其中num_choices
是输入张量第二个维度的大小。(参见上面的input_ids
) - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量中的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 对象而不是普通元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor
元组(如果传入了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (RoCBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
RoCBertForMultipleChoice 的前向方法,覆盖了 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoCBertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForMultipleChoice.from_pretrained("weiweishi/roc-bert-base-zh")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logits
RoCBertForTokenClassification
类 transformers.RoCBertForTokenClassification
< 来源 >( 配置 )
参数
- config (RoCBertForTokenClassification) — 模型的配置类,包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重,只加载配置。要加载模型权重,请查看 from_pretrained() 方法。
Roc Bert 转换器,顶部带有一个用于标记分类的头部(一个在线性层顶部的隐藏状态输出),例如用于命名实体识别 (NER) 任务。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。索引可以使用 AutoTokenizer 获得。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 形状词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 发音词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择范围为[0, 1]
:- 1 表示标记 未被遮蔽,
- 0 表示标记 被遮蔽.
- token_type_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 分段标记索引,指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
- position_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]
:- 1 表示头部 未被遮蔽,
- 0 表示头部 被遮蔽.
- inputs_embeds (
torch.Tensor
,形状为(batch_size, sequence_length, hidden_size)
, 可选) — 可选地,你可以选择直接传入嵌入表示,而不是传入input_ids
。如果你想对如何将input_ids
索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权,这将非常有用。 - labels (
torch.LongTensor
,形状为(batch_size, sequence_length)
, 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]
范围内。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量中的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 对象而不是普通元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor
元组(如果传入了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (RoCBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
RoCBertForTokenClassification 的前向方法,覆盖了 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoCBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForTokenClassification.from_pretrained("weiweishi/roc-bert-base-zh")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...
RoCBertForQuestionAnswering
类 transformers.RoCBertForQuestionAnswering
< 来源 >( 配置 )
参数
- config (RoCBertForQuestionAnswering) — 模型的配置类,包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重,只加载配置。要加载模型权重,请查看 from_pretrained() 方法。
Roc Bert 转换器,顶部带有一个用于抽取式问答任务(如 SQuAD)的跨度分类头部(一个在线性层顶部的隐藏状态输出,用于计算 span start logits
和 span end logits
)。
该模型继承自 PreTrainedModel。请查阅超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、修剪头部等)。
该模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用,并参阅 PyTorch 文档以获取所有与通用用法和行为相关的事项。
前向传播
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None input_shape_ids: typing.Optional[torch.Tensor] = None input_pronunciation_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: 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] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。索引可以使用 AutoTokenizer 获得。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 形状词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (
torch.LongTensor
,形状为(batch_size, sequence_length)
) — 发音词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。有关详细信息,请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择范围为[0, 1]
:- 1 表示标记 未被遮蔽,
- 0 表示标记 被遮蔽.
- token_type_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 分段标记索引,指示输入的第一个和第二个部分。索引选择范围为[0, 1]
:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记.
- position_ids (
torch.Tensor
,形状为(batch_size, sequence_length)
, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]
。 - head_mask (
torch.Tensor
,形状为(num_heads,)
或(num_layers, num_heads)
, 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择范围为[0, 1]
:- 1 表示头部 未被遮蔽,
- 0 表示头部 被遮蔽.
- inputs_embeds (
torch.Tensor
,形状为(batch_size, sequence_length, hidden_size)
, 可选) — 可选地,你可以选择直接传入嵌入表示,而不是传入input_ids
。如果你想对如何将input_ids
索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权,这将非常有用。 - start_positions (
torch.Tensor
,形状为(batch_size,)
, 可选) — 用于计算标记分类损失的标注跨度起始位置(索引)的标签。位置将被限制在序列长度(sequence_length
)范围内。序列之外的位置不计入损失计算。 - end_positions (
torch.Tensor
,形状为(batch_size,)
, 可选) — 用于计算标记分类损失的标注跨度结束位置(索引)的标签。位置将被限制在序列长度(sequence_length
)范围内。序列之外的位置不计入损失计算。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。更多详情请参见返回张量中的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详情请参见返回张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 对象而不是普通元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor
元组(如果传入了 return_dict=False
或当 config.return_dict=False
时),包含根据配置 (RoCBertConfig) 和输入而变化的各种元素。
-
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 后的注意力权重,用于计算自注意力头中的加权平均值。
RoCBertForQuestionAnswering 的前向方法,覆盖了 __call__
特殊方法。
尽管前向传播的配方需要在此函数中定义,但之后应调用 Module
实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoCBertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("weiweishi/roc-bert-base-zh")
>>> model = RoCBertForQuestionAnswering.from_pretrained("weiweishi/roc-bert-base-zh")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # 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
>>> round(loss.item(), 2)
...