Transformers 文档

GPT Neo

Hugging Face's logo
加入 Hugging Face 社区

并获取增强文档体验的访问权限

以开始使用

GPT Neo

概述

GPTNeo 模型由 Sid Black、Stella Biderman、Leo Gao、Phil Wang 和 Connor Leahy 在 EleutherAI/gpt-neo 存储库中发布。它是一个类似于 GPT2 的因果语言模型,在 Pile 数据集上进行训练。

该架构与 GPT2 类似,除了 GPT Neo 在每隔一层使用局部注意力,窗口大小为 256 个标记。

此模型由 valhalla 贡献。

使用示例

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

>>> from transformers import GPTNeoForCausalLM, GPT2Tokenizer

>>> model = GPTNeoForCausalLM.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> tokenizer = GPT2Tokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")

>>> prompt = (
...     "In a shocking finding, scientists discovered a herd of unicorns living in a remote, "
...     "previously unexplored valley, in the Andes Mountains. Even more surprising to the "
...     "researchers was the fact that the unicorns spoke perfect English."
... )

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

结合 GPT-Neo 和 Flash Attention 2

首先,确保安装最新版本的 Flash Attention 2 以包含滑动窗口注意力功能,并确保您的硬件与 Flash-Attention 2 兼容。有关安装的更多详细信息,请参阅 此处

还要确保以半精度加载您的模型(例如,torch.float16)。

要使用 Flash Attention 2 加载和运行模型,请参考下面的代码段

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

>>> model = AutoModelForCausalLM.from_pretrained("EleutherAI/gpt-neo-2.7B", torch_dtype=torch.float16, attn_implementation="flash_attention_2")
>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-2.7B")

>>> 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]
"def hello_world():\n    >>> run_script("hello.py")\n    >>> exit(0)\n<|endoftext|>"

预期加速

以下是比较使用 EleutherAI/gpt-neo-2.7B 检查点的 transformers 中的本机实现与模型的 Flash Attention 2 版本之间的纯推理时间的预期加速图。请注意,对于 GPT-Neo,无法在非常长的上下文中进行训练/运行,因为最大 位置嵌入 限制为 2048 - 但这适用于所有 gpt-neo 模型,而不是特定于 FA-2 的

资源

GPTNeoConfig

class transformers.GPTNeoConfig

< >

( vocab_size = 50257 max_position_embeddings = 2048 hidden_size = 2048 num_layers = 24 attention_types = [[['global', 'local'], 12]] num_heads = 16 intermediate_size = None window_size = 256 activation_function = 'gelu_new' resid_dropout = 0.0 embed_dropout = 0.0 attention_dropout = 0.0 classifier_dropout = 0.1 layer_norm_epsilon = 1e-05 initializer_range = 0.02 use_cache = True bos_token_id = 50256 eos_token_id = 50256 **kwargs )

