Transformers 文档
Phi-3
并获得增强的文档体验
开始使用
该模型于 2024 年 4 月 22 日在 HF 论文中发表，并于 2024 年 4 月 24 日贡献给 Hugging Face Transformers。
Phi-3
概述
Phi-3 模型由微软在 Phi-3 技术报告：可在手机上本地运行的高性能语言模型中提出。
总结
以下是 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 所用数据集的放大版本，由经过严格过滤的网络数据和合成数据组成。该模型还针对鲁棒性、安全性和对话格式进行了进一步对齐。我们还提供了一些初步的参数扩展结果，即训练了 4.8 万亿 token 的 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，用于扩展旋转嵌入（rotary embeddings）的上下文。查询（query）、键（key）和值（value）被融合在一起，MLP 的上投影（up projection）和门控投影（gate projection）层也被融合。 - 该模型使用的分词器与 LlamaTokenizer 完全相同，只是额外增加了一些 token。
如何使用 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", device_map="auto")
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").to(model.device)
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
< 源码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 32064 hidden_size: int = 3072 intermediate_size: int = 8192 num_hidden_layers: int = 32 num_attention_heads: int = 32 num_key_value_heads: int | None = None resid_pdrop: float | int = 0.0 embd_pdrop: float | int = 0.0 attention_dropout: float | int = 0.0 hidden_act: str = 'silu' max_position_embeddings: int = 4096 original_max_position_embeddings: int = 4096 initializer_range: float = 0.02 rms_norm_eps: float = 1e-05 use_cache: bool = True tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 32000 pad_token_id: int | None = 32000 sliding_window: int | None = None )
参数
- vocab_size (
int, 可选, 默认为32064) — 模型词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - 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）的键值头数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（MQA）；否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的键和值头应通过对该组内的所有原始头进行平均池化来构建。有关更多详细信息，请参阅这篇论文。如果未指定，将默认为num_attention_heads。 - resid_pdrop (
Union[float, int], 可选, 默认为0.0) — 嵌入、编码器和池化层中所有全连接层的丢弃（dropout）概率。 - embd_pdrop (
Union[float, int], 可选, 默认为0.0) — 嵌入的丢弃比例。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的丢弃比例。 - hidden_act (
str, 可选, 默认为silu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu","relu","silu"等。 - max_position_embeddings (
int, 可选, 默认为4096) — 该模型可能使用的最大序列长度。 - original_max_position_embeddings (
int, 可选, 默认为 4096) — 该模型训练时使用的最大序列长度。这用于在使用长缩放（long scaling）时确定原始 RoPE 嵌入的大小。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认为1e-05) — RMS 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是仅解码器生成模型时相关。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，以及可选的缩放参数，以备在想要使用具有更长max_position_embeddings的 RoPE 时使用。 - bos_token_id (
int, optional, 默认为1) — 词表中用于表示流开始（beginning-of-stream）的 Token ID。 - eos_token_id (
Union[int, list[int]], optional, 默认为32000) — 词表中用于表示流结束（end-of-stream）的 Token ID。 - pad_token_id (
int, optional, 默认为32000) — 词表中用于填充（padding）的 Token ID。 - sliding_window (
int, optional) — 滑动窗口注意力机制的窗口大小。如果设为None，则不应用滑动窗口。
这是用于存储 Phi3Model 配置的配置类。它根据指定的参数实例化 Phi3 模型，从而定义模型架构。使用默认配置实例化一个配置类将得到与 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.config验证 rope_parameters 的配置。
Phi3Model
class transformers.Phi3Model
< 源代码 >( config: Phi3Config )
参数
- config (Phi3Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
基础 Phi3 模型，输出原始隐藏状态，顶部没有任何特定的层。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，optional) — 词表中输入序列 Token 的索引。默认情况下，填充（padding）将被忽略。索引可以通过 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，optional) — 用于避免对填充 Token 索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的 Token，
- 0 表示被掩码的 Token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，optional) — 每个输入序列 Token 在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在之前解码阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许输入 Cache 实例，请参阅我们的 KV 缓存指南。如果不传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（那些其过去键值状态未提供给此模型的 Token），其形状为(batch_size, unprocessed_length)，而不是所有形状为(batch_size, sequence_length)的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）。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置 (Phi3Config) 和输入包含各种元素。
Phi3Model 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
Phi3ForCausalLM
class transformers.Phi3ForCausalLM
< 源代码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (Phi3ForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Phi3 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，optional) — 词表中输入序列 Token 的索引。默认情况下，填充（padding）将被忽略。索引可以通过 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，optional) — 用于避免对填充 Token 索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的 Token，
- 0 表示被掩码的 Token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，optional) — 每个输入序列 Token 在位置嵌入中的位置索引。选值范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在之前解码阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许输入 Cache 实例，请参阅我们的 KV 缓存指南。如果不传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（那些其过去键值状态未提供给此模型的 Token），其形状为(batch_size, unprocessed_length)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，optional) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这会很有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，optional) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]范围内，或设为 -100（参见input_ids文档字符串）。索引设为-100的 Token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的 Token 进行计算。 - use_cache (
bool，optional) — 如果设为True，将返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果是int，则仅计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。生成时通常只需要最后一个 token 的 logits，仅针对该 token 进行计算可以节省内存，这在处理长序列或大规模词表时尤为显著。如果是torch.Tensor，则必须是对应于序列长度维度中要保留的索引的一维张量。在使用打包张量格式（batch 和序列长度共享单一维度）时，此参数非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），根据配置（Phi3Config）和输入的不同，包含不同的元素。
Phi3ForCausalLM 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> 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."生成
< 源文件 >( inputs: torch.Tensor | None = None generation_config: transformers.generation.configuration_utils.GenerationConfig | None = None logits_processor: transformers.generation.logits_process.LogitsProcessorList | None = None stopping_criteria: transformers.generation.stopping_criteria.StoppingCriteriaList | None = None prefix_allowed_tokens_fn: collections.abc.Callable[[int, torch.Tensor], list[int]] | None = None synced_gpus: bool | None = None assistant_model: typing.Optional[ForwardRef('PreTrainedModel')] = None streamer: typing.Optional[ForwardRef('BaseStreamer')] = None negative_prompt_ids: torch.Tensor | None = None negative_prompt_attention_mask: torch.Tensor | None = None custom_generate: str | collections.abc.Callable | None = None **kwargs ) → ModelOutput 或 torch.LongTensor
参数
- inputs (
torch.Tensor，形状根据模态而异，可选) — 用作生成提示或编码器模型输入的序列。如果为None，该方法将使用bos_token_id和 batch size 1 进行初始化。对于仅解码器（decoder-only）模型，inputs应采用input_ids的格式。对于编码器-解码器（encoder-decoder）模型，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 处理器，用于补充从参数和生成配置构建的默认 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]]，可选) — 如果提供，该函数将在每个步骤中将束搜索（beam search）限制为仅允许的 token。如果不提供，则不应用限制。该函数接收 2 个参数：batch IDbatch_id和input_ids。它必须返回一个列表，其中包含根据 batch IDbatch_id和先前生成的 tokeninputs_ids确定的下一个生成步骤允许的 token。此参数对于条件性前缀的受限生成非常有用，如 自回归实体检索（Autoregressive Entity Retrieval） 中所述。 - synced_gpus (
bool，可选) — 是否继续执行 while 循环直到达到 max_length。除非被覆盖，否则在使用多个 GPU 的FullyShardedDataParallel或 DeepSpeed ZeRO 第 3 阶段时，此标志将被设置为True，以避免在某些 GPU 比其他 GPU 更早完成生成时发生死锁。否则，默认为False。 - assistant_model (
PreTrainedModel，可选) — 可用于加速生成的辅助模型。辅助模型必须具有完全相同的分词器（tokenizer）。当使用辅助模型预测候选 token 比运行主模型的生成速度快得多时，就能实现加速。因此，辅助模型应比主模型小得多。 - streamer (
BaseStreamer，可选) — 将用于流式传输生成序列的 Streamer 对象。生成的 token 会通过streamer.put(token_ids)传入，而 Streamer 负责后续的任何处理。 - negative_prompt_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 某些处理器（例如 CFG）所需的负面提示。Batch size 必须与输入 batch size 匹配。这是一个实验性功能，未来版本可能会有破坏性的 API 变更。 - negative_prompt_attention_mask (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) —negative_prompt_ids的 attention_mask。 - custom_generate (
str或Callable，可选) — 以下选项之一：str（Hugging Face Hub 仓库名称）：运行该仓库中custom_generate/generate.py定义的自定义generate函数，而不是标准的generate方法。该仓库完全替换了生成逻辑，返回类型可能会有所不同。str（本地仓库路径）：与上述相同，但从本地路径加载，不需要trust_remote_code。Callable：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中设置，如果未传递generation_config，则将设置为模型的默认生成配置。您可以通过将相应的参数传递给 generate() 来覆盖任何generation_config，例如.generate(inputs, num_beams=4, do_sample=True)。有关生成策略和代码示例的概述，请查阅以下指南。
Phi3ForSequenceClassification
forward
< 源文件 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → SequenceClassifierOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词表中输入序列 token 的索引。默认情况下，padding 将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]范围。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的 key 和 values），可用于加速顺序解码。这通常包含当use_cache=True或config.use_cache=True时，模型在解码前一个阶段返回的past_key_values。仅允许输入 Cache 实例，请参阅我们的 kv cache 指南。如果未传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用
past_key_values，用户应仅输入未处理的input_ids（那些其 past key value 状态未提供给此模型的输入），形状为(batch_size, unprocessed_length)，而不是形状为(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的 token 将被忽略（遮罩），损失仅针对标签在[0, ..., config.vocab_size]范围内的 token 进行计算。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回
SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutputWithPast 或 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（None）和输入，其包含不同的元素。
The GenericForSequenceClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
Phi3ForTokenClassification
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → TokenClassifierOutput 或 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 缓存指南。如果不传递
past_key_values，将默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（那些其过去键值状态未提供给此模型的输入），形状为(batch_size, unprocessed_length)，而不是形状为(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）。
返回
TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置 (None) 和输入的各种元素。
The GenericForTokenClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。