Transformers 文档
Phi-3
并获得增强的文档体验
开始使用
Phi-3
概述
Phi-3 模型由微软在 Phi-3 技术报告：一款可在手机本地运行的高性能语言模型 中提出。
摘要
以下是 Phi-3 论文的摘要：
我们推出了 phi-3-mini，一个拥有 38 亿参数的语言模型，它在 3.3 万亿个标记上进行了训练。根据学术基准和内部测试的衡量，其整体性能可与 Mixtral 8x7B 和 GPT-3.5 等模型相媲美（例如，phi-3-mini 在 MMLU 上达到 69%，在 MT-bench 上达到 8.38），尽管它足够小，可以在手机上部署。创新完全在于我们的训练数据集，它是 phi-2 所用数据集的升级版，由经过严格筛选的网络数据和合成数据组成。该模型还进一步针对鲁棒性、安全性和聊天格式进行了对齐。我们还提供了一些初步的参数扩展结果，包括一个在 4.8 万亿个标记上训练的 7B 和 14B 模型，分别称为 phi-3-small 和 phi-3-medium，它们的能力都明显强于 phi-3-mini（例如，它们在 MMLU 上分别达到 75% 和 78%，在 MT-bench 上分别达到 8.7 和 8.9）。
Phi-3 的原始代码可以在这里找到。
使用技巧
- 该模型与
Llama非常相似，主要区别在于Phi3SuScaledRotaryEmbedding和Phi3YarnScaledRotaryEmbedding，它们用于扩展旋转嵌入的上下文。查询（query）、键（key）和值（value）被融合，MLP 的上采样和门控投影层也被融合。 - 此模型使用的分词器与 LlamaTokenizer 相同，只是增加了一些额外的标记。
如何使用 Phi-3
Phi-3 已被集成到 transformers 的开发版本 (4.40.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-3-mini-4k-instruct")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> messages = [{"role": "user", "content": "Can you provide ways to eat combinations of bananas and dragonfruits?"}]
>>> inputs = tokenizer.apply_chat_template(messages, add_generation_prompt=True, return_tensors="pt")
>>> outputs = model.generate(inputs, max_new_tokens=32)
>>> text = tokenizer.batch_decode(outputs)[0]
>>> print(text)
<|user|> Can you provide ways to eat combinations of bananas and dragonfruits?<|end|><|assistant|> Certainly! Bananas and dragonfruits can be combined in various delicious ways. Here are some creative ideas for incorporating both fruitsPhi3Config
class transformers.Phi3Config
< 源代码 >( vocab_size = 32064 hidden_size = 3072 intermediate_size = 8192 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None resid_pdrop = 0.0 embd_pdrop = 0.0 attention_dropout = 0.0 hidden_act = 'silu' max_position_embeddings = 4096 original_max_position_embeddings = 4096 initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None partial_rotary_factor = 1.0 bos_token_id = 1 eos_token_id = 32000 pad_token_id = 32000 sliding_window = None **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32064) — Phi-3 模型的词汇表大小。定义了在调用 Phi3Model 时，可以通过inputs_ids表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 3072) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为 8192) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 32) — Transformer 解码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力（Grouped Query Attention）的键值（key_value）头数量。如果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 比例。 - attention_dropout (
float, 可选, 默认为 0.0) — 计算注意力分数后的 Dropout 比例。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 4096) — 该模型可能使用的最大序列长度。 - original_max_position_embeddings (
int, 可选, 默认为 4096) — 该模型训练时使用的最大序列长度。这用于在使用长序列缩放时确定原始 RoPE 嵌入的大小。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-05) — 用于 RMSNorm 的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。是否绑定权重嵌入。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否绑定词嵌入权重 - rope_theta (
float, 可选, 默认为 10000.0) — RoPE 嵌入的基础周期。 - rope_scaling (
dict, 可选) — RoPE 嵌入的缩放策略。如果为None，则不应用缩放。如果是一个字典，它必须包含以下键：type、short_factor和long_factor。type必须是longrope，short_factor和long_factor必须是数字列表，其长度等于隐藏大小除以注意力头数再除以 2。 - partial_rotary_factor (
float, 可选, 默认为 1.0) — 将应用旋转嵌入的查询和键的百分比。必须在 0.0 和 1.0 之间。 - bos_token_id (
int, 可选, 默认为 1) — “序列开始”标记的 ID。 - eos_token_id (
int, 可选, 默认为 32000) — “序列结束”标记的 ID。 - pad_token_id (
int, 可选, 默认为 32000) — 填充标记的 ID。 - sliding_window (
int, 可选) — 滑动窗口注意力窗口大小。如果为None，则不应用滑动窗口。
这是用于存储 Phi3Model 配置的配置类。它用于根据指定的参数实例化一个 Phi-3 模型，定义模型架构。使用默认值实例化配置将产生与 microsoft/Phi-3-mini-4k-instruct 类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。更多信息请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import Phi3Model, Phi3Config
>>> # Initializing a Phi-3 style configuration
>>> configuration = Phi3Config.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> # Initializing a model from the configuration
>>> model = Phi3Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configPhi3Model
class transformers.Phi3Model
< source >( config: Phi3Config )
参数
- config (Phi3Config) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
基础的 Phi3 模型，输出原始的隐藏状态（hidden-states），顶部没有任何特定的头部（head）。
该模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( 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 (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列词元的索引。默认情况下将忽略填充（Padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的前一阶段返回的 `past_key_values`，当 `use_cache=True` 或 `config.use_cache=True` 时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个长度为 `config.n_layers` 的 `tuple(torch.FloatTensor)` 元组，其中每个元组包含两个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递 `past_key_values`，将返回传统缓存格式。
如果使用了 `past_key_values`，用户可以选择只输入最后的 `input_ids`（即那些没有为其提供过去键值状态的词元），形状为 `(batch_size, 1)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。
- 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`。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 `position_ids` 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 `torch.FloatTensor` 的元组（如果传递 `return_dict=False` 或当 `config.return_dict=False` 时），根据配置（Phi3Config）和输入包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Phi3Model 的前向方法，重写了 `__call__` 特殊方法。
尽管前向传递的配方需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
Phi3ForCausalLM
class transformers.Phi3ForCausalLM
< source >( config )
参数
- config (Phi3ForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
用于因果语言建模的 Phi3 模型。
该模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( 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.phi3.modeling_phi3.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列词元的索引。默认情况下将忽略填充（Padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力机制的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的词元，
- 0 表示被掩码的词元。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速序列解码。这通常包括模型在解码的前一阶段返回的 `past_key_values`，当 `use_cache=True` 或 `config.use_cache=True` 时。允许两种格式：
- 一个 Cache 实例，请参阅我们的 kv 缓存指南；
- 一个长度为 `config.n_layers` 的 `tuple(torch.FloatTensor)` 元组，其中每个元组包含两个形状为 `(batch_size, num_heads, sequence_length, embed_size_per_head)` 的张量。这也称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果没有传递 `past_key_values`，将返回传统缓存格式。
如果使用了 `past_key_values`，用户可以选择只输入最后的 `input_ids`（即那些没有为其提供过去键值状态的词元），形状为 `(batch_size, 1)`，而不是所有形状为 `(batch_size, sequence_length)` 的 `input_ids`。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递 `input_ids`。如果你想比模型内部的嵌入查找矩阵有更多控制权来将 `input_ids` 索引转换为相关向量，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在 `[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 (
torch.LongTensor，形状为(sequence_length)，可选) — 描述输入序列词元在序列中位置的索引。与 `position_ids` 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 默认为0) — 如果是 `int`，则为最后 `logits_to_keep` 个词元计算 logits。如果是 `0`，则为所有 `input_ids` 计算 logits（特殊情况）。生成时只需要最后一个词元的 logits，仅为此词元计算可以节省内存，这对于长序列或大词汇表来说非常重要。如果是 `torch.Tensor`，则必须是 1D 的，对应于在序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度为单一维度）时很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 `torch.FloatTensor` 的元组（如果传递 `return_dict=False` 或当 `config.return_dict=False` 时），根据配置（Phi3Config）和输入包含各种元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Phi3ForCausalLM 的前向方法，重写了 `__call__` 特殊方法。
尽管前向传递的配方需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, Phi3ForCausalLM
>>> model = Phi3ForCausalLM.from_pretrained("meta-phi3/Phi3-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-phi3/Phi3-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."生成
< source >( 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。除非被覆盖，否则在使用 `FullyShardedDataParallel` 或 DeepSpeed ZeRO Stage 3 并行多 GPU 时，此标志将设置为 `True`，以避免在一个 GPU 完成生成而其他 GPU 未完成时发生死锁。否则，默认为 `False`。 - assistant_model (
PreTrainedModel, 可选) — 可用于加速生成的辅助模型。辅助模型必须具有完全相同的分词器。当使用辅助模型预测候选词元比使用您调用 generate 的模型运行生成要快得多时，可以实现加速。因此，辅助模型应该小得多。 - streamer (
BaseStreamer, 可选) — 将用于流式传输生成序列的 streamer 对象。生成的词元通过 `streamer.put(token_ids)` 传递，streamer 负责任何进一步的处理。 - negative_prompt_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 某些处理器（如 CFG）所需的负面提示。批大小必须与输入批大小匹配。这是一个实验性功能，未来版本可能会有不兼容的 API 更改。 - negative_prompt_attention_mask (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — `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)`。
有关生成策略和代码示例的概述，请查阅以下指南。
Phi3ForSequenceClassification
class transformers.Phi3ForSequenceClassification
< source >( config )
参数
- config (Phi3ForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。请查阅 from_pretrained() 方法来加载模型权重。
带有序列分类头部（线性层）的 Phi3 模型转换器。
Phi3ForSequenceClassification 使用最后一个词元来进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个词元进行分类，因此需要知道最后一个词元的位置。如果配置中定义了 `pad_token_id`，它会在每一行中找到不是填充词元的最后一个词元。如果没有定义 `pad_token_id`，它只是简单地取批次中每一行的最后一个值。由于当传递 `inputs_embeds` 而不是 `input_ids` 时它无法猜测填充词元，因此它执行相同的操作（取批次中每一行的最后一个值）。
该模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。
forward
< source >( 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)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - 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，用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有提供其过去键值状态给此模型的 `input_ids`），而不是形状为(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` 时），包含各种元素，具体取决于配置 (Phi3Config) 和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Phi3ForSequenceClassification 的 forward 方法重写了 `__call__` 特殊方法。
尽管前向传递的配方需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, Phi3ForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> model = Phi3ForSequenceClassification.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> 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 = Phi3ForSequenceClassification.from_pretrained("microsoft/Phi-3-mini-4k-instruct", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, Phi3ForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> model = Phi3ForSequenceClassification.from_pretrained("microsoft/Phi-3-mini-4k-instruct", 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 = Phi3ForSequenceClassification.from_pretrained(
... "microsoft/Phi-3-mini-4k-instruct", 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).lossPhi3ForTokenClassification
class transformers.Phi3ForTokenClassification
< 来源 >( config )
参数
- config (Phi3ForTokenClassification) — 包含模型所有参数的模型配置类。用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Phi3 Transformer 模型，顶部带有一个 token 分类头（一个在线性层之上的隐藏状态输出），例如用于命名实体识别 (NER) 任务。
该模型继承自 PreTrainedModel。请查阅超类的文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
该模型也是一个 PyTorch torch.nn.Module 的子类。可以像常规的 PyTorch Module 一样使用它，并参考 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)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示标记未被掩码，
- 0 表示标记被掩码。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.n_positions - 1]范围内选择。 - 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，用户可以选择只输入形状为(batch_size, 1)的最后一个input_ids（那些没有提供其过去键值状态给此模型的 `input_ids`），而不是形状为(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` 时），包含各种元素，具体取决于配置 (Phi3Config) 和输入。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Phi3ForTokenClassification 的 forward 方法重写了 `__call__` 特殊方法。
尽管前向传递的配方需要在此函数内定义，但之后应调用 `Module` 实例而不是此函数，因为前者会处理运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, Phi3ForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> model = Phi3ForTokenClassification.from_pretrained("microsoft/Phi-3-mini-4k-instruct")
>>> 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)
...