Hugging Face 的标志

Transformers 文档

OpenAI GPT2

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

OpenAI GPT2

Models Spaces

概述

OpenAI GPT-2 模型由 Alec Radford、Jeffrey Wu、Rewon Child、David Luan、Dario Amodei 和来自 OpenAI 的 Ilya Sutskever 在 Language Models are Unsupervised Multitask Learners 中提出。它是一个因果（单向） Transformer 模型，使用语言建模在约 40 GB 的文本数据的大型语料库上进行了预训练。

该论文的摘要如下：

GPT-2 是一个大型的基于 Transformer 的语言模型，具有 15 亿个参数，在包含 800 万个网页的数据集[1]上进行训练。GPT-2 的训练目标很简单：预测给定文本中所有先前单词的下一个单词。数据集的多样性使得这个简单的目标自然地包含了跨不同领域的许多任务的演示。GPT-2 是 GPT 的直接升级，参数增加了 10 倍以上，训练数据量增加了 10 倍以上。

Write With Transformer 是 Hugging Face 创建和托管的 Web 应用程序，展示了几种模型的生成能力。GPT-2 是其中之一，并提供五种不同尺寸：small、medium、large、xl 以及 small 检查点的精馏版本：distilgpt-2。

此模型由 thomwolf 贡献。原始代码可以在这里找到。

使用技巧

  • GPT-2 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
  • GPT-2 使用因果语言建模 (CLM) 目标进行训练，因此在预测序列中的下一个 token 方面非常强大。利用此功能，GPT-2 可以生成符合语法规则的连贯文本，这可以在 run_generation.py 示例脚本中观察到。
  • 该模型可以将 past_key_values（对于 PyTorch）或 past（对于 TF）作为输入，这是先前计算的键/值注意力对。使用此值（past_key_values 或 past）可以防止模型在文本生成上下文中重新计算预计算的值。对于 PyTorch，请参阅 GPT2Model.forward() 方法的 past_key_values 参数，或者对于 TF，请参阅 TFGPT2Model.call() 方法的 past 参数，以获取有关其用法的更多信息。
  • 启用 scale_attn_by_inverse_layer_idx 和 reorder_and_upcast_attn 标志将应用来自 Mistral 的训练稳定性改进（仅适用于 PyTorch）。

使用示例

generate() 方法可用于使用 GPT2 模型生成文本。

>>> from transformers import AutoModelForCausalLM, AutoTokenizer

>>> model = AutoModelForCausalLM.from_pretrained("gpt2")
>>> tokenizer = AutoTokenizer.from_pretrained("gpt2")

>>> prompt = "GPT2 is a model developed by OpenAI."

>>> input_ids = tokenizer(prompt, return_tensors="pt").input_ids

>>> gen_tokens = model.generate(
...     input_ids,
...     do_sample=True,
...     temperature=0.9,
...     max_length=100,
... )
>>> gen_text = tokenizer.batch_decode(gen_tokens)[0]

使用 Flash Attention 2

Flash Attention 2 是注意力分数计算的更快、更优化的版本，它依赖于 cuda 内核。

安装

首先，检查您的硬件是否与 Flash Attention 2 兼容。兼容硬件的最新列表可以在官方文档中找到。如果您的硬件与 Flash Attention 2 不兼容，您仍然可以通过 Better Transformer 支持从注意力内核优化中获益，详情请见上方内容。

接下来，安装最新版本的 Flash Attention 2

pip install -U flash-attn --no-build-isolation

用法

要使用 Flash Attention 2 加载模型，我们可以将参数 attn_implementation="flash_attention_2" 传递给 .from_pretrained。我们还将以半精度（例如 torch.float16）加载模型，因为它几乎不会降低音频质量，但会显著降低内存使用量并加快推理速度

>>> import torch
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> device = "cuda" # the device to load the model onto

>>> model = AutoModelForCausalLM.from_pretrained("gpt2", torch_dtype=torch.float16, attn_implementation="flash_attention_2")
>>> tokenizer = AutoTokenizer.from_pretrained("gpt2")

>>> prompt = "def hello_world():"

>>> model_inputs = tokenizer([prompt], return_tensors="pt").to(device)
>>> model.to(device)

>>> generated_ids = model.generate(**model_inputs, max_new_tokens=100, do_sample=True)
>>> tokenizer.batch_decode(generated_ids)[0]

预期加速

下图是一个预期加速图，比较了使用 gpt2 检查点的 transformers 原生实现与使用序列长度为 512 的模型 Flash Attention 2 版本之间的纯推理时间。

使用缩放点积注意力 (SDPA)

