Hugging Face 的 LOGO

Transformers 文档

Phi

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

PyTorch FlashAttention SDPA

Phi

Phi 是一个拥有 13 亿参数的 transformer 模型，专为 Python 代码生成进行了优化。它专注于使用“教科书质量”的代码示例、练习和合成 Python 问题的训练数据，而不是扩展模型规模或计算量。

你可以在 Phi-1 集合中找到所有原始的 Phi checkpoints。

点击右侧边栏中的 Phi 模型，查看更多关于如何将 Phi 应用于不同语言任务的示例。

下面的示例演示了如何使用 Pipeline、AutoModel 以及从命令行生成文本。

流水线
自动模型
Transformers CLI
import torch
from transformers import pipeline

pipeline = pipeline(task="text-generation", model="microsoft/phi-1.5", device=0, torch_dtype=torch.bfloat16)
pipeline("pipeline('''def print_prime(n): """ Print all primes between 1 and n"""''')")

量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。

以下示例使用 bitsandbytes 将权重仅量化为 4 位。

import torch
from transformers import BitsAndBytesConfig, AutoTokenizer, AutoModelForCausalLM

bnb_config = BitsAndBytesConfig(load_in_4bit=True, bnb_4bit_compute_dtype=torch.bfloat16, bnb_4bit_quant_type="nf4", bnb_4bit_use_double_quant=True)
tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1")
model = AutoModelForCausalLM.from_pretrained("microsoft/phi-1", torch_dtype=torch.float16, device_map="auto", attn_implementation="sdpa", quantization_config=bnb_config)

input_ids = tokenizer('''def print_prime(n):
   """
   Print all primes between 1 and n
   """''', return_tensors="pt").to("cuda")

output = model.generate(**input_ids, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))

注意

  • 如果你使用的 Transformers 版本低于 4.37.0.dev，请在 from_pretrained() 中设置 `trust_remote_code=True`。否则，请确保将 Transformers 更新到最新的稳定版本。

    import torch
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1")
model = AutoModelForCausalLM.from_pretrained(
    "microsoft/phi-1",
    torch_dtype=torch.float16,
    device_map="auto",
    trust_remote_code=True,
    attn_implementation="sdpa")

input_ids = tokenizer('''def print_prime(n):
   """
   Print all primes between 1 and n
   """''', return_tensors="pt").to("cuda")

output = model.generate(**input_ids, cache_implementation="static")
print(tokenizer.decode(output[0], skip_special_tokens=True))

PhiConfig

class 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, 可选) — 这是用于实现分组查询注意力（Grouped Query Attention）的键值头（key_value heads）数量。如果 `num_key_value_heads=num_attention_heads`，模型将使用多头注意力（Multi Head Attention，MHA）；如果 `num_key_value_heads=1`，模型将使用多查询注意力（Multi Query Attention，MQA）；否则，将使用 GQA。当将一个多头检查点转换为 GQA 检查点时，每个分组的键和值头应通过对该组内所有原始头进行均值池化来构建。更多详情，请查阅这篇论文。如果未指定，将默认为 `num_attention_heads`。
  • resid_pdrop (float, 可选, 默认为 0.0) — mlp 输出的 dropout 概率。
  • embd_pdrop (int, 可选, 默认为 0.0) — 嵌入层的 dropout 率。
  • attention_dropout (float, 可选, 默认为 0.0) — 计算注意力分数后的 dropout 率。
  • hidden_act (str 或 function, 可选, 默认为 "gelu_new") — 解码器中的非线性激活函数（函数或字符串）。
  • max_position_embeddings (int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。Phi-1 和 Phi-1.5 支持最多 2048 个标记。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
  • 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 嵌入的缩放因子。在大多数缩放类型中，x 的 `factor` 将使模型能够处理长度为 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) — 是否在投影隐藏状态后对查询（Queries）和键（Keys）进行归一化。
  • 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

PhiModel

class transformers.PhiModel

< >

( config: PhiConfig )

参数

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

基础的 Phi 模型，输出原始的隐藏状态，顶部没有任何特定的头（head）。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID？

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

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

    什么是注意力掩码？

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

    什么是位置 ID？

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

    允许两种格式：

    • 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（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

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

返回

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

transformers.modeling_outputs.BaseModelOutputWithPast 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或 `config.return_dict=False`），包含各种元素，具体取决于配置（PhiConfig）和输入。

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

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

  • past_key_values (Cache, 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

    包含预计算的隐藏状态（自注意力块中的键和值，以及如果 `config.is_encoder_decoder=True`，则在交叉注意力块中），可用于（参见 `past_key_values` 输入）加速序列解码。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 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 后的注意力权重，用于计算自注意力头中的加权平均值。

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

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

PhiForCausalLM

class transformers.PhiForCausalLM

< >

( config )

参数

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

用于因果语言建模的 Phi 模型。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.phi.modeling_phi.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID？

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

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

    什么是注意力掩码？

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

    什么是位置 ID？

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

    允许两种格式：

    • 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（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 或者，你可以选择直接传递嵌入表示，而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更多地控制如何将 input_ids 索引转换为关联向量，这会很有用。
  • labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 或 -100 之间（参见 input_ids 文档字符串）。索引设置为 -100 的标记将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 之间的标记计算。
  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • cache_position (形状为 (sequence_length) 的 torch.LongTensor, 可选) — 描绘输入序列标记在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
  • logits_to_keep (Union[int, torch.Tensor], 默认为 0) — 如果是 int，则为最后的 logits_to_keep 个标记计算 logits。如果是 0，则为所有 input_ids 计算 logits（特殊情况）。生成时只需要最后一个标记的 logits，只为该标记计算可以节省内存，这对于长序列或大词汇表来说非常重要。如果是 torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批处理和序列长度使用单一维度）时很有用。

返回

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

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

  • past_key_values (Cache, 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

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

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 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("meta-phi/Phi-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-phi/Phi-2-7b-hf")

>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> 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]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."

生成

< >

( inputs: typing.Optional[torch.Tensor] = None generation_config: typing.Optional[transformers.generation.configuration_utils.GenerationConfig] = None logits_processor: typing.Optional[transformers.generation.logits_process.LogitsProcessorList] = None stopping_criteria: typing.Optional[transformers.generation.stopping_criteria.StoppingCriteriaList] = None prefix_allowed_tokens_fn: typing.Optional[typing.Callable[[int, torch.Tensor], list[int]]] = None synced_gpus: typing.Optional[bool] = None assistant_model: typing.Optional[ForwardRef('PreTrainedModel')] = None streamer: typing.Optional[ForwardRef('BaseStreamer')] = None negative_prompt_ids: typing.Optional[torch.Tensor] = None negative_prompt_attention_mask: typing.Optional[torch.Tensor] = None use_model_defaults: typing.Optional[bool] = None custom_generate: typing.Optional[str] = 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 输入，请确保向 generate 传递 return_dict_in_generate=True, output_scores=True。此功能适用于高级用户。
  • 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。除非被覆盖，否则在使用具有多个 GPU 的 `FullyShardedDataParallel` 或 DeepSpeed ZeRO Stage 3 时，此标志将设置为 True，以避免在一个 GPU 完成生成而其他 GPU 未完成时发生死锁。否则，默认为 False。
  • assistant_model (PreTrainedModel, 可选) — 可用于加速生成的辅助模型。辅助模型必须具有完全相同的分词器。当使用辅助模型预测候选标记比使用您调用 generate 的模型运行生成快得多时，可以实现加速。因此，辅助模型应该小得多。
  • streamer (BaseStreamer, 可选) — 用于流式传输生成序列的 Streamer 对象。生成的标记通过 streamer.put(token_ids) 传递，streamer 负责任何进一步的处理。
  • negative_prompt_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 某些处理器（如 CFG）所需的负面提示。批次大小必须与输入批次大小匹配。这是一个实验性功能，未来版本中可能会有破坏性的 API 更改。
  • negative_prompt_attention_mask (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — negative_prompt_ids 的注意力掩码。
  • use_model_defaults (bool, 可选) — 当为 True 时，generation_config 中未设置的参数将设置为特定于模型的默认生成配置（`model.generation_config`），而不是全局默认值（`GenerationConfig()`）。如果未设置，从 `v4.50` 开始保存的模型将认为此标志为 True。
  • custom_generate (str, 可选) — 包含 huggingface.co 仓库名称的字符串。如果提供，将执行该仓库的 `custom_generate/generate.py` 文件中定义的自定义 `generate` 函数，而不是标准的 `generate` 方法。请注意，生成逻辑完全在该仓库中定义，返回类型可能与标准的 `generate` 方法不同。
  • kwargs (dict[str, Any], 可选) — generation_config 的临时参数化和/或将转发到模型 forward 函数的附加模型特定 kwargs。如果模型是编码器-解码器模型，则编码器特定的 kwargs 不应有前缀，解码器特定的 kwargs 应以 *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 类型为

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

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

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

PhiForSequenceClassification

class transformers.PhiForSequenceClassification

< >

( config )

参数

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

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

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

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

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下，填充将被忽略。

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

    什么是 input ID？

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

    • 1 表示 token 未被遮盖，
    • 0 表示 token 被遮盖。

    什么是注意力掩码？

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

    什么是位置 ID？

  • past_key_values (~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在先前解码阶段返回的 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（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型内部的嵌入查找矩阵更能控制如何将 input_ids 索引转换为关联向量，这很有用。
  • labels (torch.LongTensor，形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵）。
  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。

返回

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

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

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

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

  • past_key_values (Cache, 可选, 当传递 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。有关更多详细信息，请参阅我们的 kv 缓存指南。

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

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — 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 后的注意力权重，用于计算自注意力头中的加权平均值。

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

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, PhiForSequenceClassification

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

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

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

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...

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

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, PhiForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/phi-1")
>>> model = PhiForSequenceClassification.from_pretrained("microsoft/phi-1", 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 = PhiForSequenceClassification.from_pretrained(
...     "microsoft/phi-1", 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

PhiForTokenClassification

class transformers.PhiForTokenClassification

< >

( config )

参数

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

Phi transformer，顶部带有一个 token 分类头（一个线性层，位于隐藏状态输出之上），例如用于命名实体识别 (NER) 任务。

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

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

forward

< >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 词汇表中输入序列 token 的索引。默认情况下，填充将被忽略。

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

    什么是 input ID？

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

    • 1 表示 token 未被遮盖，
    • 0 表示 token 被遮盖。

    什么是注意力掩码？

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

    什么是位置 ID？

  • past_key_values (~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在先前解码阶段返回的 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（那些没有为其提供过去键值状态的 ID），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

  • inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型内部的嵌入查找矩阵更能控制如何将 input_ids 索引转换为关联向量，这很有用。
  • labels (torch.LongTensor，形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵）。
  • use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（请参阅 past_key_values）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。

返回

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

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

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

  • logits (形状为 (batch_size, sequence_length, config.num_labels) 的 torch.FloatTensor) — 分类分数（SoftMax 之前）。

  • hidden_states (tuple(torch.FloatTensor), 可选, 当传递 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（如果模型有嵌入层，则一个是嵌入层的输出，加上每个层的输出），形状为 (batch_size, sequence_length, hidden_size)。

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

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

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

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

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...
< > 在 GitHub 上更新

←Persimmon Phi-3→