RoFormer
概述
RoFormer 模型由苏剑林、于露、潘胜锋、文波和刘云峰在RoFormer: Enhanced Transformer with Rotary Position Embedding中提出。
论文摘要如下
Transformer 架构中的位置编码为序列中不同位置的元素之间的依赖关系建模提供了监督。我们研究了在基于 Transformer 的语言模型中对位置信息进行编码的各种方法，并提出了一种名为旋转位置嵌入 (RoPE) 的新实现。提议的 RoPE 使用旋转矩阵对绝对位置信息进行编码，并在自注意力公式中自然地整合了显式的相对位置依赖关系。值得注意的是，RoPE 具有宝贵的特性，例如可以扩展到任何序列长度的灵活性，随着相对距离的增加而衰减的令牌间依赖关系，以及为线性自注意力配备相对位置编码的能力。因此，配备旋转位置嵌入的增强型 Transformer，即 RoFormer，在长文本任务中取得了优异的性能。我们发布了理论分析以及一些中文数据的初步实验结果。英文基准的正在进行的实验将很快更新。
使用技巧
RoFormer 是一种类似 BERT 的自动编码模型，具有旋转位置嵌入。旋转位置嵌入在使用长文本的分类任务中显示出改进的性能。
资源
RoFormerConfig
class transformers.RoFormerConfig
< 源代码 >( vocab_size = 50000 embedding_size = None 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 = 1536 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 rotary_value = False use_cache = True **kwargs )
参数
- 词汇量 (
int, optional, defaults to 50000) — RoFormer 模型的词汇量。定义调用 RoFormerModel 或 TFRoFormerModel 时，可以通过inputs_ids表示的不同词元的数量。 - 嵌入尺寸 (
int, optional, defaults to None) — 编码器层和池化层的维度。如果未提供，则默认为hidden_size。 - 隐藏尺寸 (
int, optional, defaults to 768) — 编码器层和池化层的维度。 - 隐藏层数量 (
int, optional, defaults to 12) — Transformer 编码器中的隐藏层数量。 - 注意力头数量 (
int, optional, defaults to 12) — Transformer 编码器中每个注意力层的注意力头数量。 - 中间尺寸 (
int, optional, defaults to 3072) — Transformer 编码器中“中间”（即前馈）层的维度。 - 隐藏激活函数 (
strorfunction, optional, defaults to"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - 隐藏层丢弃率 (
float, optional, defaults to 0.1) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。 - 注意力概率丢弃率 (
float, optional, defaults to 0.1) — 注意力概率的丢弃率。 - 最大位置嵌入 (
int, optional, defaults to 1536) — 此模型可能使用的最大序列长度。通常将其设置为一个较大的值以防万一（例如 512 或 1024 或 1536）。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 层归一化层使用的epsilon。 - is_decoder (
bool, optional, defaults toFalse) — 模型是否用作解码器。如果为False，则模型用作编码器。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应该返回最后的键值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - rotary_value (
bool, optional, defaults toFalse) — 是否在值层应用旋转位置嵌入。
这是一个用于存储 RoFormerModel 配置的配置类。它用于根据指定的参数实例化一个 RoFormer 模型，定义模型架构。使用默认值实例化配置将生成与 RoFormer junnyu/roformer_chinese_base 架构类似的配置。
配置对象继承自 PretrainedConfig 并且可以用来控制模型输出。阅读 PretrainedConfig 的文档以了解更多信息。
示例
>>> from transformers import RoFormerModel, RoFormerConfig
>>> # Initializing a RoFormer junnyu/roformer_chinese_base style configuration
>>> configuration = RoFormerConfig()
>>> # Initializing a model (with random weights) from the junnyu/roformer_chinese_base style configuration
>>> model = RoFormerModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configRoFormerTokenizer
class transformers.RoFormerTokenizer
< source >( vocab_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 )
参数
- vocab_file (
str) — 包含词汇表的的文件。 - do_lower_case (
bool, optional, defaults toTrue) — 是否在标记化时将输入转换为小写。 - do_basic_tokenize (
bool, optional, defaults toTrue) — 是否在 WordPiece 之前执行基本分词。 - never_split (
Iterable, optional) — 分词时永远不会被拆分的标记集合。仅在do_basic_tokenize=True时有效。 - unk_token (
str, optional, defaults to"[UNK]") — 未知标记。不在词汇表中的标记无法转换为 ID，而是设置为此标记。 - sep_token (
str, optional, defaults to"[SEP]") — 分隔符标记，用于从多个序列构建序列，例如序列分类的两个序列或问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - pad_token (
str, optional, defaults to"[PAD]") — 用于填充的标记，例如在对不同长度的序列进行批处理时。 - cls_token (
str, optional, defaults to"[CLS]") — 分类标记，用于执行序列分类（对整个序列进行分类而不是对每个标记进行分类）。它是使用特殊标记构建的序列的第一个标记。 - mask_token (
str, optional, defaults to"[MASK]") — 用于屏蔽值的标记。这是在使用掩码语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。 - tokenize_chinese_chars (
bool, optional, defaults toTrue) — 是否对中文汉字进行分词。这很可能应该为日语停用（参见此 issue）。
- strip_accents (
bool, optional) — 是否去除所有音调符号。如果没有指定此选项，则它将由lowercase的值确定（与原始 BERT 中一样）。
构建 RoFormer 分词器。基于 Rust Jieba.
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
示例
>>> from transformers import RoFormerTokenizer
>>> tokenizer = RoFormerTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> tokenizer.tokenize("今天天气非常好。")
['今', '天', '天', '气', '非常', '好', '。']build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None )
通过连接和添加特殊标记，从序列或序列对中构建用于序列分类任务的模型输入。RoFormer 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< 源代码 >( token_ids_0: List token_ids_1: Optional = 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: Optional = None )
从传递的两个序列中创建掩码，用于序列对分类任务。RoFormer
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0s）。
RoFormerTokenizerFast
class transformers.RoFormerTokenizerFast
< source >( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )
构建一个“快速”RoFormer分词器（由 HuggingFace 的 tokenizers 库支持）。
RoFormerTokenizerFast 与 BertTokenizerFast 几乎完全相同，并执行端到端的词条化：标点符号分割和词片段。它们在对中文进行词条化时存在一些差异。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
示例
>>> from transformers import RoFormerTokenizerFast
>>> tokenizer = RoFormerTokenizerFast.from_pretrained("junnyu/roformer_chinese_base")
>>> tokenizer.tokenize("今天天气非常好。")
['今', '天', '天', '气', '非常', '好', '。']build_inputs_with_special_tokens
< source >( token_ids_0 token_ids_1 = None ) → List[int]
通过连接和添加特殊标记，从序列或序列对中构建用于序列分类任务的模型输入。RoFormer 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
RoFormerModel
class transformers.RoFormerModel
< source >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 请查看 from_pretrained() 方法来加载模型权重。
RoFormer 模型的基础转换器，输出原始隐藏状态，没有任何特定的头部。 此模型是 PyTorch torch.nn.Module 的子类。 将它用作常规 PyTorch 模块，并参考 PyTorch 文档以了解所有与一般用法和行为相关的事项。
该模型可以充当编码器（仅使用自注意力机制）或解码器，在解码器的情况下，在自注意力层之间添加一层交叉注意力层，遵循 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 作为输入。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 用于避免在填充标记索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 未掩码 的标记，
- 0 表示 掩码 的标记。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段标记索引。 索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的头部无效的掩码。 掩码值在[0, 1]中选择：- 1 表示 未掩码 的头部，
- 0 表示 掩码 的头部。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果你想更精确地控制如何将 input_ids 索引转换为关联的向量，而不是模型的内部嵌入查找矩阵，这很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, optional) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - encoder_hidden_states (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于避免对编码器输入的填充令牌索引执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。在[0, 1]中选择掩码值：- 1 表示 **未掩码** 的令牌，
- 0 表示 **掩码** 的令牌。
- past_key_values (
tuple(tuple(torch.FloatTensor))of lengthconfig.n_layerswith each tuple having 4 tensors of shape(batch_size, num_heads, sequence_length - 1, embed_size_per_head)) — 包含预先计算的注意力块的关键和值隐藏状态。可用于加速解码。如果使用past_key_values，则用户可以选择性地仅输入最后一个decoder_input_ids（其 past key value 状态未提供给此模型）的形状(batch_size, 1)，而不是所有decoder_input_ids的形状(batch_size, sequence_length)。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。
返回
transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（RoFormerConfig）和输入的各种元素。
-
last_hidden_state (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), optional, returned whenuse_cache=Trueis passed or whenconfig.use_cache=True) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量，并且如果config.is_encoder_decoder=True，则可以选择性地包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块中的键和值，以及如果
config.is_encoder_decoder=True，则可选地在交叉注意力块中），可用于（请参阅past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.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) —torch.FloatTensor的元组（每层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
The RoFormerModel 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoFormerModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerModel.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateRoFormerForCausalLM
class transformers.RoFormerForCausalLM
< 源代码 >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型相关的权重，只会加载配置。 查看 from_pretrained() 方法加载模型权重。
带有语言建模头部的 RoFormer 模型，用于 CLM 微调。 该模型是 PyTorch torch.nn.Module 子类。 将其用作普通的 PyTorch 模块，并参考 PyTorch 文档了解所有与一般使用和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列 token 在词汇表中的索引。可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 用于避免对填充 token 索引执行注意力的掩码。 掩码值从[0, 1]中选择：- 1 表示 未被掩码 的 token，
- 0 表示 被掩码 的 token。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引从[0, 1]中选择：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。 掩码值从[0, 1]中选择：- 1 表示 未被掩码 的头部，
- 0 表示 被掩码 的头部。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联的向量，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - encoder_hidden_states (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出处的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充令牌索引执行注意力的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。在[0, 1]中选择掩码值：- 1 用于未被屏蔽的令牌，
- 0 用于被屏蔽的令牌。
- past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有为此模型提供其过去键值状态的decoder_input_ids）而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算从左到右的语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的令牌将被忽略（屏蔽），损失仅针对标签在[0, ..., config.vocab_size]中的令牌计算。 - use_cache (
bool, 可选) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (RoFormerConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 语言建模损失（用于下一个词预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇量令牌的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.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 (
tuple(tuple(torch.FloatTensor)), 可选，当传入use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的torch.FloatTensor元组的元组，每个元组包含自注意力层和交叉注意力层的缓存键、值状态（如果模型用于编码器-解码器设置）。仅当config.is_decoder = True时才相关。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
RoFormerForCausalLM 的正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoFormerForCausalLM, RoFormerConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> config = RoFormerConfig.from_pretrained("junnyu/roformer_chinese_base")
>>> config.is_decoder = True
>>> model = RoFormerForCausalLM.from_pretrained("junnyu/roformer_chinese_base", config=config)
>>> inputs = tokenizer("今天天气非常好。", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsRoFormerForMaskedLM
class transformers.RoFormerForMaskedLM
< source >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文.件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
RoFormer 模型，顶部带有 语言建模 头。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充令牌索引执行注意力。在[0, 1]中选择的掩码值：- 1 用于未掩码的令牌，
- 0 用于掩码的令牌。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 段令牌索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 令牌，
- 1 对应于句子 B 令牌。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定头的无效掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩码，
- 0 表示头被掩码。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，除了传递input_ids，你可以选择直接传递嵌入表示。如果你希望比模型的内部嵌入查找矩阵对如何将input_ids 索引转换为相关向量有更多控制权，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置的各种元素 (RoFormerConfig) 和输入。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇量令牌的分数）。 -
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor的元组（每层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The RoFormerForMaskedLM 前向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoFormerForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerForMaskedLM.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)RoFormerForSequenceClassification
class transformers.RoFormerForSequenceClassification
< source >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
RoFormer 模型转换器，顶部有一个序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力操作。掩码值选择在[0, 1]中：- 1 表示未掩码的标记
- 0 表示掩码的标记
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于 句子 A 标记
- 1 对应于 句子 B 标记
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 掩码，用于使自注意力模块中选定的头部无效。掩码值选择在[0, 1]中：- 1 表示头部未掩码
- 0 表示头部已掩码
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将 input_ids 索引转换为关联向量进行更多控制（比模型的内部嵌入查找矩阵更灵活），这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含根据配置 (RoFormerConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 分类（或如果 config.num_labels==1 则为回归）损失。 -
logits (
torch.FloatTensor形状为(batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor的元组（每层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The RoFormerForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, RoFormerForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerForSequenceClassification.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = RoFormerForSequenceClassification.from_pretrained("junnyu/roformer_chinese_base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, RoFormerForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerForSequenceClassification.from_pretrained("junnyu/roformer_chinese_base", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = RoFormerForSequenceClassification.from_pretrained(
... "junnyu/roformer_chinese_base", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossRoFormerForMultipleChoice
class transformers.RoFormerForMultipleChoice
< source >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
RoFormer 模型，顶部有一个多选分类头（在池化输出的顶部有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.FloatTensor形状为(batch_size, num_choices, sequence_length)，可选) — 掩码，以避免对填充标记索引执行注意力。掩码值选择在[0, 1]中：- 1 用于未掩码的标记，
- 0 用于掩码的标记。
- token_type_ids (
torch.LongTensor形状为(batch_size, num_choices, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块中选定的头部设置为零的掩码。掩码值在[0, 1]中选择：- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，您可以在不传递input_ids的情况下选择直接传递嵌入表示。如果您想更好地控制如何将 input_ids 索引转换为关联向量，而不是模型内部的嵌入查找矩阵，那么这将很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算多选分类损失的标签。索引应在[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 时），包含根据配置 (RoFormerConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为 (1,)，可选，在提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（见上面的 input_ids）。分类得分（在 SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor的元组（每层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The RoFormerForMultipleChoice 正向方法，重写 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoFormerForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerForMultipleChoice.from_pretrained("junnyu/roformer_chinese_base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsRoFormerForTokenClassification
class transformers.RoFormerForTokenClassification
< 源代码 >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
RoFormer 模型，在其上有一个标记分类头部（隐藏状态输出之上的线性层），例如用于命名实体识别 (NER) 任务。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有事项。
The RoFormerForTokenClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoFormerForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerForTokenClassification.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).lossRoFormerForQuestionAnswering
class transformers.RoFormerForQuestionAnswering
< source >( config )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
RoFormer 模型，在顶部有一个跨度分类头，用于提取式问答任务，例如 SQuAD（在隐藏状态输出之上进行线性层计算，以计算 span start logits 和 span end logits）。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般使用和行为的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免对填充标记索引执行注意的掩码。在[0, 1]中选择掩码值：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一个和第二个部分的段标记索引。索引在[0, 1]中选择：- 0 对应于一个 句子 A 标记，
- 1 对应于一个 句子 B 标记。
- head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩盖，
- 0 表示头被掩盖。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将 input_ids 索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制，这将很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。 - start_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。 - end_positions (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列之外的位置不会被考虑用于计算损失。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (RoFormerConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 总跨度提取损失是跨度开始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 跨度开始分数（在 SoftMax 之前）。 -
end_logits (
torch.FloatTensor形状为(batch_size, sequence_length)) — 跨度结束分数（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), optional, returned whenoutput_hidden_states=Trueis passed or whenconfig.output_hidden_states=True) —torch.FloatTensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，加上每个层的输出）的形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) —torch.FloatTensor的元组（每层一个）的形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The RoFormerForQuestionAnswering forward 方法，重写了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, RoFormerForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = RoFormerForQuestionAnswering.from_pretrained("junnyu/roformer_chinese_base")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.lossTFRoFormerModel
class transformers.TFRoFormerModel
< source >( config: RoFormerConfig *inputs **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
RoFormer 模型的裸模型，输出原始隐藏状态，顶部没有特定头部。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,List[tf.Tensor]`Dict[str, tf.Tensor]或Dict[str, np.ndarray]，每个示例的形状必须为(batch_size, sequence_length)) — 输入序列词元的词表索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可选) — 掩码，以避免对填充词元索引执行注意力。[0, 1]中选择掩码值：- 1 表示未屏蔽的词元，
- 0 表示屏蔽的词元。
- token_type_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- head_mask (
np.ndarray或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]中：- 1 表示头部 未被掩码，
- 0 表示头部 被掩码。
- inputs_embeds (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量有更多控制权，而不是模型的内部嵌入查找矩阵，这很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput，而不是一个简单的元组。此参数可以在急切模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认值为 `False“) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPooling 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置的各种元素 (RoFormerConfig) 和输入。
-
last_hidden_state (
tf.Tensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (
tf.Tensor形状为(batch_size, hidden_size)) — 序列的第一个标记（分类标记）的最后一层隐藏状态，通过线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间从下一个句子预测（分类）目标中训练得到。此输出通常 不是 输入语义内容的良好总结，对于整个输入序列，您通常更好地使用隐藏状态序列的平均值或池化。
-
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFRoFormerModel 正向方法，重写了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRoFormerModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerModel.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFRoFormerForMaskedLM
class transformers.TFRoFormerForMaskedLM
< 源代码 >( config: RoFormerConfig *inputs **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
带有 language modeling 头的 RoFormer 模型。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,List[tf.Tensor]`Dict[str, tf.Tensor]或Dict[str, np.ndarray]并且每个示例必须具有形状(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 。
- attention_mask (形状为
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可选) — 避免对填充标记索引执行注意力的掩码。在[0, 1]中选择掩码值：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可选) — 掩码，用于使自注意力模块的选定头无效。在[0, 1]中选择掩码值：- 1 表示头未掩码，
- 0 表示头已掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的np.ndarray或tf.Tensor，可选) — 可选地，您可以选择直接传递嵌入式表示，而不是传递input_ids。如果您想更精确地控制如何将input_ids索引转换为关联的向量，而不是模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。此参数只能在急切模式下使用，在图模式下，将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。此参数只能在急切模式下使用，在图模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在急切模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, 可选，默认为 `False“) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor或np.ndarray形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]中（请参阅input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。
返回
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置 (RoFormerConfig) 和输入的各种元素。
-
loss (
tf.Tensor形状为(n,)，可选，其中 n 是非掩码标签的数量，在提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFRoFormerForMaskedLM 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRoFormerForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerForMaskedLM.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # retrieve index of [MASK]
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)
>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)TFRoFormerForCausalLM
class transformers.TFRoFormerForCausalLM
< source >( config: RoFormerConfig *inputs **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有 语言建模 头部的 RoFormer 模型，用于 CLM 微调。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutput or tuple(tf.Tensor)
返回
transformers.modeling_tf_outputs.TFCausalLMOutput or tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (RoFormerConfig) 和输入的不同元素。
-
loss (
tf.Tensor形状为(n,)，可选，其中 n 是非掩码标签的数量，在提供labels时返回) — 语言建模损失（用于下一个词预测）。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
labels (tf.Tensor 或 np.ndarray 形状为 (batch_size, sequence_length)，可选)：用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 中。
示例
>>> from transformers import AutoTokenizer, TFRoFormerForCausalLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerForCausalLM.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFRoFormerForSequenceClassification
class transformers.TFRoFormerForSequenceClassification
< source >( config: RoFormerConfig *inputs **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
RoFormer 模型转换器，在其之上有一个序列分类/回归头部，例如，用于 GLUE 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,List[tf.Tensor]`Dict[str, tf.Tensor]orDict[str, np.ndarray]and each example must have the shape(batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码，以避免对填充令牌索引执行注意力。在[0, 1]中选择的掩码值：- 1 表示未掩码的令牌，
- 0 表示掩码的令牌。
- token_type_ids (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length), *可选*) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- head_mask (
np.ndarray或tf.Tensor形状为(num_heads,)或(num_layers, num_heads), *可选*) — 掩码以使自注意力模块的选定头无效。掩码值在[0, 1]中选择：- 1 表示头未被掩盖，
- 0 表示头被掩盖。
- inputs_embeds (
np.ndarray或tf.Tensor形状为(batch_size, sequence_length, hidden_size), *可选*) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵对如何将input_ids索引转换为关联向量有更多控制权，这将非常有用。 - output_attentions (
bool, *可选*) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool, *可选*) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool, *可选*) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可以在急切模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool, *可选*, 默认值为 `False“) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor或np.ndarray形状为(batch_size,), *可选*) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (RoFormerConfig) 和输入的各种元素。
-
loss (
tf.Tensor形状为(batch_size, ), *可选*, 当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
tf.Tensor形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFRoFormerForSequenceClassification 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRoFormerForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerForSequenceClassification.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])>>> # 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 = TFRoFormerForSequenceClassification.from_pretrained("junnyu/roformer_chinese_base", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).lossTFRoFormerForMultipleChoice
class transformers.TFRoFormerForMultipleChoice
< 源代码 >( config: RoFormerConfig *inputs **kwargs )
参数
- 配置 (RoFormerConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看from_pretrained() 方法以加载模型权重。
RoFormer 模型，顶部有一个多选分类头（在池化输出的顶部有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,List[tf.Tensor]`Dict[str, tf.Tensor]或Dict[str, np.ndarray]，每个示例必须具有形状(batch_size, num_choices, sequence_length)) — 输入序列词元的词典索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 获取详细信息。
- attention_mask (形状为
(batch_size, num_choices, sequence_length)的np.ndarray或tf.Tensor，可选) — 用于避免对填充词元索引执行注意的掩码。掩码值选择在[0, 1]中：- 1 用于未掩码的词元，
- 0 用于掩码的词元。
- token_type_ids (形状为
(batch_size, num_choices, sequence_length)的np.ndarray或tf.Tensor，可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A 词元，
- 1 对应于句子 B 词元。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可选) — 用于使自注意力模块的选定头部失效的掩码。掩码值选择在[0, 1]中：- 1 表示头部未掩码，
- 0 表示头部掩码。
- inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的np.ndarray或tf.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为相关向量（而不是模型的内部嵌入查找矩阵）有更多控制，这将很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可以在渴望模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool, 可选，默认值为 `False“) — 是否在训练模式下使用模型（一些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor或np.ndarray形状为(batch_size,), 可选) — 用于计算多选分类损失的标签。索引应在[0, ..., num_choices]中，其中num_choices是输入张量的第二维的大小。（参见上面的input_ids）
返回
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（RoFormerConfig）和输入的各种元素。
-
loss (
tf.Tensor形状为 (batch_size, ), 可选，在提供labels时返回) — 分类损失。 -
logits (
tf.Tensor形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（参见上面的 input_ids）。分类得分（在 SoftMax 之前）。
-
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFRoFormerForMultipleChoice 前向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRoFormerForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerForMultipleChoice.from_pretrained("junnyu/roformer_chinese_base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFRoFormerForTokenClassification
class transformers.TFRoFormerForTokenClassification
< source >( config: RoFormerConfig *inputs **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
RoFormer 模型，在其上有一个标记分类头部（隐藏状态输出之上的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFTokenClassifierOutput or tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,List[tf.Tensor]`Dict[str, tf.Tensor]orDict[str, np.ndarray]and each example must have the shape(batch_size, sequence_length)) — 输入序列词语在词汇表中的索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
np.ndarrayortf.Tensorof shape(batch_size, sequence_length), optional) — 掩码以避免对填充词语索引执行注意力。掩码值在[0, 1]中选择：- 1 表示 **不掩码** 的词语，
- 0 表示 **掩码** 的词语。
- token_type_ids (
np.ndarrayortf.Tensorof shape(batch_size, sequence_length), optional) — 分段词语索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 表示 句子 A 词语，
- 1 表示 句子 B 词语。
- head_mask (
np.ndarrayortf.Tensorof shape(num_heads,)or(num_layers, num_heads), optional) — 掩码以使自注意力模块中选定的头部无效。掩码值在[0, 1]中选择：- 1 表示头部 **不掩码**，
- 0 表示头部 **掩码**。
- inputs_embeds (
np.ndarrayortf.Tensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想对如何将input_ids索引转换为关联的向量有更多控制权，而不是模型的内部嵌入查找矩阵，这将很有用。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。此参数仅可在渴望模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。此参数仅可在渴望模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。此参数可用于 eager 模式，在 graph 模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认值为 `False“) — 是否以训练模式使用模型（某些模块，例如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor或np.ndarray形状为(batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
返回
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）包括根据配置 (RoFormerConfig) 和输入的不同元素。
-
loss (
tf.Tensor形状为(n,), 可选, 其中 n 是未掩盖标签的数量，当提供labels时返回) — 分类损失。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFRoFormerForTokenClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRoFormerForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerForTokenClassification.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-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] for t in predicted_token_class_ids[0].numpy().tolist()]TFRoFormerForQuestionAnswering
class transformers.TFRoFormerForQuestionAnswering
< 源代码 >( config: RoFormerConfig *inputs **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
RoFormer 模型，顶部有一个跨度分类头，用于提取式问答任务，如 SQuAD（隐藏状态输出顶部的线性层，用于计算 跨度开始 logits 和 跨度结束 logits）。
此模型继承自 TFPreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 keras.Model 子类。将其用作常规的 TF 2.0 Keras 模型，并参考 TF 2.0 文档，了解与一般使用和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（如 PyTorch 模型），或
- 将所有输入作为列表、元组或字典放在第一个位置参数中。
支持第二种格式的原因是，Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于此支持，在使用 model.fit() 之类的 方法时，事情应该“正常工作” - 只需按 model.fit() 支持的任何格式传递输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，可以使用三种可能性将所有输入张量收集到第一个位置参数中
- 一个包含
input_ids且没有其他内容的单个张量：model(input_ids) - 一个长度可变的列表，其中包含一个或多个输入张量，按文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中一个或多个输入张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些，因为您可以像传递给任何其他 Python 函数一样传递输入！
call
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
np.ndarray,tf.Tensor,List[tf.Tensor]`Dict[str, tf.Tensor]或Dict[str, np.ndarray]，每个样本必须具有形状(batch_size, sequence_length)) — 输入序列标记在词典中的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (形状为
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可选) — 掩码以避免对填充标记索引执行注意力操作。在[0, 1]中选择掩码值：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的np.ndarray或tf.Tensor，可选) — 分割标记索引以指示输入的第一部分和第二部分。在[0, 1]中选择索引：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- head_mask (形状为
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可选) — 掩码以使自注意力模块的选定头部无效。在[0, 1]中选择掩码值：- 1 表示未屏蔽的头部，
- 0 表示屏蔽的头部。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的np.ndarray或tf.Tensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望对如何将input_ids索引转换为关联向量（而不是模型的内部嵌入查找矩阵）有更多控制权，这将很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量中的attentions。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量中的hidden_states。此参数只能在急切模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是简单的元组。此参数可以在急切模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool，可选，默认值为 `False“) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (RoFormerConfig) 和输入而变化的各种元素。
-
loss (
tf.Tensor形状为(batch_size, ), 可选，在提供start_positions和end_positions时返回) — 跨度提取总损失是开始和结束位置交叉熵的总和。 -
start_logits (
tf.Tensor形状为(batch_size, sequence_length)) — 跨度开始分数（在 SoftMax 之前）。 -
end_logits (
tf.Tensor形状为(batch_size, sequence_length)) — 跨度结束分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可选, 返回时output_hidden_states=True传递或当config.output_hidden_states=True) —tf.Tensor的元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), 可选, 返回时output_attentions=True传递或当config.output_attentions=True) —tf.Tensor的元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The TFRoFormerForQuestionAnswering 前向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRoFormerForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = TFRoFormerForQuestionAnswering.from_pretrained("junnyu/roformer_chinese_base")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]FlaxRoFormerModel
class transformers.FlaxRoFormerModel
< source >( config: RoFormerConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选，默认值为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定了所有计算将使用给定的
dtype执行。注意，这仅指定计算的 dtype，不会影响模型参数的 dtype。
不带任何特定头部，输出原始隐藏状态的裸 RoFormer 模型变压器。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载、保存和从 PyTorch 模型转换权重）。
此模型也是一个 flax.linen.Module 子类。将其用作常规 Flax linen 模块，并参考 Flax 文档以了解与一般使用和行为相关的所有事项。
最后，此模型支持 JAX 的固有功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 词汇表中输入序列词元的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充词元索引执行注意力。掩码值在[0, 1]中选择：- 1 表示 未掩码 的词元，
- 0 表示 已掩码 的词元。
- token_type_ids (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 段词元索引，指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 词元，
- 1 对应于 句子 B 词元。
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列词元的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 掩码以使注意力模块的选定头部无效。掩码值在[0, 1]` 中选择：- 1 表示头部 未掩码，
- 0 表示头部 已掩码。
- return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
返回
transformers.modeling_flax_outputs.FlaxBaseModelOutput or tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包括根据配置 (RoFormerConfig) 和输入的不同元素。
-
last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。 -
hidden_states (
tuple(jnp.ndarray)，可选，在传递了output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，在传递了output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRoFormerPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRoFormerModel
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = FlaxRoFormerModel.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxRoFormerForMaskedLM
class transformers.FlaxRoFormerForMaskedLM
< source >( config: RoFormerConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法加载模型权重。
- dtype (
jax.numpy.dtype, optional, defaults tojax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不会影响模型参数的 dtype。
带有 language modeling 头的 RoFormer 模型。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载、保存和从 PyTorch 模型转换权重）。
此模型也是一个 flax.linen.Module 子类。将其用作常规 Flax linen 模块，并参考 Flax 文档以了解与一般使用和行为相关的所有事项。
最后，此模型支持 JAX 的固有功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), optional) — 掩码以避免对填充词元索引执行注意力。在[0, 1]中选择掩码值：- 1 表示未屏蔽的词元，
- 0 表示已屏蔽的词元。
- token_type_ids (
numpy.ndarray形状为(batch_size, sequence_length), optional) — 段词元索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 词元，
- 1 对应于句子 B 词元。
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length), optional) — 输入序列词元在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
numpy.ndarray形状为(batch_size, sequence_length)，可选) -- 用于使注意力模块的特定头部失效的掩码。掩码值在[0, 1]中选择：- 1 表示头部 **未被掩码**，
- 0 表示头部 **被掩码**。
- return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (RoFormerConfig) 和输入的不同元素。
-
logits (
jnp.ndarray形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇表标记的分数）。 -
hidden_states (
tuple(jnp.ndarray)，可选，在传递了output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，在传递了output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRoFormerPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRoFormerForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = FlaxRoFormerForMaskedLM.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxRoFormerForSequenceClassification
class transformers.FlaxRoFormerForSequenceClassification
< 源代码 >( config: RoFormerConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选，默认为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
RoFormer 模型转换器，顶部有一个序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载、保存和从 PyTorch 模型转换权重）。
此模型也是一个 flax.linen.Module 子类。将其用作常规 Flax linen 模块，并参考 Flax 文档以了解与一般使用和行为相关的所有事项。
最后，此模型支持 JAX 的固有功能，例如
__call__
< 源代码 >( input_ids attention_mask = None token_type_ids = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
- token_type_ids (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length)，可选) — 输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
numpy.ndarray形状为(batch_size, sequence_length)，可选) -- 掩码以使注意力模块的选定头部无效。掩码值在[0, 1]` 中选择：- 1 表示头部未屏蔽，
- 0 表示头部屏蔽。
- return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (RoFormerConfig) 和输入。
-
logits (
jnp.ndarray形状为(batch_size, config.num_labels)) — 分类（或如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray)，可选，在传递了output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，在传递了output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRoFormerPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRoFormerForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = FlaxRoFormerForSequenceClassification.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxRoFormerForMultipleChoice
class transformers.FlaxRoFormerForMultipleChoice
< source >( config: RoFormerConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype，可选，默认值为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）之一。这可以用来启用混合精度训练或半精度推理在 GPU 或 TPU 上。如果指定，所有计算将使用给定的
dtype执行。注意，这仅指定计算的 dtype，不会影响模型参数的 dtype。
RoFormer 模型，顶部有一个多选分类头（在池化输出的顶部有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载、保存和从 PyTorch 模型转换权重）。
此模型也是一个 flax.linen.Module 子类。将其用作常规 Flax linen 模块，并参考 Flax 文档以了解与一般使用和行为相关的所有事项。
最后，此模型支持 JAX 的固有功能，例如
__call__
< 源代码 >( input_ids attention_mask = None token_type_ids = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- attention_mask (
numpy.ndarray形状为(batch_size, num_choices, sequence_length), 可选) — 用于避免对填充标记索引执行注意的掩码。掩码值在[0, 1]中选择：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (
numpy.ndarray形状为(batch_size, num_choices, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
numpy.ndarray形状为(batch_size, num_choices, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
numpy.ndarray形状为(batch_size, num_choices, sequence_length),可选） — 用于将注意力模块的选定头部归零的掩码。掩码值在[0, 1]` 中选择：- 1 表示未掩码的头部，
- 0 表示掩码的头部。
- return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
返回
transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput or tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (RoFormerConfig) 和输入的各种元素。
-
logits (
jnp.ndarray形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。（见上文中的input_ids）。分类得分（在 SoftMax 之前）。
-
hidden_states (
tuple(jnp.ndarray)，可选，在传递了output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，在传递了output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRoFormerPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRoFormerForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = FlaxRoFormerForMultipleChoice.from_pretrained("junnyu/roformer_chinese_base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})
>>> logits = outputs.logitsFlaxRoFormerForTokenClassification
class transformers.FlaxRoFormerForTokenClassification
< 源代码 >( config: RoFormerConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype, 可选, 默认值jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16（在 GPU 上）和jax.numpy.bfloat16（在 TPU 上）。这可以用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
RoFormer 模型，在其上有一个标记分类头部（隐藏状态输出之上的线性层），例如用于命名实体识别 (NER) 任务。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载、保存和从 PyTorch 模型转换权重）。
此模型也是一个 flax.linen.Module 子类。将其用作常规 Flax linen 模块，并参考 Flax 文档以了解与一般使用和行为相关的所有事项。
最后，此模型支持 JAX 的固有功能，例如
__call__
< 源代码 >( input_ids attention_mask = None token_type_ids = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列词元的词汇索引。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码，以避免对填充词元索引执行注意力。掩码值选择在[0, 1]中：- 1 表示未掩码的词元，
- 0 表示掩码的词元。
- token_type_ids (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 段词元索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A 词元，
- 1 对应于句子 B 词元。
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 输入序列词元在位置嵌入中的位置索引。选择在范围[0, config.max_position_embeddings - 1]中。 - head_mask (
numpy.ndarray形状为(batch_size, sequence_length),可选) -- 用于使注意力模块中选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部未被掩码。
- 0 表示头部被掩码。
- return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
返回
transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时)，包含取决于配置 (RoFormerConfig) 和输入的不同元素。
-
logits (
jnp.ndarray形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（在 SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray)，可选，在传递了output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，在传递了output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRoFormerPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRoFormerForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = FlaxRoFormerForTokenClassification.from_pretrained("junnyu/roformer_chinese_base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxRoFormerForQuestionAnswering
class transformers.FlaxRoFormerForQuestionAnswering
< source >( config: RoFormerConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (RoFormerConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
- dtype (
jax.numpy.dtype, 可选，默认值为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16(在 GPU 上) 和jax.numpy.bfloat16(在 TPU 上) 之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
RoFormer 模型，在顶部有一个跨度分类头，用于提取式问答任务，例如 SQuAD（在隐藏状态输出之上进行线性层计算，以计算 span start logits 和 span end logits）。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载、保存和从 PyTorch 模型转换权重）。
此模型也是一个 flax.linen.Module 子类。将其用作常规 Flax linen 模块，并参考 Flax 文档以了解与一般使用和行为相关的所有事项。
最后，此模型支持 JAX 的固有功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None head_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。索引可以使用 AutoTokenizer 获取。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 表示句子 A标记，
- 1 表示句子 B标记。
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 输入序列标记在位置嵌入中的位置索引。选择在范围[0, config.max_position_embeddings - 1]中。 - head_mask (
numpy.ndarray形状为(batch_size, sequence_length),可选) -- 用于使注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]` 中：- 1 表示头部未被掩码，
- 0 表示头部被掩码。
- return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通元组。
返回
transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），包含取决于配置 (RoFormerConfig) 和输入的不同元素。
-
start_logits (
jnp.ndarray形状为(batch_size, sequence_length)) — 跨度开始分数（在 SoftMax 之前）。 -
end_logits (
jnp.ndarray形状为(batch_size, sequence_length)) — 跨度结束分数（在 SoftMax 之前）。 -
hidden_states (
tuple(jnp.ndarray)，可选，在传递了output_hidden_states=True或config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray)，可选，在传递了output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRoFormerPreTrainedModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRoFormerForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("junnyu/roformer_chinese_base")
>>> model = FlaxRoFormerForQuestionAnswering.from_pretrained("junnyu/roformer_chinese_base")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")
>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits