参数

• save_directory (str) — 要保存词汇表的目录。
• filename_prefix (str, optional) — 添加到保存文件名称的可选前缀。

已保存文件的路径，如果未保存文件则为空元组。

参数

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

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

  输入 ID 是什么？

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

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

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

  如果使用 past_key_values，用户需要仅输入未处理的 input_ids（其过去键值状态未传递给此模型的那些），形状为 (batch_size, unprocessed_length)，而不是所有 input_ids（形状为 (batch_size, sequence_length)）。

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

  注意力掩码是什么？

• token_type_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于指示输入部分的第一和第二部分的段 token 索引。索引选择在 [0, 1]：
  • 0 对应于句子 A token，
  • 1 对应于句子 B token。

  token 类型 ID 是什么？

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

  位置 ID 是什么？

• 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。
• return_dict (bool, optional) — 是否返回 ModelOutput 而不是纯元组。
• cache_position (torch.Tensor of shape (sequence_length), optional) — 描绘输入序列 token 在序列中位置的索引。与 position_ids 不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整序列长度。

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

• 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, 形状 (batch_size, sequence_length), 可选) — 输入序列 token 在词汇表中的索引。默认情况下，填充（padding）将被忽略。

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

  什么是输入 ID？

• 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，用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids（即其过去键值状态未提供给此模型的那些），而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

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

  什么是 attention masks？

• token_type_ids (torch.LongTensor, 形状 (batch_size, sequence_length), 可选) — 用于指示输入的第一个和第二个部分的 segment token 索引。索引选择范围为 [0, 1]：
  • 0 对应于*句子 A* token，
  • 1 对应于*句子 B* token。

  什么是 token type IDs？

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

  什么是 position IDs？

• inputs_embeds (torch.FloatTensor, 形状 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以选择直接传入嵌入表示，而不是传入 input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，则此选项很有用。
• labels (torch.LongTensor, 形状 (batch_size, sequence_length), 可选) — 用于语言建模的标签。请注意，标签在模型内部是移位的，即您可以设置 labels = input_ids。索引选择范围为 [-100, 0, ..., config.vocab_size]。所有设置为 -100 的标签都将被忽略（掩码），损失仅为 [0, ..., config.vocab_size] 中的标签计算。
• use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。有关详细信息，请参阅返回的张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。有关详细信息，请参阅返回的张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回一个 ModelOutput 而不是一个纯元组。
• cache_position (torch.Tensor, 形状 (sequence_length), 可选) — 描述输入序列 token 在序列中的位置的索引。与 position_ids 不同，此张量不受 padding 的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
• logits_to_keep (Union[int, torch.Tensor], 可选, 默认为 0) — 如果为 int，则计算最后 logits_to_keep 个 token 的 logits。如果为 0，则计算所有 input_ids 的 logits（特殊情况）。生成时只需要最后一个 token 的 logits，并且仅为该 token 计算它们可以节省内存，这对于长序列或大词汇量来说非常显著。如果为 torch.Tensor，则必须是 1D 的，对应于要保留的序列长度维度上的索引。当使用 packed tensor 格式（批次和序列长度的单个维度）时，这很有用。

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

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

参数

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

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

  什么是输入 ID？

• 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，用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids（即其过去键值状态未提供给此模型的那些），而不是所有形状为 (batch_size, sequence_length) 的 input_ids。

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

  什么是 attention masks？

• token_type_ids (torch.LongTensor, 形状 (batch_size, sequence_length), 可选) — 用于指示输入的第一个和第二个部分的 segment token 索引。索引选择范围为 [0, 1]：
  • 0 对应于*句子 A* token，
  • 1 对应于*句子 B* token。

  什么是 token type IDs？

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

  什么是 position IDs？

• inputs_embeds (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地，您可以直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型内部的嵌入查找矩阵对如何将 input_ids 索引转换为关联向量有更多的控制，这将非常有用。
• labels (torch.LongTensor, 形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 范围内。如果 config.num_labels == 1，则计算回归损失（均方损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵）。
• use_cache (bool, 可选) — 如果设置为 True，则会返回 past_key_values 键值状态，并可用于加速解码（请参阅 past_key_values）。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 如果设置为 True，则返回一个 ModelOutput，而不是一个普通的元组。

一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个元组 torch.FloatTensor（如果传递了 return_dict=False 或当 config.return_dict=False 时），具体取决于配置（CTRLConfig）和输入。

• loss (形状为 (1,) 的 torch.FloatTensor，可选，当提供 labels 时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。

• logits (形状为 (batch_size, config.num_labels) 的 torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。