参数

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

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

  什么是输入 ID？

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

  什么是注意力掩码？

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

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

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

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

  什么是位置 ID？

• 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))，每个元组都有两个形状为 (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 索引转换为相关向量进行更多控制，而不是模型的内部嵌入查找矩阵，这将非常有用。
• 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 (torch.LongTensor 形状为 (sequence_length)，可选) — 指示输入序列标记在序列中的位置的索引。与 position_ids 不同，该张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

参数

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

  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅

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

  什么是注意力掩码？

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

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

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

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

  什么是位置 ID？

• past_key_values (Cache 或 tuple(tuple(torch.FloatTensor)), 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在 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 索引转换为关联的向量，这将非常有用。
• 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 (torch.LongTensor 形状为 (sequence_length), 可选) — 指示输入序列令牌在序列中的位置的索引。与 position_ids 相反，该张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

  参数 — labels (torch.LongTensor 形状为 (batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。索引应该在 [0, ..., config.vocab_size] 或 -100 之间（参见 input_ids 文档字符串）。索引设置为 -100 的令牌将被忽略（掩码），仅对标签在 [0, ..., config.vocab_size] 之间的令牌计算损失。

  num_logits_to_keep (int, 可选): 计算最后 num_logits_to_keep 个令牌的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。生成仅需要最后一个令牌的 logits，并且仅针对该令牌计算它们可以节省内存，对于长序列或大型词汇量而言，这将变得非常重要。

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (Phi3Config) 和输入而变化的各种元素。

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

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

• past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 在传递了 use_cache=True 或 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 的元组，每个元组包含两个形状为 (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 之后的注意力权重。

参数

• inputs (形状随模态变化的 torch.Tensor, 可选) — 用作生成提示或作为编码器模型输入的序列。如果为 None，则该方法使用 bos_token_id 和批次大小 1 初始化它。对于仅解码器模型，inputs 应采用 input_ids 的格式。对于编码器-解码器模型，inputs 可以表示 input_ids、input_values、input_features 或 pixel_values 中的任何一个。
• generation_config (GenerationConfig, 可选) — 用作生成调用基本参数化的生成配置。传递给生成的 **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]], 可选) — 如果提供，此函数在每一步都将束搜索限制为仅允许的令牌。如果没有提供，则不应用任何约束。此函数接受 2 个参数：批次 ID batch_id 和 input_ids。它必须返回一个列表，其中包含根据批次 ID batch_id 和先前生成的令牌 inputs_ids 条件化的下一个生成步骤的允许令牌。此参数对于根据前缀进行约束生成很有用，如 自回归实体检索 中所述。
• synced_gpus (bool, 可选) — 是否继续运行 while 循环直到 max_length。除非被覆盖，否则此标志将在 DeepSpeed ZeRO Stage 3 多个 GPU 环境下设置为 True 以避免在某个 GPU 在其他 GPU 完成生成之前完成生成时挂起。否则它将被设置为 False。
• assistant_model (PreTrainedModel, 可选) — 可以用于加速生成的助理模型。助理模型必须具有完全相同的标记器。当使用助理模型预测候选令牌比使用您正在调用生成的模型运行生成快得多时，可以实现加速。因此，助理模型应该更小。
• 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 的注意力掩码。
• 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 (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列 token 在词汇表中的索引。 如果您提供填充，默认情况下将忽略填充。

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

  什么是输入 ID？

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

  什么是注意力掩码？

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

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

  如果您想更改填充行为，您应该阅读 modeling_opt._prepare_decoder_attention_mask 并修改以满足您的需求。 有关默认策略的更多信息，请查看 论文 中的图表 1。

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

  什么是位置 ID？

• 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（那些没有提供给该模型的过去键值状态的 input_ids），而不是所有形状为 (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。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。
• cache_position (torch.LongTensor 形状为 (sequence_length)，可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确的位置更新缓存，并推断完整的序列长度。
• labels (torch.LongTensor 形状为 (batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

参数

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

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

  什么是输入 ID？

• attention_mask (torch.Tensor 形状为 (batch_size, sequence_length)，可选) — 避免对填充标记索引执行注意的掩码。[0, 1] 中选择掩码值：
  • 1 表示 **未屏蔽** 的标记，
  • 0 表示 **屏蔽** 的标记。

  什么是注意掩码？

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

  如果使用 past_key_values，则可选地只需要输入最后一个 input_ids（那些没有提供给该模型的过去键值状态的 input_ids）（形状为 (batch_size, 1)），而不是形状为 (batch_size, sequence_length) 的所有 input_ids。

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

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

  什么是位置 ID？

• 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（那些没有提供给该模型的过去键值状态的 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。
• return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是普通元组。
• cache_position (torch.LongTensor 形状为 (sequence_length), 可选) — 指示输入序列令牌在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
• 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 之后的注意力权重。