Transformers 文档
PhiMoE
并访问增强的文档体验
开始使用
PhiMoE
概述
PhiMoE 模型由 Microsoft 在 Phi-3 Technical Report: A Highly Capable Language Model Locally on Your Phone 中提出。
总结
以下是 Phi-3 论文的摘要
我们介绍了 phi-3-mini，一个在 3.3 万亿个 token 上训练的 38 亿参数语言模型，其总体性能（通过学术基准和内部测试衡量）可与 Mixtral 8x7B 和 GPT-3.5 等模型相媲美（例如，phi-3-mini 在 MMLU 上达到 69%，在 MT-bench 上达到 8.38），尽管它足够小，可以部署在手机上。我们的训练数据集是 phi-2 使用的数据集的放大版本，由经过严格过滤的公开网络数据和合成数据组成。该模型还进一步针对稳健性、安全性和聊天格式进行了对齐。我们还提供了参数缩放结果，其中 7B、14B 模型训练了 4.8T 个 token，分别称为 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，它们被用于扩展 rotary embeddings 的上下文。query、key 和 values 被融合在一起，MLP 的 up 和 gate 投影层也进行了融合。 - 此模型使用的 tokenizer 与 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
< source >( 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可以表示的不同 token 的数量 - 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) — 这是用于实现分组查询注意力 (Grouped Query Attention) 的 key_value 头部的数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力 (Multi Head Attention, MHA)；如果num_key_value_heads=1，模型将使用多查询注意力 (Multi Query Attention, MQA)；否则将使用 GQA。当将多头检查点转换为 GQA 检查点时，每个组 key 和 value 头部都应通过对该组内所有原始头部进行平均池化来构建。有关更多详细信息，请查看 本文。如果未指定，则默认为8。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为4096*32) — 此模型可能使用的最大序列长度。Mixtral 的滑动窗口注意力机制允许处理最多 4096*32 个 token 的序列。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-05) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的 key/values 注意力 (并非所有模型都使用)。仅当config.is_decoder=True时相关。 - pad_token_id (
int, 可选) — padding token 的 id。 - bos_token_id (
int, 可选, 默认为 1) — “beginning-of-sequence” token 的 id。 - eos_token_id (
int, 可选, 默认为 2) — “end-of-sequence” 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) — 每个 Sparse MLP 层的专家数量。 - output_router_logits (
bool, optional, defaults toFalse) — 模型是否应返回路由器的 logits。启用此项还将允许模型输出辅助损失。有关更多详细信息，请参阅此处 - router_aux_loss_coef (
float, optional, defaults to 0.001) — 用于总损失的辅助损失因子。 - router_jitter_noise (
float, optional, defaults to 0.01) — 添加到路由器的噪声量。 - input_jitter_noise (
float, optional, defaults to 0.0) — 输入抖动噪声 - attention_bias (
bool, optional, defaults toFalse) — 注意力偏置 - lm_head_bias (
bool, optional, defaults toFalse) — 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
< source >( config: PhimoeConfig )
参数
- config (PhimoeConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
- config — PhimoeConfig
裸机 Phimoe 模型，输出原始隐藏状态，顶部没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是一个 PhimoeDecoderLayer
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.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 return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None )
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, optional) — 用于避免在填充标记索引上执行注意力的掩码。在[0, 1]中选择的掩码值：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
可以使用 AutoTokenizer 获取索引。 有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。如果您想更改填充行为，则应阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参见 论文中的图 1。- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - past_key_values (
tuple(tuple(torch.FloatTensor)), optional, 当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可以用于（请参阅
past_key_values输入）加速顺序解码。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将其过去键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, optional) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，并且可以用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 - output_router_logits (
bool, optional) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，不应在推理期间返回。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, optional) — 描述输入序列标记在序列中位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整序列长度。
PhimoeModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默忽略它们。
PhimoeForCausalLM
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.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 return_dict: 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 or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果您提供 padding，默认情况下将被忽略。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在[0, 1]中选择：- 1 表示 token 未被掩盖，
- 0 表示 token 被掩盖。
可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后的decoder_input_ids（请参阅past_key_values）。如果您想更改 padding 行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) —tuple(tuple(torch.FloatTensor))的元组，长度为config.n_layers，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（self-attention 块和 cross-attention 块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。如果使用
past_key_values，用户可以选择仅输入最后的decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_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, 可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - output_router_logits (
bool, 可选) — 是否返回所有 router 的 logits。它们对于计算 router 损失很有用，不应在推理期间返回。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor, 形状为(sequence_length), 可选) — 索引描述输入序列 tokens 在序列中的位置。与position_ids相反，此张量不受 padding 的影响。它用于在正确的位置更新缓存并推断完整序列长度。 - labels (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 用于计算 masked language modeling 损失的标签。索引应在[0, ..., config.vocab_size]或 -100 中（参见input_idsdocstring）。索引设置为-100的 tokens 将被忽略（掩盖），损失仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。 - logits_to_keep (
int或torch.Tensor, 可选) — 如果是int，则计算最后logits_to_keep个 tokens 的 logits。 如果为0，则计算所有input_ids的 logits（特殊情况）。 生成只需要最后一个 token logits，并且仅针对该 token 计算它们可以节省内存，这对于长序列或大词汇量大小而言变得非常重要。 如果是torch.Tensor，则必须是 1D，对应于在序列长度维度中要保留的索引。 这在使用 packed tensor 格式（批次和序列长度的单维度）时很有用。
返回
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 (
torch.FloatTensor, 形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
aux_loss (
torch.FloatTensor, 可选, 当提供labels时返回) — sparse 模块的 aux_loss。 -
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 routers 计算的原始 router logits（后 softmax），这些项用于计算 Mixture of Experts 模型的辅助损失。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) —tuple(tuple(torch.FloatTensor))的元组，长度为config.n_layers，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量)包含预先计算的隐藏状态（self-attention 块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（embeddings 的输出，如果模型具有 embedding 层，则为一个；每层的输出也为一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始 embedding 输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。attention softmax 之后的 Attention 权重，用于计算 self-attention heads 中的加权平均值。
PhimoeForCausalLM forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但之后应调用 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."generate
< 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], typing.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 **kwargs ) → ModelOutput or torch.LongTensor
参数
- inputs (
torch.Tensor, 形状根据模态而变化, 可选) — 用作生成的 prompt 或作为模型编码器输入的序列。如果为None，则该方法使用bos_token_id和批次大小 1 初始化它。对于仅解码器模型，inputs应为input_ids格式。对于编码器-解码器模型，inputs 可以表示input_ids、input_values、input_features或pixel_values中的任何一个。 - generation_config (GenerationConfig, 可选) — 要用作生成调用的基本参数化的生成配置。传递给 generate 的与
generation_config的属性匹配的**kwargs将覆盖它们。如果未提供generation_config，将使用默认值，默认值具有以下加载优先级：1) 来自generation_config.json模型文件（如果存在）；2) 来自模型配置。请注意，未指定的参数将继承 GenerationConfig 的默认值，应检查其文档以参数化生成。 - logits_processor (
LogitsProcessorList, 可选) — 自定义 logits processors，用于补充从参数和生成配置构建的默认 logits processors。 如果传递的 logit processor 已经使用参数或生成配置创建，则会抛出错误。 此功能适用于高级用户。 - stopping_criteria (
StoppingCriteriaList, 可选) — 自定义停止标准，作为从参数和生成配置构建的默认停止标准的补充。如果传递的停止标准已经使用参数或生成配置创建，则会抛出错误。如果您的停止标准依赖于scores输入，请确保将return_dict_in_generate=True, output_scores=True传递给generate。此功能 предназначена для опытных пользователей。 - prefix_allowed_tokens_fn (
Callable[[int, torch.Tensor], List[int]], 可选) — 如果提供，此函数会在每一步将束搜索约束为仅允许的 token。如果未提供，则不应用约束。此函数接受 2 个参数：批次 IDbatch_id和input_ids。它必须返回一个列表，其中包含基于批次 IDbatch_id和先前生成的 tokeninputs_ids的下一个生成步骤的允许 token。此参数对于基于前缀的约束生成非常有用，如 Autoregressive Entity Retrieval 中所述。 - synced_gpus (
bool, 可选) — 是否继续运行 while 循环直到 max_length。除非被覆盖，否则如果使用FullyShardedDataParallel或具有多个 GPU 的 DeepSpeed ZeRO Stage 3 以避免当一个 GPU 在其他 GPU 之前完成生成时发生死锁，则此标志将设置为True。否则，默认为False。 - assistant_model (
PreTrainedModel, 可选) — 可以用于加速生成的辅助模型。辅助模型必须具有完全相同的 tokenizer。当使用辅助模型预测候选 token 比使用您调用 generate 的模型运行生成快得多时，即可实现加速。因此，辅助模型应该小得多。 - streamer (
BaseStreamer, 可选) — 将用于流式传输生成序列的 Streamer 对象。生成的 token 通过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的 attention_mask。 - use_model_defaults (
bool, 可选) — 当为True时，generation_config中未设置的参数将设置为模型特定的默认生成配置 (model.generation_config)，而不是全局默认值 (GenerationConfig())。如果未设置，从v4.50开始保存的模型会将此标志视为True。 - 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 类型是
为具有语言建模头的模型生成 token id 序列。
大多数生成控制参数在 generation_config 中设置，如果未传递，则将其设置为模型的默认生成配置。您可以通过将相应的参数传递给 generate() 来覆盖任何 generation_config，例如 .generate(inputs, num_beams=4, do_sample=True)。
有关生成策略和代码示例的概述，请查看以下指南。
PhimoeForSequenceClassification
class transformers.PhimoeForSequenceClassification
< source >( config )
参数
- config (PhimoeConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
Phimoe 模型转换器，顶部带有序列分类头（线性层）。 PhimoeForSequenceClassification 使用最后一个 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
< 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.Union[transformers.cache_utils.Cache, typing.List[torch.FloatTensor], NoneType] = 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 return_dict: typing.Optional[bool] = None )
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。默认情况下，如果您提供填充，则填充将被忽略。索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对 padding token 索引执行 attention 的掩码。在[0, 1]中选择的掩码值：- 1 表示 未被掩盖 的 token，
- 0 表示 被掩盖 的 token。
索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。如果要更改填充行为，则应阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参见 论文 中的图 1。- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)) 的张量和 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些状态可以用于（请参阅
past_key_values输入）加速顺序解码。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_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, 可选) — 是否返回所有 attention 层的 attention 张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - output_router_logits (
bool, 可选) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，并且不应在推理期间返回。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length)，可选) — 描述输入序列 tokens 在序列中位置的索引。与position_ids相反，此张量不受 padding 的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失）。如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
The PhimoeForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但之后应调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默忽略它们。