Hugging Face 的 logo

Transformers 文档

Phi

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验

开始使用

Phi

概述

Phi-1 模型由 Suriya Gunasekar、Yi Zhang、Jyoti Aneja、Caio César Teodoro Mendes、Allie Del Giorno、Sivakanth Gopi、Mojan Javaheripi、Piero Kauffmann、Gustavo de Rosa、Olli Saarikivi、Adil Salim、Shital Shah、Harkirat Singh Behl、Xin Wang、Sébastien Bubeck、Ronen Eldan、Adam Tauman Kalai、Yin Tat Lee 和 Yuanzhi Li 在 教科书就是你所需要的 中提出。

Phi-1.5 模型由 Yuanzhi Li、Sébastien Bubeck、Ronen Eldan、Allie Del Giorno、Suriya Gunasekar 和 Yin Tat Lee 在 教科书就是你所需要的 II：phi-1.5 技术报告 中提出。

总结

在 Phi-1 和 Phi-1.5 的论文中，作者展示了数据质量在训练中相对于模型规模的重要性。他们选择了高质量的“教科书”数据以及合成生成的数据，用于训练他们基于 Transformer 的小型模型 Phi-1，该模型具有 13 亿个参数。尽管规模较小，但 Phi-1 在 HumanEval 上的 Pass@1 准确率达到了 50.6%，在 MBPP 上达到了 55.5%。他们对 Phi-1.5 采用了相同的策略，并创建了另一个具有 13 亿个参数的模型，其在自然语言任务上的性能与大 5 倍的模型相当，并且超越了大多数非前沿的 LLM。Phi-1.5 呈现了许多大型 LLM 的特征，例如“逐步思考”或执行一些基本的上下文学习的能力。通过这两个实验，作者成功地展示了在训练机器学习模型时，训练数据质量的巨大影响。

Phi-1 论文的摘要如下：

我们介绍了 phi-1，这是一种用于代码的新型大型语言模型，其规模远小于竞争模型：phi-1 是一种基于 Transformer 的模型，具有 13 亿个参数，在 8 个 A100 上训练了 4 天，使用从网络上选择的部分“教科书质量”数据（60 亿个 token）以及使用 GPT-3.5 合成生成的教科书和练习（10 亿个 token）。尽管规模较小，但 phi-1 在 HumanEval 上的 Pass@1 准确率达到了 50.6%，在 MBPP 上达到了 55.5%。与 phi-1-base（我们模型在编码练习数据集上微调之前的版本）和 phi-1-small（一个较小的模型，具有 3.5 亿个参数，使用与 phi-1 相同的管道训练，仍然在 HumanEval 上达到 45% 的准确率）相比，它还展示了令人惊讶的新兴特性。

Phi-1.5 论文的摘要如下：

我们继续研究小型基于 Transformer 的语言模型的潜力，这项研究始于 TinyStories（一个可以生成连贯英语的 1000 万参数模型）以及随后的 phi-1（一个具有 13 亿个参数的模型，其 Python 编码性能接近最先进水平）的工作。后一项工作提出使用现有的大型语言模型 (LLM) 生成“教科书质量”数据，以此作为与传统网络数据相比增强学习过程的一种方式。我们遵循“教科书就是你所需要的一切”的方法，这次专注于自然语言中的常识推理，并创建了一个名为 phi-1.5 的新 13 亿参数模型，其在自然语言任务上的性能与大 5 倍的模型相当，并且在更复杂的推理任务（例如小学数学和基本编码）上超越了大多数非前沿的 LLM。更一般地说，phi-1.5 呈现了许多大型 LLM 的特征，既有好的——例如“逐步思考”或执行一些基本的上下文学习的能力——也有坏的，包括幻觉以及产生有毒和有偏见内容的可能性——令人鼓舞的是，由于没有使用网络数据，我们在这一方面看到了改进。我们开源 phi-1.5 以促进对这些紧迫主题的进一步研究。

该模型由 Susnato Dhar 提供。

