CamemBERT
概述
CamemBERT 模型由 Louis Martin、Benjamin Muller、Pedro Javier Ortiz Suárez、Yoann Dupont、Laurent Romary、Éric Villemonte de la Clergerie、Djamé Seddah 和 Benoît Sagot 在 CamemBERT：一款美味的法国语言模型 中提出。它基于 Facebook 于 2019 年发布的 RoBERTa 模型。它是一个在 138GB 法语文本上训练的模型。
该论文的摘要是这样的：
预训练语言模型现在在自然语言处理中无处不在。尽管它们取得了成功，但大多数可用模型要么是在英语数据上训练的，要么是在多种语言数据的拼接上训练的。这使得此类模型的实际使用——除英语以外的所有语言——都非常有限。为了解决法语的这个问题，我们发布了 CamemBERT，它是双向变换器编码器 (BERT) 的法语版本。我们在多个下游任务中测量了 CamemBERT 与多语言模型相比的性能，即词性标注、依存句法分析、命名实体识别和自然语言推理。CamemBERT 改进了所考虑的大多数任务的最新技术水平。我们发布了 CamemBERT 的预训练模型，希望能促进法语 NLP 的研究和下游应用。
此模型由 ALMAnaCH 团队 (Inria) 贡献。原始代码可以在 此处 找到。
此实现与 RoBERTa 相同。有关使用示例以及有关输入和输出的信息，请参阅 RoBERTa 的文档。
资源
CamembertConfig
类 transformers.CamembertConfig
< 源代码 >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
参数
- vocab_size (
int, 可选, 默认值为 30522) — BERT 模型的词汇量大小。定义在调用 CamembertModel 或 TFCamembertModel 时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认值为 768) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认值为 12) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认值为 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, 可选, 默认值: 3072) — Transformer 编码器中“中间”（通常称为前馈）层的维度。 - hidden_act (
str或Callable, 可选, 默认值:"gelu") — 编码器和池化器中使用的非线性激活函数（函数或字符串）。如果是字符串，则支持"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认值: 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认值: 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认值: 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。 - type_vocab_size (
int, 可选, 默认值: 2) — 调用 CamembertModel 或 TFCamembertModel 时传递的token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认值: 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float，可选，默认为 1e-12) — 层归一化层使用的 epsilon 值。 - position_embedding_type (
str，可选，默认为"absolute") — 位置嵌入的类型。从"absolute"、"relative_key"、"relative_key_query"中选择一个。对于位置嵌入，使用"absolute"。有关"relative_key"的更多信息，请参阅 Self-Attention with Relative Position Representations (Shaw et al.)。有关"relative_key_query"的更多信息，请参阅 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的*方法 4*。 - is_decoder (
bool，可选，默认为False) — 模型是否用作解码器。如果为False，则模型用作编码器。 - use_cache (
bool，可选，默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - classifier_dropout (
float，可选) — 分类头的 dropout 比率。
这是用于存储 CamembertModel 或 TFCamembertModel 的配置的配置类。它用于根据指定的参数实例化 Camembert 模型，定义模型架构。使用默认值实例化配置将产生与 Camembert almanach/camembert-base 架构相似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。请阅读 PretrainedConfig 的文档以了解更多信息。
示例
>>> from transformers import CamembertConfig, CamembertModel
>>> # Initializing a Camembert almanach/camembert-base style configuration
>>> configuration = CamembertConfig()
>>> # Initializing a model (with random weights) from the almanach/camembert-base style configuration
>>> model = CamembertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configCamembertTokenizer
类 transformers.CamembertTokenizer
< 源代码 >( vocab_file bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' additional_special_tokens = ['<s>NOTUSED', '</s>NOTUSED', '<unk>NOTUSED'] sp_model_kwargs: Optional = None **kwargs )
参数
- vocab_file (
str) — 包含实例化分词器所需词汇的 SentencePiece 文件（通常扩展名为 .spm）。 - bos_token (
str, 可选, 默认值为"<s>") — 预训练期间使用的序列开始标记。可以用作序列分类标记。使用特殊标记构建序列时，这不是用于序列开头的标记。使用的标记是
cls_token。 - eos_token (
str, 可选, 默认值为"</s>") — 序列结束标记。使用特殊标记构建序列时，这不是用于序列结尾的标记。使用的标记是
sep_token。 - sep_token (
str, 可选, 默认值为"</s>") — 分隔标记，用于从多个序列构建序列时使用，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认值为"<s>") — 用于进行序列分类（对整个序列进行分类，而不是对每个标记进行分类）的分类标记。它是使用特殊标记构建的序列的第一个标记。 - unk_token (
str，可选，默认为"<unk>") — 未知词元。不在词汇表中的词元无法转换为 ID，而是设置为该词元。 - pad_token (
str，可选，默认为"<pad>") — 用于填充的词元，例如在对不同长度的序列进行批处理时。 - mask_token (
str，可选，默认为"<mask>") — 用于屏蔽值的词元。这是使用屏蔽语言建模训练此模型时使用的词元。这是模型将尝试预测的词元。 - additional_special_tokens (
List[str]，可选，默认为['<s>NOTUSED', '</s>NOTUSED', '<unk>NOTUSED']) — 分词器使用的其他特殊词元。 - sp_model_kwargs (
dict，可选) — 将传递给SentencePieceProcessor.__init__()方法。SentencePiece 的 Python 包装器 可用于设置：-
enable_sampling：启用子词正则化。 -
nbest_size：unigram 的采样参数。对 BPE-Dropout 无效。nbest_size = {0,1}：不执行采样。nbest_size > 1：从 nbest_size 个结果中采样。nbest_size < 0：假设 nbest_size 为无穷大，并使用前向过滤和后向采样算法从所有假设（格）中采样。
-
alpha：unigram 采样的平滑参数，以及 BPE-dropout 的合并操作的丢弃概率。
-
- sp_model (
SentencePieceProcessor) — 用于每次转换（字符串、词元和 ID）的 SentencePiece 处理器。
改编自 RobertaTokenizer 和 XLNetTokenizer。构建一个 CamemBERT 分词器。基于 SentencePiece。
此分词器继承自 PreTrainedTokenizer，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接序列或序列对并添加特殊标记来构建用于序列分类任务的模型输入。CamemBERT 序列采用以下格式
- 单个序列：
<s> X </s> - 序列对：
<s> A </s></s> B </s>
get_special_tokens_mask
< 来源 >( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊标记的标记列表中检索序列 ID。当使用分词器 prepare_for_model 方法添加特殊标记时，将调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
根据传入的两个序列创建一个掩码，用于序列对分类任务。 CamemBERT 与 RoBERTa 一样，不使用标记类型 ID，因此返回一个零列表。
CamembertTokenizerFast
class transformers.CamembertTokenizerFast
< source >( vocab_file = None tokenizer_file = None bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' additional_special_tokens = ['<s>NOTUSED', '</s>NOTUSED', '<unk>NOTUSED'] **kwargs )
参数
- vocab_file (
str) — SentencePiece 文件（通常扩展名为 .spm）包含实例化分词器所需的词汇表。 - bos_token (
str, 可选, 默认值"<s>") — 预训练期间使用的序列开始标记。可以用作序列分类标记。使用特殊标记构建序列时，这不是用于序列开头的标记。使用的标记是
cls_token。 - eos_token (
str, 可选, 默认值"</s>") — 序列结束标记。使用特殊标记构建序列时，这不是用于序列结尾的标记。使用的标记是
sep_token。 - sep_token (
str, 可选, 默认值"</s>") — 分隔标记，用于从多个序列构建序列时使用，例如用于序列分类的两个序列或用于问答的文本和问题。它也用作使用特殊标记构建的序列的最后一个标记。 - cls_token (
str, 可选, 默认值"<s>") — 分类标记，在进行序列分类（对整个序列进行分类而不是对每个标记进行分类）时使用。它是使用特殊标记构建的序列的第一个标记。 - unk_token (
str，可选，默认为"<unk>") — 未知词元。不在词汇表中的词元无法转换为 ID，并将被设置为该词元。 - pad_token (
str，可选，默认为"<pad>") — 用于填充的词元，例如在对不同长度的序列进行批处理时。 - mask_token (
str，可选，默认为"<mask>") — 用于屏蔽值的词元。这是使用遮蔽语言建模训练此模型时使用的词元。这是模型将尝试预测的词元。 - additional_special_tokens (
List[str]，可选，默认为["<s>NOTUSED", "</s>NOTUSED"]) — 分词器使用的其他特殊词元。
构造一个“快速”CamemBERT 分词器（由 HuggingFace 的 *tokenizers* 库支持）。改编自 RobertaTokenizer 和 XLNetTokenizer。基于 字节对编码。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。
build_inputs_with_special_tokens
< source >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
通过连接序列或序列对并添加特殊标记来构建用于序列分类任务的模型输入。CamemBERT 序列采用以下格式
- 单个序列：
<s> X </s> - 序列对：
<s> A </s></s> B </s>
create_token_type_ids_from_sequences
< 源代码 >( token_ids_0: List token_ids_1: Optional = None ) → List[int]
根据传入的两个序列创建一个掩码，用于序列对分类任务。 CamemBERT 与 RoBERTa 一样，不使用标记类型 ID，因此返回一个零列表。
CamembertModel
类 transformers.CamembertModel
< 源代码 >( config add_pooling_layer = True )
参数
- config (CamembertConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型相关的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
基本的 CamemBERT 模型转换器，输出原始隐藏状态，顶部没有任何特定头部。
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
该模型可以充当编码器（仅具有自注意力）以及解码器，在这种情况下，在自注意力层之间添加一层交叉注意力层，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 *Attention is all you need*_ 中描述的架构。
为了充当解码器，需要使用设置为 True 的配置的 is_decoder 参数来初始化模型。 为了在 Seq2Seq 模型中使用，需要使用 is_decoder 参数和 add_cross_attention 都设置为 True 来初始化模型； 然后，将 encoder_hidden_states 作为输入传递给正向传递。
.. _*Attention is all you need*： https://arxiv.org/abs/1706.03762
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None past_key_values: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详细信息。
- 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* 标记。
- position_ids (
torch.LongTensor类型为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[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索引转换为关联向量，而不是模型的内部嵌入查找矩阵，那么这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor类型为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出处的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)或(batch_size, sequence_length, target_length), 可选) — 掩码，用于避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器，则在交叉注意力中使用此掩码。在[0, 1]中选择的掩码值：- 1 表示 未被掩码 的标记，
- 0 表示 已被掩码 的标记。
- past_key_values (长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用
past_key_values，则用户可以选择只输入形状为(batch_size, 1)的最后一个decoder_input_ids（那些没有将其过去的键值状态提供给此模型的 ID），而不是输入形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并且可以使用这些状态来加速解码（请参阅past_key_values）。
返回值
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置（CamembertConfig）和输入而定的各种元素。
-
last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层输出处的隐藏状态序列。 -
pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 序列的第一个标记（分类标记）在经过用于辅助预训练任务的层进一步处理后的最后一层隐藏状态。例如，对于 BERT 系列模型，这将返回经过线性层和 tanh 激活函数处理后的分类标记。线性层权重是在预训练期间从下一个句子预测（分类）目标中训练出来的。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True和config.add_cross_attention=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
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输入）来加速顺序解码。
CamembertModel 的 forward 方法会覆盖 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CamembertModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertModel.from_pretrained("almanach/camembert-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateCamembertForCausalLM
类 transformers.CamembertForCausalLM
< source >( config )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部带有 language modeling 头，用于 CLM 微调。
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None past_key_values: Tuple = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 标记。
- position_ids (
torch.LongTensor类型，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[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索引转换为关联向量，而不是使用模型内部的嵌入查找矩阵，则此参数非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - encoder_hidden_states (
torch.FloatTensor类型为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
torch.FloatTensor类型为(batch_size, sequence_length), 可选) — 掩码，用于避免对编码器输入的填充标记索引执行注意力。如果模型配置为解码器，则在交叉注意力中使用此掩码。在[0, 1]中选择的掩码值：- 1 表示**未被掩码**的标记，
- 0 表示**已被掩码**的标记。
- labels (
torch.LongTensor类型为(batch_size, sequence_length), 可选) — 用于计算从左到右的语言建模损失（下一个单词预测）的标签。索引应该在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。 - past_key_values (
tuple(tuple(torch.FloatTensor))长度为config.n_layers，每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)的张量) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用
past_key_values，用户可以选择只输入最后的decoder_input_ids（那些没有将过去的键值状态提供给此模型的），其形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False），包含根据配置 (CamembertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor类型为(1,), 可选，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor， 形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。交叉注意力 SoftMax 之后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
-
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的torch.FloatTensor元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态（如果模型在编码器-解码器设置中使用）。仅在config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可以使用这些状态（请参阅
past_key_values输入）来加速序列解码。
CamembertForCausalLM 前向方法，重写了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CamembertForCausalLM, AutoConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> config = AutoConfig.from_pretrained("almanach/camembert-base")
>>> config.is_decoder = True
>>> model = CamembertForCausalLM.from_pretrained("almanach/camembert-base", config=config)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsCamembertForMaskedLM
类 transformers.CamembertForMaskedLM
< 源代码 >( config )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
顶部带有 language modeling 头的 CamemBERT 模型。
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 更多详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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_ 标记。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)， 可选) — 位置嵌入中每个输入序列标记的位置索引。 在[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索引转换为关联向量，这将非常有用。 - **output_attentions** (``bool``, *可选*) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 `attentions`。
- **output_hidden_states** (``bool``, *可选*) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 `hidden_states`。
- **return_dict** (``bool``, *可选*) — 是否返回 ModelOutput 而不是普通的元组。
- **labels** (``torch.LongTensor`` ，形状为 ``(batch_size, sequence_length)``, *可选*) — 用于计算掩码语言建模损失的标签。索引应该在 ``[-100, 0, ..., config.vocab_size]`` 中（参见 `input_ids` 文档字符串） 索引设置为 ``-100`` 的标记将被忽略（掩码），损失仅针对标签在 ``[0, ..., config.vocab_size]`` 中的标记计算。
- **kwargs** (``Dict[str, any]``, *可选*, 默认为 ``{}``) — 用于隐藏已弃用的旧参数。
返回值
transformers.modeling_outputs.MaskedLMOutput 或 ``tuple(torch.FloatTensor)``
一个 transformers.modeling_outputs.MaskedLMOutput 或一个 ``torch.FloatTensor`` 的元组（如果传递了 ``return_dict=False`` 或 ``config.return_dict=False``），其中包含根据配置 (CamembertConfig) 和输入而定的各种元素。
-
**loss** (``torch.FloatTensor`` ，形状为 ``(1,)``, *可选*, 当提供 `labels` 时返回) — 掩码语言建模 (MLM) 损失。
-
logits (
torch.FloatTensor， 形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
CamembertForMaskedLM forward 方法，覆盖了 ``__call__`` 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CamembertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertForMaskedLM.from_pretrained("almanach/camembert-base")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
' Paris'
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
0.1CamembertForSequenceClassification
类 transformers.CamembertForSequenceClassification
< 源代码 >( config )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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 标记。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[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索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor， 形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[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），其中包含根据配置（CamembertConfig）和输入的不同元素。
-
loss (
torch.FloatTensor，形状为(1,)，可选，在提供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时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
CamembertForSequenceClassification 的前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, CamembertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = CamembertForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
'optimism'
>>> # 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 = CamembertForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.08多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, CamembertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = CamembertForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # 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 = CamembertForSequenceClassification.from_pretrained(
... "cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossCamembertForMultipleChoice
类 transformers.CamembertForMultipleChoice
< 源代码 >( config )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部有一个多项选择分类头（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< 源代码 >( input_ids: Optional = None token_type_ids: Optional = None attention_mask: Optional = None labels: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor类型为(batch_size, num_choices, sequence_length), 可选) — 用于避免在填充标记索引上执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示对应标记未被遮蔽，
- 0 表示对应标记已被遮蔽。
- token_type_ids (
torch.LongTensor类型为(batch_size, num_choices, sequence_length), 可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引值在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor类型为(batch_size, num_choices, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在[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, num_choices, sequence_length, hidden_size), 可选) — 可选择地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想更好地控制如何将input_ids索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput， 而不是简单的元组。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算多项选择分类损失的标签。索引应该在[0, ..., num_choices-1]中，其中num_choices是输入张量的第二维的大小。(参见上面的input_ids)
返回值
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或 config.return_dict=False)，包含根据配置 (CamembertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor，形状为 (1,)，可选，当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor，形状为(batch_size, num_choices)) — num_choices 是输入张量的第二维。(参见上面的 input_ids)。分类分数 (SoftMax 之前)。
-
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
CamembertForMultipleChoice 的前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CamembertForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertForMultipleChoice.from_pretrained("almanach/camembert-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsCamembertForTokenClassification
类 transformers.CamembertForTokenClassification
< 源代码 >( config )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部有一个标记分类头 (隐藏状态输出顶部的一个线性层)，例如用于命名实体识别 (NER) 任务。
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解更多详细信息。
- 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_ 标记。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)， 可选) — 位置嵌入中每个输入序列标记的位置索引。 在[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索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，则此参数非常有用。 - **output_attentions** (
bool, *可选*) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - **output_hidden_states** (
bool, *可选*) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - **return_dict** (
bool, *可选*) — 是否返回 ModelOutput 而不是普通元组。 - **labels** (
torch.LongTensor, 形状为(batch_size, sequence_length), *可选*) — 用于计算词分类损失的标签。索引应该在[0, ..., config.num_labels - 1]中。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），根据配置 (CamembertConfig) 和输入包含各种元素。
-
**loss** (
torch.FloatTensor, 形状为(1,), *可选*, 当提供labels时返回) — 分类损失。 -
**logits** (
torch.FloatTensor, 形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
CamembertForTokenClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CamembertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("Jean-Baptiste/roberta-large-ner-english")
>>> model = CamembertForTokenClassification.from_pretrained("Jean-Baptiste/roberta-large-ner-english")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
['O', 'ORG', 'ORG', 'O', 'O', 'O', 'O', 'O', 'LOC', 'O', 'LOC', 'LOC']
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
0.01CamembertForQuestionAnswering
class transformers.CamembertForQuestionAnswering
< source >( config )
参数
- config (CamembertConfig) — 包含模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部有一个用于提取式问答任务（如 SQuAD）的跨度分类头（在隐藏状态输出之上有一个线性层，用于计算 span start logits 和 span end logits
此模型继承自 PreTrainedModel。 查看超类文档以了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般使用和行为相关的所有事项。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 更多细节请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。 在[0, 1]中选择的掩码值：- 未被掩码 的标记为 1，
- 被掩码 的标记为 0。
- token_type_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 _句子 A_ 标记，
- 1 对应于 _句子 B_ 标记。
- position_ids (
torch.LongTensor， 形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[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索引转换为关联向量（而不是模型的内部嵌入查找矩阵），则此参数非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - start_positions (
torch.LongTensor， 形状为(batch_size,)，可选) — 用于计算标记分类损失的标签化跨度开始位置（索引）的标签。 位置被限制在序列的长度（sequence_length）。 序列之外的位置不参与损失的计算。 - end_positions (
torch.LongTensor， 形状为(batch_size,)，可选) — 用于计算标记分类损失的标签化跨度结束位置（索引）的标签。 位置被限制在序列的长度（sequence_length）。 序列之外的位置不参与损失的计算。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），包含根据配置 (CamembertConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor， 形状为(1,)，可选，在提供labels时返回) — 总跨度提取损失是开始和结束位置的交叉熵之和。 -
start_logits (
torch.FloatTensor， 形状为(batch_size, sequence_length)) — 跨度开始分数（SoftMax 之前）。 -
end_logits (
torch.FloatTensor， 形状为(batch_size, sequence_length)) — 跨度结束分数（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型有嵌入层，则一个用于嵌入的输出，另外一个用于每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，在传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
CamembertForQuestionAnswering forward 方法，重写 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CamembertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("deepset/roberta-base-squad2")
>>> model = CamembertForQuestionAnswering.from_pretrained("deepset/roberta-base-squad2")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
' puppet'
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
0.86TFCamembertModel
类 transformers.TFCamembertModel
< 源代码 >( config *inputs **kwargs )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
基本的 CamemBERT 模型转换器，输出原始隐藏状态，顶部没有任何特定头部。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = 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 encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = 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.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 未被掩码的标记为 1，
- 被掩码的标记为 0。
- token_type_ids (
Numpy array或tf.Tensor， 形状为(batch_size, sequence_length)， 可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 *句子 A* 标记，
- 1 对应于 *句子 B* 标记。
- position_ids (
Numpy array或tf.Tensor， 形状为(batch_size, sequence_length)， 可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor， 形状为(num_heads,)或(num_layers, num_heads)， 可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部 **未被掩码**，
- 0 表示头部 **已被掩码**。
- inputs_embeds (
tf.Tensor， 形状为(batch_size, sequence_length, hidden_size)， 可选) — 可选择地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool， 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool， 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。此参数可在积极模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认值:False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间的行为不同）。 - encoder_hidden_states (
tf.Tensor类型为(batch_size, sequence_length, hidden_size), 可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
tf.Tensor类型为(batch_size, sequence_length), 可选) — 掩码，用于避免对编码器输入的填充标记索引执行注意力。如果模型被配置为解码器，则在交叉注意力中使用此掩码。在[0, 1]中选择的掩码值：- 1 表示 未被掩码 的标记,
- 0 表示 被掩码 的标记。
- past_key_values (
Tuple[Tuple[tf.Tensor]]长度为config.n_layers) — 包含注意力块的预计算键和值隐藏状态。可用于加速解码。如果使用past_key_values，则用户可以选择只输入形状为(batch_size, 1)的最后decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。 - use_cache (
bool, 可选, 默认值:True) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。在训练期间设置为False，在生成期间设置为True
返回值
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndCrossAttentions 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置 (CamembertConfig) 和输入而定的各种元素。
-
last_hidden_state (
tf.Tensor类型为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。 -
pooler_output (
tf.Tensor类型为(batch_size, hidden_size)) — 序列的第一个标记（分类标记）的最后一层隐藏状态，由线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间根据下一个句子预测（分类）目标进行训练。此输出通常并非输入语义内容的良好摘要，对整个输入序列的隐藏状态进行平均或池化通常是更好的选择。
-
past_key_values （
List[tf.Tensor]，可选，在传递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)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
TFCamembertModel 前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertModel
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = TFCamembertModel.from_pretrained("almanach/camembert-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> last_hidden_states = outputs.last_hidden_stateTFCamembertForCausalLM
类 transformers.TFCamembertForCausalLM
< 源代码 >( config: CamembertConfig *inputs **kwargs )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
CamemBERT 模型，顶部带有 language modeling 头，用于 CLM 微调。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = 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 encoder_hidden_states: np.ndarray | tf.Tensor | None = None encoder_attention_mask: np.ndarray | tf.Tensor | None = None past_key_values: Optional[Tuple[Tuple[Union[np.ndarray, tf.Tensor]]]] = 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.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的标记，
- 0 表示 已被掩码 的标记。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。此参数只能在渴望模式下使用，在图模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。此参数只能在渴望模式下使用，在图模式下，将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在渴望模式下使用，在图模式下，该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间的行为有所不同）。 - encoder_hidden_states (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力中使用。 - encoder_attention_mask (
tf.Tensor, 形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对编码器输入的填充标记索引执行注意力。如果模型被配置为解码器，则在交叉注意力中使用此掩码。掩码值在[0, 1]中选择：- 未被掩码 的标记为 1，
- 被掩码 的标记为 0。
- past_key_values (长度为
config.n_layers的Tuple[Tuple[tf.Tensor]]) — 包含注意力块的预先计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values，则用户可以选择只输入decoder_input_ids的最后一个（那些没有将其过去的键值状态提供给该模型的）形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - use_cache (
bool, 可选, 默认为True) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。在训练期间设置为False，在生成期间设置为True - labels (
tf.Tensor或np.ndarray，形状为(batch_size, sequence_length)，可选) — 用于计算交叉熵分类损失的标签。索引应在[0, ..., config.vocab_size - 1]中。
返回值
transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFCausalLMOutputWithCrossAttentions 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (CamembertConfig) 和输入而定的各种元素。
-
loss (形状为
(n,)的tf.Tensor，可选，其中 n 是非掩码标签的数量，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的tf.Tensor) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states （
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均值。
-
past_key_values （
List[tf.Tensor]，可选，在传递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输入）来加速序列解码。
TFCamembertForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertForCausalLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = TFCamembertForCausalLM.from_pretrained("almanach/camembert-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="tf")
>>> outputs = model(inputs)
>>> logits = outputs.logitsTFCamembertForMaskedLM
类 transformers.TFCamembertForMaskedLM
< 源代码 >( config *inputs **kwargs )
参数
- config (CamembertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
顶部带有 language modeling 头的 CamemBERT 模型。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = 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 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.TFMaskedLMOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]中选择的掩码值：- 未被掩码的标记为 1，
- 被掩码的标记为 0。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。在[0, 1]中选择的索引：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您想要更好地控制如何将input_ids索引转换为关联向量，而不是模型的内部嵌入查找矩阵，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在积极模式下使用，在图形模式下将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在积极模式下使用，在图形模式下将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在积极模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，例如 dropout 模块，在训练和评估之间的行为不同）。 - labels (形状为
(batch_size, sequence_length)的tf.Tensor，可选) — 用于计算掩码语言模型损失的标签。索引应该在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算
返回值
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFMaskedLMOutput 或 tf.Tensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False）包含根据配置（CamembertConfig）和输入的不同元素。
-
loss (形状为
(n,)的tf.Tensor，可选，其中 n 是非掩码标签的数量，在提供labels时返回) — 掩码语言建模 (MLM) 损失。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的tf.Tensor) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
hidden_states （
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFCamembertForMaskedLM 前向方法，覆盖 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertForMaskedLM
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = TFCamembertForMaskedLM.from_pretrained("almanach/camembert-base")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = tf.where((inputs.input_ids == tokenizer.mask_token_id)[0])
>>> selected_logits = tf.gather_nd(logits[0], indices=mask_token_index)
>>> predicted_token_id = tf.math.argmax(selected_logits, axis=-1)
>>> tokenizer.decode(predicted_token_id)
' Paris'TFCamembertForSequenceClassification
class transformers.TFCamembertForSequenceClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型转换器，顶部带有序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = 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 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, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 了解更多详情。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示 未被掩码 的标记，
- 0 表示 已被掩码 的标记。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的hidden_states。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在渴望模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间的行为不同）。 - labels (
tf.Tensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方误差）；如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回值
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一个由 tf.Tensor 组成的元组（如果传递了 return_dict=False 或 config.return_dict=False），其中包含根据配置 (CamembertConfig) 和输入的不同元素。
-
loss (形状为
(batch_size, )的tf.Tensor，可选，在提供labels时返回) — 分类（如果 config.num_labels==1 则为回归）损失。 -
logits (形状为
(batch_size, config.num_labels)的tf.Tensor) — 分类（如果 config.num_labels==1 则为回归）分数（SoftMax 之前）。 -
hidden_states （
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFCamembertForSequenceClassification 前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertForSequenceClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> model = TFCamembertForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion")
>>> 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])
>>> model.config.id2label[predicted_class_id]
'optimism'>>> # 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 = TFCamembertForSequenceClassification.from_pretrained("cardiffnlp/twitter-roberta-base-emotion", num_labels=num_labels)
>>> labels = tf.constant(1)
>>> loss = model(**inputs, labels=labels).loss
>>> round(float(loss), 2)
0.08TFCamembertForMultipleChoice
类 transformers.TFCamembertForMultipleChoice
< 源代码 >( config *inputs **kwargs )
参数
- config (CamembertConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只会加载配置。 查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部有一个多项选择分类头（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< 源代码 >( input_ids: TFModelInputType | None = 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 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.TFMultipleChoiceModelOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。详见 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。掩码值在[0, 1]中选择：- 1 表示标记**未被掩码**，
- 0 表示标记**已被掩码**。
- token_type_ids (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, num_choices, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
tf.Tensor，形状为(batch_size, num_choices, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，则此选项很有用。 - **output_attentions** (``bool``, *可选*) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的 ``attentions``。此参数只能在积极模式下使用，在图形模式下，将使用配置中的值。
- **output_hidden_states** (``bool``, *可选*) — 是否返回所有层的隐藏状态。有关详细信息，请参阅返回张量下的 ``hidden_states``。此参数只能在积极模式下使用，在图形模式下，将使用配置中的值。
- **return_dict** (``bool``, *可选*) — 是否返回 ModelOutput 而不是普通元组。此参数可以在积极模式下使用，在图形模式下，该值将始终设置为 True。
- **training** (``bool``, *可选*, 默认为 ``False``) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间的行为不同）。
- **labels** (``tf.Tensor`` ，形状为 ``(batch_size,)``, *可选*) — 用于计算多项选择分类损失的标签。索引应该在 ``[0, ..., num_choices]`` 中，其中 ``num_choices`` 是输入张量第二维的大小。（参见上面的 ``input_ids``）
返回值
transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或 ``tuple(tf.Tensor)``
一个 transformers.modeling_tf_outputs.TFMultipleChoiceModelOutput 或一个 ``tf.Tensor`` 元组（如果传递了 ``return_dict=False`` 或 ``config.return_dict=False``），包含根据配置 (CamembertConfig) 和输入的不同元素。
-
**loss** (``tf.Tensor`` ，形状为 *(batch_size, )*， *可选*，在提供 ``labels`` 时返回) — 分类损失。
-
**logits** (``tf.Tensor`` ，形状为 ``(batch_size, num_choices)``) — *num_choices* 是输入张量的第二维。（参见上面的 *input_ids*）。
分类分数 (SoftMax 之前)。
-
hidden_states （
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFCamembertForMultipleChoice 正向方法，覆盖 ``__call__`` 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertForMultipleChoice
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = TFCamembertForMultipleChoice.from_pretrained("almanach/camembert-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="tf", padding=True)
>>> inputs = {k: tf.expand_dims(v, 0) for k, v in encoding.items()}
>>> outputs = model(inputs) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> logits = outputs.logitsTFCamembertForTokenClassification
类 transformers.TFCamembertForTokenClassification
< source >( config *inputs **kwargs )
参数
- config (CamembertConfig) — 包含模型所有参数的模型配置类。 使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。 请查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部有一个标记分类头 (隐藏状态输出顶部的一个线性层)，例如用于命名实体识别 (NER) 任务。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = 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 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.TFTokenClassifierOutput 或 tuple(tf.Tensor)
参数
- input_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 更多详细信息，请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode()。
- attention_mask (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 掩码，用于避免对填充标记索引执行注意力。 在[0, 1]中选择的掩码值：- 1 表示**未掩码**的标记，
- 0 表示**已掩码**的标记。
- token_type_ids (
Numpy array或tf.Tensor， 形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 *句子 A* 标记，
- 1 对应于 *句子 B* 标记。
- position_ids (
Numpy array或tf.Tensor， 形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor， 形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩码**，
- 0 表示头部**已被掩码**。
- inputs_embeds (
tf.Tensor， 形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更能控制如何将input_ids索引转换为关联向量，则此选项很有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在积极模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool, 可选, 默认值False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估之间具有不同的行为）。 - labels (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]中。
返回值
transformers.modeling_tf_outputs.TFTokenClassifierOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFTokenClassifierOutput 或一个 tf.Tensor 元组（如果传递了 return_dict=False 或 config.return_dict=False）包含取决于配置（CamembertConfig）和输入的各种元素。
-
loss (
tf.Tensor形状为(n,), 可选，其中 n 是未屏蔽标签的数量，在提供labels时返回) — 分类损失。 -
logits (
tf.Tensor形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。 -
hidden_states （
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFCamembertForTokenClassification 正向方法，覆盖 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertForTokenClassification
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-large-ner-english")
>>> model = TFCamembertForTokenClassification.from_pretrained("ydshieh/roberta-large-ner-english")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="tf"
... )
>>> logits = model(**inputs).logits
>>> predicted_token_class_ids = tf.math.argmax(logits, axis=-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t] for t in predicted_token_class_ids[0].numpy().tolist()]
>>> predicted_tokens_classes
['O', 'ORG', 'ORG', 'O', 'O', 'O', 'O', 'O', 'LOC', 'O', 'LOC', 'LOC']TFCamembertForQuestionAnswering
类 transformers.TFCamembertForQuestionAnswering
< source >( config *inputs **kwargs )
参数
- config (CamembertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
CamemBERT 模型，顶部带有一个跨度分类头，用于提取式问答任务，如 SQuAD（隐藏状态输出顶部的线性层，用于计算“跨度开始 logits”和“跨度结束 logits”）。
该模型继承自 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的单个 Tensor，没有其他内容：model(input_ids) - 一个变长列表，其中包含一个或多个输入 Tensor，按照文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 一个字典，其中包含一个或多个与文档字符串中给出的输入名称相关联的输入 Tensor：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用子类化创建模型和层时，您无需担心任何这些问题，因为您可以像传递给任何其他 Python 函数一样传递输入！
调用
< source >( input_ids: TFModelInputType | None = 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 output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None start_positions: np.ndarray | tf.Tensor | None = None end_positions: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput or tuple(tf.Tensor)
参数
- input_ids （形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor） — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。 请参阅 PreTrainedTokenizer.call() 和 PreTrainedTokenizer.encode() 了解更多详情。
- attention_mask （形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor，可选） — 掩码以避免对填充标记索引执行注意力。 在[0, 1]中选择的掩码值：- 未屏蔽标记为 1，
- 屏蔽标记为 0。
- token_type_ids （形状为
(batch_size, sequence_length)的Numpy array或tf.Tensor，可选） — 段标记索引，用于指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于*句子 A* 标记，
- 1 对应于*句子 B* 标记。
- position_ids (
Numpy array或tf.Tensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - head_mask (
Numpy array或tf.Tensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于将自注意力模块的选定头部置零的掩码。掩码值在[0, 1]中选择：- 1 表示头部**未被掩盖**，
- 0 表示头部**已被掩盖**。
- inputs_embeds (
tf.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 或者，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望更好地控制如何将input_ids索引转换为关联向量，而不是使用模型的内部嵌入查找矩阵，则此选项非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。此参数只能在渴望模式下使用，在图形模式下，将使用配置中的值。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在渴望模式下使用，在图形模式下，该值将始终设置为 True。 - training (
bool，可选，默认为False) — 是否在训练模式下使用模型（某些模块，如 dropout 模块，在训练和评估期间的行为不同）。 - start_positions (形状为
(batch_size,)的tf.Tensor，可选) — 用于计算标记分类损失的标记跨度的开始位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列外的位置不考虑用于计算损失。 - end_positions (形状为
(batch_size,)的tf.Tensor，可选) — 用于计算标记分类损失的标记跨度的结束位置（索引）的标签。位置被限制在序列的长度（sequence_length）内。序列外的位置不考虑用于计算损失。
返回值
transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFQuestionAnsweringModelOutput 或一个 tf.Tensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (CamembertConfig) 和输入而定的各种元素。
-
loss (形状为
(batch_size, )的tf.Tensor，可选，当提供start_positions和end_positions时返回) — 总跨度提取损失是起始位置和结束位置的交叉熵之和。 -
start_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度开始分数（SoftMax 之前）。 -
end_logits (形状为
(batch_size, sequence_length)的tf.Tensor) — 跨度结束分数（SoftMax 之前）。 -
hidden_states （
tuple(tf.Tensor)，可选，在传递output_hidden_states=True或config.output_hidden_states=True时返回）—tf.Tensor元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态以及初始嵌入输出。
-
attentions （
tuple(tf.Tensor)，可选，在传递output_attentions=True或config.output_attentions=True时返回）—tf.Tensor元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
TFCamembertForQuestionAnswering 前向方法，覆盖 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的方法，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者则会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, TFCamembertForQuestionAnswering
>>> import tensorflow as tf
>>> tokenizer = AutoTokenizer.from_pretrained("ydshieh/roberta-base-squad2")
>>> model = TFCamembertForQuestionAnswering.from_pretrained("ydshieh/roberta-base-squad2")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="tf")
>>> outputs = model(**inputs)
>>> answer_start_index = int(tf.math.argmax(outputs.start_logits, axis=-1)[0])
>>> answer_end_index = int(tf.math.argmax(outputs.end_logits, axis=-1)[0])
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens)
' puppet'