PyTorch 包括一个原生的缩放点积注意力 (SDPA) 运算符，作为 torch.nn.functional 的一部分。此函数包含多个实现，可以根据输入和正在使用的硬件应用。有关更多信息，请参阅官方文档或 GPU 推理页面。

当有可用的实现时，对于 torch>=2.1.1，SDPA 默认使用，但您也可以在 from_pretrained() 中设置 attn_implementation="sdpa" 以显式请求使用 SDPA。

from transformers import AutoModelForCausalLM
model = AutoModelForCausalLM.from_pretrained("gpt2", torch_dtype=torch.float16, attn_implementation="sdpa")
...

为了获得最佳加速，我们建议以半精度（例如 torch.float16 或 torch.bfloat16）加载模型。

在一个本地基准测试（rtx3080ti-16GB，PyTorch 2.2.1，OS Ubuntu 22.04）中使用 float16 和 gpt2-large，我们在训练和推理期间看到了以下加速。

训练

批大小 序列长度 每批次时间 (Eager - 秒) 每批次时间 (SDPA - 秒) 加速 (%) Eager 峰值内存 (MB) SDPA 峰值内存 (MB) 内存节省 (%)
1 128 0.039 0.032 23.042 3482.32 3494.62 -0.352
1 256 0.073 0.059 25.15 3546.66 3552.6 -0.167
1 512 0.155 0.118 30.96 4230.1 3665.59 15.4
1 1024 0.316 0.209 50.839 8682.26 4881.09 77.875
2 128 0.07 0.06 15.324 3557.8 3545.91 0.335
2 256 0.143 0.122 16.53 3901.5 3657.68 6.666
2 512 0.267 0.213 25.626 7062.21 4876.47 44.822
2 1024 OOM (内存溢出) 0.404 / OOM (内存溢出) 8096.35 SDPA 不会 OOM
4 128 0.134 0.128 4.412 3675.79 3648.72 0.742
4 256 0.243 0.217 12.292 6129.76 4871.12 25.839
4 512 0.494 0.406 21.687 12466.6 8102.64 53.858
4 1024 OOM (内存溢出) 0.795 / OOM (内存溢出) 14568.2 SDPA 不会 OOM

推理

批大小 序列长度 每个 token 延迟 Eager (毫秒) 每个 token 延迟 SDPA (毫秒) 加速 (%) 内存 Eager (MB) 内存 SDPA (MB) 内存节省 (%)
1 128 7.991 6.968 14.681 1685.2 1701.32 -0.947
1 256 8.462 7.199 17.536 1745.49 1770.78 -1.428
1 512 8.68 7.853 10.529 1907.69 1921.29 -0.708
1 768 9.101 8.365 8.791 2032.93 2068.12 -1.701
2 128 9.169 9.001 1.861 1803.84 1811.4 -0.418
2 256 9.907 9.78 1.294 1907.72 1921.44 -0.714
2 512 11.519 11.644 -1.071 2176.86 2197.75 -0.951
2 768 13.022 13.407 -2.873 2464.3 2491.06 -1.074
4 128 10.097 9.831 2.709 1942.25 1985.13 -2.16
4 256 11.599 11.398 1.764 2177.28 2197.86 -0.937
4 512 14.653 14.45 1.411 2753.16 2772.57 -0.7
4 768 17.846 17.617 1.299 3327.04 3343.97 -0.506

资源

以下是官方 Hugging Face 和社区（🌎 表示）资源的列表，可帮助您开始使用 GPT2。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将对其进行审核！该资源最好展示一些新的东西，而不是重复现有资源。

文本生成

GPT2Config

class transformers.GPT2Config

< >