Phi-1、Phi-1.5 和 Phi-2 的原始代码分别可以在 这里、这里 和 这里 找到。

使用技巧

  • 该模型与 Llama 非常相似，主要区别在于 PhiDecoderLayer，其中它们并行配置了 PhiAttention 和 PhiMLP 层。
  • 该模型使用的分词器与 CodeGenTokenizer 相同。

如何使用 Phi-2

Phi-2 已集成到 transformers 的开发版本 (4.37.0.dev) 中。在通过 pip 发布正式版本之前，请确保您正在执行以下操作之一：

  • 加载模型时，请确保将 trust_remote_code=True 作为 from_pretrained() 函数的参数传递。

  • 将您的本地 transformers 更新到开发版本：pip uninstall -y transformers && pip install git+https://github.com/huggingface/transformers。前面的命令是克隆和从源代码安装的替代方法。

>>> from transformers import AutoModelForCausalLM, AutoTokenizer

>>> model = AutoModelForCausalLM.from_pretrained("microsoft/phi-2")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-2")

>>> inputs = tokenizer('Can you help me write a formal email to a potential business partner proposing a joint venture?', return_tensors="pt", return_attention_mask=False)

>>> outputs = model.generate(**inputs, max_length=30)
>>> text = tokenizer.batch_decode(outputs)[0]
>>> print(text)
Can you help me write a formal email to a potential business partner proposing a joint venture?
Input: Company A: ABC Inc.
Company B

示例：

>>> from transformers import PhiForCausalLM, AutoTokenizer

>>> # define the model and tokenizer.
>>> model = PhiForCausalLM.from_pretrained("microsoft/phi-1_5")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1_5")

>>> # feel free to change the prompt to your liking.
>>> prompt = "If I were an AI that had just achieved"

>>> # apply the tokenizer.
>>> tokens = tokenizer(prompt, return_tensors="pt")

>>> # use the model to generate new tokens.
>>> generated_output = model.generate(**tokens, use_cache=True, max_new_tokens=10)

>>> tokenizer.batch_decode(generated_output)[0]
'If I were an AI that had just achieved a breakthrough in machine learning, I would be thrilled'

结合 Phi 和 Flash Attention 2

首先，确保安装最新版本的 Flash Attention 2 以包含滑动窗口注意力功能。

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

还要确保您的硬件与 Flash-Attention 2 兼容。在 flash-attn 存储库的官方文档中了解更多信息。还要确保以半精度加载您的模型（例如 torch.float16“）。

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

>>> import torch
>>> from transformers import PhiForCausalLM, AutoTokenizer

>>> # define the model and tokenizer and push the model and tokens to the GPU.
>>> model = PhiForCausalLM.from_pretrained("microsoft/phi-1_5", torch_dtype=torch.float16, attn_implementation="flash_attention_2").to("cuda")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1_5")

>>> # feel free to change the prompt to your liking.
>>> prompt = "If I were an AI that had just achieved"

>>> # apply the tokenizer.
>>> tokens = tokenizer(prompt, return_tensors="pt").to("cuda")

>>> # use the model to generate new tokens.
>>> generated_output = model.generate(**tokens, use_cache=True, max_new_tokens=10)
>>> tokenizer.batch_decode(generated_output)[0]
'If I were an AI that had just achieved a breakthrough in machine learning, I would be thrilled'

预期加速

下面是一个预期的加速图，比较了使用 microsoft/phi-1 检查点在 transformers 中使用原生实现的纯推理时间和使用序列长度为 2048 的模型的 Flash Attention 2 版本。

PhiConfig

类 transformers.PhiConfig

< >

( vocab_size = 51200 hidden_size = 2048 intermediate_size = 8192 num_hidden_layers = 24 num_attention_heads = 32 num_key_value_heads = None resid_pdrop = 0.0 embd_pdrop = 0.0 attention_dropout = 0.0 hidden_act = 'gelu_new' max_position_embeddings = 2048 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None partial_rotary_factor = 0.5 qk_layernorm = False bos_token_id = 1 eos_token_id = 2 **kwargs )

