Transformers

( vocab_size = 50257 n_positions = 1024 n_embd = 768 n_layer = 12 n_head = 12 n_inner = None activation_function = 'gelu_new' resid_pdrop = 0.1 embd_pdrop = 0.1 attn_pdrop = 0.1 layer_norm_epsilon = 1e-05 initializer_range = 0.02 summary_type = 'cls_index' summary_use_proj = True summary_activation = None summary_proj_to_labels = True summary_first_dropout = 0.1 scale_attn_weights = True use_cache = True bos_token_id = 50256 eos_token_id = 50256 scale_attn_by_inverse_layer_idx = False reorder_and_upcast_attn = False **kwargs )

参数

vocab_size (int，可选，默认为 50257) — GPT-2 模型的词汇表大小。定义了调用 GPT2Model 或 TFGPT2Model 时传递的 inputs_ids 可以表示的不同词元的数量。
n_positions (int，可选，默认为 1024) — 该模型可能使用的最大序列长度。通常将其设置为一个较大的值以备不时之需（例如 512、1024 或 2048）。
n_embd (int，可选，默认为 768) — 嵌入和隐藏状态的维度。
n_layer (int，可选，默认为 12) — Transformer 编码器中的隐藏层数量。
n_head (int，可选，默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
n_inner (int，可选) — 内部前馈层的维度。None 将其设置为 4 倍的 n_embd
activation_function (str，可选，默认为 "gelu_new") — 激活函数，可选列表为 ["relu", "silu", "gelu", "tanh", "gelu_new"]。
resid_pdrop (float，可选，默认为 0.1) — 嵌入、编码器和池化层中所有全连接层的丢弃（dropout）概率。
embd_pdrop (float，可选，默认为 0.1) — 嵌入层的丢弃率。
attn_pdrop (float，可选，默认为 0.1) — 注意力层的丢弃率。
layer_norm_epsilon (float，可选，默认为 1e-05) — 层归一化层中使用的 epsilon 值。
initializer_range (float，可选，默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
summary_type (string，可选，默认为 "cls_index") — 用于序列摘要的参数，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

必须是以下选项之一：
- "last": 取最后一个词元（token）的隐藏状态（类似 XLNet）。
- "first": 取第一个词元（token）的隐藏状态（类似 BERT）。
- "mean": 取所有词元（token）隐藏状态的平均值。
- "cls_index": 提供一个分类词元位置的张量（类似 GPT/GPT-2）。
- "attn": 暂未实现，使用多头注意力。
summary_use_proj (bool，可选，默认为 True) — 用于序列摘要的参数，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

是否在向量提取后添加一个投影层。
summary_activation (str，可选) — 用于序列摘要的参数。用于 GPT2DoubleHeadsModel 中的多项选择头。

传递 "tanh" 表示对输出使用 tanh 激活函数，任何其他值都将导致不使用激活函数。
summary_proj_to_labels (bool，可选，默认为 True) — 用于序列摘要的参数，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

投影层的输出是应该有 config.num_labels 个类别还是 config.hidden_size 个类别。
summary_first_dropout (float，可选，默认为 0.1) — 用于序列摘要的参数，在模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中使用。

在投影和激活之后使用的丢弃率。
scale_attn_weights (bool，可选，默认为 True) — 通过除以 sqrt(hidden_size) 来缩放注意力权重。
use_cache (bool，可选，默认为 True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。
bos_token_id (int，可选，默认为 50256) — 词汇表中句子开头词元（token）的 ID。
eos_token_id (int, 可选, 默认为 50256) — 词汇表中句子结束标记的 ID。
scale_attn_by_inverse_layer_idx (bool, 可选, 默认为 False) — 是否额外通过 1 / layer_idx + 1 缩放注意力权重。
reorder_and_upcast_attn (bool, 可选, 默认为 False) — 是否在计算注意力（点积）之前缩放键（K），并在使用混合精度训练时将注意力点积/softmax提升为 float()。

这是一个配置类，用于存储 GPT2Model 或 TFGPT2Model 的配置。它用于根据指定的参数实例化一个 GPT-2 模型，定义模型架构。使用默认值实例化配置将产生与 GPT-2 openai-community/gpt2 架构相似的配置。

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

示例

>>> from transformers import GPT2Config, GPT2Model

>>> # Initializing a GPT2 configuration
>>> configuration = GPT2Config()

>>> # Initializing a model (with random weights) from the configuration
>>> model = GPT2Model(configuration)

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

GPT2Tokenizer

class transformers.GPT2Tokenizer

参数

vocab_file (str) — 词汇表文件的路径。
merges_file (str) — 合并文件的路径。
errors (str, 可选, 默认为 "replace") — 将字节解码为 UTF-8 时遵循的范式。更多信息请参阅 bytes.decode。
unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知标记。不在词汇表中的标记无法转换为 ID，将被设置为此标记。
bos_token (str, 可选, 默认为 "<|endoftext|>") — 序列开始标记。
eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列结束标记。
pad_token (str, 可选) — 用于填充的标记，例如在批处理不同长度的序列时使用。
add_prefix_space (bool, 可选, 默认为 False) — 是否在输入前添加一个初始空格。这允许将开头的单词像其他单词一样处理。（GPT2 分词器通过前面的空格来检测单词的开头）。
add_bos_token (bool, 可选, 默认为 False) — 是否在输入前添加一个初始的句子开始标记。这允许将开头的单词像其他单词一样处理。

构建一个 GPT-2 分词器。基于字节级的字节对编码（Byte-Pair-Encoding）。

这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会

无论是否在句子开头（无空格），编码方式都会不同

>>> from transformers import GPT2Tokenizer

>>> tokenizer = GPT2Tokenizer.from_pretrained("openai-community/gpt2")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]

>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]

您可以通过在实例化此分词器时或在对某些文本调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以这种方式进行预训练，这可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此分词器会在每个词（甚至是第一个词）之前添加一个空格。

此分词器继承自 PreTrainedTokenizer，该类包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

( save_directory: str filename_prefix: typing.Optional[str] = None )

GPT2TokenizerFast

class transformers.GPT2TokenizerFast

参数

vocab_file (str, 可选) — 词汇表文件的路径。
merges_file (str, 可选) — 合并文件的路径。
tokenizer_file (str, 可选) — tokenizers 文件的路径（通常具有 .json 扩展名），其中包含加载分词器所需的一切。
unk_token (str, 可选, 默认为 "<|endoftext|>") — 未知标记。不在词汇表中的标记无法转换为 ID，将被设置为此标记。
bos_token (str, 可选, 默认为 "<|endoftext|>") — 序列开始标记。
eos_token (str, 可选, 默认为 "<|endoftext|>") — 序列结束标记。
add_prefix_space (bool, 可选, 默认为 False) — 是否在输入前添加一个初始空格。这允许将开头的单词像其他单词一样处理。（GPT2 分词器通过前面的空格来检测单词的开头）。

构建一个“快速”的 GPT-2 分词器（由 HuggingFace 的 *tokenizers* 库支持）。基于字节级的字节对编码（Byte-Pair-Encoding）。

这个分词器经过训练，将空格视为词元的一部分（有点像 sentencepiece），所以一个词会

无论是否在句子开头（无空格），编码方式都会不同

>>> from transformers import GPT2TokenizerFast

>>> tokenizer = GPT2TokenizerFast.from_pretrained("openai-community/gpt2")
>>> tokenizer("Hello world")["input_ids"]
[15496, 995]

>>> tokenizer(" Hello world")["input_ids"]
[18435, 995]

您可以通过在实例化此分词器时传递 add_prefix_space=True 来绕过此行为，但由于模型并非以此方式进行预训练，这可能会导致性能下降。

当与 is_split_into_words=True 一起使用时，此分词器需要以 add_prefix_space=True 进行实例化。

此分词器继承自 PreTrainedTokenizerFast，该类包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

GPT2 特定输出

class transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput

( loss: typing.Optional[torch.FloatTensor] = None mc_loss: typing.Optional[torch.FloatTensor] = None logits: typing.Optional[torch.FloatTensor] = None mc_logits: typing.Optional[torch.FloatTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None hidden_states: typing.Optional[tuple[torch.FloatTensor]] = None attentions: typing.Optional[tuple[torch.FloatTensor]] = None )

参数

loss (torch.FloatTensor，形状为 (1,), 可选，在提供了 labels 时返回) — 语言建模损失。
mc_loss (torch.FloatTensor，形状为 (1,), 可选，在提供了 mc_labels 时返回) — 多项选择分类损失。
logits (torch.FloatTensor，形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数（在 SoftMax 之前的每个词汇标记的分数）。
mc_logits (torch.FloatTensor，形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数（在 SoftMax 之前的每个选项的分数）。
past_key_values (tuple[tuple[torch.Tensor]], 可选，当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的元组，包含形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量元组。

包含预计算的隐藏状态（注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

用于预测两个句子是否连续的模型输出的基类。

class transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput

( logits: Optional[tf.Tensor] = None mc_logits: Optional[tf.Tensor] = None past_key_values: list[tf.Tensor] | None = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )

参数

logits (tf.Tensor，形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数（在 SoftMax 之前的每个词汇标记的分数）。
mc_logits (tf.Tensor，形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数（在 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 输入）加速顺序解码。
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 之后的注意力权重，用于计算自注意力头中的加权平均值。

用于预测两个句子是否连续的模型输出的基类。

Pytorch

隐藏 Pytorch 内容

GPT2Model

class transformers.GPT2Model

( config )

参数

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

裸 Gpt2 模型，输出原始的隐藏状态，没有任何特定的头在其之上。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[tuple[tuple[torch.Tensor]], transformers.cache_utils.Cache, NoneType] = None cache_position: 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.Tensor] = None encoder_attention_mask: typing.Optional[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.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)) — 如果 past_key_values 为 None，则 input_ids_length = sequence_length，否则为 past_key_values[0][0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列标记的索引。

如果使用 past_key_values，则只有那些没有计算过其过去状态的 input_ids 才应作为 input_ids 传递。

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

什么是输入 ID？
past_key_values (Union[tuple[tuple[torch.Tensor]], ~cache_utils.Cache, NoneType]) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在解码的先前阶段，当 use_cache=True 或 config.use_cache=True 时由模型返回的 past_key_values。

允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组有两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递 past_key_values，将返回旧版缓存格式。

如果使用 past_key_values，用户可以选择只输入最后的 input_ids（那些没有向该模型提供其过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
cache_position (torch.LongTensor，形状 (sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
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* 的词元。
什么是词元类型 ID？
position_ids (torch.LongTensor，形状 (batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。选值范围为 [0, config.n_positions - 1]。

什么是位置 ID？
head_mask (torch.FloatTensor，形状 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示该头未被屏蔽，
- 0 表示该头已被屏蔽。
inputs_embeds (torch.FloatTensor，形状 (batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入式表示，而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这会非常有用。
encoder_hidden_states (torch.Tensor，形状 (batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。
encoder_attention_mask (torch.FloatTensor，形状 (batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充词元索引执行注意力计算的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。掩码值选自 [0, 1]：
- 1 表示词元未被屏蔽，
- 0 表示词元已被屏蔽。
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.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GPT2Config）和输入，包含各种元素。

last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (Cache，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv 缓存指南。

包含预先计算的隐藏状态（自注意力块中的键和值，如果 config.is_encoder_decoder=True，则可选地包含交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 且 config.add_cross_attention=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

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

GPT2Model 的前向方法，覆盖了 __call__ 特殊方法。

尽管前向传播的流程需要在此函数内定义，但之后应调用 Module 实例而不是这个函数，因为前者会负责运行前处理和后处理步骤，而后者会静默地忽略它们。

GPT2LMHeadModel

class transformers.GPT2LMHeadModel

( config )

参数

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

GPT2 Transformer 模型，顶部带有一个语言建模头（线性层，权重与输入嵌入绑定）。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None cache_position: 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.Tensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = 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 logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状 (batch_size, input_ids_length)) — 如果 past_key_values 为 None，则 input_ids_length = sequence_length；否则为 past_key_values[0][0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

如果使用 past_key_values，则只有那些过去未计算的 input_ids 才应作为 input_ids 传递。

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

什么是输入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传递 past_key_values，将返回传统缓存格式。

如果使用 past_key_values，用户可以选择只输入最后的 input_ids（那些没有向该模型提供其过去键值状态的词元），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
cache_position (torch.LongTensor，形状 (sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
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* 的词元。
什么是词元类型 ID？
position_ids (torch.LongTensor，形状 (batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。选值范围为 [0, config.n_positions - 1]。

什么是位置 ID？
head_mask (torch.FloatTensor，形状 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示该头未被屏蔽，
- 0 表示该头已被屏蔽。
inputs_embeds (torch.FloatTensor，形状 (batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入式表示，而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这会非常有用。
encoder_hidden_states (torch.Tensor，形状 (batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。
encoder_attention_mask (torch.FloatTensor，形状 (batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充词元索引执行注意力计算的掩码。如果模型被配置为解码器，则此掩码用于交叉注意力。掩码值选自 [0, 1]：
- 1 表示词元未被屏蔽，
- 0 表示词元已被屏蔽。
labels (torch.LongTensor，形状 (batch_size, input_ids_length)，可选) — 语言建模的标签。请注意，标签在模型内部会被移动，即你可以设置 labels = input_ids。索引选自 [-100, 0, ..., config.vocab_size]。所有设置为 -100 的标签都会被忽略（屏蔽），损失只对 [0, ..., config.vocab_size] 范围内的标签进行计算。
use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
logits_to_keep (Union[int, torch.Tensor]，默认为 0) — 如果是 int，则计算最后 logits_to_keep 个词元的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。对于生成任务，只需要最后一个词元的 logits，仅为该词元计算 logits 可以节省内存，这对于长序列或大词汇表来说非常重要。如果是一个 torch.Tensor，则必须是一维的，对应于要在序列长度维度中保留的索引。这在使用打包张量格式（批处理和序列长度使用单一维度）时非常有用。

transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GPT2Config）和输入，包含各种元素。

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 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
past_key_values (Cache，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv 缓存指南。

包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。

GPT2LMHeadModel 的前向方法，覆盖了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2LMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2LMHeadModel.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> loss = outputs.loss
>>> logits = outputs.logits

GPT2DoubleHeadsModel

class transformers.GPT2DoubleHeadsModel

( config )

参数

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

GPT2 Transformer 模型，顶部带有一个语言建模头和一个多项选择分类头，例如用于 RocStories/SWAG 任务。这两个头是两个线性层。语言建模头的权重与输入嵌入绑定，分类头将输入序列中指定分类词元索引的输入作为输入）。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = None cache_position: 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 mc_token_ids: typing.Optional[torch.LongTensor] = None labels: typing.Optional[torch.LongTensor] = None mc_labels: typing.Optional[torch.LongTensor] = 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.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状 (batch_size, input_ids_length)) — 如果 past_key_values 为 None，则 input_ids_length = sequence_length；否则为 past_key_values[0][0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

如果使用 past_key_values，则只有那些过去未计算的 input_ids 才应作为 input_ids 传递。

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

什么是输入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传递 past_key_values，将返回传统缓存格式。

如果使用 past_key_values，用户可以选择只输入最后的 input_ids（那些没有向该模型提供其过去键值状态的词元），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
cache_position (torch.LongTensor，形状 (sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
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* 的词元。
什么是词元类型 ID？
position_ids (torch.LongTensor，形状 (batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。选值范围为 [0, config.n_positions - 1]。

什么是位置 ID？
head_mask (torch.FloatTensor，形状 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示该头未被屏蔽，
- 0 表示该头已被屏蔽。
inputs_embeds (torch.FloatTensor，形状 (batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入式表示，而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这会非常有用。
mc_token_ids (torch.LongTensor，形状 (batch_size, num_choices)，可选，默认为输入最后一个词元的索引) — 每个输入序列中分类词元的索引。选值范围为 [0, input_ids.size(-1) - 1]。
labels (torch.LongTensor，形状 (batch_size, input_ids_length)，可选) — 语言建模的标签。请注意，标签在模型内部会被移动，即你可以设置 labels = input_ids。索引选自 [-100, 0, ..., config.vocab_size - 1]。所有设置为 -100 的标签都会被忽略（屏蔽），损失只对 [0, ..., config.vocab_size - 1] 范围内的标签进行计算。
mc_labels (torch.LongTensor，形状为 (batch_size)，可选) — 用于计算多项选择分类损失的标签。索引应在 [0, ..., num_choices] 范围内，其中 num_choices 是输入张量第二个维度的大小。（参见上面的 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.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GPT2Config）和输入，包含各种元素。

loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失。
mc_loss (torch.FloatTensor，形状为 (1,)，可选，当提供了 mc_labels 时返回) — 多项选择分类损失。
logits (torch.FloatTensor，形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。
mc_logits (torch.FloatTensor，形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数（SoftMax 之前的每个选项的分数）。
past_key_values (tuple[tuple[torch.Tensor]]，可选，当传递了 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的元组，包含形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量的元组。

包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

GPT2DoubleHeadsModel 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2DoubleHeadsModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2DoubleHeadsModel.from_pretrained("openai-community/gpt2")

>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> num_added_tokens = tokenizer.add_special_tokens({"cls_token": "[CLS]"})
>>> # Update the model embeddings with the new vocabulary size
>>> embedding_layer = model.resize_token_embeddings(len(tokenizer))

>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoded_choices = [tokenizer.encode(s) for s in choices]
>>> cls_token_location = [tokens.index(tokenizer.cls_token_id) for tokens in encoded_choices]

>>> input_ids = torch.tensor(encoded_choices).unsqueeze(0)  # Batch size: 1, number of choices: 2
>>> mc_token_ids = torch.tensor([cls_token_location])  # Batch size: 1

>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_logits = outputs.logits
>>> mc_logits = outputs.mc_logits

GPT2ForQuestionAnswering

class transformers.GPT2ForQuestionAnswering

( config )

参数

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

Gpt2 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, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None；否则为 past_key_values[0][0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列标记的索引。

如果使用了 past_key_values，则只应将尚未计算其过去状态的 input_ids 作为 input_ids 传入。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
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 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]。

什么是位置 ID？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示头未被掩码，
- 0 表示头已被掩码。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递 input_ids，而是直接传递一个嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关向量，这会很有用。
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 时），根据配置（GPT2Config）和输入，包含各种元素。

loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。
start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。
end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

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

GPT2ForQuestionAnswering 的 forward 方法，覆盖了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, GPT2ForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForQuestionAnswering.from_pretrained("openai-community/gpt2")

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

GPT2ForSequenceClassification

class transformers.GPT2ForSequenceClassification

( config )

参数

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

GPT2 模型 Transformer，顶部带有一个序列分类头（线性层）。

GPT2ForSequenceClassification 使用最后一个标记来进行分类，就像其他因果模型（例如 GPT-1）一样。

由于它对最后一个标记进行分类，因此需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果未定义 pad_token_id，它会简单地取每行批次中的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测填充标记，因此它会做同样的操作（取每行批次中的最后一个值）。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = 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 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.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None；否则为 past_key_values[0][0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列标记的索引。

如果使用了 past_key_values，则只应将尚未计算其过去状态的 input_ids 作为 input_ids 传入。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组有两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递 past_key_values，将返回旧版缓存格式。

如果使用了 past_key_values，用户可以选择只输入最后一个 input_ids（那些没有为其提供过去键值状态的标记），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
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 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]。

什么是位置 ID？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示头未被掩码，
- 0 表示头已被掩码。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以不传递 input_ids，而是直接传递一个嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关向量，这会很有用。
labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵）。
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.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GPT2Config）和输入，包含各种元素。

loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。
logits (形状为 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。
past_key_values (Cache，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 这是一个 Cache 实例。更多详情，请参阅我们的 kv 缓存指南。

包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

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

GPT2ForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2ForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForSequenceClassification.from_pretrained("openai-community/gpt2")

>>> 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 = GPT2ForSequenceClassification.from_pretrained("openai-community/gpt2", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, GPT2ForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForSequenceClassification.from_pretrained("openai-community/gpt2", 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 = GPT2ForSequenceClassification.from_pretrained(
...     "openai-community/gpt2", num_labels=num_labels, problem_type="multi_label_classification"
... )

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

GPT2ForTokenClassification

class transformers.GPT2ForTokenClassification

( config )

参数

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

Gpt2 Transformer 模型，顶部带有一个标记分类头（在隐藏状态输出之上添加一个线性层），例如用于命名实体识别（NER）任务。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是一个 PyTorch torch.nn.Module 子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.Tensor]]] = 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 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.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None；否则为 past_key_values[0][0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列标记的索引。

如果使用了 past_key_values，则只应将尚未计算其过去状态的 input_ids 作为 input_ids 传入。

可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
past_key_values (tuple[tuple[torch.Tensor]]，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组有两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为旧版缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递 past_key_values，将返回旧版缓存格式。

如果使用了 past_key_values，用户可以选择只输入最后一个 input_ids（那些没有为其提供过去键值状态的标记），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
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 的词元。
什么是词元类型 ID？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列词元的位置索引。在 [0, config.n_positions - 1] 范围内选择。

什么是位置 ID？
head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头 未被屏蔽，
- 0 表示头 被屏蔽。
inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以不传递 input_ids，而是直接传递一个嵌入表示。如果你想比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为相关向量，这会很有用。
labels (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵）。
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.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GPT2Config）和输入，包含各种元素。

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 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 元组（一个用于嵌入层的输出，如果模型有嵌入层，+ 一个用于每层输出）。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 元组（每层一个）。

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

GPT2ForTokenClassification 的前向方法，会覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, GPT2ForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = GPT2ForTokenClassification.from_pretrained("openai-community/gpt2")

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

TensorFlow

隐藏 TensorFlow 内容

TFGPT2Model

class transformers.TFGPT2Model

( config *inputs **kwargs )

参数

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

这是一个基础的 GPT2 模型 Transformer，它输出原始的隐藏状态，顶部没有任何特定的头。

此模型继承自 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 past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = 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 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.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)

参数

input_ids (Numpy array 或 tf.Tensor，形状为 (batch_size, input_ids_length)) — input_ids_length = 如果 past_key_values 为 None，则为 sequence_length，否则为 past_key_values[0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

如果使用了 past_key_values，则只有那些尚未计算过其过去状态的输入 ID 才应作为 input_ids 传递。

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

什么是输入 ID？
past_key_values (list[tf.Tensor]，长度为 config.n_layers) — 包含由模型计算的预计算隐藏状态（注意力块中的键和值）（参见下面的 past_key_values 输出）。可用于加速顺序解码。那些过去状态已提供给此模型的词元 ID 不应作为输入 ID 传递，因为它们已经被计算过了。
attention_mask (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示词元 未被屏蔽，
- 0 表示词元 被屏蔽。
如果使用了 past_key_values，attention_mask 需要包含用于 past_key_values 的掩码策略。换句话说，attention_mask 的长度必须始终为：len(past_key_values) + len(input_ids)

什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, input_ids_length), 可选) — 片段词元索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 的词元，
- 1 对应于 句子 B 的词元。
什么是词元类型 ID？
position_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, input_ids_length), 可选) — 位置嵌入中每个输入序列词元的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头 未被屏蔽，
- 0 表示头 被屏蔽。
inputs_embeds (tf.Tensor，形状为 (batch_size, input_ids_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 模块在训练和评估之间有不同的行为）。
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，用户可以选择只输入最后的 decoder_input_ids（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
use_cache (bool, 可选，默认为 True) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past）。在训练期间设置为 False，在生成期间设置为 True。

transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPastAndCrossAttentions 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（GPT2Config）和输入，包含各种元素。

last_hidden_state (tf.Tensor of shape (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
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.FloatTensor), 可选，当传递 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 之后，用于计算交叉注意力头中的加权平均。

TFGPT2Model 的前向方法，会覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFGPT2Model
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2Model.from_pretrained("openai-community/gpt2")

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

>>> last_hidden_states = outputs.last_hidden_state

TFGPT2LMHeadModel

class transformers.TFGPT2LMHeadModel

( config *inputs **kwargs )

参数

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

GPT2 Transformer 模型，顶部带有一个语言建模头（线性层，权重与输入嵌入绑定）。

此模型继承自 TFPreTrainedModel。请查看超类的文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

这个模型也是 keras.Model 的子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

所有输入作为关键字参数（如 PyTorch 模型），或
所有输入作为第一个位置参数中的列表、元组或字典。

只有一个 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 past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = 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 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, input_ids_length)) — input_ids_length = 如果 past_key_values 为 None，则为 sequence_length，否则为 past_key_values[0].shape[-2]（输入过去键值状态的 sequence_length）。词汇表中输入序列词元的索引。

如果使用了 past_key_values，则只有那些尚未计算过其过去状态的输入 ID 才应作为 input_ids 传递。

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

什么是输入 ID？
past_key_values (list[tf.Tensor]，长度为 config.n_layers) — 包含由模型计算的预计算隐藏状态（注意力块中的键和值）（参见下面的 past_key_values 输出）。可用于加速顺序解码。那些过去状态已提供给此模型的词元 ID 不应作为输入 ID 传递，因为它们已经被计算过了。
attention_mask (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length), 可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值在 [0, 1] 中选择：
- 1 表示词元 未被屏蔽，
- 0 表示词元 被屏蔽。
如果使用了 past_key_values，attention_mask 需要包含用于 past_key_values 的掩码策略。换句话说，attention_mask 的长度必须始终为：len(past_key_values) + len(input_ids)

什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, input_ids_length), 可选) — 片段词元索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 的词元，
- 1 对应于 句子 B 的词元。
什么是词元类型 ID？
position_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, input_ids_length), 可选) — 位置嵌入中每个输入序列词元的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于置零自注意力模块中选定头的掩码。掩码值在 [0, 1] 中选择：
- 1 表示头 未被屏蔽，
- 0 表示头 被屏蔽。
inputs_embeds (tf.Tensor，形状为 (batch_size, input_ids_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 模块在训练和评估之间有不同的行为）。
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，用户可以选择只输入最后的 decoder_input_ids（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 decoder_input_ids。
use_cache (bool, 可选，默认为 True) — 如果设置为 True，将返回 past_key_values 键值状态，可用于加速解码（参见 past）。在训练期间设置为 False，在生成期间设置为 True。
labels (tf.Tensor，形状为 (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 时），根据配置（GPT2Config）和输入，包含各种元素。

loss (形状为(n,)的tf.Tensor，可选，其中n是非掩码标签的数量，当提供了labels时返回) — 语言建模损失（用于下一标记预测）。
logits (tf.Tensor of 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 输入）加速顺序解码。

TFGPT2LMHeadModel 的前向方法，会覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFGPT2LMHeadModel
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2LMHeadModel.from_pretrained("openai-community/gpt2")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logits

TFGPT2DoubleHeadsModel

class transformers.TFGPT2DoubleHeadsModel

( config *inputs **kwargs )

参数

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

此模型继承自 TFPreTrainedModel。请查看超类的文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

这个模型也是 keras.Model 的子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

所有输入作为关键字参数（如 PyTorch 模型），或
所有输入作为第一个位置参数中的列表、元组或字典。

只有一个 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 past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = 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 mc_token_ids: np.ndarray | tf.Tensor | None = 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.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tuple(tf.Tensor)

参数

input_ids (Numpy 数组 或 tf.Tensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None，否则为 past_key_values[0].shape[-2] (输入过去键值状态的 sequence_length)。词汇表中输入序列标记的索引。

如果使用了 past_key_values，则只有那些没有计算过其过去状态的输入 ID 才应作为 input_ids 传递。

索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什么是输入 ID？
past_key_values (list[tf.Tensor]，长度为 config.n_layers) — 包含由模型计算的预计算隐藏状态（注意力块中的键和值）（参见下面的 past_key_values 输出）。可用于加速顺序解码。已将过去状态提供给该模型的标记 ID 不应作为输入 ID 传递，因为它们已经被计算过。
attention_mask (tf.Tensor 或 Numpy 数组，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自 [0, 1]：
- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
如果使用 past_key_values，attention_mask 需要包含用于 past_key_values 的掩码策略。换句话说，attention_mask 的长度必须始终为：len(past_key_values) + len(input_ids)

什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy 数组，形状为 (batch_size, input_ids_length)，可选) — 用于指示输入的第一和第二部分的片段标记索引。索引选自 [0, 1]：
- 0 对应于 *句子 A* 的标记，
- 1 对应于 *句子 B* 的标记。
什么是标记类型 ID？
position_ids (tf.Tensor 或 Numpy 数组，形状为 (batch_size, input_ids_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.max_position_embeddings - 1]。

什么是位置 ID？
head_mask (Numpy 数组 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示头未被掩码，
- 0 表示头已被掩码。
inputs_embeds (tf.Tensor，形状为 (batch_size, input_ids_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 模块在训练和评估之间有不同的行为）。
mc_token_ids (tf.Tensor 或 Numpy 数组，形状为 (batch_size, num_choices)，可选，默认为输入最后一个标记的索引) — 每个输入序列中分类标记的索引。选自范围 [0, input_ids.size(-1) - 1]。

transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或 tuple(tf.Tensor)

一个 transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (GPT2Config) 和输入而定的各种元素。

logits (tf.Tensor，形状为 (batch_size, num_choices, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。
mc_logits (tf.Tensor，形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数（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 输入）加速顺序解码。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

TFGPT2DoubleHeadsModel 的前向方法重写了 __call__ 特殊方法。

示例

>>> import tensorflow as tf
>>> from transformers import AutoTokenizer, TFGPT2DoubleHeadsModel

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = TFGPT2DoubleHeadsModel.from_pretrained("openai-community/gpt2")

>>> # Add a [CLS] to the vocabulary (we should train it also!)
>>> num_added_tokens = tokenizer.add_special_tokens({"cls_token": "[CLS]"})

>>> embedding_layer = model.resize_token_embeddings(
...     len(tokenizer)
... )  # Update the model embeddings with the new vocabulary size

>>> choices = ["Hello, my dog is cute [CLS]", "Hello, my cat is cute [CLS]"]
>>> encoded_choices = [tokenizer.encode(s) for s in choices]
>>> cls_token_location = [tokens.index(tokenizer.cls_token_id) for tokens in encoded_choices]

>>> input_ids = tf.constant(encoded_choices)[None, :]  # Batch size: 1, number of choices: 2
>>> mc_token_ids = tf.constant([cls_token_location])  # Batch size: 1

>>> outputs = model(input_ids, mc_token_ids=mc_token_ids)
>>> lm_prediction_scores, mc_prediction_scores = outputs[:2]

TFGPT2ForSequenceClassification

class transformers.TFGPT2ForSequenceClassification

( config *inputs **kwargs )

参数

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

GPT2 模型 Transformer，顶部带有一个序列分类头（线性层）。

TFGPT2ForSequenceClassification 使用最后一个标记进行分类，与其他因果模型（例如 GPT-1）的做法相同。

此模型继承自 TFPreTrainedModel。请查看超类的文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头等）。

这个模型也是 keras.Model 的子类。可以像使用常规的 TF 2.0 Keras 模型一样使用它，并参考 TF 2.0 文档了解所有与通用用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种输入格式

所有输入作为关键字参数（如 PyTorch 模型），或
所有输入作为第一个位置参数中的列表、元组或字典。

只有一个 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 past_key_values: Optional[tuple[tuple[Union[np.ndarray, tf.Tensor]]]] = 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 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.TFSequenceClassifierOutputWithPast 或 tuple(tf.Tensor)

参数

input_ids (Numpy 数组 或 tf.Tensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length，如果 past_key_values 为 None，否则为 past_key_values[0].shape[-2] (输入过去键值状态的 sequence_length)。词汇表中输入序列标记的索引。

如果使用了 past_key_values，则只有那些没有计算过其过去状态的输入 ID 才应作为 input_ids 传递。

索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。

什么是输入 ID？
past_key_values (list[tf.Tensor]，长度为 config.n_layers) — 包含由模型计算的预计算隐藏状态（注意力块中的键和值）（参见下面的 past_key_values 输出）。可用于加速顺序解码。已将过去状态提供给该模型的标记 ID 不应作为输入 ID 传递，因为它们已经被计算过。
attention_mask (tf.Tensor 或 Numpy 数组，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选自 [0, 1]：
- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
如果使用 past_key_values，attention_mask 需要包含用于 past_key_values 的掩码策略。换句话说，attention_mask 的长度必须始终为：len(past_key_values) + len(input_ids)

什么是注意力掩码？
token_type_ids (tf.Tensor 或 Numpy 数组，形状为 (batch_size, input_ids_length)，可选) — 用于指示输入的第一和第二部分的片段标记索引。索引选自 [0, 1]：
- 0 对应于 *句子 A* 的标记，
- 1 对应于 *句子 B* 的标记。
什么是标记类型 ID？
position_ids (tf.Tensor 或 Numpy 数组，形状为 (batch_size, input_ids_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.max_position_embeddings - 1]。

什么是位置 ID？
head_mask (Numpy 数组 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于置零自注意力模块中选定头的掩码。掩码值选自 [0, 1]：
- 1 表示头未被掩码，
- 0 表示头已被掩码。
inputs_embeds (tf.Tensor，形状为 (batch_size, input_ids_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)，可选) — 用于计算交叉熵分类损失的标签。索引应在 [0, ..., config.vocab_size - 1] 范围内。

transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或 tuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (GPT2Config) 和输入而定的各种元素。

loss (tf.Tensor，形状为 (batch_size, )，可选，当提供 labels 时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。
logits (tf.Tensor，形状为 (batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（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 输入）加速顺序解码。
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 后的注意力权重，用于计算自注意力头中的加权平均值。

TFGPT2ForSequenceClassification 的前向方法重写了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, TFGPT2ForSequenceClassification
>>> import tensorflow as tf

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/DialogRPT-updown")
>>> model = TFGPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown")

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

>>> logits = model(**inputs).logits

>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[0])

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = TFGPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown", num_labels=num_labels)

>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss

TFSequenceClassifierOutputWithPast

class transformers.modeling_tf_outputs.TFSequenceClassifierOutputWithPast

( loss: tf.Tensor | None = None logits: Optional[tf.Tensor] = None past_key_values: list[tf.Tensor] | None = None hidden_states: tuple[tf.Tensor] | None = None attentions: tuple[tf.Tensor] | None = None )

参数

loss (tf.Tensor，形状为 (batch_size, )，可选，当提供 labels 时返回) — 分类（如果 config.num_labels==1，则为回归）损失。
logits (tf.Tensor，形状为 (batch_size, config.num_labels)) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。
past_key_values (list[tf.Tensor]，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — tf.Tensor 列表，长度为 config.n_layers，每个张量的形状为 (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 之后的注意力权重，用于计算自注意力头中的加权平均值。

句子分类模型输出的基类。

TFGPT2Tokenizer

class transformers.TFGPT2Tokenizer

( vocab: dict merges: list max_length: typing.Optional[int] = None pad_token_id: typing.Optional[int] = None )

参数

vocab (dict[str, int]) — 用于字节对编码器的词汇字典
merges (list[str]) — 用于字节对编码器的合并列表

这是一个用于 GPT2 的图内分词器。它应该像其他分词器一样，使用 from_pretrained() 方法进行初始化。它也可以使用 from_tokenizer() 方法进行初始化，该方法从现有的标准分词器对象导入设置。

图内分词器与其他 Hugging Face 分词器不同，它们实际上是 Keras 层，设计用于在调用模型时运行，而不是在预处理期间。因此，它们的选项比标准分词器类要有限。当您想创建一个从 tf.string 输入直接到输出的端到端模型时，它们最有用。

from_config

( config )

参数

config (Dict) — 包含键的字典，如 `get_config` 中所述。

从配置创建 TFGPT2Tokenizer

from_pretrained

( pretrained_model_name_or_path: typing.Union[str, os.PathLike] *init_inputs **kwargs )

参数

pretrained_model_name_or_path (Union[str, os.PathLike]) — 预训练模型的路径

从预训练的 GPT2Tokenizer 创建 TFGPT2Tokenizer

示例

from transformers import TFGPT2Tokenizer

tf_tokenizer = TFGPT2Tokenizer.from_pretrained("openai-community/gpt2")

from_tokenizer

( tokenizer: GPT2Tokenizer *args **kwargs )

参数

tokenizer (GPT2Tokenizer) —

从 GPT2Tokenizer 创建 TFGPT2Tokenizer

示例

from transformers import AutoTokenizer, TFGPT2Tokenizer

tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
tf_tokenizer = TFGPT2Tokenizer.from_tokenizer(tokenizer)

JAX

隐藏 JAX 内容

FlaxGPT2Model

class transformers.FlaxGPT2Model

( config: GPT2Config input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

config (GPT2Config) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32、jax.numpy.float16（在 GPU 上）和 jax.numpy.bfloat16（在 TPU 上）之一。

这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的 `dtype` 执行。

请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。

如果你希望更改模型参数的 dtype，请参阅 to_fp16() 和 to_bf16()。

这是一个基础的 GPT2 模型 Transformer，它输出原始的隐藏状态，顶部没有任何特定的头。

该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是 Flax Linen flax.nn.Module 的子类。可以像常规 Flax 模块一样使用它，并参考 Flax 文档了解所有与常规用法和行为相关的事项。

最后，此模型支持固有的 JAX 功能，例如

call

( input_ids attention_mask = None position_ids = None encoder_hidden_states: typing.Optional[jax.Array] = None encoder_attention_mask: typing.Optional[jax.Array] = None params: typing.Optional[dict] = None past_key_values: 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 ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

input_ids (numpy.ndarray，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length。词汇表中输入序列标记的索引。

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

什么是输入 ID？
attention_mask (numpy.ndarray，形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选自 [0, 1]：
- 1 表示**未被掩码**的标记，
- 0 表示**被掩码**的标记。
什么是注意力掩码？
position_ids (numpy.ndarray，形状为 (batch_size, input_ids_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选值范围为 [0, config.max_position_embeddings - 1]。
past_key_values (dict[str, np.ndarray], 可选, 由 init_cache 返回或在传递先前的 past_key_values 时返回) — 包含预计算的隐藏状态（注意力块中的键和值）的字典，可用于快速自回归解码。预计算的键和值隐藏状态的形状为 [batch_size, max_length]。
output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。更多细节请参阅返回张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参阅返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置（GPT2Config）和输入。

last_hidden_state (形状为 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray) — 模型最后一层输出的隐藏状态序列。

如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (tuple(tuple(jnp.ndarray)), 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(jnp.ndarray) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，并且如果 config.is_encoder_decoder=True，则可选地包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

包含预先计算的隐藏状态（自注意力块中的键和值，如果 config.is_encoder_decoder=True，则可选地包含交叉注意力块中的键和值），可用于（参见 past_key_values 输入）加速顺序解码。
hidden_states (tuple(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.add_cross_attention=True 或 config.output_attentions=True 时返回) — jnp.ndarray 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

FlaxGPT2PreTrainedModel 的前向方法会覆盖 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, FlaxGPT2Model

>>> tokenizer = AutoTokenizer.from_pretrained("openai-community/gpt2")
>>> model = FlaxGPT2Model.from_pretrained("openai-community/gpt2")

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

>>> last_hidden_states = outputs.last_hidden_state

FlaxGPT2LMHeadModel

class transformers.FlaxGPT2LMHeadModel

( config: GPT2Config input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )

参数

config (GPT2Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
dtype (jax.numpy.dtype, 可选, 默认为 jax.numpy.float32) — 计算的数据类型。可以是 jax.numpy.float32、jax.numpy.float16（在 GPU 上）和 jax.numpy.bfloat16（在 TPU 上）之一。

这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的 `dtype` 执行。

请注意，这仅指定计算的 dtype，不影响模型参数的 dtype。

如果你希望更改模型参数的 dtype，请参阅 to_fp16() 和 to_bf16()。

GPT2 Transformer 模型，顶部带有一个语言建模头（线性层，权重与输入嵌入绑定）。

该模型继承自 FlaxPreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是 Flax Linen flax.nn.Module 的子类。可以像常规 Flax 模块一样使用它，并参考 Flax 文档了解所有与常规用法和行为相关的事项。

最后，此模型支持固有的 JAX 功能，例如

call