Transformers 文档

CTRL

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

在模型、数据集和 Spaces 上进行协作

通过加速推理获得更快的示例

切换文档主题

开始使用

该模型于 2019 年 9 月 11 日在 HF 论文中发布，并于 2020 年 11 月 16 日贡献给 Hugging Face Transformers。

CTRL

概述

CTRL 模型由 Nitish Shirish Keskar、Bryan McCann、Lav R. Varshney、Caiming Xiong 和 Richard Socher 在 CTRL: A Conditional Transformer Language Model for Controllable Generation（CTRL：一种用于可控生成的条件 Transformer 语言模型）中提出。它是一个因果（单向）Transformer，在约 140 GB 的大规模文本语料库上通过语言建模进行预训练，并将第一个 token 保留为控制代码（例如 Links、Books、Wikipedia 等）。

论文摘要如下：

大规模语言模型展现了令人期待的文本生成能力，但用户很难轻松控制生成文本的特定方面。我们发布了 CTRL，这是一个拥有 16.3 亿参数的条件 Transformer 语言模型，旨在根据控制代码进行调节，从而支配风格、内容和特定任务的行为。控制代码源自与原始文本自然共现的结构，在保留无监督学习优势的同时，为文本生成提供了更明确的控制。这些代码还允许 CTRL 在给定序列的情况下预测训练数据的哪些部分最有可能出现。这提供了一种通过基于模型的来源归属来分析海量数据的潜在方法。

该模型由 keskarnitishr 贡献。原始代码可以在这里找到。

使用技巧

CTRL 利用控制代码来生成文本：它要求生成过程必须以特定的单词、句子或链接开头，以生成连贯的文本。更多信息请参考原始实现。
CTRL 是一种带有绝对位置嵌入（absolute position embeddings）的模型，因此通常建议在右侧而不是左侧填充输入。
CTRL 使用因果语言建模（CLM）目标进行训练，因此在预测序列中的下一个 token 方面非常强大。利用此特性，CTRL 可以生成语法连贯的文本，这在 run_generation.py 示例脚本中可以看到。
PyTorch 模型可以将 past_key_values 作为输入，这是先前计算的键/值注意力对。使用 past_key_values 可以防止模型在文本生成的上下文中重新计算预先计算的值。有关此参数用法的更多信息，请参阅 forward 方法。

资源

CTRLConfig

class transformers.CTRLConfig

< 源代码 >

( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 246534 n_positions: int = 256 n_embd: int = 1280 dff: int = 8192 n_layer: int = 48 n_head: int = 16 resid_pdrop: float | int = 0.1 embd_pdrop: float | int = 0.1 layer_norm_epsilon: float = 1e-06 initializer_range: float = 0.02 use_cache: bool = True pad_token_id: int | None = None bos_token_id: int | None = None eos_token_id: int | list[int] | None = None tie_word_embeddings: bool = True )

参数

vocab_size (int, 可选, 默认为 246534) — 模型词汇表大小。定义了 input_ids 可以表示的不同 token 的数量。
n_positions (int, 可选, 默认为 256) — 此模型可能使用的最大序列长度。
n_embd (int, 可选, 默认为 1280) — 嵌入和隐藏状态的维度。
dff (int, 可选, 默认为 8192) — 前馈网络 (FFN) 内部层的维度。
n_layer (int, 可选, 默认为 48) — Transformer 解码器中的隐藏层数量。
n_head (int, 可选, 默认为 16) — Transformer 解码器中每个注意力层的注意力头数量。
resid_pdrop (Union[float, int], 可选, 默认为 0.1) — 嵌入、编码器和池化层中所有全连接层的 dropout 概率。
embd_pdrop (Union[float, int], 可选, 默认为 0.1) — 嵌入层的 dropout 比率。
layer_norm_epsilon (float, 可选, 默认为 1e-06) — 层归一化层使用的 epsilon 值。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。
use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后计算的键/值注意力（并非所有模型都使用）。仅在 config.is_decoder=True 或模型是仅解码器生成模型时相关。
pad_token_id (int, 可选) — 词汇表中用于填充的 token ID。
bos_token_id (int, 可选) — 词汇表中用于流开始的 token ID。
eos_token_id (Union[int, list[int]], 可选) — 词汇表中用于流结束的 token ID。
tie_word_embeddings (bool, 可选, 默认为 True) — 是否根据模型的 tied_weights_keys 映射绑定权重嵌入。

这是用于存储 CTRLModel 配置的配置类。它用于根据指定的参数实例化一个 Ctrl 模型，从而定义模型架构。使用默认值实例化配置将产生与 Salesforce/ctrl 类似的配置。

配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import CTRLConfig, CTRLModel

>>> # Initializing a CTRL configuration
>>> configuration = CTRLConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = CTRLModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