参数

  • vocab_size (int, 可选, 默认值为 50257) — GPT Neo 模型的词汇量大小。定义了调用GPTNeoModel时传递的inputs_ids 可以表示的不同标记的数量。模型的词汇量大小。定义了传递给GPTNeoModel的forward方法的inputs_ids可以表示的不同标记。
  • max_position_embeddings (int, 可选, 默认值为 2048) — 此模型可能使用的最大序列长度。通常将此设置为一个较大的值,以防万一(例如,512 或 1024 或 2048)。
  • hidden_size (int, 可选, 默认值为 2048) — 编码器层和池化层的维度。
  • num_layers (int, 可选, 默认值为 24) — Transformer 编码器中的隐藏层数量。
  • attention_types (List, 可选, 默认值为 [[['global', 'local'], 12]]) — List 中每层的注意力类型,格式为 [[["attention_type"], num_layerss]],例如对于 24 层模型 [[["global"], 24]][[["global", "local"], 12]],从 ["global", "local"] 中选择attention_type 的值。
  • num_heads (int, 可选, 默认值为 16) — Transformer 编码器中每个注意力层的注意力头数量。
  • intermediate_size (int, 可选, 默认值为 8192) — Transformer 编码器中“中间”(即前馈)层的维度。
  • window_size (int, 可选, 默认值为 256) — 局部注意力的滑动窗口大小。
  • activation_function (strfunction, 可选, 默认值为 "gelu_new") — 编码器和池化器中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""selu""gelu_new"
  • resid_dropout (float, 可选, 默认值为 0.0) — 注意力模式中使用的残差丢弃。
  • embed_dropout (float, 可选, 默认值为 0.0) — 嵌入、编码器和池化器中所有全连接层的丢弃概率。
  • attention_dropout (float, 可选, 默认值为 0.0) — 注意力概率的丢弃率。
  • classifier_dropout (float, 可选, 默认值为 0.1) — 在进行令牌分类时使用的参数,在模型 GPTNeoForTokenClassification 中使用。隐藏层的丢弃率。
  • layer_norm_epsilon (float, 可选, 默认值为 1e-05) — 层归一化层使用的 epsilon。
  • initializer_range (float, 可选, 默认值为 0.02) — 用于初始化所有权重矩阵的截断正态初始化的标准差。
  • use_cache (bool, 可选, 默认值为 True) — 模型是否应该返回最后的键/值注意力(并非所有模型都使用)。仅在 config.is_decoder=True 时才相关。
  • bos_token_id (int, 可选, 默认值为 50256) — 词汇表中句首标记的 id。
  • eos_token_id (int, 可选, 默认值为 50256) — 词汇表中句尾标记的 id。

这是一个配置类,用于存储 GPTNeoModel 的配置。它用于根据指定的参数实例化 GPT Neo 模型,定义模型架构。使用默认值实例化配置将产生与 GPTNeo EleutherAI/gpt-neo-1.3B 架构类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import GPTNeoConfig, GPTNeoModel

>>> # Initializing a GPTNeo EleutherAI/gpt-neo-1.3B style configuration
>>> configuration = GPTNeoConfig()

>>> # Initializing a model (with random weights) from the EleutherAI/gpt-neo-1.3B style configuration
>>> model = GPTNeoModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config
Pytorch
隐藏 Pytorch 内容

GPTNeoModel

class transformers.GPTNeoModel

< >

( config )

参数

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

GPT Neo 模型的裸 Transformer,输出原始隐藏状态,没有任何特定头部。

此模型继承自 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 use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则 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]] 长度为 config.num_layers) — 包含模型计算的预先计算的隐藏状态(注意块中的键和值)(见下文的 past_key_values 输出)。可用于加速顺序解码。传递到此模型的 input_ids 应不作为 input_ids 传递,因为它们已计算完毕。
  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示未掩码的标记。
    • 0 表示掩码的标记。

    什么是注意力掩码?

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

    • 0 对应于一个 句子 A 标记,
    • 1 对应于一个 句子 B 标记。

    什么是标记类型 ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 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 索引转换为关联的向量,这很有用。

    如果使用了 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.BaseModelOutputWithPastAndCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPastAndCrossAttentions 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=Falseconfig.return_dict=False),包括根据配置 (GPTNeoConfig) 和输入而变化的各种元素。

  • 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=Trueconfig.use_cache=True 时返回) — 长度为 config.n_layerstuple(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=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (一个用于嵌入的输出,如果模型具有嵌入层,+ 一个用于每一层的输出) ,形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

  • cross_attentions (tuple(torch.FloatTensor), 可选,当传入 output_attentions=Trueconfig.add_cross_attention=Trueconfig.output_attentions=True 时返回) — 形状为 (batch_size, num_heads, sequence_length, sequence_length)torch.FloatTensor 元组 (每个层一个)。

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

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

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

示例

>>> from transformers import AutoTokenizer, GPTNeoModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = GPTNeoModel.from_pretrained("EleutherAI/gpt-neo-1.3B")

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

>>> last_hidden_states = outputs.last_hidden_state

GPTNeoForCausalLM

class transformers.GPTNeoForCausalLM

< >

( config )

参数

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

GPT Neo 模型 Transformer,顶部带有一个语言建模头 (权重与输入嵌入绑定的线性层)。

此模型继承自 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.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, input_ids_length)torch.LongTensor) — input_ids_length = sequence_length 如果 past_key_valuesNone 否则 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 (长度为 config.num_layersTuple[Tuple[torch.Tensor]]) — 包含模型计算的预计算隐藏状态 (注意力块中的键和值) (见下文的 past_key_values 输出)。可用于加速顺序解码。应该将过去值传递给此模型的 input_ids 不应作为 input_ids 传入,因为它们已经计算过了。
  • attention_mask (形状为 (batch_size, sequence_length)torch.FloatTensor可选) — 掩码以避免对填充标记索引执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示 未屏蔽 的标记,
    • 0 表示 屏蔽 的标记。

    什么是注意力掩码?

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

    • 0 对应于一个 句子 A 标记,
    • 1 对应于一个 句子 B 标记。

    什么是标记类型 ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)可选) — 每个输入序列标记在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 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 索引转换为关联向量,这将非常有用。

    如果使用了 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.CausalLMOutputWithCrossAttentionstuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时),包括根据配置 (GPTNeoConfig) 和输入的不同元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,在提供 labels 时返回) — 语言建模损失 (用于下一个标记预测)。

  • logits (torch.FloatTensor 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数 (SoftMax 之前的每个词汇标记的分数)。

  • hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (一个用于嵌入的输出,如果模型具有嵌入层,+ 一个用于每一层的输出) ,形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=Trueconfig.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 时返回) — torch.FloatTensor 元组,长度为 config.n_layers,每个元组包含自注意力和交叉注意力层的缓存键、值状态 (如果模型在编码器-解码器设置中使用)。仅在 config.is_decoder = True 时才相关。

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

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

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = GPTNeoForCausalLM.from_pretrained("EleutherAI/gpt-neo-1.3B")

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

