Transformers 文档
CTRL
并获得增强的文档体验
开始
CTRL
概述
CTRL 模型在 CTRL: A Conditional Transformer Language Model for Controllable Generation 中被 Nitish Shirish Keskar, Bryan McCann, Lav R. Varshney, Caiming Xiong 和 Richard Socher 提出。它是一个因果（单向）transformer 预训练模型，使用语言建模在约 140 GB 的文本数据的超大型语料库上进行训练，其中第一个 token 保留为控制代码（例如 Links、Books、Wikipedia 等）。
论文摘要如下
大规模语言模型展现出令人鼓舞的文本生成能力，但用户无法轻松控制生成文本的特定方面。我们发布了 CTRL，一个 16.3 亿参数的条件 transformer 语言模型，经过训练以控制管理风格、内容和特定于任务的行为的控制代码。控制代码源于自然地与原始文本共同出现的结构，保留了无监督学习的优势，同时提供了对文本生成的更明确的控制。这些代码还允许 CTRL 预测给定序列时训练数据中最有可能的部分。这为通过基于模型的来源归因分析大量数据提供了一种潜在方法。
此模型由 keskarnitishr 贡献。原始代码可以在这里找到。
使用技巧
- CTRL 使用控制代码来生成文本：它要求生成以某些单词、句子或链接开头，以生成连贯的文本。有关更多信息，请参阅原始实现。
- CTRL 是一个具有绝对位置嵌入的模型，因此通常建议在右侧而不是左侧填充输入。
- CTRL 使用因果语言建模 (CLM) 目标进行训练，因此非常擅长预测序列中的下一个 token。利用此功能，CTRL 可以生成语法连贯的文本，这可以在 run_generation.py 示例脚本中观察到。
- PyTorch 模型可以将
past_key_values作为输入，这是先前计算的键/值注意力对。TensorFlow 模型接受past作为输入。使用past_key_values值可以防止模型在文本生成的上下文中重新计算预先计算的值。有关此参数用法的更多信息，请参阅forward方法。
资源
CTRLConfig
类 transformers.CTRLConfig
< source >( vocab_size = 246534 n_positions = 256 n_embd = 1280 dff = 8192 n_layer = 48 n_head = 16 resid_pdrop = 0.1 embd_pdrop = 0.1 layer_norm_epsilon = 1e-06 initializer_range = 0.02 use_cache = True **kwargs )
参数
- vocab_size (
int, 可选, 默认为 246534) — CTRL 模型的词汇表大小。 定义了在调用 CTRLModel 或 TFCTRLModel 时，可以通过inputs_ids传递的不同 token 的数量。 - n_positions (
int, 可选, 默认为 256) — 模型可能使用的最大序列长度。 通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。 - n_embd (
int, 可选, 默认为 1280) — 嵌入和隐藏状态的维度。 - dff (
int, 可选, 默认为 8192) — 前馈网络 (FFN) 内部维度的维度。 - n_layer (
int, 可选, 默认为 48) — Transformer 编码器中隐藏层的数量。 - n_head (
int, 可选, 默认为 16) — Transformer 编码器中每个注意力层的注意力头数。 - resid_pdrop (
float, 可选, 默认为 0.1) — 嵌入层、编码器和池化器中所有全连接层的 dropout 概率。 - embd_pdrop (
int, 可选, 默认为 0.1) — 嵌入的 dropout 比率。 - layer_norm_epsilon (
float, 可选, 默认为 1e-06) — 层归一化层中使用的 epsilon 值 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回上次的键/值注意力（并非所有模型都使用）。
这是用于存储 CTRLModel 或 TFCTRLModel 配置的配置类。 它用于根据指定的参数实例化 CTRL 模型，定义模型架构。 使用默认值实例化配置将产生与来自 SalesForce 的 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.configCTRLTokenizer
类 transformers.CTRLTokenizer
< source >( vocab_file merges_file unk_token = '<unk>' **kwargs )
构建 CTRL 分词器。 基于字节对编码 (Byte-Pair-Encoding)。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。 用户应参考此超类以获取有关这些方法的更多信息。
CTRLModel
类 transformers.CTRLModel
< source >( config )
参数
- config (CTRLConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
裸 CTRL 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 PreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在 padding token 索引上执行注意力的掩码。在[0, 1]中选择的掩码值：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。在[0, 1]中选择的索引：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor，可选) — 用于使自注意力模块的选定头无效的掩码。在[0, 1]中选择的掩码值：- 1 表示头 未被掩码，
- 0 表示头 已被掩码。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递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 而不是普通的元组。
返回值
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (CTRLConfig) 和输入。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层的输出的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及可选地，如果config.is_encoder_decoder=True，则还有 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含可用于加速顺序解码的预先计算的隐藏状态（自注意力模块中的键和值，以及可选地，如果
config.is_encoder_decoder=True，则在交叉注意力模块中）（请参阅past_key_values输入）。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则embeddings 的输出为 1 个，+ 每层的输出为 1 个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CTRLModel 前向方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在该函数中定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> 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
< source >( config )
参数
- config (CTRLConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
CTRL 模型 Transformer，顶部带有一个语言建模头（线性层，其权重与输入嵌入绑定）。
此模型继承自 PreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 如果past_key_values为None，则input_ids_length=sequence_length，否则为past_key_values[0].shape[-2]（输入过去键值状态的sequence_length）。词汇表中输入序列 token 的索引。如果使用了
past_key_values，则只应将未计算过去的输入 ID 作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past_key_values (
Tuple[Tuple[torch.FloatTensor]]，长度为config.n_layers的元组) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。可用于加速顺序解码。已将其过去状态提供给此模型的input_ids不应作为 input ids 传递，因为它们已被计算出来。 - attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在 padding token 索引上执行注意力的掩码。在[0, 1]中选择的掩码值：- 1 表示 token 未被掩码，
- 0 表示 token 已被掩码。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。在[0, 1]中选择的索引：- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的注意力头无效的掩码。 掩码值在[0, 1]中选择：- 1 表示注意力头未被屏蔽，
- 0 表示注意力头被屏蔽。
- 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 而不是纯元组。 - labels (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 用于语言建模的标签。 请注意，标签在模型内部已移位，即您可以设置labels = input_ids。 索引在[-100, 0, ..., config.vocab_size]中选择。 所有设置为-100的标签都将被忽略（屏蔽），损失仅针对[0, ..., config.vocab_size]中的标签计算。
返回值
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (CTRLConfig) 和输入。
-
loss (
torch.FloatTensor, 形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensor, 形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) —tuple(torch.FloatTensor)的元组，长度为config.n_layers，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量)包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则embeddings 的输出为 1 个，+ 每层的输出为 1 个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CTRLLMHeadModel forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在该函数中定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> 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
< source >( config )
参数
- config (CTRLConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
带有序列分类头（线性层）的 CTRL 模型转换器。 CTRLForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-2）一样。 由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。 如果在配置中定义了 pad_token_id，它会在每行中找到最后一个不是填充 token 的 token。 如果未定义 pad_token_id，它会简单地取每行批次中的最后一个值。 由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测填充 token，因此它执行相同的操作（取每行批次的最后一个值）。
此模型继承自 PreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档，了解与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.Tuple[typing.Tuple[torch.FloatTensor]]] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, sequence_length)) — 如果past_key_values为None，则input_ids_length=sequence_length；否则为past_key_values[0].shape[-2]（输入的过去键值状态的sequence_length）。 词汇表中输入序列 token 的索引。如果使用
past_key_values，则只应将未计算过去的输入 ID 作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past_key_values (
Tuple[Tuple[torch.FloatTensor]], 长度为config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力模块中的键和值）（请参阅下面的past_key_values输出）。 可用于加速顺序解码。 已将其过去状态提供给此模型的input_ids不应作为输入 ID 传递，因为它们已被计算过。 - attention_mask (
torch.FloatTensor, 形状为(batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 token 未被屏蔽，
- 0 表示 token 被屏蔽。
- token_type_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 段 token 索引，用于指示输入的第一个和第二个部分。 索引在[0, 1]中选择：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。 在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.FloatTensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于使自注意力模块中选定的注意力头无效的掩码。 掩码值在[0, 1]中选择：- 1 表示注意力头未被屏蔽，
- 0 表示注意力头被屏蔽。
- 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, optional) — 是否返回 ModelOutput 而不是纯粹的元组。 - labels (
torch.LongTensor，形状为(batch_size,)，optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方误差损失）；如果config.num_labels > 1，则计算分类损失（交叉熵损失）。
返回值
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (CTRLConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,)，optional，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则embeddings 的输出为 1 个，+ 每层的输出为 1 个），形状为(batch_size, sequence_length, hidden_size)。模型在每层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CTRLForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在该函数中定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> 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()TFCTRLModel
class transformers.TFCTRLModel
< source >( config *inputs **kwargs )
参数
- config (CTRLConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
裸 CTRL 模型 Transformer，输出原始隐藏状态，顶部没有任何特定的 head。
此模型继承自 TFPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（如 PyTorch 模型），或
- 所有输入都作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅具有
input_ids且没有其他内容的单个张量：model(input_ids) - 具有一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 具有一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFBaseModelOutputWithPast 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length，如果past为None，否则为past[0].shape[-2]（输入过去键值状态的sequence_length）。词汇表中输入序列标记的索引。
如果使用
past，则仅应将未计算过去的输入 ID 作为input_ids传递。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past (长度为
config.n_layers的List[tf.Tensor]) — 包含模型计算的预先计算的隐藏状态（注意力块中的键和值）（请参阅下面的past输出）。可用于加速顺序解码。已将其过去状态提供给此模型的标记 ID 不应作为输入 ID 传递，因为它们已被计算出。 - attention_mask (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，optional) — 掩码，以避免在填充标记索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示标记未被掩盖，
- 0 表示标记被掩盖。
- token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，optional) — 分段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，optional) — 用于使自注意力模块的选定头无效的掩码。掩码值在[0, 1]中选择：- 1 表示头未被掩盖，
- 0 表示头被掩盖。
- inputs_embeds (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length, hidden_size)，optional) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past键值状态，并且可以用于加速解码（请参阅past）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是纯粹的元组。此参数可以在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool, optional, 默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。
返回值
transformers.modeling_tf_outputs.TFBaseModelOutputWithPast 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPast 或一个 tf.Tensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (CTRLConfig) 和输入。
-
last_hidden_state (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
List[tf.Tensor]，optional，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)）。包含预先计算的隐藏状态（注意力块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（每个层的输出对应一个，外加嵌入的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFCTRLModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在该函数中定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCTRLModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = TFCTRLModel.from_pretrained("Salesforce/ctrl")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFCTRLLMHeadModel
class transformers.TFCTRLLMHeadModel
< source >( config *inputs **kwargs )
参数
- config (CTRLConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
CTRL 模型 Transformer，顶部带有一个语言建模头（线性层，其权重与输入嵌入绑定）。
此模型继承自 TFPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（如 PyTorch 模型），或
- 所有输入都作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅具有
input_ids且没有其他内容的单个张量：model(input_ids) - 具有一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 具有一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< source >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFCausalLMOutputWithPast 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length，如果past为None；否则为past[0].shape[-2](输入 past 键值状态的sequence_length)。词汇表中输入序列 tokens 的索引。
如果使用
past，则仅应将未计算 past 的输入 ID 作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past (
List[tf.Tensor]，长度为config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力块中的键和值）（请参阅下面的past输出）。 可用于加速顺序解码。 已将其 past 提供给此模型的 token IDs 不应作为输入 IDs 传递，因为它们已被计算过。 - attention_mask (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩蔽，
- 0 表示 tokens 被掩蔽。
- token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。 在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定 head 无效的掩码。 掩码值在[0, 1]中选择：- 1 表示 head 未被掩蔽，
- 0 表示 head 被掩蔽。
- inputs_embeds (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past键值状态，并且可以用于加速解码（请参阅past）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回张量下的attentions。 此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回张量下的hidden_states。 此参数只能在即时模式下使用，在图模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 此参数可以在即时模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算交叉熵分类损失的标签。 索引应为[0, ..., config.vocab_size - 1]。
返回值
transformers.modeling_tf_outputs.TFCausalLMOutputWithPast 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithPast 或一个 tf.Tensor 的 tuple (如果传递了 return_dict=False，或者当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (CTRLConfig) 和输入。
-
loss (
tf.Tensor，形状为(n,)，可选，当提供labels时返回，其中 n 是非掩蔽标签的数量) — 语言建模损失（用于下一个 token 预测）。 -
logits (
tf.Tensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
List[tf.Tensor]，optional，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tf.Tensor列表，每个张量的形状为(2, batch_size, num_heads, sequence_length, embed_size_per_head)）。包含预先计算的隐藏状态（注意力块中的键和值），这些状态可用于（请参阅
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（每个层的输出对应一个，外加嵌入的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFCTRLLMHeadModel forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在该函数中定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCTRLLMHeadModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = TFCTRLLMHeadModel.from_pretrained("Salesforce/ctrl")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFCTRLForSequenceClassification
class transformers.TFCTRLForSequenceClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (CTRLConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，而只会加载配置。 查看 from_pretrained() 方法以加载模型权重。
CTRL 模型转换器，顶部带有序列分类 head（线性层）。
TFCTRLForSequenceClassification 使用最后一个 token 来进行分类，就像其他因果模型（例如 GPT-1、GPT-2）一样。
由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。 如果在配置中定义了 pad_token_id，它将查找每行中不是 padding token 的最后一个 token。 如果未定义 pad_token_id，它将简单地获取批处理中每行的最后一个值。 由于当传递 inputs_embeds 而不是 input_ids 时，它无法猜测 padding token，因此它会执行相同的操作（获取批处理中每行的最后一个值）。
此模型继承自 TFPreTrainedModel。查看超类文档以获取库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参阅 TF 2.0 文档以了解与常规用法和行为相关的所有事项。
transformers 中的 TensorFlow 模型和层接受两种输入格式
- 所有输入都作为关键字参数（如 PyTorch 模型），或
- 所有输入都作为第一个位置参数中的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持，当使用诸如 model.fit() 之类的方法时，事情应该对您“正常工作” - 只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在 Keras 方法（如 fit() 和 predict()）之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用以下三种可能性来收集第一个位置参数中的所有输入张量
- 仅具有
input_ids且没有其他内容的单个张量：model(input_ids) - 具有一个或多个输入张量的可变长度列表，顺序与文档字符串中给出的顺序相同：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 具有一个或多个输入张量的字典，这些张量与文档字符串中给出的输入名称相关联：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，当使用 子类化 创建模型和层时，您无需担心任何这些，因为您可以像对待任何其他 Python 函数一样传递输入！
call
< 源代码 >( input_ids: TFModelInputType | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = None attention_mask: np.ndarray | tf.Tensor | None = None token_type_ids: np.ndarray | tf.Tensor | None = None position_ids: np.ndarray | tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None inputs_embeds: np.ndarray | tf.Tensor | None = None use_cache: Optional[bool] = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length，如果past为None；否则为past[0].shape[-2](输入 past 键值状态的sequence_length)。词汇表中输入序列 tokens 的索引。
如果使用
past，则仅应将未计算 past 的输入 ID 作为input_ids传递。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- past (
List[tf.Tensor]，长度为config.n_layers) — 包含模型计算的预先计算的隐藏状态（注意力块中的键和值）（请参阅下面的past输出）。 可用于加速顺序解码。 已将其 past 提供给此模型的 token IDs 不应作为输入 IDs 传递，因为它们已被计算过。 - attention_mask (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行注意力的掩码。 掩码值在[0, 1]中选择：- 1 表示 tokens 未被掩蔽，
- 0 表示 tokens 被掩蔽。
- token_type_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — Segment token indices to indicate first and second portions of the inputs. Indices are selected in[0, 1]:- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length)，可选) — Position embeddings 中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于置空 self-attention 模块中选定 head 的 Mask。 Mask 值在[0, 1]中选择：- 1 表示 head 不被 mask，
- 0 表示 head 被 mask。
- inputs_embeds (
tf.Tensor或Numpy array，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past键值状态，可用于加速解码（请参阅past）。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor，形状为(batch_size, sequence_length)，可选) — 用于计算交叉熵分类损失的标签。 索引应在[0, ..., config.vocab_size - 1]中。
返回值
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (CTRLConfig) 和输入。
-
loss (
tf.Tensor，形状为(batch_size, )，可选，当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
tf.Tensor，形状为(batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）分数（在 SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（每个层的输出对应一个，外加嵌入的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态，加上初始嵌入输出。
-
attentions (
tuple(tf.Tensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —tf.Tensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
TFCTRLForSequenceClassification 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管前向传递的配方需要在该函数中定义，但应在此之后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCTRLForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("Salesforce/ctrl")
>>> model = TFCTRLForSequenceClassification.from_pretrained("Salesforce/ctrl")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> predicted_class_id = int(tf.math.argmax(logits, axis=-1)[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 = TFCTRLForSequenceClassification.from_pretrained("Salesforce/ctrl", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss