Transformers 文档
RoBERTa
并获得增强的文档体验
开始使用
RoBERTa
RoBERTa通过新的预训练目标改进了 BERT，证明了BERT训练不足，并且训练设计很重要。预训练目标包括动态掩码、句子打包、更大的批次和字节级 BPE 分词器。
你可以在 Facebook AI 组织下找到所有原始的 RoBERTa 检查点。
点击右侧边栏中的 RoBERTa 模型，查看更多如何将 RoBERTa 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 和命令行来预测 <mask> 标记。
import torch
from transformers import pipeline
pipeline = pipeline(
task="fill-mask",
model="FacebookAI/roberta-base",
torch_dtype=torch.float16,
device=0
)
pipeline("Plants create <mask> through a process known as photosynthesis.")注意
- RoBERTa 没有
token_type_ids，因此你不需要指明哪个标记属于哪个段落。使用分隔符tokenizer.sep_token或</s>来分隔你的段落。
RobertaConfig
class transformers.RobertaConfig
< 源 >( vocab_size = 50265 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 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 50265) — RoBERTa 模型的词汇表大小。定义了在调用 RobertaModel 或 TFRobertaModel 时，可以通过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或Callable, 可选, 默认为"gelu") — 编码器和池化层中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"silu"和"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) — 传递给 RobertaModel 或 TFRobertaModel 的token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - position_embedding_type (
str, 可选, 默认为"absolute") — 位置嵌入的类型。选择"absolute"、"relative_key"或"relative_key_query"之一。对于位置嵌入，使用"absolute"。有关"relative_key"的更多信息，请参阅Self-Attention with Relative Position Representations (Shaw et al.)。有关"relative_key_query"的更多信息，请参阅Improve Transformer Models with Better Relative Position Embeddings (Huang et al.)中的方法 4。 - is_decoder (
bool, 可选, 默认为False) — 模型是否用作解码器。如果为False，模型用作编码器。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - classifier_dropout (
float, 可选) — 分类头的 dropout 比率。
这是一个配置类，用于存储 RobertaModel 或 TFRobertaModel 的配置。它用于根据指定的参数实例化 RoBERTa 模型，定义模型架构。使用默认值实例化配置将产生与 RoBERTa FacebookAI/roberta-base 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import RobertaConfig, RobertaModel
>>> # Initializing a RoBERTa configuration
>>> configuration = RobertaConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = RobertaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configRobertaTokenizer
class transformers.RobertaTokenizer
< 源 >( vocab_file merges_file errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - merges_file (
str) — 合并文件的路径。 - errors (
str, 可选, 默认为"replace") — 解码字节为 UTF-8 时遵循的范例。有关更多信息，请参阅 bytes.decode。 - bos_token (
str, 可选, 默认为"<s>") — 在预训练期间使用的序列开始标记。可用作序列分类器标记。当使用特殊标记构建序列时，这不是用于序列开始的标记。使用的标记是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束标记。当使用特殊标记构建序列时，这不是用于序列结束的标记。使用的标记是
sep_token。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符标记，用于从多个序列构建一个序列，例如，用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认为"<s>") — 分类器标记，用于进行序列分类（对整个序列进行分类，而不是对每个标记进行分类）。当使用特殊标记构建时，它是序列的第一个标记。 - unk_token (
str, 可选, 默认为"<unk>") — 未知标记。不在词汇表中的标记无法转换为 ID，而是被设置为此标记。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的标记，例如在批处理不同长度的序列时使用。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩盖值的词元。这是在使用掩码语言建模训练此模型时使用的词元。模型将尝试预测此词元。 - add_prefix_space (
bool, 可选, 默认为False) — 是否在输入前添加一个初始空格。这使得开头的单词可以像其他任何单词一样被处理。（RoBERTa分词器通过前面的空格来检测单词的开头）。
构建一个 RoBERTa 分词器，它源自 GPT-2 分词器，使用字节级字节对编码（Byte-Pair-Encoding）。
这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会
无论是否在句子开头（无空格），编码方式都会不同
>>> from transformers import RobertaTokenizer
>>> tokenizer = RobertaTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> tokenizer("Hello world")["input_ids"]
[0, 31414, 232, 2]
>>> tokenizer(" Hello world")["input_ids"]
[0, 20920, 232, 2]您可以通过在实例化此分词器时或在对某些文本调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式进行预训练，这可能会导致性能下降。
当与 is_split_into_words=True 一起使用时，此分词器会在每个词（甚至是第一个词）之前添加一个空格。
该分词器继承自 PreTrainedTokenizer，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
通过连接和添加特殊词元，从一个序列或一对序列为序列分类任务构建模型输入。一个 RoBERTa 序列具有以下格式
- 单个序列：
<s> X </s> - 序列对：
<s> A </s></s> B </s>
get_special_tokens_mask
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]
从没有添加特殊标记的标记列表中检索序列ID。此方法在使用分词器prepare_for_model方法添加特殊标记时调用。
create_token_type_ids_from_sequences
< 来源 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
从传入的两个序列中创建一个掩码，用于序列对分类任务。RoBERTa 不使用词元类型 ID，因此返回一个全为零的列表。
RobertaTokenizerFast
class transformers.RobertaTokenizerFast
< 来源 >( vocab_file = None merges_file = None tokenizer_file = None errors = 'replace' bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' add_prefix_space = False trim_offsets = True **kwargs )
参数
- vocab_file (
str) — 词汇表文件的路径。 - merges_file (
str) — 合并文件的路径。 - errors (
str, 可选, 默认为"replace") — 将字节解码为 UTF-8 时遵循的范式。更多信息请参阅 bytes.decode。 - bos_token (
str, 可选, 默认为"<s>") — 在预训练期间使用的序列开始词元。可用作序列分类器词元。当使用特殊词元构建序列时，这不是用于序列开始的词元。使用的词元是
cls_token。 - eos_token (
str, 可选, 默认为"</s>") — 序列结束词元。当使用特殊词元构建序列时，这不是用于序列结束的词元。使用的词元是
sep_token。 - sep_token (
str, 可选, 默认为"</s>") — 分隔符词元，用于从多个序列构建一个序列，例如用于序列分类的两个序列，或用于问答任务的文本和问题。它也用作使用特殊词元构建的序列的最后一个词元。 - cls_token (
str, 可选, 默认为"<s>") — 分类器词元，用于序列分类（对整个序列进行分类，而不是逐词元分类）。当使用特殊词元构建序列时，它是序列的第一个词元。 - unk_token (
str, 可选, 默认为"<unk>") — 未知词元。不在词汇表中的词元无法转换为 ID，而是被设置为此词元。 - pad_token (
str, 可选, 默认为"<pad>") — 用于填充的词元，例如在批处理不同长度的序列时使用。 - mask_token (
str, 可选, 默认为"<mask>") — 用于掩盖值的词元。这是在使用掩码语言建模训练此模型时使用的词元。模型将尝试预测此词元。 - add_prefix_space (
bool, 可选, 默认为False) — 是否在输入前添加一个初始空格。这使得开头的单词可以像其他任何单词一样被处理。（RoBERTa分词器通过前面的空格来检测单词的开头）。 - trim_offsets (
bool, 可选, 默认为True) — 后处理步骤是否应修剪偏移量以避免包含空白字符。
构建一个“快速”RoBERTa分词器（由HuggingFace的 *tokenizers* 库支持），它源自GPT-2分词器，使用字节级字节对编码。
这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会
无论是否在句子开头（无空格），编码方式都会不同
>>> from transformers import RobertaTokenizerFast
>>> tokenizer = RobertaTokenizerFast.from_pretrained("FacebookAI/roberta-base")
>>> tokenizer("Hello world")["input_ids"]
[0, 31414, 232, 2]
>>> tokenizer(" Hello world")["input_ids"]
[0, 20920, 232, 2]您可以通过在实例化此分词器时或在对某些文本调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式进行预训练，这可能会导致性能下降。
当与 is_split_into_words=True 一起使用时，此分词器需要以 add_prefix_space=True 进行实例化。
该分词器继承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。
RobertaModel
class transformers.RobertaModel
< 来源 >( config add_pooling_layer = True )
参数
- config (RobertaModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, 可选, 默认为True) — 是否添加池化层
该模型既可以作为编码器（仅使用自注意力机制），也可以作为解码器。在作为解码器时，在自注意力层之间会添加一个交叉注意力层，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中描述的架构。
要作为解码器使用，模型需要将配置中的 `is_decoder` 参数设置为 `True` 进行初始化。要在 Seq2Seq 模型中使用，模型初始化时需要将 `is_decoder` 参数和 `add_cross_attention` 都设置为 `True`；然后，前向传播需要一个 `encoder_hidden_states`作为输入。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 来源 >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 词汇表中输入序列词元的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示词元未被屏蔽，
- 0 表示词元被屏蔽。
- token_type_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于*句子 A*的词元，
- 1 对应于*句子 B*的词元。
- position_ids (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列词元的位置索引。选自范围[0, config.n_positions - 1]。 - head_mask (
torch.Tensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头未被屏蔽，
- 0 表示头被屏蔽。
- inputs_embeds (
torch.Tensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 或者，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你希望比模型的内部嵌入查找矩阵有更多控制权来将 `input_ids` 索引转换为关联向量，这将非常有用。 - encoder_hidden_states (
torch.Tensor, 形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充词元索引执行注意力的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。掩码值选自[0, 1]：- 1 表示词元未被屏蔽，
- 0 表示词元被屏蔽。
- past_key_values (
list[torch.FloatTensor], 可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在解码的前一个阶段由模型返回的 `past_key_values`，当 `use_cache=True` 或 `config.use_cache=True` 时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 `config.n_layers` 的 `tuple(tuple(torch.FloatTensor))`，每个元组包含 2 个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量）。这也称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果未传递 `past_key_values`，将返回旧版缓存格式。
如果使用 `past_key_values`，用户可以选择只输入最后一个 `input_ids`（那些没有为其提供过去键值状态的 `input_ids`），其形状为 `(batch_size, 1)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。
- use_cache (
bool, 可选) — 如果设置为 `True`，则返回 `past_key_values` 键值状态，可用于加速解码（请参阅 `past_key_values`）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 `torch.FloatTensor` 的元组（如果传递 `return_dict=False` 或 `config.return_dict=False`），包含各种元素，具体取决于配置（RobertaConfig）和输入。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor, 形状为(batch_size, hidden_size)) — 序列的第一个词元（分类词元）的最后一层隐藏状态，经过用于辅助预训练任务的层进一步处理。例如，对于 BERT 系列模型，这返回经过线性层和 tanh 激活函数处理后的分类词元。线性层权重在预训练期间通过下一句预测（分类）目标进行训练。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 和 `config.add_cross_attention=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, 可选, 当传入 `use_cache=True` 或 `config.use_cache=True` 时返回) — 这是一个 Cache 实例。更多详情请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（自注意力块中的键和值，如果 `config.is_encoder_decoder=True`，则还包括交叉注意力块中的键和值），可用于加速序列解码（参见 `past_key_values` 输入）。
RobertaModel 的前向方法覆盖了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
RobertaForCausalLM
class transformers.RobertaForCausalLM
< 源码 >( config )
参数
- config (RobertaForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoBERTa 模型，顶部带有一个用于 CLM 微调的 `语言建模` 头。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 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* 标记。此参数仅在模型使用 `type_vocab_size` 参数（值为 2）初始化时才能使用。此张量中的所有值应始终小于 `type_vocab_size`。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - 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` 索引转换为相关向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在编码器输入的填充标记索引上执行注意力的掩码。如果模型被配置为解码器，则在交叉注意力中使用此掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见 `input_ids` 文档字符串）。索引设置为 `-100` 的标记将被忽略（遮盖），损失仅对标签在 `[0, ..., config.vocab_size]` 范围内的标记进行计算。 - past_key_values (
tuple[tuple[torch.FloatTensor]]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在先前解码阶段返回的 `past_key_values`，当 `use_cache=True` 或 `config.use_cache=True` 时。允许两种格式：
- Cache 实例，请参阅我们的 KV 缓存指南；
- 长度为 `config.n_layers` 的 `tuple(torch.FloatTensor)` 元组，其中每个元组包含 2 个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量。这也被称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果未传递 `past_key_values`，将返回旧版缓存格式。
如果使用 `past_key_values`，用户可以选择只输入最后一个 `input_ids`（那些没有为其提供过去键值状态的 `input_ids`），形状为 `(batch_size, 1)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。
- use_cache (
bool，可选) — 如果设置为 `True`，将返回 `past_key_values` 键值状态，可用于加速解码（参见 `past_key_values`）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 `torch.FloatTensor` 的元组（如果 `return_dict=False` 或 `config.return_dict=False`），包含各种元素，具体取决于配置（RobertaConfig）和输入。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
Cache, 可选, 当传入 `use_cache=True` 或 `config.use_cache=True` 时返回) — 这是一个 Cache 实例。更多详情请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
RobertaForCausalLM 的前向方法覆盖了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, RobertaForCausalLM, AutoConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> config = AutoConfig.from_pretrained("FacebookAI/roberta-base")
>>> config.is_decoder = True
>>> model = RobertaForCausalLM.from_pretrained("FacebookAI/roberta-base", config=config)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsRobertaForMaskedLM
class transformers.RobertaForMaskedLM
< 源码 >( config )
参数
- config (RobertaForMaskedLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有一个 `语言建模` 头的 Roberta 模型。”
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.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* 标记。此参数仅在模型使用 `type_vocab_size` 参数（值为 2）初始化时才能使用。此张量中的所有值应始终小于 `type_vocab_size`。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - 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` 索引转换为相关向量，这将非常有用。 - encoder_hidden_states (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在编码器输入的填充标记索引上执行注意力的掩码。如果模型被配置为解码器，则在交叉注意力中使用此掩码。掩码值选自[0, 1]：- 1 表示标记未被遮盖，
- 0 表示标记已被遮盖。
- labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见 `input_ids` 文档字符串）。索引设置为 `-100` 的标记将被忽略（遮盖），损失仅对标签在 `[0, ..., config.vocab_size]` 范围内的标记进行计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 `torch.FloatTensor` 的元组（如果 `return_dict=False` 或 `config.return_dict=False`），包含各种元素，具体取决于配置（RobertaConfig）和输入。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RobertaForMaskedLM 的前向方法覆盖了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, RobertaForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = RobertaForMaskedLM.from_pretrained("FacebookAI/roberta-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)
>>> tokenizer.decode(predicted_token_id)
...
>>> 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)
>>> round(outputs.loss.item(), 2)
...RobertaForSequenceClassification
class transformers.RobertaForSequenceClassification
< 源码 >( config )
参数
- config (RobertaForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoBERTa 模型转换器，顶部带有一个序列分类/回归头（一个在池化输出之上的线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.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* 标记。此参数仅在模型使用 `type_vocab_size` 参数（值为 2）初始化时才能使用。此张量中的所有值应始终小于 `type_vocab_size`。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - 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` 索引转换为相关向量，这将非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果 `config.num_labels == 1`，则计算回归损失（均方损失），如果 `config.num_labels > 1`，则计算分类损失（交叉熵）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 对象而不是一个普通的元组。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（RobertaConfig）和输入而不同的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。 -
logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RobertaForSequenceClassification 的 forward 方法覆盖了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, RobertaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = RobertaForSequenceClassification.from_pretrained("FacebookAI/roberta-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()
>>> 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 = RobertaForSequenceClassification.from_pretrained("FacebookAI/roberta-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, RobertaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = RobertaForSequenceClassification.from_pretrained("FacebookAI/roberta-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 = RobertaForSequenceClassification.from_pretrained(
... "FacebookAI/roberta-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).lossRobertaForMultipleChoice
class transformers.RobertaForMultipleChoice
< 源代码 >( config )
参数
- config (RobertaForMultipleChoice) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有选择题分类头的 Roberta 模型（在池化输出之上添加一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。仅当模型使用值为
type_vocab_size参数初始化时才能使用此参数。= 2。此张量中的所有值应始终 < type_vocab_size。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), 可选) — 掩码，用于避免在填充标记索引上执行注意力。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- labels (
torch.LongTensor，形状为(batch_size,), 可选) — 用于计算选择题分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量第二维的大小。（请参阅上面的input_ids） - position_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - 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 对象而不是一个普通的元组。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（RobertaConfig）和输入而不同的各种元素。
-
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RobertaForMultipleChoice 的 forward 方法覆盖了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, RobertaForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = RobertaForMultipleChoice.from_pretrained("FacebookAI/roberta-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.logitsRobertaForTokenClassification
class transformers.RobertaForTokenClassification
< 源代码 >( config )
参数
- config (RobertaForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有词元分类头的 Roberta transformer（在隐藏状态输出之上添加一个线性层），例如用于命名实体识别（NER）任务。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.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 标记。仅当模型使用值为
type_vocab_size参数初始化时才能使用此参数。= 2。此张量中的所有值应始终 < type_vocab_size。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - 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索引转换为相关向量，这会非常有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算词元分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 对象而不是一个普通的元组。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（RobertaConfig）和输入而不同的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。 -
logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RobertaForTokenClassification 的 forward 方法覆盖了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, RobertaForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = RobertaForTokenClassification.from_pretrained("FacebookAI/roberta-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]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...RobertaForQuestionAnswering
class transformers.RobertaForQuestionAnswering
< 源代码 >( config )
参数
- config (RobertaForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有跨度分类头的 Roberta transformer，用于抽取式问答任务，如 SQuAD（在隐藏状态输出之上添加一个线性层以计算 span start logits 和 span end logits）。
此模型继承自 PreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪注意力头等）。
此模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.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 标记。仅当模型使用值为
type_vocab_size参数初始化时才能使用此参数。= 2。此张量中的所有值应始终 < type_vocab_size。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - 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索引转换为相关向量，这会非常有用。 - start_positions (
torch.LongTensor，形状为(batch_size,), 可选) — 标记的跨度开始位置（索引）的标签，用于计算词元分类损失。位置被限制在序列长度（sequence_length）内。序列之外的位置在计算损失时不会被考虑。 - end_positions (
torch.LongTensor，形状为(batch_size,), 可选) — 标记的跨度结束位置（索引）的标签，用于计算词元分类损失。位置被限制在序列长度（sequence_length）内。序列之外的位置在计算损失时不会被考虑。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 对象而不是一个普通的元组。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置（RobertaConfig）和输入而不同的各种元素。
-
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), 可选, 在传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则一个用于嵌入层的输出，另外每个层一个输出），形状为 `(batch_size, sequence_length, hidden_size)`。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传入 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
RobertaForQuestionAnswering 的 forward 方法覆盖了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, RobertaForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = RobertaForQuestionAnswering.from_pretrained("FacebookAI/roberta-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]
>>> 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)
...TFRobertaModel
class transformers.TFRobertaModel
< 源代码 >( config *inputs **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
这是一个基础的 RoBERTa 模型转换器，输出原始的隐藏状态，顶部没有任何特定的处理头。
此模型继承自 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 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = 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.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的片段标记索引。索引在[0, 1]中选择：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
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 在训练和评估模式下行为不同）。 - encoder_hidden_states (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型被配置为解码器，此掩码用于交叉注意力。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- past_key_values (
tuple[tuple[tf.Tensor]]，长度为config.n_layers) — 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。如果使用past_key_values，用户可以选择只输入最后一个decoder_input_ids（那些没有给出过去键值状态的 ID），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选, 默认为True) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。在训练期间设置为False，在生成期间设置为True。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (RobertaConfig) 和输入而定的各种元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
tf.Tensor，形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经由一个线性层和一个 Tanh 激活函数进一步处理。线性层的权重在预训练期间通过下一句预测（分类）目标进行训练。此输出通常不是输入语义内容的良好摘要，通常最好对整个输入序列的隐藏状态进行平均或池化。
-
past_key_values (
list[tf.Tensor], 可选, 在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
TFRobertaModel 的前向方法，覆盖了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = TFRobertaModel.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFRobertaForCausalLM
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = None use_cache: Optional[bool] = 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.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于指示输入的第一部分和第二部分的片段标记索引。索引在[0, 1]中选择：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在[0, 1]中选择：- 1 表示头未被遮盖，
- 0 表示头被遮盖。
- inputs_embeds (
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 在训练和评估模式下行为不同）。 - encoder_hidden_states (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型被配置为解码器，此掩码用于交叉注意力。掩码值在[0, 1]中选择：- 1 表示标记未被遮盖，
- 0 表示标记被遮盖。
- past_key_values (
tuple[tuple[tf.Tensor]]，长度为config.n_layers) — 包含预先计算的注意力块的键和值隐藏状态。可用于加速解码。如果使用past_key_values，用户可以选择只输入最后一个decoder_input_ids（那些没有给出过去键值状态的 ID），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选, 默认为True) — 如果设置为True，将返回past_key_values键值状态，可用于加速解码（参见past_key_values）。在训练期间设置为False，在生成期间设置为True。 - labels (
tf.Tensor或np.ndarray，形状为(batch_size, sequence_length), 可选) — 用于计算交叉熵分类损失的标签。索引应在[0, ..., config.vocab_size - 1]范围内。
返回
transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (RobertaConfig) 和输入而定的各种元素。
-
loss (形状为
(n,)的tf.Tensor，可选，其中n是非掩码标签的数量，当提供了labels时返回) — 语言建模损失（用于下一标记预测）。 -
logits (
tf.Tensorof shape(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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(tf.Tensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
-
past_key_values (
list[tf.Tensor], 可选, 在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head))。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
TFRobertaForCausalLM 的前向方法，覆盖了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaForCausalLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = TFRobertaForCausalLM.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFRobertaForMaskedLM
class transformers.TFRobertaForMaskedLM
< 源代码 >( config *inputs **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoBERTa 模型，顶部带有一个 `语言建模` 头。
此模型继承自 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 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_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 (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值的选择范围为[0, 1]：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
- token_type_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一和第二部分。索引的选择范围为[0, 1]：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- position_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy 数组或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的选择范围为[0, 1]：- 1 表示该头未被掩码，
- 0 表示该头已被掩码。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递 `input_ids`，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关联的向量，这会非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 Eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - labels (
tf.Tensor，形状为(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 时），根据配置（RobertaConfig）和输入，包含各种元素。
-
loss (
tf.Tensorof shape(n,), 可选, 其中 n 是非掩码标签的数量，当提供labels时返回) — 掩码语言模型 (MLM) 损失。 -
logits (
tf.Tensorof shape(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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFRobertaForMaskedLM 的前向方法，重写了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = TFRobertaForMaskedLM.from_pretrained("FacebookAI/roberta-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)
>>> tokenizer.decode(predicted_token_id)
' Paris'TFRobertaForSequenceClassification
class transformers.TFRobertaForSequenceClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoBERTa 模型转换器，顶部带有一个序列分类/回归头（一个在池化输出之上的线性层），例如用于 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 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_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 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值的选择范围为[0, 1]：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
- token_type_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一和第二部分。索引的选择范围为[0, 1]：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- position_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy 数组或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的选择范围为[0, 1]：- 1 表示该头未被掩码，
- 0 表示该头已被掩码。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递 `input_ids`，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关联的向量，这会非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 Eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - labels (
tf.Tensor，形状为(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 时），根据配置（RobertaConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFRobertaForSequenceClassification 的前向方法，重写了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = TFRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> 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])
>>> model.config.id2label[predicted_class_id]
'optimism'>>> # 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 = TFRobertaForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.08TFRobertaForMultipleChoice
class transformers.TFRobertaForMultipleChoice
< 源代码 >( config *inputs **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Roberta 模型，顶部带有一个多项选择分类头（在池化输出之上是一个线性层和一个 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 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_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 (
Numpy 数组或tf.Tensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy 数组或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值的选择范围为[0, 1]：- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
- token_type_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 片段标记索引，用于指示输入的第一和第二部分。索引的选择范围为[0, 1]：- 0 对应于 *A 句子* 的标记，
- 1 对应于 *B 句子* 的标记。
- position_ids (
Numpy 数组或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy 数组或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定的头无效的掩码。掩码值的选择范围为[0, 1]：- 1 表示该头未被掩码，
- 0 表示该头已被掩码。
- inputs_embeds (
tf.Tensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，你可以不传递 `input_ids`，而是直接传递嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 `input_ids` 索引转换为相关联的向量，这会非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。此参数只能在 Eager 模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。此参数可以在 Eager 模式下使用，在图模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否以训练模式使用模型（某些模块，如 dropout 模块，在训练和评估之间有不同的行为）。 - labels (
tf.Tensor，形状为(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 时），根据配置（RobertaConfig）和输入，包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFRobertaForMultipleChoice 的前向方法，重写了 `__call__` 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = TFRobertaForMultipleChoice.from_pretrained("FacebookAI/roberta-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.logitsTFRobertaForTokenClassification
class transformers.TFRobertaForTokenClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoBERTa 模型，顶部带有一个标记分类头（在隐藏状态输出之上是一个线性层），例如用于命名实体识别（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 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_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 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选自[0, 1]：- 1 表示标记未被屏蔽，
- 0 表示标记已被屏蔽。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选自范围[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的张量下的attentions。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的hidden_states。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。此参数可在即时模式（eager mode）下使用，在图模式（graph mode）下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否以训练模式使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - labels (
tf.Tensor，形状为(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 时），包含各种元素，具体取决于配置 (RobertaConfig) 和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFRobertaForTokenClassification 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-large-ner-english")
>>> model = TFRobertaForTokenClassification.from_pretrained("ydshieh/roberta-large-ner-english")
>>> 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()]
>>> predicted_tokens_classes
['O', 'ORG', 'ORG', 'O', 'O', 'O', 'O', 'O', 'LOC', 'O', 'LOC', 'LOC']TFRobertaForQuestionAnswering
class transformers.TFRobertaForQuestionAnswering
< source >( config *inputs **kwargs )
参数
- config (RobertaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
RoBERTa 模型，顶部带有一个用于抽取式问答任务（如 SQuAD）的片段分类头（在隐藏状态输出之上是用于计算 span start logits 和 span end 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 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_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 (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。详情请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选自[0, 1]：- 1 表示标记未被屏蔽，
- 0 表示标记已被屏蔽。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引选自[0, 1]：- 0 对应于句子 A 的标记，
- 1 对应于句子 B 的标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。选自范围[0, config.max_position_embeddings - 1]。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于屏蔽自注意力模块中选定头的掩码。掩码值选自[0, 1]：- 1 表示头未被屏蔽，
- 0 表示头已被屏蔽。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回的张量下的attentions。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的hidden_states。此参数只能在即时模式（eager mode）下使用，在图模式（graph mode）下将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。此参数可在即时模式（eager mode）下使用，在图模式（graph mode）下该值将始终设置为 True。 - training (
bool, 可选, 默认为False) — 是否以训练模式使用模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。 - start_positions (
tf.Tensor，形状为(batch_size,), 可选) — 标记片段开始位置（索引）的标签，用于计算标记分类损失。位置被限制在序列长度（sequence_length）范围内。超出序列范围的位置不计入损失计算。 - end_positions (
tf.Tensor，形状为(batch_size,), 可选) — 标记片段结束位置（索引）的标签，用于计算标记分类损失。位置被限制在序列长度（sequence_length）范围内。超出序列范围的位置不计入损失计算。
返回
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (RobertaConfig) 和输入。
-
loss (
tf.Tensor，形状为(batch_size, ), 可选, 在提供start_positions和end_positions时返回) — 总片段提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度起始分数（SoftMax 之前）。 -
end_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度结束分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
TFRobertaForQuestionAnswering 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, TFRobertaForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-base-squad2")
>>> model = TFRobertaForQuestionAnswering.from_pretrained("ydshieh/roberta-base-squad2")
>>> 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]
>>> tokenizer.decode(predict_answer_tokens)
' puppet'FlaxRobertaModel
class transformers.FlaxRobertaModel
< source >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
这是一个基础的 RoBERTa 模型转换器，输出原始的隐藏状态，顶部没有任何特定的处理头。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 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.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (RobertaConfig) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
jnp.ndarray，形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过线性层和 Tanh 激活函数进一步处理。线性层权重是在预训练期间从下一句预测（分类）目标中训练的。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaModel
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaModel.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxRobertaForCausalLM
class transformers.FlaxRobertaForCausalLM
< source >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
Roberta 模型，顶部带有一个语言建模头（在隐藏状态输出之上是一个线性层），例如用于自回归任务。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 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.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（RobertaConfig）和输入包含各种元素。
-
logits (形状为
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回) —jnp.ndarray的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
-
past_key_values (
tuple(tuple(jnp.ndarray))，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的jnp.ndarray元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态（如果模型在编码器-解码器设置中使用）。仅当config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaForCausalLM.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]FlaxRobertaForMaskedLM
class transformers.FlaxRobertaForMaskedLM
< 来源 >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
RoBERTa 模型，顶部带有一个 `语言建模` 头。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 来源 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 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.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (RobertaConfig) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
jnp.ndarray，形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，经过线性层和 Tanh 激活函数进一步处理。线性层权重是在预训练期间从下一句预测（分类）目标中训练的。 -
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaForMaskedLM.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxRobertaForSequenceClassification
class transformers.FlaxRobertaForSequenceClassification
< 来源 >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
Roberta 模型 Transformer，其顶部带有一个序列分类/回归头（一个线性层位于池化输出之上），例如用于 GLUE 任务。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 来源 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = 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 时），根据配置（RobertaConfig）和输入包含各种元素。
-
logits (形状为
(batch_size, config.num_labels)的jnp.ndarray) — 分类（如果 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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaForSequenceClassification.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxRobertaForMultipleChoice
class transformers.FlaxRobertaForMultipleChoice
< 来源 >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
Roberta 模型，顶部带有一个多项选择分类头（在池化输出之上是一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 来源 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或 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 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（RobertaConfig）和输入包含各种元素。
-
logits (形状为
(batch_size, num_choices)的jnp.ndarray) — 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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaForMultipleChoice.from_pretrained("FacebookAI/roberta-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.logitsFlaxRobertaForTokenClassification
class transformers.FlaxRobertaForTokenClassification
< 来源 >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
Roberta 模型，其顶部带有一个标记分类头（一个线性层位于隐藏状态输出之上），例如用于命名实体识别（NER）任务。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 来源 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = None ) → transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或 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 时），包含根据配置（RobertaConfig）和输入的不同而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaForTokenClassification.from_pretrained("FacebookAI/roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logitsFlaxRobertaForQuestionAnswering
class transformers.FlaxRobertaForQuestionAnswering
< 来源 >( config: RobertaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )
参数
- config (RobertaConfig) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有片段分类头的 RoBERTa 模型，用于像 SQuAD 这样的抽取式问答任务（在隐藏状态输出之上有一个线性层，用于计算 `span start logits` 和 `span end logits`）。
此模型继承自 FlaxPreTrainedModel。请查看超类文档，了解库为所有模型实现的通用方法（例如下载、保存和转换 PyTorch 模型的权重）。
此模型也是一个 flax.linen.Module 的子类。可以像使用常规 Flax linen Module 一样使用它，并参考 Flax 文档了解所有与一般用法和行为相关的事项。
最后，此模型支持固有的 JAX 功能，例如
__call__
< 来源 >( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None past_key_values: typing.Optional[dict] = 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 时），包含根据配置（RobertaConfig）和输入的不同而变化的各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxRobertaPreTrainedModel 的前向方法重写了 __call__ 特殊方法。
尽管前向传递的逻辑需要在此函数中定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默忽略它们。
示例
>>> from transformers import AutoTokenizer, FlaxRobertaForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("FacebookAI/roberta-base")
>>> model = FlaxRobertaForQuestionAnswering.from_pretrained("FacebookAI/roberta-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