Transformers 文档
RoCBert
并获得增强的文档体验
开始使用
此模型于 2022-05-27 发布，并于 2022-11-08 添加到 Hugging Face Transformers。
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",
dtype=torch.float16,
device=0
)
pipeline("這家餐廳的拉麵是我[MASK]過的最好的拉麵之")RoCBertConfig
class transformers.RoCBertConfig
< 来源 >( vocab_size = 30522 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 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 use_cache = True pad_token_id = 0 classifier_dropout = None enable_pronunciation = True enable_shape = True pronunciation_embed_dim = 768 pronunciation_vocab_size = 910 shape_embed_dim = 512 shape_vocab_size = 24858 concat_input = True is_decoder = False add_cross_attention = False tie_word_embeddings = 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时相关。 - 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_vocab_size (
int, 可选, 默认为 24858) — RoCBert 模型的字形词汇表大小。定义了调用 RoCBertModel 时传入的input_shape_ids可以表示的不同标记的数量。 - concat_input (
bool, 可选, 默认为True) — 定义了字形嵌入、发音嵌入和词嵌入的合并方式，如果值为 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.configRoCBertTokenizer
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: list[int] | None = None cls_token_id: int | None = None sep_token_id: int | None = None ) → List[int]
通过连接和添加特殊标记，从一个序列或一对序列构建用于序列分类任务的模型输入。BERT 序列的格式如下：
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 源 >( token_ids_0: list token_ids_1: list[int] | None = 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: list[int] | None = None ) → list[int]
为用于序列对分类任务的两个序列创建一个掩码。
此方法根据分词器的配置属性动态构建 token 类型 ID
token_type_ids_pattern: 要使用的模式 ("all_zeros" 或 "bert_style")token_type_ids_include_special_tokens: 在长度计算中是否计入特殊标记
示例
# All zeros pattern (default, used by RoBERTa, BART, etc.)
tokenizer.token_type_ids_pattern = "all_zeros"
# Returns: [0, 0, 0, ...] for both sequences
# BERT-style pattern (first sequence gets 0s, second gets 1s)
tokenizer.token_type_ids_pattern = "bert_style"
# Returns: [0, 0, 0, ..., 1, 1, 1, ...] for sequence pairsRoCBertModel
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 Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源 >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None cache_position: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → 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]。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想对如何将input_ids索引转换为相关向量有比模型内部嵌入查找矩阵更多的控制，这将很有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对编码器输入中的填充标记索引执行注意力操作的掩码。如果模型配置为解码器，则此掩码用于交叉注意力。掩码值选择范围为[0, 1]：- 1 表示 未被掩码 的标记，
- 0 表示 被掩码 的标记。
- past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码前期阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，用户应仅输入形状为(batch_size, unprocessed_length)的未处理input_ids（即没有向模型提供其过去的键值状态的input_ids），而不是形状为(batch_size, sequence_length)的所有input_ids。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - cache_position (形状为
(sequence_length)的torch.Tensor，可选) — 表示输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or 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 (
torch.FloatTensor，形状为(batch_size, hidden_size)) — 序列第一个 token（分类 token）在进一步通过用于辅助预训练任务的层后的最后一个隐藏状态。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层的权重是通过预训练期间的下一句预测（分类）目标来训练的。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueandconfig.add_cross_attention=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.
RoCBertModel 的 forward 方法，会覆盖 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
RoCBertForPreTraining
class transformers.RoCBertForPreTraining
< 源 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForPreTraining) — 包含模型所有参数的模型配置类。使用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoCBert 模型在预训练期间具有对比损失和 masked_lm_loss。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源 >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None attack_input_ids: torch.Tensor | None = None attack_input_shape_ids: torch.Tensor | None = None attack_input_pronunciation_ids: torch.Tensor | None = None attack_attention_mask: torch.Tensor | None = None attack_token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels_input_ids: torch.Tensor | None = None labels_input_shape_ids: torch.Tensor | None = None labels_input_pronunciation_ids: torch.Tensor | None = None labels_attention_mask: torch.Tensor | None = None labels_token_type_ids: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → 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]。 - 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 标记。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组 (如果传入 return_dict=False 或当 config.return_dict=False 时)，包含根据配置 (RoCBertConfig) 和输入而定的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RoCBertForPreTraining 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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
class transformers.RoCBertForCausalLM
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForCausalLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法以加载模型权重。
RoCBert 模型，顶部带有用于 CLM 微调的 语言建模 头。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: list[torch.Tensor] | None = None labels: torch.Tensor | None = None use_cache: bool | None = None cache_position: torch.Tensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or 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表示被掩码的标记。
- past_key_values (
list, 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加快顺序解码。这通常包括模型在解码前一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。只允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，用户应仅输入形状为(batch_size, unprocessed_length)的未处理input_ids（那些未将过去键值状态提供给此模型的输入），而不是形状为(batch_size, sequence_length)的所有input_ids。 - 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)。 - cache_position (形状为
(sequence_length)的torch.Tensor，可选) — 表示输入序列标记在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果是int，则计算最后logits_to_keep个标记的 logits。如果是0，则计算所有input_ids的 logits (特殊情况)。生成时只需要最后一个标记的 logits，仅计算该标记的 logits 可以节省内存，这对于长序列或大词汇量来说非常显著。如果是torch.Tensor，则必须是 1D 的，对应于序列长度维度中要保留的索引。这在使用打包张量格式 (批次和序列长度为单个维度) 时非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or 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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
RoCBertForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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.logitsRoCBertForMaskedLM
class transformers.RoCBertForMaskedLM
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForMaskedLM) — 模型配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法以加载模型权重。
顶部带有 语言建模 头的 Roc Bert 模型。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.MaskedLMOutput or 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表示被掩码的标记。
- labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内 (参见input_ids文档字符串)。索引设置为-100的标记将被忽略 (掩码)，损失仅针对标签在[0, ..., config.vocab_size]范围内的标记进行计算。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 元组 (如果传入 return_dict=False 或当 config.return_dict=False 时)，包含根据配置 (RoCBertConfig) 和输入而定的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RoCBertForMaskedLM 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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 model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForSequenceClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化并不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法以加载模型权重。
RoCBert 模型转换器，顶部带有一个序列分类/回归头（在池化输出之上添加一个线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.SequenceClassifierOutput or 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索引转换为关联向量的方式有更多控制，而不是使用模型的内部嵌入查找矩阵，这会很有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），其中包含根据配置 (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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RoCBertForSequenceClassification 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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).lossRoCBertForMultipleChoice
class transformers.RoCBertForMultipleChoice
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForMultipleChoice) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，仅加载配置。请查阅 from_pretrained() 方法加载模型权重。
Roc Bert 模型，其顶部带有多项选择分类头（池化输出顶部的一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 形状词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 发音词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充 token 索引执行注意力掩码。掩码值选择在[0, 1]之间：- 1 表示 未掩码 的 token，
- 0 表示 已掩码 的 token。
- token_type_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选) — 用于指示输入的第一部分和第二部分的段 token 索引。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传入嵌入表示而不是input_ids。如果你想对如何将 input_ids 索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量第二维的大小。（请参阅上面的input_ids）
返回
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RoCBertForMultipleChoice 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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.logitsRoCBertForTokenClassification
class transformers.RoCBertForTokenClassification
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForTokenClassification) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，仅加载配置。请查阅 from_pretrained() 方法加载模型权重。
Roc Bert 转换器，其顶部带有一个 token 分类头（隐藏状态输出顶部的一个线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 形状词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 发音词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充 token 索引执行注意力掩码。掩码值选择在[0, 1]之间：- 1 表示 未掩码 的 token，
- 0 表示 已掩码 的 token。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于指示输入的第一部分和第二部分的段 token 索引。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，你可以选择直接传入嵌入表示而不是input_ids。如果你想对如何将input_ids索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算 token 分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RoCBertForTokenClassification 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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
class transformers.RoCBertForQuestionAnswering
< source >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (RoCBertForQuestionAnswering) — 模型的配置类，包含模型的所有参数。使用配置文件初始化时不会加载与模型相关的权重，仅加载配置。请查阅 from_pretrained() 方法加载模型权重。
Roc Bert 转换器，其顶部带有一个跨度分类头，用于提取式问答任务，如 SQuAD（隐藏状态输出顶部的一个线性层，用于计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( input_ids: torch.Tensor | None = None input_shape_ids: torch.Tensor | None = None input_pronunciation_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None start_positions: torch.Tensor | None = None end_positions: torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词汇表中输入序列 token 的索引。默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_shape_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 形状词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_pronunciation_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 发音词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充 token 索引执行注意力掩码。掩码值选择在[0, 1]之间：- 1 表示 未掩码 的 token，
- 0 表示 已掩码 的 token。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于指示输入的第一部分和第二部分的段 token 索引。索引选择在[0, 1]之间：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，你可以选择直接传入嵌入表示而不是input_ids。如果你想对如何将input_ids索引转换为关联向量拥有比模型内部嵌入查找矩阵更多的控制权，这将非常有用。 - start_positions (形状为
(batch_size,)的torch.Tensor，可选) — 用于计算 token 分类损失的已标注跨度起始位置（索引）的标签。位置被限制为序列的长度（sequence_length）。序列之外的位置不计入损失计算。 - end_positions (形状为
(batch_size,)的torch.Tensor，可选) — 用于计算 token 分类损失的已标注跨度结束位置（索引）的标签。位置被限制为序列的长度（sequence_length）。序列之外的位置不计入损失计算。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），其中包含根据配置 (RoCBertConfig) 和输入而定的各种元素。
-
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RoCBertForQuestionAnswering 的前向方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
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)
...