参数

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

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

  输入 ID 是什么？

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

  Attention 掩码是什么？

• position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为 [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（即尚未将其过去键值状态提供给此模型的 input_ids），其形状为 (batch_size, unprocessed_length)，而不是所有 input_ids 的形状 (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), 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。
• cache_position (torch.LongTensor of shape (sequence_length), optional) — 指示输入序列 token 在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。

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

• 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 of shape (batch_size, sequence_length), optional) — 词汇表中输入序列 token 的索引。默认情况下会忽略填充。

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

  输入 ID 是什么？

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

  Attention 掩码是什么？

• position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为 [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（即尚未将其过去键值状态提供给此模型的 input_ids），其形状为 (batch_size, unprocessed_length)，而不是所有 input_ids 的形状 (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，您也可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型内部的嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
• labels (torch.LongTensor of shape (batch_size, sequence_length), 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）。
• cache_position (torch.LongTensor of shape (sequence_length), optional) — 指示输入序列 token 在序列中的位置的索引。与 position_ids 相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
• logits_to_keep (Union[int, torch.Tensor], optional, defaults to 0) — 如果为 int，则计算最后 logits_to_keep 个 token 的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。仅最后一个 token 的 logits 对于生成是必需的，并且仅为此 token 计算它们可以节省内存，这对于长序列或大词汇量大小而言非常可观。如果为 torch.Tensor，则必须是 1D，对应于要保留在序列长度维度中的索引。当使用打包张量格式（批处理和序列长度的单维）时，这很有用。

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

• 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 且与 generation_config 属性匹配的 **kwargs 将覆盖它们。如果未提供 generation_config，则将使用默认值，其加载优先级如下：1) 如果存在，则从 generation_config.json 模型文件加载；2) 从模型配置加载。请注意，未指定的参数将继承 GenerationConfig 的默认值，应检查其文档以参数化生成。
• logits_processor (LogitsProcessorList, 可选) — 自定义 logit processor，用于补充由参数和生成配置构建的默认 logit processor。如果传递的 logit processor 已使用参数或生成配置创建，则会引发错误。此功能面向高级用户。
• stopping_criteria (StoppingCriteriaList, 可选) — 自定义停止条件，用于补充由参数和生成配置构建的默认停止条件。如果传递的停止条件已使用参数或生成配置创建，则会引发错误。如果您的停止条件依赖于 scores 输入，请确保为 generate 传递 return_dict_in_generate=True, output_scores=True。此功能面向高级用户。
• 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, 可选) — 可用于加速生成的助手模型。助手模型必须拥有完全相同的 tokenizer。通过助手模型预测候选 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 仓库名称)：运行该仓库中 custom_generate/generate.py 定义的自定义 generate 函数，而不是标准的 generate 方法。该仓库将完全替换生成逻辑，返回值可能有所不同。
  • str (本地仓库路径)：与上面相同，但来自本地路径，不需要 trust_remote_code。
  • Callable：generate 将执行常规的输入准备步骤，然后调用提供的可调用对象来运行解码循环。有关更多信息，请参阅 文档。
• kwargs (dict[str, Any], 可选) — generation_config 和/或模型特定附加参数的即时参数化，将转发到模型的 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()。

  什么是 input IDs？

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

  什么是 attention masks？

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

  什么是 position IDs？

• past_key_values (~cache_utils.Cache, 可选) — 可以用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常由解码过程早期阶段返回的 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 状态未传递给此模型）而不是所有 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, optional) — 如果设置为 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 of shape (batch_size, sequence_length), optional) — Input sequence tokens的索引，在词汇表中。默认情况下，填充将被忽略。

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

  输入 IDs 是什么？

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

  注意力掩码是什么？

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

  位置 ID 是什么？

• past_key_values (~cache_utils.Cache, optional) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括在 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)，而不是全部 input_ids 形状为 (batch_size, sequence_length)。

• inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地，而不是传递 input_ids，您可以选择直接传递嵌入表示。如果您想比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
• labels (torch.LongTensor of shape (batch_size, sequence_length), 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）。

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