参数

  • vocab_size (int, 可选, 默认为 51200) — Phi 模型的词汇量大小。定义了调用 PhiModel 时传递的 inputs_ids 可以表示的不同标记的数量。
  • hidden_size (int, 可选, 默认为 2048) — 隐藏表示的维度。
  • intermediate_size (int, 可选, 默认为 8192) — MLP 表示的维度。
  • num_hidden_layers (int, 可选, 默认为 24) — Transformer 解码器中隐藏层的数量。
  • num_attention_heads (int, 可选, 默认为 32) — Transformer 解码器中每个注意力层的注意力头的数量。
  • num_key_value_heads (int, 可选) — 这是应用于实现分组查询注意力的键值头的数量。如果 num_key_value_heads=num_attention_heads，则模型将使用多头注意力 (MHA)，如果 num_key_value_heads=1，则模型将使用多查询注意力 (MQA)，否则将使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组键和值头应通过对该组中所有原始头进行平均池化来构建。有关更多详细信息，请查看 这篇论文。如果未指定，则默认为 num_attention_heads。
  • resid_pdrop (float, 可选, 默认为 0.0) — mlp 输出的 dropout 概率。
  • embd_pdrop (int, 可选, 默认为 0.0) — 嵌入的 dropout 比率。
  • hidden_act (str 或 function，可选，默认为 "gelu_new") — 解码器中的非线性激活函数（函数或字符串）。
  • max_position_embeddings (int，可选，默认为 2048) — 此模型可能使用的最大序列长度。Phi-1 和 Phi-1.5 支持最多 2048 个 token。
  • initializer_range (float，可选，默认为 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float，可选，默认为 1e-05) — rms 归一化层使用的 epsilon。
  • use_cache (bool，可选，默认为 True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅当 config.is_decoder=True 时才相关。是否绑定权重嵌入。
  • tie_word_embeddings (bool，可选，默认为 False) — 是否绑定权重嵌入
  • rope_theta (float，可选，默认为 10000.0) — RoPE 嵌入的基本周期。
  • rope_scaling (Dict，可选) — 包含 RoPE 嵌入缩放配置的字典。注意：如果您应用新的 rope 类型，并且您期望模型在更长的 max_position_embeddings 上工作，我们建议您相应地更新此值。预期内容：rope_type (str)：要使用的 RoPE 的子变体。可以是 [‘default’, ‘linear’, ‘dynamic’, ‘yarn’, ‘longrope’, ‘llama3’] 中的一个，其中 ‘default’ 是原始 RoPE 实现。factor (float，可选)：与除 ‘default’ 之外的所有 rope 类型一起使用。要应用于 RoPE 嵌入的缩放因子。在大多数缩放类型中，factor 为 x 将使模型能够处理长度为 x * 原始最大预训练长度的序列。original_max_position_embeddings (int，可选)：与 ‘dynamic’, ‘longrope’ 和 ‘llama3’ 一起使用。预训练期间使用的原始最大位置嵌入。attention_factor (float，可选)：与 ‘yarn’ 和 ‘longrope’ 一起使用。要应用于注意力计算的缩放因子。如果未指定，则默认为实现建议的值，使用 factor 字段推断建议值。beta_fast (float，可选)：仅与 ‘yarn’ 一起使用。设置线性斜坡函数中外推（仅）边界的参数。如果未指定，则默认为 32。beta_slow (float，可选)：仅与 ‘yarn’ 一起使用。设置线性斜坡函数中插值（仅）边界的参数。如果未指定，则默认为 1。short_factor (List[float]，可选)：仅与 ‘longrope’ 一起使用。要应用于短上下文（< original_max_position_embeddings）的缩放因子。必须是与隐藏大小相同长度的数字列表，除以注意力头的数量除以 2 long_factor (List[float]，可选)：仅与 ‘longrope’ 一起使用。要应用于长上下文（< original_max_position_embeddings）的缩放因子。必须是与隐藏大小相同长度的数字列表，除以注意力头的数量除以 2 low_freq_factor (float，可选)：仅与 ‘llama3’ 一起使用。应用于 RoPE 低频分量的缩放因子 high_freq_factor (float，可选)：仅与 ‘llama3’ 一起使用。应用于 RoPE 高频分量的缩放因子
  • partial_rotary_factor (float，可选，默认为 0.5) — 将具有旋转嵌入的查询和键的百分比。
  • qk_layernorm (bool, 可选, 默认为 False) — 是否在投影隐藏状态后对查询和键进行标准化。
  • bos_token_id (int, 可选, 默认为 1) — 表示序列开始的标记 ID。
  • eos_token_id (int, 可选, 默认为 2) — 表示序列结束的标记 ID。

这是用于存储 PhiModel 配置的配置类。它用于根据指定的参数实例化 Phi 模型，定义模型架构。使用默认值实例化配置将产生与 Phi microsoft/phi-1 类似的配置。

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

示例

>>> from transformers import PhiModel, PhiConfig

>>> # Initializing a Phi-1 style configuration
>>> configuration = PhiConfig.from_pretrained("microsoft/phi-1")

>>> # Initializing a model from the configuration
>>> model = PhiModel(configuration)

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

PhiModel

class transformers.PhiModel

< >

( config: PhiConfig )

参数

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

不带任何特定头的基本 Phi 模型，输出原始隐藏状态。此模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。

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

包含 config.num_hidden_layers 层的 Transformer 解码器。每一层都是一个 PhiDecoderLayer

正向传播

< >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None )