( 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 可以表示的不同 token 的数量。
  • 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) — 嵌入的 dropout 比率。
  • attn_pdrop (float, 可选, 默认为 0.1) — 注意力的 dropout 比率。
  • 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"：提供分类 token 位置的 Tensor（如 GPT/GPT-2）。
    • "attn"：现在未实现，请使用多头注意力。
  • summary_use_proj (bool, 可选, 默认为 True) — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel。

    是否在向量提取后添加投影。

  • summary_activation (str, 可选) — 在进行序列摘要时使用的参数。用于 GPT2DoubleHeadsModel 中的多项选择头。

    传递 "tanh" 以将 tanh 激活应用于输出，任何其他值都将导致无激活。

  • summary_proj_to_labels (bool, optional, 默认为 True) — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中。

    指示投影输出应具有 config.num_labels 还是 config.hidden_size 个类别。

  • summary_first_dropout (float, optional, 默认为 0.1) — 在进行序列摘要时使用的参数，用于模型 GPT2DoubleHeadsModel 和 TFGPT2DoubleHeadsModel 中。

    在投影和激活后使用的 dropout 比率。

  • scale_attn_weights (bool, optional, 默认为 True) — 通过除以 sqrt(hidden_size) 来缩放注意力权重。
  • use_cache (bool, optional, 默认为 True) — 模型是否应返回最后的键/值注意力 (并非所有模型都使用)。
  • bos_token_id (int, optional, 默认为 50256) — 词汇表中句子起始标记的 ID。
  • eos_token_id (int, optional, 默认为 50256) — 词汇表中句子结束标记的 ID。
  • scale_attn_by_inverse_layer_idx (bool, optional, 默认为 False) — 是否额外地通过 1 / layer_idx + 1 缩放注意力权重。
  • reorder_and_upcast_attn (bool, optional, 默认为 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 merges_file errors = 'replace' unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' pad_token = None add_prefix_space = False add_bos_token = False **kwargs )

参数

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

构建 GPT-2 tokenizer。基于字节级 Byte-Pair-Encoding。

此 tokenizer 经过训练，可以将空格视为标记的一部分（有点像 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]

您可以通过在实例化此 tokenizer 或在某些文本上调用它时传递 add_prefix_space=True 来绕过此行为，但由于模型不是以这种方式预训练的，因此可能会导致性能下降。

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

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

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

GPT2TokenizerFast

class transformers.GPT2TokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None unk_token = '<|endoftext|>' bos_token = '<|endoftext|>' eos_token = '<|endoftext|>' add_prefix_space = False **kwargs )

参数

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

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

此 tokenizer 经过训练，可以将空格视为标记的一部分（有点像 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: Optional = None mc_loss: Optional = None logits: FloatTensor = None mc_logits: FloatTensor = None past_key_values: Optional = None hidden_states: Optional = None attentions: Optional = 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 之后的 GPT2Attentions 权重，用于计算自注意力头中的加权平均值。

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

class transformers.models.gpt2.modeling_tf_gpt2.TFGPT2DoubleHeadsModelOutput

< >

( logits: tf.Tensor = None mc_logits: 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)。

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

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

Pytorch
隐藏 Pytorch 内容

GPT2Model

class transformers.GPT2Model

< >

( config )

参数

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

裸 GPT2 模型，输出原始隐藏状态，顶部没有任何特定的 head。

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