GPTNeoForQuestionAnswering

class transformers.GPTNeoForQuestionAnswering

< >

( config )

参数

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

GPT-Neo 模型转换器,在其上添加了跨度分类头,用于 SQuAD 等抽取式问答任务(在隐藏状态输出之上添加线性层,用于计算跨度开始 logits 和跨度结束 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 or tuple(torch.FloatTensor)

参数

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

    如果使用 past_key_values,则应将没有计算其过去值的 input_ids 作为 input_ids 传递。

    索引可以使用 AutoTokenizer 获取。 请查看 PreTrainedTokenizer.encode()PreTrainedTokenizer.call() 以了解详情。

    什么是 input IDs?

  • past_key_values (Tuple[Tuple[torch.Tensor]] of length config.num_layers) — 包含模型计算的预先计算的隐藏状态(注意力块中的键和值)(参见下面的 past_key_values 输出)。 可以用于加速顺序解码。 传递给此模型的 input_ids 应该没有被传递为 input_ids,因为它们已经计算过了。
  • attention_mask (torch.FloatTensor of shape (batch_size, sequence_length), optional) — 用于避免对填充 token 索引执行注意力的掩码。 掩码值选择在 [0, 1] 中:

    • 1 表示未屏蔽的 token,
    • 0 表示屏蔽的 token。

    什么是注意力掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, input_ids_length), optional) — 段 token 索引,用于指示输入的第一部分和第二部分。 索引选择在 [0, 1] 中:

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

    什么是 token 类型 ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列中每个 token 在位置嵌入中的位置索引。在 [0, config.max_position_embeddings - 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 索引转换为相关向量进行更多控制,而不是模型的内部嵌入查找矩阵,这将很有用。

    如果使用 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,), 可选) — 用于计算 token 分类损失的标记跨度开始位置的标签 (索引)。位置被限制在序列长度 (sequence_length) 内。序列之外的位置不会被考虑用于计算损失。
  • end_positions (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算 token 分类损失的标记跨度结束位置的标签 (索引)。位置被限制在序列长度 (sequence_length) 内。序列之外的位置不会被考虑用于计算损失。

返回值

transformers.modeling_outputs.QuestionAnsweringModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或者当 config.return_dict=False 时),包含根据配置 (GPTNeoConfig) 和输入的不同元素。

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

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

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

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

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

