参数

• 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。

  什么是注意力掩码？

• position_ids (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。
• past_key_values (~cache_utils.Cache, 可选) — 可用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。通常包括在 use_cache=True 或 config.use_cache=True 时，模型在上一个解码阶段返回的 past_key_values。

  仅允许 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果未传递 past_key_values，则默认情况下将初始化 DynamicCache。

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

  如果使用了 past_key_values，用户应仅传递未处理的 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 索引转换为相关的向量，这将很有用。
• use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，用于加速解码（请参阅 past_key_values）。
• cache_position (torch.LongTensor, 形状为 (sequence_length), 可选) — 指示输入序列 token 在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整的序列长度。

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

• last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, 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 后的注意力权重，用于计算自注意力头中的加权平均值。

• router_logits (tuple(torch.FloatTensor), 可选, 当传递 output_router_probs=True 且 config.add_router_probs=True 时，或 config.output_router_probs=True 时返回) — 形状为 (batch_size, sequence_length, num_experts) 的 torch.FloatTensor 元组（每一层一个）。

  由 MoE 路由器计算的原始路由器对数（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 索引进行注意力计算的掩码。掩码值选择在 [0, 1]:
  • 1 表示 **未掩码** 的 token，
  • 0 表示 **已掩码** 的 token。

  什么是注意力掩码？

• 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 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, 形状为 (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）。
• output_router_logits (bool, *可选*) — 是否返回所有路由器的 logits。它们对于计算路由器损失很有用，并且在推理期间不应返回。
• 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 计算它们可以节省内存，这对于长序列或大词汇量来说非常可观。如果是一个 torch.Tensor，则必须是一维的，对应于序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度的单维度）时很有用。

transformers.modeling_outputs.MoeCausalLMOutputWithPast 或一个元组（如果传递了 return_dict=False 或当 config.return_dict=False 时为 torch.FloatTensor），包含根据配置（PhimoeConfig）和输入的不同元素。

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

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

• aux_loss (torch.FloatTensor，可选，当提供 labels 时返回) — 稀疏模块的辅助损失。

• router_logits (tuple(torch.FloatTensor), 可选, 当传递 output_router_probs=True 且 config.add_router_probs=True 时，或 config.output_router_probs=True 时返回) — 形状为 (batch_size, sequence_length, num_experts) 的 torch.FloatTensor 元组（每一层一个）。

  由 MoE 路由器计算的原始路由器对数（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, *可选*) — 将用作生成调用的基本参数化的生成配置。与 generation_config 属性匹配的传递给 generate 的 **kwargs 将覆盖它们。如果未提供 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。它必须返回一个列表，其中包含允许的 token 以便根据批次 ID batch_id 和先前生成的 token inputs_ids 进行下一步生成。此参数对于受前缀约束的生成很有用，如 Autoregressive Entity Retrieval 中所述。
• synced_gpus (bool, *可选*) — 是否继续运行 while 循环直到 max_length。除非被覆盖，否则当使用 FullyShardedDataParallel 或带有多个 GPU 的 DeepSpeed ZeRO Stage 3 时，此标志将设置为 True，以避免在一台 GPU 完成生成早于其他 GPU 时死锁。否则，默认为 False。
• assistant_model (PreTrainedModel, *可选*) — 可用于加速生成的辅助模型。辅助模型必须具有完全相同的分词器。加速是通过使用辅助模型预测候选 token 比使用您调用 generate 的模型进行生成快得多来实现的。因此，辅助模型应该小得多。
• 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 的注意力掩码。
• custom_generate (str or Callable, optional) — One of the following:
  • str (Hugging Face Hub repository name): runs the custom generate function defined at custom_generate/generate.py in that repository instead of the standard generate method. The repository fully replaces the generation logic, and the return type may differ.
  • str (local repository path): same as above but from a local path, trust_remote_code not required.
  • Callable: generate will perform the usual input preparation steps, then call the provided callable to run the decoding loop. For more information, see the docs.
• kwargs (dict[str, Any], optional) — Ad hoc parametrization of generation_config and/or additional model-specific kwargs that will be forwarded to the forward function of the model. If the model is an encoder-decoder model, encoder specific kwargs should not be prefixed and decoder specific kwargs should be prefixed with 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 of shape (batch_size, sequence_length), optional) — Indices of input sequence tokens in the vocabulary. Padding will be ignored by default.

  Indices can be obtained using AutoTokenizer. See PreTrainedTokenizer.encode() and PreTrainedTokenizer.call() for details.

  What are input IDs?

• attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — Mask to avoid performing attention on padding token indices. Mask values selected in [0, 1]:
  • 1 for tokens that are not masked,
  • 0 for tokens that are masked.

  What are attention masks?

• position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — Indices of positions of each input sequence tokens in the position embeddings. Selected in the range [0, config.n_positions - 1].

  What are position IDs?

• past_key_values (~cache_utils.Cache, optional) — Pre-computed hidden-states (key and values in the self-attention blocks and in the cross-attention blocks) that can be used to speed up sequential decoding. This typically consists in the past_key_values returned by the model at a previous stage of decoding, when use_cache=True or config.use_cache=True.

  Only Cache instance is allowed as input, see our kv cache guide. If no past_key_values are passed, DynamicCache will be initialized by default.

  The model will output the same cache format that is fed as input.

  If past_key_values are used, the user is expected to input only unprocessed input_ids (those that don’t have their past key value states given to this model) of shape (batch_size, unprocessed_length) instead of all input_ids of shape (batch_size, sequence_length).

• inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — Optionally, instead of passing input_ids you can choose to directly pass an embedded representation. This is useful if you want more control over how to convert input_ids indices into associated vectors than the model’s internal embedding lookup matrix.
• labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — Labels for computing the masked language modeling loss. Indices should either be in [0, ..., config.vocab_size] or -100 (see input_ids docstring). Tokens with indices set to -100 are ignored (masked), the loss is only computed for the tokens with labels in [0, ..., config.vocab_size].
• use_cache (bool, optional) — If set to True, past_key_values key value states are returned and can be used to speed up decoding (see 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 后的注意力权重，用于计算自注意力头中的加权平均值。