此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般用法和行为相关的所有事项。

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

    如果使用 past_key_values，则只有未计算过往信息的 input_ids 应作为 input_ids 传递。

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

    什么是输入 IDs？

  • past_key_values (Tuple[Tuple[torch.Tensor]]，长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将过往信息提供给此模型的 input_ids 不应作为 input_ids 传递，因为它们已被计算过。
  • attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 tokens 未被掩蔽，
    • 0 表示 tokens 被掩蔽。

    如果使用 past_key_values，则 attention_mask 需要包含用于 past_key_values 的掩蔽策略。 换句话说，attention_mask 始终必须具有以下长度： len(past_key_values) + len(input_ids)

    什么是注意力掩码？

  • token_type_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)，可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在 [0, 1] 中选择：

    • 0 对应于 句子 A token，
    • 1 对应于 句子 B token。

    什么是 token 类型 IDs？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 IDs？

  • head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定头无效的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩蔽，
    • 0 表示 head 被掩蔽。
  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。

    如果使用 past_key_values，则可以选择仅输入最后一个 inputs_embeds（请参阅 past_key_values）。

  • 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 (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，如果 config.is_encoder_decoder=True，则还可选地包含 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。

    包含预先计算的隐藏状态（自注意力模块中的键和值，以及如果 config.is_encoder_decoder=True，则还可选地包含交叉注意力模块中的键和值），这些状态可用于（请参阅 past_key_values 输入）加速顺序解码。

  • hidden_states (tuple(torch.FloatTensor)，可选，当传递 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 之后，用于计算交叉注意力头中的加权平均值。

GPT2Model forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, GPT2Model
>>> import torch

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

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

>>> last_hidden_states = outputs.last_hidden_state

GPT2LMHeadModel

class transformers.GPT2LMHeadModel

< >

( config )

参数

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

带有语言建模头的 GPT2 模型转换器（线性层，其权重与输入嵌入相关联）。

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

此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般用法和行为相关的所有事项。

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

    如果使用 past_key_values，则只有未计算过往信息的 input_ids 应作为 input_ids 传递。

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

    什么是输入 IDs？

  • past_key_values (Tuple[Tuple[torch.Tensor]]，长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将过往信息提供给此模型的 input_ids 不应作为 input_ids 传递，因为它们已被计算过。
  • attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 tokens 未被掩蔽，
    • 0 表示 tokens 被掩蔽。

    如果使用 past_key_values，则 attention_mask 需要包含用于 past_key_values 的掩蔽策略。 换句话说，attention_mask 始终必须具有以下长度： len(past_key_values) + len(input_ids)

    什么是注意力掩码？

  • token_type_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)，可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在 [0, 1] 中选择：

    • 0 对应于 句子 A token，
    • 1 对应于 句子 B token。

    什么是 token 类型 IDs？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。范围为 [0, config.max_position_embeddings - 1]。

    什么是位置 IDs？

  • 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 索引转换为关联向量，这将非常有用。

    如果使用了 past_key_values，则可以选择仅输入最后一个 inputs_embeds（请参阅 past_key_values）。

  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于语言建模的标签。请注意，标签在模型内部已移位，即您可以设置 labels = input_ids。索引选自 [-100, 0, ..., config.vocab_size]。所有设置为 -100 的标签都将被忽略（掩蔽），损失仅针对 [0, ..., config.vocab_size] 中的标签计算。

返回值

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 时返回) — 语言建模损失（用于下一个标记预测）。

  • logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 torch.FloatTensor 元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态（如果模型用于编码器-解码器设置）。仅当 config.is_decoder = True 时相关。

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

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

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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 (GPT2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

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

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

此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般用法和行为相关的所有事项。

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None mc_token_ids: Optional = None labels: Optional = None mc_labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None **kwargs ) → transformers.models.gpt2.modeling_gpt2.GPT2DoubleHeadsModelOutput 或 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] (输入 past key value 状态的 sequence_length)。词汇表中输入序列标记的索引。

    如果使用 past_key_values，则仅应将未计算 past 的 input_ids 作为 input_ids 传递。

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

    什么是输入 IDs？

  • past_key_values (长度为 config.n_layers 的 Tuple[Tuple[torch.Tensor]]) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的 past_key_values 输出）。可用于加速顺序解码。已将 past 传递给此模型的 input_ids 不应作为 input_ids 传递，因为它们已被计算过。
  • attention_mask (torch.FloatTensor，形状为 (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 (torch.LongTensor，形状为 (batch_size, input_ids_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引选自 [0, 1]：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是标记类型 IDs？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。范围为 [0, config.max_position_embeddings - 1]。

    什么是位置 IDs？

  • 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 索引转换为关联向量，这将非常有用。

    如果使用了 past_key_values，则可以选择仅输入最后一个 inputs_embeds（请参阅 past_key_values）。

  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • mc_token_ids (torch.LongTensor, 形状为 (batch_size, num_choices)，可选，默认为输入序列的最后一个标记的索引) — 每个输入序列中分类标记的索引。在范围 [0, input_ids.size(-1) - 1] 中选择。
  • labels (torch.LongTensor, 形状为 (batch_size, sequence_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）

返回值

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 之后的 GPT2 注意力权重，用于计算自注意力头中的加权平均值。

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

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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 (GPT2Config) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。

带有跨度分类头的 GPT-2 模型转换器，用于抽取式问答任务，如 SQuAD（隐藏状态输出之上的线性层，用于计算 span start logits 和 span end logits）。

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

此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般用法和行为相关的所有事项。

forward

< >

( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.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()。

    什么是输入 IDs？

  • past_key_values (Tuple[Tuple[torch.Tensor]]，长度为 config.n_layers) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的 past_key_values 输出）。可用于加速顺序解码。已将其过去状态提供给此模型的 input_ids 不应作为 input_ids 传递，因为它们已被计算。
  • attention_mask (torch.FloatTensor, 形状为 (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 (torch.LongTensor, 形状为 (batch_size, input_ids_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是标记类型 IDs？

  • position_ids (torch.LongTensor, 形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 IDs？

  • 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 索引转换为关联向量，这将非常有用。

    如果使用 past_key_values，则可以选择仅输入最后一个 inputs_embeds（请参阅 past_key_values）。

  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • start_positions (torch.LongTensor, 形状为 (batch_size,)，可选) — 用于计算标记分类损失的标记跨度开始位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。
  • end_positions (torch.LongTensor, 形状为 (batch_size,)，可选) — 用于计算标记分类损失的标记跨度结束位置（索引）的标签。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。

返回值

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

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

  • loss (torch.FloatTensor, 形状为 (1,)，可选，当提供 labels 时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor, 形状为 (batch_size, sequence_length)) — 跨度开始分数（SoftMax 之前）。

  • end_logits (torch.FloatTensor, 形状为 (batch_size, sequence_length)) — 跨度结束分数（SoftMax 之前）。

  • hidden_states (tuple(torch.FloatTensor)，可选，当传递 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

此示例使用随机模型，因为真实模型都非常大。为了获得正确的结果，您应该使用 openai-community/gpt2 而不是 openai-community/gpt2。如果您在加载该检查点时内存不足，可以尝试在 from_pretrained 调用中添加 device_map="auto"。

示例

>>> 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]

>>> # 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

GPT2ForSequenceClassification

class transformers.GPT2ForSequenceClassification

< >

( config )

参数

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

带有序列分类头部（线性层）的 GPT2 模型转换器。

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

由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它会找到每行中最后一个不是 padding token 的 token。如果没有定义 pad_token_id，它只会取每行批次的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测 padding token，因此它会执行相同的操作（取每行批次的最后一个值）。

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

此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般用法和行为相关的所有事项。

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.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] (输入 past key value 状态的 sequence_length)。词汇表中输入序列 tokens 的索引。

    如果使用 past_key_values，则只有未计算其 past 的 input_ids 应作为 input_ids 传递。

    索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。

    什么是 input IDs？

  • past_key_values (Tuple[Tuple[torch.Tensor]]，长度为 config.n_layers) — 包含模型计算的预先计算的隐藏状态（attention 模块中的 key 和 values）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将其 past 提供给此模型的 input_ids 不应作为 input_ids 传递，因为它们已被计算过。
  • attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 避免在 padding token 索引上执行 attention 的 Mask。Mask 值在 [0, 1] 中选择：

    • 1 表示 tokens 未被 mask，
    • 0 表示 tokens 被 mask。

    如果使用 past_key_values，则 attention_mask 需要包含用于 past_key_values 的 mask 策略。换句话说，attention_mask 始终必须具有长度：len(past_key_values) + len(input_ids)

    什么是 attention masks？

  • token_type_ids (torch.LongTensor，形状为 (batch_size, input_ids_length)，可选) — 分段 token 索引以指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：

    • 0 对应于 句子 A token，
    • 1 对应于 句子 B token。

    什么是 token type IDs？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是 position IDs？

  • head_mask (torch.FloatTensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify self-attention 模块的选定 head 的 Mask。Mask 值在 [0, 1] 中选择：

    • 1 表示 head 未被 mask，
    • 0 表示 head 被 mask。
  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。

    如果使用 past_key_values，则可以选择仅输入最后一个 inputs_embeds（请参阅 past_key_values）。

  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参见返回的 tensors 下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的 tensors 下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。
  • labels (torch.LongTensor，形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应为 [0, ..., config.num_labels - 1]。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

返回值

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

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

  • loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 分类（或回归，如果 config.num_labels==1）损失。

  • logits (torch.FloatTensor，形状为 (batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。

  • past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，每个 tuple 都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的 tensors)

    包含可用于加速顺序解码的预先计算的隐藏状态（self-attention 模块中的 key 和 values）（请参阅 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

单标签分类示例

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

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

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

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()

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

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

多标签分类示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/DialogRPT-updown")
>>> model = GPT2ForSequenceClassification.from_pretrained("microsoft/DialogRPT-updown", 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(
...     "microsoft/DialogRPT-updown", 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 (GPT2Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。

带有 token 分类头部（隐藏状态输出之上的线性层）的 GPT2 模型，例如用于命名实体识别 (NER) 任务。

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

此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与一般用法和行为相关的所有事项。

forward

< >

( input_ids: Optional = None past_key_values: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput or 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()。

    什么是输入 IDs？

  • past_key_values (Tuple[Tuple[torch.Tensor]]，长度为 config.n_layers) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将过去状态提供给此模型的 input_ids 不应作为 input_ids 传递，因为它们已被计算出。
  • attention_mask (torch.FloatTensor，形状为 (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 (torch.LongTensor，形状为 (batch_size, input_ids_length)，可选) — 片段令牌索引，用于指示输入的第一个和第二个部分。 索引在 [0, 1] 中选择：

    • 0 对应于句子 A 令牌，
    • 1 对应于句子 B 令牌。

    什么是令牌类型 IDs？

  • position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列令牌在位置嵌入中的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 IDs？

  • 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 索引转换为关联的向量，这将非常有用。

    如果使用 past_key_values，则可以选择仅输入最后的 inputs_embeds（请参阅 past_key_values）。

  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回的张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • labels (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于计算序列分类/回归损失的标签。 索引应为 [0, ..., config.num_labels - 1]。 如果 config.num_labels == 1，则计算回归损失（均方误差损失）。如果 config.num_labels > 1，则计算分类损失（交叉熵）。

返回值

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

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

  • loss (torch.FloatTensor，形状为 (1,)，可选，当提供 labels 时返回) — 分类损失。

  • logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_labels)) — 分类得分（在 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

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

>>> tokenizer = AutoTokenizer.from_pretrained("brad1141/gpt2-finetuned-comp2")
>>> model = GPT2ForTokenClassification.from_pretrained("brad1141/gpt2-finetuned-comp2")

>>> 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
['Lead', 'Lead', 'Lead', 'Position', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead', 'Lead']

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.25
TensorFlow
隐藏 TensorFlow 内容

TFGPT2Model

class transformers.TFGPT2Model

< >

( config *inputs **kwargs )

参数

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

裸 GPT2 模型，输出原始隐藏状态，顶部没有任何特定的 head。

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

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。

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

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，则可以使用以下三种可能性来收集第一个位置参数中的所有输入张量

  • 仅包含 input_ids 且不包含其他内容的单个张量：model(input_ids)
  • 包含一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！

call

< >

( input_ids: TFModelInputType | None = None 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 or tuple(tf.Tensor)

参数

  • input_ids (Numpy array 或 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，则只有未计算过去的输入 IDs 应作为 input_ids 传递。

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

    什么是输入 IDs？

  • past_key_values (List[tf.Tensor]，长度为 config.n_layers) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将过去状态提供给此模型的令牌 IDs 不应作为输入 IDs 传递，因为它们已被计算出。
  • attention_mask (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免对 padding 标记索引执行 attention。掩码值在 [0, 1] 中选择：

    • 1 表示标记未被掩盖，
    • 0 表示标记被掩盖。

    如果使用了 past_key_values，则 attention_mask 需要包含用于 past_key_values 的掩码策略。换句话说，attention_mask 始终必须具有以下长度：len(past_key_values) + len(input_ids)

    什么是 attention 掩码？

  • token_type_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是 token type IDs？

  • position_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是 position IDs？

  • head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify self-attention 模块中选定的 head 的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 被掩盖。
  • inputs_embeds (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示而不是传递 input_ids。如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • output_attentions (bool，可选) — 是否返回所有 attention 层的 attention tensors。有关更多详细信息，请参阅返回的 tensors 下的 attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。有关更多详细信息，请参阅返回的 tensors 下的 hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是纯元组。此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。
  • training (bool，可选，默认为 False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。
  • encoder_hidden_states (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的 hidden-states 序列。如果模型配置为解码器，则在 cross-attention 中使用。
  • encoder_attention_mask (tf.Tensor，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免对编码器输入的 padding 标记索引执行 attention。如果模型配置为解码器，则此掩码在 cross-attention 中使用。掩码值在 [0, 1] 中选择：

    • 1 表示标记未被掩盖，
    • 0 表示标记被掩盖。
  • past_key_values (Tuple[Tuple[tf.Tensor]]，长度为 config.n_layers) — 包含 attention 块的预计算 key 和 value hidden states。可用于加速解码。如果使用了 past，则用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids（那些没有将其 past key value states 提供给此模型的），而不是形状为 (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，形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的 hidden-states 序列。

    如果使用 past_key_values，则仅输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (List[tf.Tensor]，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — tf.Tensor 的列表，长度为 config.n_layers，每个 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 的元组（embedding 的输出一个，每层的输出一个），形状为 (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__ 特殊方法。

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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 模型转换器（线性层，其权重与输入嵌入相关联）。

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

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。

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

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，则可以使用以下三种可能性来收集第一个位置参数中的所有输入张量

  • 仅包含 input_ids 且不包含其他内容的单个张量：model(input_ids)
  • 包含一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！

call

< >

( input_ids: TFModelInputType | None = None 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 = sequence_length 如果 past_key_values 为 None，否则为 past_key_values[0].shape[-2]（输入 past key value states 的 sequence_length）。词汇表中输入序列标记的索引。

    如果使用 past_key_values，则只有未计算 past 的输入 IDs 应作为 input_ids 传递。

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

    什么是 input IDs？

  • past_key_values (List[tf.Tensor]，长度为 config.n_layers) — 包含模型计算的预计算 hidden-states（attention 块中的 key 和 values）（请参阅下面的 past_key_values 输出）。可用于加速顺序解码。已将 past 提供给此模型的标记 ID 不应作为输入 ID 传递，因为它们已被计算。
  • attention_mask (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 掩码，用于避免对 padding 标记索引执行 attention。掩码值在 [0, 1] 中选择：

    • 1 表示标记未被掩盖，
    • 0 表示标记被掩盖。

    如果使用了 past_key_values，则 attention_mask 需要包含用于 past_key_values 的掩码策略。换句话说，attention_mask 始终必须具有以下长度：len(past_key_values) + len(input_ids)

    什么是 attention 掩码？

  • token_type_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在 [0, 1] 中选择：

    • 0 对应于句子 A 标记，
    • 1 对应于句子 B 标记。

    什么是 token type IDs？

  • position_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是 position IDs？

  • head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于屏蔽自注意力模块中选定 attention head 的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示 attention head 不被屏蔽，
    • 0 表示 attention head 被屏蔽。
  • inputs_embeds (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 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)，可选) — 用于避免在编码器输入的填充 token 索引上执行注意力的掩码。 如果模型配置为解码器，则在交叉注意力中使用此掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 token 不被屏蔽，
    • 0 表示 token 被屏蔽。
  • past_key_values (Tuple[Tuple[tf.Tensor]]，长度为 config.n_layers) — 包含注意力块的预计算的键和值隐藏状态。 可用于加速解码。 如果使用 past，则用户可以选择仅输入最后 decoder_input_ids（那些没有将其过去键值状态提供给此模型的），形状为 (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 (tf.Tensor，形状为 (n,)，可选，当提供 labels 时返回，其中 n 是非屏蔽标签的数量) — 语言建模损失（用于下一个 token 预测）。

  • logits (tf.Tensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇 token 的分数）。

  • hidden_states (tuple(tf.Tensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 元组（embeddings 的输出一个，每层的输出一个），形状为 (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 时返回) — tf.Tensor 的列表，长度为 config.n_layers，每个 tensor 的形状为 (2, batch_size, num_heads, sequence_length, embed_size_per_head))。

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

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

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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() 方法以加载模型权重。

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

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

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。

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

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，则可以使用以下三种可能性来收集第一个位置参数中的所有输入张量

  • 仅包含 input_ids 且不包含其他内容的单个张量：model(input_ids)
  • 包含一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！

call

< >

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

    如果使用 past_key_values，则只有未计算过去的输入 ID 应作为 input_ids 传递。

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

    什么是输入 ID？

  • past_key_values (List[tf.Tensor]，长度为 config.n_layers) — 包含模型计算的预计算隐藏状态（注意力块中的键和值）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将其过去状态提供给此模型的 token id 不应作为输入 id 传递，因为它们已被计算。
  • attention_mask (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上执行注意力的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 token 不被屏蔽，
    • 0 表示 token 被屏蔽。

    如果使用 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, sequence_length)，可选) — 段 token 索引，用于指示输入的第一个和第二个部分。 索引在 [0, 1] 中选择：

    • 0 对应于句子 A token，
    • 1 对应于句子 B token。

    什么是 token 类型 ID？

  • position_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 ID？

  • head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于屏蔽自注意力模块中选定 attention head 的掩码。掩码值在 [0, 1] 中选择：

    • 1 表示 attention head 不被屏蔽，
    • 0 表示 attention head 被屏蔽。
  • inputs_embeds (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 详见返回张量下的 attentions 部分了解更多详情。 此参数仅在 eager 模式下可用，在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states 部分了解更多详情。 此参数仅在 eager 模式下可用，在 graph 模式下将使用配置中的值。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。 此参数可在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。
  • training (bool, optional, defaults to False) — 是否使用训练模式的模型（某些模块如 dropout 模块在训练和评估之间有不同的行为）。
  • mc_token_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, num_choices)，可选，默认为输入序列的最后一个 token 的索引) — 每个输入序列中分类 token 的索引。 在范围 [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 之前每个词汇 token 的分数）。

  • mc_logits (tf.Tensor，形状为 (batch_size, num_choices)) — 多项选择分类头的预测分数（SoftMax 之前每个选项的分数）。

  • past_key_values (List[tf.Tensor]，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — tf.Tensor 的列表，长度为 config.n_layers，每个 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 元组（embeddings 的输出一个，每层的输出一个），形状为 (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 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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 模型转换器。

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

由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它会找到每行中最后一个不是 padding token 的 token。如果没有定义 pad_token_id，它只会取每行批次的最后一个值。由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测 padding token，因此它会执行相同的操作（取每行批次的最后一个值）。

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

此模型也是 keras.Model 子类。 将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档，了解与常规用法和行为相关的所有事项。

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

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

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时首选此格式。 由于这种支持，当使用诸如 model.fit() 之类的方法时，对于您来说，事情应该“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！ 但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建自己的层或模型时，则可以使用以下三种可能性来收集第一个位置参数中的所有输入张量

  • 仅包含 input_ids 且不包含其他内容的单个张量：model(input_ids)
  • 包含一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：model([input_ids, attention_mask]) 或 model([input_ids, attention_mask, token_type_ids])
  • 包含一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：model({"input_ids": input_ids, "token_type_ids": token_type_ids})

请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！

call

< >

( input_ids: TFModelInputType | None = None 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 array 或 tf.Tensor，形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_values 为 None，否则为 past_key_values[0].shape[-2] (输入过去 key value 状态的 sequence_length)。 词汇表中输入序列 token 的索引。

    如果使用 past_key_values，则仅应将未计算其过去的输入 ID 作为 input_ids 传递。

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

    什么是输入 ID？

  • past_key_values (长度为 config.n_layers 的 List[tf.Tensor]) — 包含模型计算的预先计算的隐藏状态（注意力块中的键和值）（请参阅下面的 past_key_values 输出）。 可用于加速顺序解码。 已将其过去状态提供给此模型的 token ID 不应作为输入 ID 传递，因为它们已被计算出来。
  • attention_mask (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 token 未被掩盖，
    • 0 表示 token 已被掩盖。

    如果使用 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, sequence_length)，可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在 [0, 1] 中选择：

    • 0 对应于 句子 A token，
    • 1 对应于 句子 B token。

    什么是 token 类型 ID？

  • position_ids (tf.Tensor 或 Numpy array，形状为 (batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。 在范围 [0, config.max_position_embeddings - 1] 中选择。

    什么是位置 ID？

  • head_mask (Numpy array 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于 nullify 自注意力模块的选定头的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 head 未被掩盖，
    • 0 表示 head 已被掩盖。
  • inputs_embeds (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 详见返回张量下的 attentions 部分了解更多详情。 此参数仅在 eager 模式下可用，在 graph 模式下将使用配置中的值。
  • output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states 部分了解更多详情。 此参数仅在 eager 模式下可用，在 graph 模式下将使用配置中的值。
  • return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通的元组。 此参数可在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。
  • training (bool, optional, defaults to 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 时返回) — tf.Tensor 的列表，长度为 config.n_layers，每个 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 元组（embeddings 的输出一个，每层的输出一个），形状为 (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 的 forward 方法，覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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: 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 (形状为 (batch_size, ) 的 tf.Tensor，可选，当提供 labels 时返回) — 分类（如果 config.num_labels==1 则为回归）损失。
  • logits (形状为 (batch_size, config.num_labels) 的 tf.Tensor) — 分类（如果 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 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 tf.Tensor 元组（每个嵌入输出一个，每层输出一个）。

    模型在每一层输出端的隐藏状态，加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选，当传递 output_attentions=True 或 config.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 tf.Tensor 元组（每层一个）。

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

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

TFGPT2Tokenizer

class transformers.TFGPT2Tokenizer

< >

( vocab: Dict merges: List max_length: int = None pad_token_id: 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: Union *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 模型，输出原始隐藏状态，顶部没有任何特定的 head。

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

此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参考 Flax 文档以了解与常规用法和行为相关的所有事项。

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

__call__

< >

( input_ids attention_mask = None position_ids = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None params: dict = None past_key_values: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID？

  • attention_mask (形状为 (batch_size, sequence_length) 的 numpy.ndarray, 可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在 [0, 1] 中选择：

    • 1 表示 未被掩盖 的 token，
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码？

  • position_ids (numpy.ndarray，形状为 (batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的索引。在范围 [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 (jnp.ndarray，形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出端的隐藏状态序列。

    如果使用 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(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 的 forward 方法覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> 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 模型转换器（线性层，其权重与输入嵌入相关联）。

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

此模型也是 Flax Linen flax.nn.Module 子类。将其用作常规 Flax 模块，并参考 Flax 文档以了解与常规用法和行为相关的所有事项。

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

__call__

< >

( input_ids attention_mask = None position_ids = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None params: dict = None past_key_values: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID？

  • attention_mask (numpy.ndarray，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 在 [0, 1] 中选择的掩码值：

    • 1 表示 未被掩盖 的 token，
    • 0 表示 被掩盖 的 token。

    什么是注意力掩码？

  • position_ids (numpy.ndarray，形状为 (batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的索引。在范围 [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.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

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

  • logits (jnp.ndarray，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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 输入）加速顺序解码。

FlaxGPT2PreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数内定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, FlaxGPT2LMHeadModel

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

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

>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]
< > 更新 在 GitHub 上

←GPT-J GPTBigCode→