示例

>>> from transformers import AutoTokenizer, GPTNeoForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = GPTNeoForQuestionAnswering.from_pretrained("EleutherAI/gpt-neo-1.3B")

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

GPTNeoForSequenceClassification

class transformers.GPTNeoForSequenceClassification

< >

( config )

参数

  • config (GPTNeoConfig) — 模型配置类,包含模型的所有参数。用配置文

GPTNeo 模型转换器,顶部带有序列分类头(线性层)。

GPTNeoForSequenceClassification 使用最后一个令牌进行分类,就像其他因果模型(例如 GPT-1)一样。

由于它对最后一个令牌进行分类,因此需要知道最后一个令牌的位置。如果配置中定义了 pad_token_id,它会找到每行中不是填充令牌的最后一个令牌。如果没有定义 pad_token_id,它只会简单地获取批处理中每行的最后一个值。由于它无法在传递 inputs_embeds 而不是 input_ids 时猜测填充令牌,因此它会执行相同的操作(获取批处理中每行的最后一个值)。

此模型继承自 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.SequenceClassifierOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, input_ids_length)) — input_ids_length = sequence_length 如果 past_key_valuesNone,否则为 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]] 长度为 config.num_layers) — 包含模型计算的预计算隐藏状态(注意块中的键和值)(参见下面的 past_key_values 输出)。可用于加快顺序解码。传递给此模型的具有过去的 input_ids 不应作为 input_ids 传递,因为它们已经计算过了。
  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)可选) — 避免对填充令牌索引执行注意的掩码。在 [0, 1] 中选择的掩码值:

    • 1 表示未被掩盖的令牌,
    • 0 表示被掩盖的令牌。

    什么是注意掩码?

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

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

    什么是标记类型 ID?

  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。从 [0, config.max_position_embeddings - 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 索引转换为关联的向量,这很有用。

    如果使用了 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,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1,则计算回归损失(均方损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回值

transformers.modeling_outputs.SequenceClassifierOutputWithPasttuple(torch.FloatTensor)

transformers.modeling_outputs.SequenceClassifierOutputWithPasttorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (GPTNeoConfig) 和输入的不同元素。

  • 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_layerstuple(torch.FloatTensor) 元组,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。

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

  • hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (一个用于嵌入的输出,如果模型具有嵌入层,+ 一个用于每一层的输出) ,形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

GPTNeoForSequenceClassification 正向方法覆盖了 __call__ 特殊方法。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = GPTNeoForSequenceClassification.from_pretrained("EleutherAI/gpt-neo-1.3B")

>>> 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 = GPTNeoForSequenceClassification.from_pretrained("EleutherAI/gpt-neo-1.3B", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, GPTNeoForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = GPTNeoForSequenceClassification.from_pretrained("EleutherAI/gpt-neo-1.3B", 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 = GPTNeoForSequenceClassification.from_pretrained(
...     "EleutherAI/gpt-neo-1.3B", 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

GPTNeoForTokenClassification

class transformers.GPTNeoForTokenClassification

< >

( config )

参数

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

在 GPT Neo 模型之上添加一个令牌分类头部(在隐藏状态输出之上添加一个线性层),例如用于命名实体识别(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_valuesNone,否则 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]] 长度为 config.num_layers) — 包含模型计算的预计算隐藏状态(注意块中的键和值)(参见下面的 past_key_values 输出)。 可以用来加速顺序解码。 应该将 past_key_values 传递到此模型的 input_ids 不应作为 input_ids 传递,因为它们已经计算过了。
  • attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充令牌索引执行注意的掩码。 在 [0, 1] 中选择掩码值:

    • 1 表示 未掩码 的令牌,
    • 0 表示 掩码 的令牌。

    什么是注意掩码?

  • token_type_ids (torch.LongTensor of shape (batch_size, input_ids_length), optional) — 用于指示输入的第一部分和第二部分的片段标记索引。索引在 [0, 1] 中选择:

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

    什么是令牌类型 ID?

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

    什么是位置 ID?

  • head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — 用于使自注意力模块的选定头部失效的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示头部未被掩码
    • 0 表示头部被掩码
  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,您可以选择直接传递嵌入式表示,而不是传递 input_ids。如果您希望比模型内部嵌入查找矩阵对如何将 input_ids 索引转换为相关向量有更多控制,这将很有用。

    如果使用 past_key_values,则可以选择仅输入最后一个 inputs_embeds(参见 past_key_values)。

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

返回值

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

A transformers.modeling_outputs.TokenClassifierOutputtorch.FloatTensor 的元组(如果传递 return_dict=False 或当 config.return_dict=False 时),包含根据配置(GPTNeoConfig)和输入的不同元素。

  • loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 分类损失。

  • logits (torch.FloatTensor of shape (batch_size, sequence_length, config.num_labels)) — 分类分数(在 SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor)可选,在传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — torch.FloatTensor 元组 (一个用于嵌入的输出,如果模型具有嵌入层,+ 一个用于每一层的输出) ,形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor)可选,在传递 output_attentions=Trueconfig.output_attentions=True 时返回) — torch.FloatTensor 元组 (每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

GPTNeoForTokenClassification 前向方法,重写 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, GPTNeoForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-125m")
>>> model = GPTNeoForTokenClassification.from_pretrained("EleutherAI/gpt-neo-125m")

>>> inputs = tokenizer(
...     "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )

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

>>> predicted_token_class_ids = logits.argmax(-1)

>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]

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

FlaxGPTNeoModel

class transformers.FlaxGPTNeoModel

< >

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

参数

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

    这可以用来启用混合精度训练或半精度推理在 GPU 或 TPU 上。 如果指定,所有计算将使用给定的 dtype 进行。

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

    如果您想更改模型参数的 dtype,请参见 to_fp16()to_bf16()

基础 GPTNeo 模型变压器,输出原始隐藏状态,没有任何特定的头部。

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

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

最后,此模型支持固有的 JAX 特性,例如

__call__

< >

( input_ids attention_mask = None position_ids = 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.FlaxBaseModelOutputtuple(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, 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.FlaxBaseModelOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False 或者当 config.return_dict=False 时),包含各种元素,具体取决于配置 (GPTNeoConfig) 和输入。

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

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxGPTNeoPreTrainedModel 正向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxGPTNeoModel

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = FlaxGPTNeoModel.from_pretrained("EleutherAI/gpt-neo-1.3B")

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

>>> last_hidden_states = outputs.last_hidden_state

FlaxGPTNeoForCausalLM

class transformers.FlaxGPTNeoForCausalLM

< >

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

参数

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

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

    注意,这只会指定计算的 dtype,不会影响模型参数的 dtype

    如果你想改变模型参数的 dtype,请查看 to_fp16()to_bf16()

带有语言建模头的 GPTNeo 模型变换器(线性层,权重与输入嵌入绑定)。

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

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

最后,此模型支持固有的 JAX 特性,例如

__call__

< >

( input_ids attention_mask = None position_ids = 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.FlaxMaskedLMOutputtuple(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, sequence_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.FlaxMaskedLMOutputtuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutputtorch.FloatTensor 的元组(如果传递了 return_dict=False,或者当 config.return_dict=False 时),包含根据配置(GPTNeoConfig)和输入而定的各种元素。

  • logits (jnp.ndarray 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数(SoftMax 之前的每个词表标记的分数)。

  • hidden_states (tuple(jnp.ndarray)可选,在传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — jnp.ndarray 的元组(一个用于嵌入的输出,一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出的隐藏状态以及初始嵌入输出。

  • attentions (tuple(jnp.ndarray)可选,在传递 output_attentions=True 或当 config.output_attentions=True 时返回) — jnp.ndarray 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

FlaxGPTNeoPreTrainedModel 正向方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, FlaxGPTNeoForCausalLM

>>> tokenizer = AutoTokenizer.from_pretrained("EleutherAI/gpt-neo-1.3B")
>>> model = FlaxGPTNeoForCausalLM.from_pretrained("EleutherAI/gpt-neo-1.3B")

>>> 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 上更新