参数

• input_ids (torch.LongTensor, shape (batch_size, sequence_length), optional) — 词汇表中的输入序列标记索引。默认情况下会忽略填充。

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

  输入 ID 是什么？

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

  注意力掩码是什么？

• position_ids (torch.LongTensor, shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为 [0, config.n_positions - 1]。

  位置 ID 是什么？

• past_key_values (~cache_utils.Cache, optional) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常由解码前一阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

  只允许使用 Cache 实例，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

  模型将输出与输入相同的缓存格式。

  如果使用了 past_key_values，则用户应仅输入未处理的 input_ids（其 past key value 状态未传递给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 input_ids，形状为 (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor, shape (batch_size, sequence_length, hidden_size), optional) — 可选，而不是传递 input_ids，您可以直接传递嵌入表示。如果您想对如何将 input_ids 索引转换为关联向量的控制程度超过模型的内部嵌入查找矩阵，则此选项很有用。
• use_cache (bool, optional) — 如果设置为 True，则返回 past_key_values 键值状态，可用于加速解码（参见 past_key_values）。
• cache_position (torch.LongTensor, shape (sequence_length), optional) — 描绘输入序列标记在序列中位置的索引。与 position_ids 相反，此张量不受填充影响。它用于在正确位置更新缓存并推断完整序列长度。

一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），根据配置（Phi3Config）和输入包含各种元素。

• last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。

  如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

• past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

  Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) 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 后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• input_ids (torch.LongTensor, shape (batch_size, sequence_length), optional) — 词汇表中的输入序列标记索引。默认情况下会忽略填充。

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

  输入 ID 是什么？

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

  注意力掩码是什么？

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

  什么是位置 ID？

• 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（即没有将过去键值状态提供给此模型的 input_ids），形状为 (batch_size, unprocessed_length)，而不是所有 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, 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）。
• cache_position (torch.LongTensor, 形状为 (sequence_length), 可选) — 描绘输入序列 token 在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
• logits_to_keep (Union[int, torch.Tensor], 可选, 默认为 0) — 如果是 int，则计算最后 logits_to_keep 个 token 的 logits。如果是 0，则计算所有 input_ids 的 logits（特殊情况）。仅需要最后一个 token 的 logits 用于生成，并且仅为该 token 计算 logits 可以节省内存，这对于长序列或大词汇量大小非常重要。如果是 torch.Tensor，必须是 1D 的，对应于序列长度维度中要保留的索引。当使用打包张量格式（批次和序列长度的单维度）时，这很有用。

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

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

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

• past_key_values (Cache, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

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

参数

• 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 处理器。如果传入的 logit 处理器已通过参数或生成配置创建，则会引发错误。此功能面向高级用户。
• stopping_criteria (StoppingCriteriaList, 可选) — 自定义停止标准，用于补充由参数和生成配置构建的默认停止标准。如果传递的停止标准已通过参数或生成配置创建，则会引发错误。如果您的停止标准依赖于 scores 输入，请确保将 return_dict_in_generate=True, output_scores=True 传递给 generate。此功能面向高级用户。
• prefix_allowed_tokens_fn (Callable[[int, torch.Tensor], list[int]], 可选) — 如果提供，此函数将约束束搜索在每个步骤仅允许的 token。如果未提供，则不应用约束。此函数接受两个参数：批次 ID batch_id 和 input_ids。它必须返回一个列表，其中包含根据批次 ID batch_id 和先前生成的 token inputs_ids 的下一个生成步骤的允许 token。此参数对于受前缀约束的生成很有用，如 Autoregressive Entity Retrieval 中所述。
• synced_gpus (bool, 可选) — 是否继续运行 while 循环直到 max_length。除非覆盖，否则如果使用 FullyShardedDataParallel 或多 GPU 的 DeepSpeed ZeRO Stage 3，此标志将设置为 True，以避免其中一个 GPU 在其他 GPU 完成生成前死锁。否则，默认为 False。
• assistant_model (PreTrainedModel, 可选) — 一个辅助模型，可用于加速生成。辅助模型必须具有完全相同的分词器。通过辅助模型预测候选 token 比从您调用的模型运行生成要快得多，从而实现加速。因此，辅助模型应该小得多。
• 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。
• custom_generate (str 或 Callable, 可选) — 以下之一：
  • str (Hugging Face Hub 仓库名称): 运行该仓库中定义的自定义 generate 函数 (custom_generate/generate.py)，而不是标准的 generate 方法。该仓库完全取代了生成逻辑，并且返回类型可能不同。
  • str (本地仓库路径): 与上面相同，但来自本地路径，不需要 trust_remote_code。
  • Callable: generate 将执行通常的输入准备步骤，然后调用提供的可调用对象来运行解码循环。有关更多信息，请参阅 文档。
• kwargs (dict[str, Any], 可选) — generation_config 和/或附加模型特定 kwargs 的临时参数化，这些参数将被转发到模型的 forward 函数。如果模型是编码器-解码器模型，编码器特定 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 索引上执行 attention 的掩码。掩码值选择在 [0, 1] 中：
  • 1 表示未掩码的 token，
  • 0 表示已掩码的 token。

  Attention 掩码是什么？

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

  位置 ID 是什么？

• past_key_values (~cache_utils.Cache, 可选) — 预计算的隐藏状态（自 attention 块和交叉 attention 块中的 key 和 value），可用于加速序列解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

  只有 Cache 实例才允许作为输入，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

  模型将输出与输入相同的 cache 格式。

  如果使用 past_key_values，用户应仅输入未处理的 input_ids（即没有其 past key value 状态已提供给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 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, 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）。

A transformers.modeling_outputs.SequenceClassifierOutputWithPast or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.

• 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, optional, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。

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

参数

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

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

  输入 ID 是什么？

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

  Attention 掩码是什么？

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

  位置 ID 是什么？

• past_key_values (~cache_utils.Cache, 可选) — 预计算的隐藏状态（自 attention 块和交叉 attention 块中的 key 和 value），可用于加速序列解码。这通常由模型在解码的先前阶段返回的 past_key_values 组成，当 use_cache=True 或 config.use_cache=True 时。

  只有 Cache 实例才允许作为输入，请参阅我们的 kv cache 指南。如果未传入 past_key_values，则默认初始化 DynamicCache。

  模型将输出与输入相同的 cache 格式。

  如果使用 past_key_values，用户应仅输入未处理的 input_ids（即没有其 past key value 状态已提供给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 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, 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）。

A transformers.modeling_outputs.TokenClassifierOutput or a tuple of torch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (None) and inputs.

• 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 后的注意力权重，用于计算自注意力头中的加权平均值。