参数

  • input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列标记的索引。如果您提供填充，则默认情况下会忽略填充。

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

    什么是输入 ID？

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择在 [0, 1] 中：

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

    什么是注意力掩码？

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

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

    如果要更改填充行为，则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。

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

    什么是位置 ID？

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

    允许两种格式：

    • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为传统缓存格式。

    模型将输出与输入相同的缓存格式。如果未传递 past_key_values，则将返回传统缓存格式。

    如果使用 past_key_values，则用户可以选择仅输入最后一个 input_ids（那些没有将其过去的键值状态提供给此模型的）形状为 (batch_size, 1)，而不是所有 input_ids 形状为 (batch_size, sequence_length)。

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望对如何将 input_ids 索引转换为关联向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor 形状为 (sequence_length)，可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

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

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

PhiForCausalLM

类 transformers.PhiForCausalLM

< >

( config )

正向传播

< >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: 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 cache_position: Optional = None num_logits_to_keep: int = 0 ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，则默认情况下将忽略填充。

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

    什么是输入 ID？

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。在 [0, 1] 中选择掩码值：

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

    什么是注意力掩码？

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

    如果使用 past_key_values，则可以选择仅输入最后一个 input_ids（其过去键值状态未提供给此模型）形状为 (batch_size, 1) 而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

    如果您想更改填充行为，您应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。

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

    什么是位置 ID？

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

    允许两种格式：

    • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor))，每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为旧的缓存格式。

    模型将输出与作为输入馈送的相同的缓存格式。如果未传递 past_key_values，则将返回旧的缓存格式。

    如果使用 past_key_values，则用户可以选择仅输入最后一个 input_ids（其过去键值状态未提供给此模型）形状为 (batch_size, 1) 而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor 形状为 (sequence_length)，可选) — 描述输入序列令牌在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

    参数 — labels (torch.LongTensor 形状为 (batch_size, sequence_length)，可选)：用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 中（请参阅 input_ids 文档字符串）。索引设置为 -100 的令牌将被忽略（掩码），仅针对标签在 [0, ..., config.vocab_size] 中的令牌计算损失。

    num_logits_to_keep (int，可选)：计算最后 num_logits_to_keep 个令牌的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。生成只需要最后一个令牌的 logits，并且仅为该令牌计算它们可以节省内存，这对于长序列或大型词汇量来说非常重要。

