Transformers 文档
PhiMoE
并获得增强的文档体验
开始使用
PhiMoE
概述
PhiMoE 模型由 Microsoft 在 Phi-3 技术报告：一款可在手机上本地运行的高性能语言模型 中提出。
摘要
Phi-3 论文的摘要如下：
我们推出了 phi-3-mini，一个拥有 38 亿参数的语言模型，在 3.3 万亿个 tokens 上进行训练，其整体性能（通过学术基准和内部测试衡量）可与 Mixtral 8x7B 和 GPT-3.5 等模型媲美（例如，phi-3-mini 在 MMLU 上达到 69%，在 MT-bench 上达到 8.38），尽管它足够小，可以部署在手机上。我们的训练数据集是 phi-2 使用的数据集的放大版本，由经过严格过滤的公开网络数据和合成数据组成。该模型还进一步针对鲁棒性、安全性和聊天格式进行了对齐。我们还提供了参数缩放结果，包括训练了 4.8T tokens 的 7B 和 14B 模型，分别称为 phi-3-small 和 phi-3-medium，它们都比 phi-3-mini 强大得多（例如，在 MMLU 上分别达到 75% 和 78%，在 MT-bench 上分别达到 8.7 和 8.9）。为了增强多语言、多模态和长上下文能力，我们推出了 phi-3.5 系列的三个模型：phi-3.5-mini、phi-3.5-MoE 和 phi-3.5-Vision。phi-3.5-MoE 是一个 16 x 3.8B MoE 模型，拥有 66 亿个活跃参数，与 Llama 3.1 和 Mixtral 系列等同等规模的其他开源模型相比，在语言推理、数学和代码任务中表现出卓越的性能，并与 Gemini-1.5-Flash 和 GPT-4o-mini 持平。同时，phi-3.5-Vision 是一个从 phi-3.5-mini 派生出来的 42 亿参数模型，在推理任务中表现出色，并擅长处理单图像和文本提示以及多图像和文本提示。
PhiMoE 的原始代码可以在这里找到。
使用提示
- 此模型与
Mixtral非常相似，主要区别在于使用了Phi3LongRoPEScaledRotaryEmbedding，它们用于扩展旋转嵌入的上下文。查询、键和值是融合的，MLP 的上层和门控投影层也是融合的。 - 此模型使用的分词器与 LlamaTokenizer 相同，但额外添加了一些 token。
如何使用 PhiMoE
Phi-3.5-MoE-instruct 已集成到 transformers 的开发版本 (4.44.2.dev) 中。在通过 pip 发布官方版本之前，请确保您正在执行以下操作：
- 加载模型时，请确保将
trust_remote_code=True作为参数传递给from_pretrained()函数。
可以使用以下命令验证当前 transformers 版本：pip list | grep transformers。
所需包的示例
flash_attn==2.5.8
torch==2.3.1
accelerate==0.31.0
transformers==4.43.0import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, pipeline
torch.random.manual_seed(0)
model = AutoModelForCausalLM.from_pretrained(
"microsoft/Phi-3.5-MoE-instruct",
device_map="cuda",
torch_dtype="auto",
trust_remote_code=True,
)
tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
messages = [
{"role": "system", "content": "You are a helpful AI assistant."},
{"role": "user", "content": "Can you provide ways to eat combinations of bananas and dragonfruits?"},
{"role": "assistant", "content": "Sure! Here are some ways to eat bananas and dragonfruits together: 1. Banana and dragonfruit smoothie: Blend bananas and dragonfruits together with some milk and honey. 2. Banana and dragonfruit salad: Mix sliced bananas and dragonfruits together with some lemon juice and honey."},
{"role": "user", "content": "What about solving an 2x + 3 = 7 equation?"},
]
pipe = pipeline(
"text-generation",
model=model,
tokenizer=tokenizer,
)
generation_args = {
"max_new_tokens": 500,
"return_full_text": False,
"temperature": 0.0,
"do_sample": False,
}
output = pipe(messages, **generation_args)
print(output[0]['generated_text'])PhimoeConfig
class transformers.PhimoeConfig
< 来源 >( vocab_size = 32064 hidden_size = 4096 intermediate_size = 6400 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 8 hidden_act = 'silu' max_position_embeddings = 131072 initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False rope_theta = 1000000.0 rope_scaling = None sliding_window = None attention_dropout = 0.0 num_experts_per_tok = 2 num_local_experts = 16 output_router_logits = False router_aux_loss_coef = 0.001 router_jitter_noise = 0.01 input_jitter_noise = 0.0 attention_bias = False lm_head_bias = False **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32064) — Phimoe 模型的词汇表大小。定义了调用 PhimoeModel 时传递的inputs_ids可以表示的不同 tokens 的数量。 - hidden_size (
int, 可选, 默认为 4096) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认为 6400) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为 32) — Transformer 编码器中每个注意力层的注意力头数量。 - num_key_value_heads (
int, 可选, 默认为 8) — 用于实现分组查询注意力的键值头数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力 (MHA)；如果num_key_value_heads=1，模型将使用多查询注意力 (MQA)；否则使用 GQA。将多头检查点转换为 GQA 检查点时，每个分组的键和值头应通过对该组中所有原始头进行平均池化来构建。有关更多详细信息，请查看这篇论文。如果未指定，将默认为8。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为4096*32) — 此模型可能使用的最大序列长度。Mixtral 的滑动窗口注意力允许最长达 4096*32 个 tokens 的序列。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-05) — RMS 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时才相关。 - pad_token_id (
int, 可选) — 填充 token 的 ID。 - bos_token_id (
int, 可选, 默认为 1) — “序列开始”token 的 ID。 - eos_token_id (
int, 可选, 默认为 2) — “序列结束”token 的 ID。 - tie_word_embeddings (
bool, 可选, 默认为False) — 模型的输入和输出词嵌入是否应该绑定。 - rope_theta (
float, 可选, 默认为 1000000.0) — RoPE 嵌入的基本周期。 - rope_scaling (
dict, 可选) — RoPE 嵌入的缩放策略。如果为None，则不应用缩放。如果为字典，则必须包含以下键：type、short_factor、long_factor、short_mscale、long_mscale和original_max_position_embeddings。type必须是longrope，short_mscale和long_scale必须是数字，short_factor和long_factor必须是列表，其中包含与注意力头大小的一半长度相同的数字，original_max_position_embeddings必须是整数。 - sliding_window (
int, 可选) — 滑动窗口注意力窗口大小。如果未指定，将默认为262144。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - num_experts_per_tok (
int, 可选, 默认为 2) — 每个 token 要路由的专家数量，也可以解释为top-p路由参数 - num_local_experts (
int, 可选, 默认为 16) — 每个稀疏 MLP 层的专家数量。 - output_router_logits (
bool, 可选, 默认为False) — 模型是否应返回路由器的 logits。启用此功能还将允许模型输出辅助损失。更多详细信息请参见此处 - router_aux_loss_coef (
float, 可选, 默认为 0.001) — 总损失的辅助损失因子。 - router_jitter_noise (
float, 可选, 默认为 0.01) — 添加到路由器中的噪声量。 - input_jitter_noise (
float, 可选, 默认为 0.0) — 输入抖动噪声 - attention_bias (
bool, 可选, 默认为False) — 注意力偏置 - lm_head_bias (
bool, 可选, 默认为False) — LM 头偏置
这是用于存储 PhimoeModel 配置的配置类。它用于根据指定的参数实例化 Phi-moe 模型，定义模型架构。使用默认值实例化配置将生成与 microsoft/Phi-3.5-MoE-instruct 类似的配置。配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import PhimoeModel, PhimoeConfig
>>> # Initializing a Phi-3 style configuration
>>> configuration = PhimoeConfig.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> # Initializing a model from the configuration
>>> model = PhimoeModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configPhimoeModel
class transformers.PhimoeModel
< 源代码 >( config: PhimoeConfig )
参数
- config (PhimoeConfig) — 模型的配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法以加载模型权重。
不带任何特定头部的 Phimoe 模型，输出原始隐藏状态。
此模型继承自 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[list[torch.FloatTensor]] = 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 output_router_logits: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None ) → transformers.modeling_outputs.MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示**未被遮蔽**的 token，
- 0 表示**被遮蔽**的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
list[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（那些没有将其过去的键值状态提供给此模型的 token），而不是所有形状为(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。 - output_router_logits (
bool, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，不应在推理期间返回。 - cache_position (形状为
(sequence_length)的torch.LongTensor，可选) — 指示输入序列 token 在序列中的位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.MoeModelOutputWithPast 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.MoeModelOutputWithPast 或 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（PhimoeConfig）和输入的不同元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, 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 后的注意力权重，用于计算自注意力头中的加权平均值。
-
router_logits (
tuple(torch.FloatTensor), 可选, 当传入output_router_probs=True和config.add_router_probs=True或config.output_router_probs=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, sequence_length, num_experts)。由 MoE 路由器计算的原始路由器对数（softmax 后），这些术语用于计算专家混合模型的辅助损失。
PhimoeModel 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在函数内部定义，但之后应该调用 Module 实例，而不是直接调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
PhimoeForCausalLM
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[list[torch.FloatTensor]] = 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 output_router_logits: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **loss_kwargs ) → transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示**未被遮蔽**的 token，
- 0 表示**被遮蔽**的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
list[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（那些没有将其过去的键值状态提供给此模型的 token），而不是所有形状为(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的 token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 计算。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states。 - output_router_logits (
bool, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，不应在推理期间返回。 - cache_position (形状为
(sequence_length)的torch.LongTensor，可选) — 指示输入序列 token 在序列中的位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], 默认为0) — 如果是int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，只计算该 token 可以节省内存，这对于长序列或大词汇量来说非常显著。如果为torch.Tensor，则必须是 1D 的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批量和序列长度的单一维度）时很有用。
返回
transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.MoeCausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置（PhimoeConfig）和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
aux_loss (
torch.FloatTensor，可选，当提供labels时返回) — 稀疏模块的辅助损失。 -
router_logits (
tuple(torch.FloatTensor), 可选, 当传入output_router_probs=True和config.add_router_probs=True或config.output_router_probs=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, sequence_length, num_experts)。由 MoE 路由器计算的原始路由器对数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
PhimoeForCausalLM 的 forward 方法，重写了 __call__ 特殊方法。
尽管前向传播的实现需要在函数内部定义，但之后应该调用 Module 实例，而不是直接调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, PhimoeForCausalLM
>>> model = PhimoeForCausalLM.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> 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, 可选) — 用作生成调用基础参数化的生成配置。传递给生成与
generation_config属性匹配的**kwargs将覆盖它们。如果未提供generation_config，将使用默认值，其加载优先级如下：1) 如果存在，从generation_config.json模型文件中加载；2) 从模型配置中加载。请注意，未指定的参数将继承 GenerationConfig 的默认值，应查阅其文档以参数化生成。 - logits_processor (
LogitsProcessorList, 可选) — 补充从参数和生成配置构建的默认 logits 处理器的自定义 logits 处理器。如果传入的 logits 处理器已用参数或生成配置创建，则会抛出错误。此功能适用于高级用户。 - stopping_criteria (
StoppingCriteriaList, 可选) — 补充从参数和生成配置构建的默认停止准则的自定义停止准则。如果传入的停止准则已用参数或生成配置创建，则会抛出错误。如果您的停止准则依赖于scores输入，请确保向generate传递return_dict_in_generate=True, output_scores=True。此功能适用于高级用户。 - prefix_allowed_tokens_fn (
Callable[[int, torch.Tensor], list[int]], 可选) — 如果提供，此函数将在每一步将束搜索限制为仅允许的 token。如果未提供，则不应用任何限制。此函数接受 2 个参数：批次 IDbatch_id和input_ids。它必须返回一个列表，其中包含在批次 IDbatch_id和先前生成的 tokeninputs_ids的条件下，下一步生成允许的 token。此参数对于基于前缀的约束生成很有用，如 自回归实体检索 中所述。 - synced_gpus (
bool, 可选) — 是否继续运行 `while` 循环直到 `max_length`。除非被覆盖，如果使用 `FullyShardedDataParallel` 或 DeepSpeed ZeRO Stage 3 与多个 GPU，此标志将被设置为 `True`，以避免在一个 GPU 比其他 GPU 更早完成生成时发生死锁。否则，默认为 `False`。 - assistant_model (
PreTrainedModel, 可选) — 可用于加速生成过程的辅助模型。辅助模型必须具有完全相同的分词器。当使用辅助模型预测候选词元比使用你正在调用 `generate` 的模型运行生成速度快得多时，即可实现加速。因此，辅助模型应该小得多。 - streamer (
BaseStreamer, 可选) — 将用于流式传输生成序列的流式传输器对象。生成的标记通过 `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` 的注意力掩码。 - 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)`。
有关生成策略和代码示例的概述，请查阅以下指南。
PhimoeForSequenceClassification
class transformers.PhimoeForSequenceClassification
< source >( config )
参数
- config (PhimoeForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
Phimoe 模型 Transformer 顶部带有一个序列分类头（线性层）。PhimoeForSequenceClassification 使用最后一个标记进行分类，与其他因果模型（如 GPT-2）一样。由于它对最后一个标记进行分类，因此它需要知道最后一个标记的位置。如果在配置中定义了 `pad_token_id`，它会在每一行中找到不是填充标记的最后一个标记。如果未定义 `pad_token_id`，它只需取批处理中每一行的最后一个值。由于当传递 `inputs_embeds` 而不是 `input_ids` 时无法猜测填充标记，因此它也这样做（取批处理中每一行的最后一个值）。
此模型继承自 PreTrainedModel。请查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。请将其作为常规 PyTorch 模块使用，并参考 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 or 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, 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码前期返回的 `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` 索引如何转换为相关向量有更多控制，而不是模型的内部嵌入查找矩阵，这会很有用。 - 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 时），其中包含根据配置 (PhimoeConfig) 和输入的不同元素。
-
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 后的注意力权重，用于计算自注意力头中的加权平均值。
PhimoeForSequenceClassification 的 `forward` 方法，覆盖了 `__call__` 特殊方法。
尽管前向传播的实现需要在函数内部定义，但之后应该调用 Module 实例，而不是直接调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, PhimoeForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> model = PhimoeForSequenceClassification.from_pretrained("microsoft/Phi-3.5-MoE-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 = PhimoeForSequenceClassification.from_pretrained("microsoft/Phi-3.5-MoE-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, PhimoeForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("microsoft/Phi-3.5-MoE-instruct")
>>> model = PhimoeForSequenceClassification.from_pretrained("microsoft/Phi-3.5-MoE-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 = PhimoeForSequenceClassification.from_pretrained(
... "microsoft/Phi-3.5-MoE-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).loss