CTRLTokenizer

class transformers.CTRLTokenizer

< 源代码 >

( vocab_file merges_file unk_token = '<unk>' **kwargs )

参数

vocab_file (str) — 词汇表文件的路径。
merges_file (str) — 合并文件的路径。
unk_token (str, 可选, 默认为 "<unk>") — 未知词元。不在词表中的词元无法转换为 ID，会被设置为该词元。

构建一个 CTRL 分词器。基于字节对编码 (Byte-Pair-Encoding)。

该分词器继承自 PreTrainedTokenizer，其中包含大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< 源码 >

( save_directory: str filename_prefix: str | None = None ) → tuple[str, ...]

参数

save_directory (str) — 保存词表的目录。
filename_prefix (str, 可选) — 添加到已保存文件名中的可选前缀。

tuple[str, ...]

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

常见词汇表保存模式的默认实现。将 self.encoder/self.vocab 保存为 JSON，可选地包含 self.bpe_ranks 作为合并。如果没有词汇表，则返回空元组。

如果您的分词器需要自定义保存逻辑 (例如，SentencePiece 模型、多个词汇表文件或特殊文件格式)，请重写此方法。

CTRLModel

class transformers.CTRLModel

< 源码 >

( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )

参数

config (CTRLModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。

输出原始隐藏状态且顶部没有任何特定任务头的纯 Ctrl 模型。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源码 >

( input_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

参数

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

索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。

什么是输入 ID？
past_key_values (~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的 key 和 values），可用于加速顺序解码。这通常包含当 use_cache=True 或 config.use_cache=True 时模型在先前解码阶段返回的 past_key_values。

仅允许使用 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果没有传入 past_key_values，默认将初始化 DynamicCache。

模型将输出与作为输入传入时相同的缓存格式。

如果使用了 past_key_values，则要求用户仅输入未处理的 input_ids（那些其过去键值状态未提供给此模型的 input_ids），形状应为 (batch_size, unprocessed_length)，而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：
- 1 表示未被屏蔽的词元，
- 0 表示被屏蔽的词元。
什么是注意力掩码？
token_type_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于区分输入的第一部分和第二部分的片段词元索引。索引选自 [0, 1]：
- 0 对应于句子 A 词元，
- 1 对应于句子 B 词元。
什么是词元类型 ID？
position_ids (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 每个输入序列词元在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]。

什么是位置 ID？
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 而不是纯元组。

BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

根据配置 (CTRLConfig) 和输入，BaseModelOutputWithPast 或 tuple(torch.FloatTensor)（如果传入了 return_dict=False 或 config.return_dict=False）。

CTRLModel 前向传播方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

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

如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (Cache，*可选*，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。

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

示例

>>> from transformers import AutoTokenizer, CTRLModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = CTRLModel.from_pretrained("Salesforce/ctrl")

>>> # CTRL was trained with control codes as the first token
>>> inputs = tokenizer("Opinion My dog is cute", return_tensors="pt")
>>> assert inputs["input_ids"][0, 0].item() in tokenizer.control_codes.values()

>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 5, 1280]

CTRLLMHeadModel

class transformers.CTRLLMHeadModel

< 源码 >

参数

config (CTRLLMHeadModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。

带有语言建模头（与输入嵌入权重绑定的线性层）的 CTRL 模型 Transformer。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源码 >

( input_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs ) → CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

参数

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

索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。

什么是输入 ID？
past_key_values (~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的 key 和 values），可用于加速顺序解码。这通常包含当 use_cache=True 或 config.use_cache=True 时模型在先前解码阶段返回的 past_key_values。

仅允许使用 Cache 实例作为输入，请参阅我们的 kv cache 指南。如果没有传入 past_key_values，默认将初始化 DynamicCache。

模型将输出与作为输入传入时相同的缓存格式。

如果使用了 past_key_values，则要求用户仅输入未处理的 input_ids（那些其过去键值状态未提供给此模型的 input_ids），形状应为 (batch_size, unprocessed_length)，而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
attention_mask (torch.FloatTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免对填充词元索引执行注意力的掩码。掩码值选自 [0, 1]：
- 1 表示未被屏蔽的词元，
- 0 表示被屏蔽的词元。
什么是注意力掩码？
token_type_ids (shape为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 用于指示输入第一部分和第二部分的片段 token 索引。索引选自 [0, 1]：
- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
什么是 token 类型 ID？
position_ids (shape为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]。

什么是位置 ID？
inputs_embeds (shape为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 作为一个选项，您可以选择直接传入嵌入表示，而不是传入 input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关的向量，这非常有用。
labels (shape为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 语言建模的标签。请注意，标签会在模型内部进行偏移，即您可以设置 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, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的 hidden_states。
return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
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 张量，对应于在序列长度维度上需要保留的索引。当使用打包（packed）张量格式（batch 和序列长度使用单个维度）时，这非常有用。

CausalLMOutputWithPast or tuple(torch.FloatTensor)

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

The CTRLLMHeadModel 的 forward 方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

loss (torch.FloatTensor 形状为 (1,)，可选，当提供 labels 时返回) — 语言建模损失（用于下一个 token 预测）。
logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。
past_key_values (Cache，*可选*，当传入 use_cache=True 或 config.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。

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

示例

>>> import torch
>>> from transformers import AutoTokenizer, CTRLLMHeadModel

>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = CTRLLMHeadModel.from_pretrained("Salesforce/ctrl")

>>> # CTRL was trained with control codes as the first token
>>> inputs = tokenizer("Wikipedia The llama is", return_tensors="pt")
>>> assert inputs["input_ids"][0, 0].item() in tokenizer.control_codes.values()

>>> sequence_ids = model.generate(inputs["input_ids"])
>>> sequences = tokenizer.batch_decode(sequence_ids)
>>> sequences
['Wikipedia The llama is a member of the family Bovidae. It is native to the Andes of Peru,']

>>> outputs = model(**inputs, labels=inputs["input_ids"])
>>> round(outputs.loss.item(), 2)
9.21

>>> list(outputs.logits.shape)
[1, 5, 246534]

CTRLForSequenceClassification

class transformers.CTRLForSequenceClassification

< 源代码 >

参数

config (CTRLForSequenceClassification) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。

在顶部带有序列分类头（线性层）的 CTRL 模型变换器。CTRLForSequenceClassification 使用最后一个 token 进行分类，就像其他因果模型（如 GPT-2）一样。由于它在最后一个 token 上进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它会找到每一行中不是填充 token 的最后一个 token。如果未定义 pad_token_id，它只会取 batch 中每一行的最后一个值。由于当传入 inputs_embeds 而不是 input_ids 时无法猜测填充 token，因此它执行相同的操作（取 batch 中每一行的最后一个值）。

该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< 源代码 >

( input_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → SequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

input_ids (shape为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 词汇表中输入序列 token 的索引。填充项将被默认忽略。

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

什么是输入 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，用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids（那些其过去键值状态未提供给此模型的输入），而不是形状为 (batch_size, sequence_length) 的所有 input_ids。
attention_mask (shape为 (batch_size, sequence_length) 的 torch.FloatTensor, 可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选自 [0, 1]：
- 1 表示未被掩盖的 token，
- 0 表示被掩盖的 token。
什么是注意力掩码？
token_type_ids (shape为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 用于指示输入第一部分和第二部分的片段 token 索引。索引选自 [0, 1]：
- 0 对应于 句子 A 的 token，
- 1 对应于 句子 B 的 token。
什么是 token 类型 ID？
position_ids (shape为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 每个输入序列 token 在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]。

什么是位置 ID？
inputs_embeds (shape为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 作为一个选项，您可以选择直接传入嵌入表示，而不是传入 input_ids。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关的向量，这非常有用。
labels (shape为 (batch_size,) 的 torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在 [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, 可选) — 是否返回一个 ModelOutput 而不是普通的元组。

SequenceClassifierOutput 或 tuple(torch.FloatTensor)

一个 SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），根据配置（CTRLConfig）和输入包含不同的元素。

CTRLForSequenceClassification 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

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

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, CTRLForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = CTRLForSequenceClassification.from_pretrained("Salesforce/ctrl")

>>> # CTRL was trained with control codes as the first token
>>> inputs = tokenizer("Opinion My dog is cute", return_tensors="pt")
>>> assert inputs["input_ids"][0, 0].item() in tokenizer.control_codes.values()

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'LABEL_0'

>>> import torch

>>> torch.manual_seed(42)
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = CTRLForSequenceClassification.from_pretrained("Salesforce/ctrl", num_labels=num_labels)

>>> labels = torch.tensor(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.93

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, CTRLForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = CTRLForSequenceClassification.from_pretrained(
...     "Salesforce/ctrl", problem_type="multi_label_classification"
... )

>>> # CTRL was trained with control codes as the first token
>>> inputs = tokenizer("Opinion My dog is cute", return_tensors="pt")
>>> assert inputs["input_ids"][0, 0].item() in tokenizer.control_codes.values()

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'LABEL_0'

>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = CTRLForSequenceClassification.from_pretrained("Salesforce/ctrl", num_labels=num_labels)

>>> num_labels = len(model.config.id2label)
>>> labels = torch.nn.functional.one_hot(torch.tensor([predicted_class_id]), num_classes=num_labels).to(
...     torch.float
... )
>>> loss = model(**inputs, labels=labels).loss
>>> loss.backward()

在 GitHub 上更新

←CPMANT DBRX→