返回

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

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

  • loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个令牌预测）。

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

  • past_key_values (tuple(tuple(torch.FloatTensor))，可选，当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (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后的注意力权重，用于计算自注意力头中的加权平均值。

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

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

示例

>>> from transformers import AutoTokenizer, PhiForCausalLM

>>> model = PhiForCausalLM.from_pretrained("microsoft/phi-1")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1")

>>> prompt = "This is an example script ."
>>> inputs = tokenizer(prompt, return_tensors="pt")

>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
'This is an example script .\n\n\n\nfrom typing import List\n\ndef find_most_common_letter(words: List[str'

生成

< >

( inputs: Optional = None generation_config: Optional = None logits_processor: Optional = None stopping_criteria: Optional = None prefix_allowed_tokens_fn: Optional = None synced_gpus: Optional = None assistant_model: Optional = None streamer: Optional = None negative_prompt_ids: Optional = None negative_prompt_attention_mask: Optional = None **kwargs ) → ModelOutput 或 torch.LongTensor

参数

  • inputs (torch.Tensor，其形状取决于模态，可选) — 用于生成提示或作为编码器模型输入的序列。如果为 None，则该方法会用 bos_token_id 和 1 的批大小初始化它。对于解码器专用模型，inputs 应采用 input_ids 的格式。对于编码器-解码器模型，inputs 可以表示 input_ids、input_values、input_features 或 pixel_values 中的任何一个。
  • generation_config (GenerationConfig，可选) — 用作生成调用的基本参数化的生成配置。传递给 generate 的 **kwargs 与 generation_config 的属性匹配将覆盖它们。如果未提供 generation_config，则将使用默认值，其加载优先级如下：1) 来自 generation_config.json 模型文件（如果存在）；2) 来自模型配置。请注意，未指定的参数将继承 GenerationConfig 的默认值，应检查其文档以参数化生成。
  • logits_processor (LogitsProcessorList，可选) — 补充从参数和生成配置构建的默认 logits 处理器的自定义 logits 处理器。如果传递的 logit 处理器已使用参数或生成配置创建，则会抛出错误。此功能适用于高级用户。
  • stopping_criteria (StoppingCriteriaList，可选) — 补充从参数和生成配置构建的默认停止条件的自定义停止条件。如果传递的停止条件已使用参数或生成配置创建，则会抛出错误。如果您的停止条件依赖于 scores 输入，请确保将 return_dict_in_generate=True, output_scores=True 传递给 generate。此功能适用于高级用户。
  • prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], List[int]]，可选) — 如果提供，此函数会将束搜索限制在每个步骤仅允许的标记上。如果未提供，则不应用任何约束。此函数接受 2 个参数：批 ID batch_id 和 input_ids。它必须返回一个列表，其中包含根据批 ID batch_id 和先前生成的标记 inputs_ids 确定下一生成步骤的允许标记。此参数对于受前缀约束的生成很有用，如 Autoregressive Entity Retrieval 中所述。
  • synced_gpus (bool，可选) — 是否继续运行 while 循环直到 max_length。除非覆盖，否则此标志将在 DeepSpeed ZeRO Stage 3 多 GPU 环境下设置为 True，以避免在某个 GPU 完成生成之前其他 GPU 停止。否则，它将设置为 False。
  • assistant_model (PreTrainedModel，可选) — 可用于加速生成的辅助模型。辅助模型必须具有完全相同的标记器。当使用辅助模型预测候选标记的速度比使用您从中调用 generate 的模型运行生成的速度快得多时，可以实现加速。因此，辅助模型应该更小。
  • streamer (BaseStreamer，可选) — 用于流式传输生成序列的流式传输对象。生成的 token 通过 streamer.put(token_ids) 传递，流式传输对象负责任何进一步的处理。
  • negative_prompt_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 一些处理器（如 CFG）所需的负向提示。批大小必须与输入批大小匹配。这是一个实验性功能，在未来版本中可能会更改 API。
  • negative_prompt_attention_mask (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — negative_prompt_ids 的注意力掩码。
  • kwargs (Dict[str, Any]，可选) — generation_config 的临时参数化和/或将转发到模型 forward 函数的其他特定于模型的关键字参数。如果模型是编码器-解码器模型，则编码器特定的关键字参数不应加前缀，解码器特定的关键字参数应以 decoder_ 为前缀。

返回

ModelOutput 或 torch.LongTensor

ModelOutput（如果 return_dict_in_generate=True 或 config.return_dict_in_generate=True）或 torch.LongTensor。

如果模型不是编码器-解码器模型（model.config.is_encoder_decoder=False），则可能的 ModelOutput 类型为

如果模型是编码器-解码器模型（model.config.is_encoder_decoder=True），则可能的 ModelOutput 类型为

为具有语言建模头的模型生成 token ID 序列。

大多数生成控制参数都设置在 generation_config 中，如果未传递，则将其设置为模型的默认生成配置。可以通过将相应的参数传递给 generate() 来覆盖任何 generation_config，例如 .generate(inputs, num_beams=4, do_sample=True)。

有关生成策略和代码示例的概述，请查看以下指南。

PhiForSequenceClassification

类 transformers.PhiForSequenceClassification

< >

( config )

参数

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

在顶部具有序列分类头的 PhiModel（线性层）。

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

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

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

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

正向传播

< >

( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = 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 )

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下，如果您提供填充，则填充将被忽略。

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

    什么是输入 ID？

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在 [0, 1] 中：

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

    什么是注意力掩码？

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

    如果使用了 past_key_values，则可以选择仅输入最后的 input_ids（那些没有为此模型提供过去键值状态的 input_ids）（参见 past_key_values）。

    如果您想更改填充行为，则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。

    • 1 表示头部未被掩盖，
    • 0 表示头部被掩盖。
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为 [0, config.n_positions - 1]。

    什么是位置 ID？

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

    允许两种格式：

    • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也称为传统缓存格式。

    模型将输出与输入相同的缓存格式。如果未传递 past_key_values，则将返回传统缓存格式。

    如果使用了 past_key_values，则用户可以选择仅输入最后的 input_ids（那些没有为此模型提供过去键值状态的 input_ids），形状为 (batch_size, 1)，而不是所有 input_ids，形状为 (batch_size, sequence_length)。

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor 形状为 (sequence_length), 可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
  • labels (torch.LongTensor 形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

The PhiForSequenceClassification 前向方法覆盖了 __call__ 特殊方法。

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

PhiForTokenClassification

类 transformers.PhiForTokenClassification

< >

( config: PhiConfig )

参数

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

PhiModel 在顶部具有标记分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。

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

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

正向传播

< >

( input_ids: Optional = None past_key_values: Optional = None attention_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 **deprecated_arguments ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，则默认情况下会忽略填充。

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

    什么是输入 ID？

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力操作的掩码。掩码值选择在 [0, 1] 中：

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

    什么是注意力掩码？

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

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

    如果要更改填充行为，则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图 1。

    • 1 表示头部未被掩码，
    • 0 表示头部被掩码。
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。选择范围为 [0, config.n_positions - 1]。

    什么是位置ID？

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

    允许两种格式：

    • 一个 Cache 实例，请参阅我们的 kv 缓存指南；
    • 长度为 config.n_layers 的 tuple(torch.FloatTensor) 元组，每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。这也被称为旧版缓存格式。

    模型将输出与输入相同的缓存格式。如果未传递 past_key_values，则将返回旧版缓存格式。

    如果使用 past_key_values，则用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 input_ids（其过去键值状态未提供给此模型），而不是形状为 (batch_size, sequence_length) 的所有 input_ids。

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor 形状为 (sequence_length)，可选) — 描述输入序列标记在序列中的位置的索引。与 position_ids 不同，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
  • labels (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [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 时），包含根据配置 (PhiConfig) 和输入而变化的各种元素。

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

The PhiForTokenClassification 前向方法，重写了 __call__ 特殊方法。

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

示例

>>> from transformers import AutoTokenizer, PhiForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1")
>>> model = PhiForTokenClassification.from_pretrained("microsoft/phi-1")

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

←柿子 Phi-3→