Transformers 文档
CamemBERT
并获得增强的文档体验
开始使用
该模型于 2019-11-10 发布在 HF 论文中，并于 2020-11-16 贡献给 Hugging Face Transformers。
CamemBERT
CamemBERT 是一个基于 RoBERTa 的语言模型，但专门针对来自 OSCAR 数据集的法语文本进行了训练，这使其在处理法语任务时更加有效。
CamemBERT 的独特之处在于，它是从海量、高质量的法语数据集进行学习的，而不是混合多种语言。这有助于它比许多多语言模型更深入地理解法语。
CamemBERT 的常见应用包括掩码语言建模（填充掩码预测）、文本分类（情感分析）、标记分类（实体识别）和句子对分类（蕴含任务）。
您可以在 ALMAnaCH 组织下找到所有原始的 CamemBERT 检查点。
该模型由 ALMAnaCH (Inria) 团队贡献。
点击右侧边栏中的 CamemBERT 模型，查看更多关于如何将 CamemBERT 应用于不同 NLP 任务的示例。
下面的示例演示了如何使用 Pipeline、AutoModel 以及从命令行预测 <mask> 标记。
from transformers import pipeline
pipeline = pipeline("fill-mask", model="camembert-base", device=0)
pipeline("Le camembert est un délicieux fromage <mask>.")量化通过以较低精度表示权重来减轻大型模型的内存负担。请参阅量化概述了解可用选项。
下面的示例使用 bitsandbytes 量化将权重降至 8 位。
import torch
from transformers import AutoModelForMaskedLM, AutoTokenizer, BitsAndBytesConfig
quant_config = BitsAndBytesConfig(load_in_8bit=True)
model = AutoModelForMaskedLM.from_pretrained(
"almanach/camembert-large",
quantization_config=quant_config,
device_map="auto"
)
tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-large")
inputs = tokenizer("Le camembert est un délicieux fromage <mask>.", return_tensors="pt").to(model.device)
with torch.no_grad():
outputs = model(**inputs)
predictions = outputs.logits
masked_index = torch.where(inputs["input_ids"] == tokenizer.mask_token_id)[1]
predicted_token_id = predictions[0, masked_index].argmax(dim=-1)
predicted_token = tokenizer.decode(predicted_token_id)
print(f"The predicted token is: {predicted_token}")CamembertConfig
class transformers.CamembertConfig
< 代码源 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 30522 hidden_size: int = 768 num_hidden_layers: int = 12 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: str = 'gelu' hidden_dropout_prob: float | int = 0.1 attention_probs_dropout_prob: float | int = 0.1 max_position_embeddings: int = 512 type_vocab_size: int = 2 initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 pad_token_id: int | None = 1 bos_token_id: int | None = 0 eos_token_id: int | list[int] | None = 2 use_cache: bool = True classifier_dropout: float | int | None = None is_decoder: bool = False add_cross_attention: bool = False tie_word_embeddings: bool = True )
参数
- vocab_size (
int, 可选, 默认为30522) — 模型的词汇表大小。定义了可以用input_ids表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为768) — 隐藏表示的维度。 - num_hidden_layers (
int, 可选, 默认为12) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认为12) — Transformer 解码器中每个注意力层的注意力头数。 - intermediate_size (
int, 可选, 默认为3072) — MLP 表示的维度。 - hidden_act (
str, 可选, 默认为gelu) — 解码器中的非线性激活函数（函数或字符串）。例如"gelu"、"relu"、"silu"等。 - hidden_dropout_prob (
Union[float, int], 可选, 默认为0.1) — 嵌入层、编码器和池化层中所有全连接层的随机丢弃概率（dropout probability）。 - attention_probs_dropout_prob (
Union[float, int], 可选, 默认为0.1) — 注意力概率的随机丢弃比率。 - max_position_embeddings (
int, 可选, 默认为512) — 此模型可能使用的最大序列长度。 - type_vocab_size (
int, 可选, 默认为2) —token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为1e-12) — 层归一化层使用的 epsilon 值。 - pad_token_id (
int, 可选, 默认为1) — 词汇表中用于填充（padding）的标记 ID。 - bos_token_id (
int, 可选, 默认为0) — 词汇表中用于序列开始（beginning-of-stream）的标记 ID。 - eos_token_id (
Union[int, list[int]], 可选, 默认为2) — 词汇表中用于序列结束（end-of-stream）的标记 ID。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是仅解码器的生成模型时有效。 - classifier_dropout (
Union[float, int], 可选) — 分类器的随机丢弃比率。 - is_decoder (
bool, 可选, 默认为False) — 模型是否用作解码器。如果为False，则模型用作编码器。 - add_cross_attention (
bool, 可选, 默认为False) — 是否应向模型添加交叉注意力层。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。
这是用于存储 CamembertModel 配置的配置类。它用于根据指定的参数实例化 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
class transformers.CamembertTokenizer
< 代码源 >( bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' additional_special_tokens = None add_prefix_space = True vocab_file = None vocab: str | dict | list | None = None **kwargs )
参数
- 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>") — 用于遮盖值的标记。这是使用掩码语言建模（masked language modeling）训练此模型时使用的标记。这是模型将尝试预测的标记。 - additional_special_tokens (
list[str], 可选, 默认为["<s>NOTUSED", "</s>NOTUSED"]) — 分词器使用的额外特殊标记。 - add_prefix_space (
bool, 可选, 默认为True) — 是否在输入中添加初始空格。这允许将开头的单词视为与其他单词一样。 - vocab_file (
str, 可选) — 包含实例化分词器所需词汇表的 SentencePiece 文件（通常具有 .spm 扩展名）。 - vocab (
str,dict或list, 可选) — 自定义词汇表字典。如果未提供，词汇表将从 vocab_file 加载。
构建一个“快速（fast）”CamemBERT 分词器（由 HuggingFace 的 tokenizers 库支持）。改编自 RobertaTokenizer 和 XLNetTokenizer。基于 Unigram。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此基类以获取有关这些方法的更多信息。
get_special_tokens_mask
< 代码源 >( token_ids_0: list[int] token_ids_1: list[int] | None = None already_has_special_tokens: bool = False ) → 一个介于 0 和 1 之间的整数列表
Retrieve sequence ids from a token list that has no special tokens added.
For fast tokenizers, data collators call this with already_has_special_tokens=True to build a mask over an already-formatted sequence. In that case, we compute the mask by checking membership in all_special_ids.
CamembertTokenizerFast
class transformers.CamembertTokenizer
< 代码源 >( bos_token = '<s>' eos_token = '</s>' sep_token = '</s>' cls_token = '<s>' unk_token = '<unk>' pad_token = '<pad>' mask_token = '<mask>' additional_special_tokens = None add_prefix_space = True vocab_file = None vocab: str | dict | list | None = None **kwargs )
参数
- 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>") — 用于遮盖值的标记。这是使用掩码语言建模（masked language modeling）训练此模型时使用的标记。这是模型将尝试预测的标记。 - additional_special_tokens (
list[str], 可选, 默认为["<s>NOTUSED", "</s>NOTUSED"]) — 分词器使用的额外特殊标记。 - add_prefix_space (
bool, 可选, 默认为True) — 是否在输入中添加初始空格。这允许将开头的单词视为与其他单词一样。 - vocab_file (
str, 可选) — 包含实例化分词器所需词汇表的 SentencePiece 文件（通常具有 .spm 扩展名）。 - vocab (
str,dict或list, 可选) — 自定义词汇表字典。如果未提供，词汇表将从 vocab_file 加载。
构建一个“快速（fast）”CamemBERT 分词器（由 HuggingFace 的 tokenizers 库支持）。改编自 RobertaTokenizer 和 XLNetTokenizer。基于 Unigram。
此分词器继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。用户应参考此基类以获取有关这些方法的更多信息。
CamembertModel
class transformers.CamembertModel
< 代码源 >( config add_pooling_layer = True )
参数
- config (CamembertModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
- add_pooling_layer (
bool, 可选, 默认为True) — 是否添加池化层。
该模型可以作为编码器（仅包含自注意力）或解码器，在这种情况下，会在自注意力层之间添加一个交叉注意力层，遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在《Attention is all you need》中描述的架构。
要作为解码器运行，模型需要将配置中的 is_decoder 参数设置为 True。要用于 Seq2Seq 模型，模型需要同时将 is_decoder 和 add_cross_attention 参数设置为 True；此时，前向传播将需要 encoder_hidden_states 作为输入。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 代码源 >( input_ids: torch.Tensor | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值选在[0, 1]之间：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 分段 token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应 句子 A 的 token，
- 1 对应 句子 B 的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望比模型内部的嵌入查找矩阵更可控地将input_ids索引转换为关联向量，这将非常有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的torch.Tensor，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免在编码器输入的填充 token 索引上执行注意力的掩码。如果模型被配置为解码器，该掩码将用于交叉注意力。掩码值选在[0, 1]之间：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含由模型在解码的前一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果没有传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户应仅输入未处理的形状为(batch_size, unprocessed_length)的input_ids（即那些没有将其过去键值状态提供给本模型的 token），而不是形状为(batch_size, sequence_length)的所有input_ids。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回
BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)
一个 BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertModel 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。pooler_output (
torch.FloatTensor，形状为(batch_size, hidden_size)) — 序列第一个 token（分类 token）在进一步通过用于辅助预训练任务的层后的最后一个隐藏状态。例如，对于 BERT 系列模型，这会返回经过线性层和 tanh 激活函数处理后的分类 token。线性层的权重是通过预训练期间的下一句预测（分类）目标来训练的。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueandconfig.add_cross_attention=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.
CamembertForCausalLM
class transformers.CamembertForCausalLM
< 代码源 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CamembertForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
顶部带有 语言建模 头的 Camembert 模型，用于 CLM 微调。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 代码源 >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None labels: torch.LongTensor | None = None past_key_values: tuple[tuple[torch.FloatTensor]] | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在填充 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。仅当模型使用
type_vocab_size参数初始化且该参数值>= 2 时，才能使用此参数。此张量中的所有值应始终 < type_vocab_size。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望比模型内部的嵌入查找矩阵更可控地将input_ids索引转换为关联向量，这将非常有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在编码器输入的填充 token 索引上执行注意力的掩码。如果模型被配置为解码器，该掩码将用于交叉注意力。掩码值选在[0, 1]之间：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]之间（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），仅对标签在[0, ..., config.vocab_size]中的 token 计算损失。 - past_key_values (
tuple[tuple[torch.FloatTensor]]，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含由模型在解码的前一阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果没有传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户应仅输入未处理的形状为(batch_size, unprocessed_length)的input_ids（即那些没有将其过去键值状态提供给本模型的 token），而不是形状为(batch_size, sequence_length)的所有input_ids。 - use_cache (
bool，可选) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果是int，则为最后logits_to_keep个 token 计算 logits。如果是0，则为所有input_ids计算 logits（特殊情况）。生成时仅需要最后一个 token 的 logits，仅为该 token 计算 logits 可以节省内存，这对于长序列或大词表大小非常显著。如果是torch.Tensor，必须是 1D 的，对应于在序列长度维度中要保留的索引。这在使用打包张量格式（批次和序列长度为单维度）时非常有用。
返回
CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertForCausalLM 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
示例
>>> 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
class transformers.CamembertForMaskedLM
< 代码源 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CamembertForMaskedLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
顶部带有 语言建模 头的 Camembert 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 代码源 >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None encoder_hidden_states: torch.FloatTensor | None = None encoder_attention_mask: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MaskedLMOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在填充 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。仅当模型使用
type_vocab_size参数初始化且该参数值>= 2 时，才能使用此参数。此张量中的所有值应始终 < type_vocab_size。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你希望比模型内部的嵌入查找矩阵更可控地将input_ids索引转换为关联向量，这将非常有用。 - encoder_hidden_states (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 编码器最后一层输出的隐藏状态序列。如果模型被配置为解码器，则用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在编码器输入的填充 token 索引上执行注意力的掩码。如果模型被配置为解码器，该掩码将用于交叉注意力。掩码值选在[0, 1]之间：- 1 代表未被掩码的 token，
- 0 代表被掩码的 token。
- labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]之间（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），仅对标签在[0, ..., config.vocab_size]中的 token 计算损失。
返回
MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 MaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertForMaskedLM 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模 (MLM) 损失。logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> 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)
...
>>> 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)
...CamembertForSequenceClassification
class transformers.CamembertForSequenceClassification
< 代码源 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CamembertForSequenceClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
顶部带有序列分类/回归头（池化输出之上的线性层）的 Camembert 模型 transformer，例如用于 GLUE 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 代码源 >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列 token 的索引。默认情况下将忽略填充（Padding）。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免在填充 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。仅当模型使用
type_vocab_size参数初始化且该参数值>= 2 时，才能使用此参数。此张量中的所有值应始终 < type_vocab_size。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 选填，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想要比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这将非常有用。 - labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方误差损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertForSequenceClassification 的前向传播方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, CamembertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertForSequenceClassification.from_pretrained("almanach/camembert-base")
>>> 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]
...
>>> # 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("almanach/camembert-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, CamembertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertForSequenceClassification.from_pretrained("almanach/camembert-base", 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(
... "almanach/camembert-base", 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
class transformers.CamembertForMultipleChoice
< 源码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CamembertForMultipleChoice) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
在顶部带有多项选择分类头（池化输出之上的线性层和 softmax）的 Camembert 模型，例如用于 RocStories/SWAG 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.LongTensor | None = None token_type_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None labels: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0,1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。此参数仅在模型使用值为
= 2 的
type_vocab_size参数初始化时才能使用。此张量中的所有值应始终 < type_vocab_size。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 **未遮盖** 的标记，
- 0 表示 **已遮盖** 的标记。
- labels (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算多项选择分类损失的标签。索引应在[0, ..., num_choices-1]范围内，其中num_choices是输入张量第二维的大小。（参见上面的input_ids） - position_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]范围内选择。 - inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor，可选) — 选填，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想要比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这将非常有用。
返回
MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
一个 MultipleChoiceModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertForMultipleChoice 的前向传播方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> 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
class transformers.CamembertForTokenClassification
< 源码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CamembertForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
在顶部带有标记分类头（隐藏状态输出之上的线性层）的 Camembert 转换器，例如用于命名实体识别 (NER) 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 **未遮盖** 的标记，
- 0 表示 **已遮盖** 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0,1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。此参数仅在模型使用值为
= 2 的
type_vocab_size参数初始化时才能使用。此张量中的所有值应始终 < type_vocab_size。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 选填，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想要比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这将非常有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。
返回
TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertForTokenClassification 的前向传播方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, CamembertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertForTokenClassification.from_pretrained("almanach/camembert-base")
>>> 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
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...CamembertForQuestionAnswering
class transformers.CamembertForQuestionAnswering
< 源码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (CamembertForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
顶部带有片段分类头的 Camembert 转换器，用于 SQuAD 等抽取式问答任务（隐藏状态输出之上的线性层，用于计算 span start logits 和 span end logits）。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.FloatTensor | None = None token_type_ids: torch.LongTensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示 **未遮盖** 的标记，
- 0 表示 **已遮盖** 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在[0,1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。此参数仅在模型使用值为
= 2 的
type_vocab_size参数初始化时才能使用。此张量中的所有值应始终 < type_vocab_size。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 选填，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想要比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这将非常有用。 - start_positions (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算标记分类损失的标记片段起始位置（索引）标签。位置被限制在序列长度（sequence_length）内。序列之外的位置不计入损失计算。 - end_positions (形状为
(batch_size,)的torch.LongTensor，可选) — 用于计算标记分类损失的标记片段结束位置（索引）标签。位置被限制在序列长度（sequence_length）内。序列之外的位置不计入损失计算。
返回
QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 QuestionAnsweringModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置（CamembertConfig）和输入的各种元素。
CamembertForQuestionAnswering 的前向传播方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, CamembertForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("almanach/camembert-base")
>>> model = CamembertForQuestionAnswering.from_pretrained("almanach/camembert-base")
>>> 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)
...
>>> # 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)
...