参数

• input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列标记的索引。 如果您提供 padding，默认情况下将被忽略。

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

  什么是输入 IDs？

• attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — Mask (掩码)，用于避免在 padding 标记索引上执行 attention。 Mask 值在 [0, 1] 中选择：
  • 1 表示标记未被掩盖，
  • 0 表示标记被掩盖。

  什么是 attention mask？

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

  如果使用 past_key_values，则可以选择仅输入最后一个 input_ids（请参阅 past_key_values）。

  如果您想更改 padding 行为，您应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。 有关默认策略的更多信息，请参见 论文 中的图 1。

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

  什么是 position IDs？

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

  允许两种格式：

  • Cache 实例，请参阅我们的 kv 缓存指南；
  • 长度为 config.n_layers 的 tuple(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（那些没有将其 past key value 状态提供给此模型的 input_ids），而不是形状为 (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, 可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
• cache_position (形状为 (sequence_length) 的 torch.LongTensor, 可选) — 描述输入序列标记在序列中位置的索引。 与 position_ids 相反，此张量不受 padding 的影响。 它用于在正确的位置更新缓存并推断完整序列长度。

参数

• input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列 tokens 的索引。如果您提供填充，默认情况下会忽略填充。

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

  什么是输入 IDs？

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

  什么是注意力掩码？

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

  如果使用了 past_key_values，则可以选择仅输入最后的 input_ids（请参阅 past_key_values）。

  如果您想更改填充行为，您应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参见 论文 中的图 1。

  • 1 表示 head 未被掩码，
  • 0 表示 head 已被掩码。
• position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围 [0, config.n_positions - 1] 中选择。

  什么是位置 IDs？

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

  允许两种格式：

  • Cache 实例，请参阅我们的 kv 缓存指南；
  • 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。 这也称为旧版缓存格式。

  模型将输出与作为输入馈送的缓存格式相同的格式。 如果未传递 past_key_values，则将返回旧版缓存格式。

  如果使用 past_key_values，用户可以选择仅输入最后的 input_ids（那些没有将其过去键值状态提供给此模型的输入 IDs），其形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

• inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
• use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
• cache_position (形状为 (sequence_length) 的 torch.LongTensor, 可选) — 描述输入序列 tokens 在序列中位置的索引。 与 position_ids 相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。
• labels (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 用于计算掩码语言建模损失的标签。 索引应为 [0, ..., config.vocab_size] 或 -100（请参阅 input_ids 文档字符串）。 索引设置为 -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，对应于要在序列长度维度中保留的索引。 这在使用打包张量格式（批次和序列长度的单个维度）时很有用。

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包括各种元素，具体取决于配置 (Phi3Config) 和输入。

• loss (形状为 (1,) 的 torch.FloatTensor, 可选, 当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。

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

• 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) 的张量)

  包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（请参阅 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 之后的注意力权重，用于计算自注意力 head 中的加权平均值。

参数

• 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 处理器。 如果传递的 logits 处理器已使用参数或生成配置创建，则会抛出错误。 此功能适用于高级用户。
• stopping_criteria (StoppingCriteriaList, 可选) — 自定义停止标准，用于补充从参数和生成配置构建的默认停止标准。 如果传递的停止标准已使用参数或生成配置创建，则会抛出错误。 如果您的停止标准取决于 scores 输入，请确保将 return_dict_in_generate=True, output_scores=True 传递给 generate。 此功能适用于高级用户。
• prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], List[int]], 可选) — 如果提供，此函数会在每个步骤将 beam search 约束为仅允许的 tokens。 如果未提供，则不应用约束。 此函数接受 2 个参数：批次 ID batch_id 和 input_ids。 它必须返回一个列表，其中包含基于批次 ID batch_id 和先前生成的 tokens inputs_ids 的下一个生成步骤的允许 tokens。 此参数对于基于前缀的约束生成很有用，如 自回归实体检索 中所述。
• synced_gpus (bool, 可选) — 是否继续运行 while 循环直到 max_length。 除非被覆盖，否则如果使用 FullyShardedDataParallel 或 DeepSpeed ZeRO Stage 3 与多个 GPU，则此标志将设置为 True，以避免当一个 GPU 在其他 GPU 之前完成生成时发生死锁。 否则，默认为 False。
• assistant_model (PreTrainedModel, 可选) — 可用于加速生成的辅助模型。 辅助模型必须具有完全相同的 tokenizer。 当使用辅助模型预测候选 tokens 比使用您正在从中调用 generate 的模型运行生成快得多时，可以实现加速。 因此，辅助模型应该小得多。
• streamer (BaseStreamer, 可选) — 流式器对象，用于流式传输生成的序列。生成的 token 会传递给 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 的 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 (如果 return_dict_in_generate=True 或当 config.return_dict_in_generate=True 时) 或一个 torch.LongTensor。

如果模型不是编码器-解码器模型 (model.config.is_encoder_decoder=False)，则可能的 ModelOutput 类型为

• GenerateDecoderOnlyOutput,
• GenerateBeamDecoderOnlyOutput

如果模型是编码器-解码器模型 (model.config.is_encoder_decoder=True)，则可能的 ModelOutput 类型为

• GenerateEncoderDecoderOutput,
• GenerateBeamEncoderDecoderOutput

参数

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

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

  什么是输入 IDs？

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

  什么是 attention 掩码？

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

  如果使用 past_key_values，则可以选择仅输入最后的 input_ids（请参阅 past_key_values）。

  如果您想更改填充行为，则应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息，请参见 论文 中的图 1。

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

  什么是位置 IDs？

• past_key_values (Cache 或 tuple(tuple(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，则用户可以选择仅输入最后的 input_ids（那些没有将其过去的键值状态提供给此模型的 input_ids），形状为 (batch_size, 1)，而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

• inputs_embeds (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
• output_attentions (bool，可选) — 是否返回所有 attention 层的 attention 张量。有关更多详细信息，请参见返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。
• cache_position (形状为 (sequence_length) 的 torch.LongTensor，可选) — 描述输入序列 token 在序列中位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存，并推断完整的序列长度。
• labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

参数

• input_ids (torch.LongTensor，形状为 (batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。 如果提供，默认情况下会忽略 padding。

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

  什么是输入 IDs？

• attention_mask (torch.Tensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在 [0, 1] 中选择：
  • 1 表示 tokens 未被 mask，
  • 0 表示 tokens 被 mask。

  什么是 attention masks？

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

  如果使用了 past_key_values，则可以选择仅输入最后的 input_ids（请参阅 past_key_values）。

  如果你想更改 padding 行为，你应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据你的需求进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。

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

  什么是位置 IDs？

• past_key_values (Cache 或 tuple(tuple(torch.FloatTensor))，可选) — 预先计算的 hidden-states（self-attention 块和 cross-attention 块中的 key 和 values），可用于加速顺序解码。 这通常包括模型在先前解码阶段返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。

  允许两种格式：

  • Cache 实例，请参阅我们的 kv cache 指南；
  • 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，每个元组都有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。 这也称为旧版缓存格式。

  模型将输出与作为输入馈送的缓存格式相同的格式。 如果未传递 past_key_values，则将返回旧版缓存格式。

  如果使用 past_key_values，用户可以选择仅输入最后 input_ids（那些没有将其过去 key value 状态提供给此模型的）形状为 (batch_size, 1) 而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

• inputs_embeds (torch.FloatTensor，形状为 (batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示而不是传递 input_ids。 如果你想比模型的内部 embedding 查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。
• use_cache (bool，可选) — 如果设置为 True，则返回 past_key_values 键值状态，并且可以用于加速解码（请参阅 past_key_values）。
• output_attentions (bool，可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• 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，则计算分类损失（交叉熵损失）。

一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (Phi3Config) 和输入。

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

• logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_labels)) — 分类得分（在 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 之后的注意力权重，用于计算自注意力 head 中的加权平均值。