Transformers 文档
CANINE
并获得增强的文档体验
开始使用
CANINE
概述
CANINE 模型由 Jonathan H. Clark、Dan Garrette、Iulia Turc 和 John Wieting 在CANINE: Pre-training an Efficient Tokenization-Free Encoder for Language Representation 中提出。它是首批训练 Transformer 时不使用显式分词步骤（例如 Byte Pair Encoding (BPE)、WordPiece 或 SentencePiece）的论文之一。相反，该模型直接在 Unicode 字符级别进行训练。在字符级别进行训练不可避免地会带来更长的序列长度，CANINE 通过高效的下采样策略解决了这个问题，然后再应用深度 Transformer 编码器。
该论文的摘要如下：
流水线式 NLP 系统在很大程度上已被端到端神经建模所取代，但几乎所有常用模型仍然需要显式分词步骤。虽然最近基于数据衍生的子词词汇表的分词方法不如手动设计的分词器那样脆弱，但这些技术并非同样适用于所有语言，并且使用任何固定词汇表都可能限制模型的适应能力。在本文中，我们介绍了 CANINE，一种直接在字符序列上操作的神经编码器，无需显式分词或词汇表，以及一种直接在字符上操作或可选地使用子词作为软归纳偏差的预训练策略。为了有效且高效地使用其更细粒度的输入，CANINE 将下采样（减少输入序列长度）与深度 Transformer 堆栈（编码上下文）相结合。CANINE 在 TyDi QA（一项具有挑战性的多语言基准测试）上，性能优于可比的 mBERT 模型 2.8 F1，尽管模型参数减少了 28%。
使用技巧
- CANINE 内部使用了不少于 3 个 Transformer 编码器：2 个“浅层”编码器（仅包含单层）和 1 个“深层”编码器（是常规 BERT 编码器）。首先，使用“浅层”编码器，通过局部注意力机制来情境化字符嵌入。接下来，在下采样之后，应用“深层”编码器。最后，在上采样之后，使用“浅层”编码器来创建最终的字符嵌入。有关上采样和下采样的详细信息，请参阅论文。
- 默认情况下，CANINE 使用的最大序列长度为 2048 个字符。可以使用 CanineTokenizer 为模型准备文本。
- 分类可以通过在线性层之上放置特殊 [CLS] 标记（具有预定义的 Unicode 代码点）的最终隐藏状态来完成。但是，对于标记分类任务，需要再次对下采样的标记序列进行上采样，以匹配原始字符序列的长度（为 2048）。有关此操作的详细信息，请参阅论文。
模型检查点
- google/canine-c：使用自回归字符损失进行预训练，12 层，768 隐藏层，12 个注意力头，1.21 亿参数（大小约 500 MB）。
- google/canine-s：使用子词损失进行预训练，12 层，768 隐藏层，12 个注意力头，1.21 亿参数（大小约 500 MB）。
使用示例
CANINE 在原始字符上工作，因此可以在没有分词器的情况下使用
>>> from transformers import CanineModel
>>> import torch
>>> model = CanineModel.from_pretrained("google/canine-c") # model pre-trained with autoregressive character loss
>>> text = "hello world"
>>> # use Python's built-in ord() function to turn each character into its unicode code point id
>>> input_ids = torch.tensor([[ord(char) for char in text]])
>>> outputs = model(input_ids) # forward pass
>>> pooled_output = outputs.pooler_output
>>> sequence_output = outputs.last_hidden_state但是，对于批量推理和训练，建议使用分词器（将所有序列填充/截断到相同长度）
>>> from transformers import CanineTokenizer, CanineModel
>>> model = CanineModel.from_pretrained("google/canine-c")
>>> tokenizer = CanineTokenizer.from_pretrained("google/canine-c")
>>> inputs = ["Life is like a box of chocolates.", "You never know what you gonna get."]
>>> encoding = tokenizer(inputs, padding="longest", truncation=True, return_tensors="pt")
>>> outputs = model(**encoding) # forward pass
>>> pooled_output = outputs.pooler_output
>>> sequence_output = outputs.last_hidden_state资源
CanineConfig
class transformers.CanineConfig
< source >( 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 = 16384 type_vocab_size = 16 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 bos_token_id = 57344 eos_token_id = 57345 downsampling_rate = 4 upsampling_kernel_size = 4 num_hash_functions = 8 num_hash_buckets = 16384 local_transformer_stride = 128 **kwargs )
参数
- hidden_size (
int, 可选, 默认为 768) — 编码器层和池化器层的维度。 - num_hidden_layers (
int, 可选, 默认为 12) — 深度 Transformer 编码器中隐藏层的数量。 - num_attention_heads (
int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_size (
int, 可选, 默认为 3072) — Transformer 编码器中“中间”层（即，前馈层）的维度。 - hidden_act (
str或function, 可选, 默认为"gelu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，则支持"gelu","relu","selu"和"gelu_new"。 - hidden_dropout_prob (
float, 可选, 默认为 0.1) — 嵌入、编码器和池化器中所有全连接层的 dropout 概率。 - attention_probs_dropout_prob (
float, 可选, 默认为 0.1) — 注意力概率的 dropout 比率。 - max_position_embeddings (
int, 可选, 默认为 16384) — 此模型可能使用的最大序列长度。 - type_vocab_size (
int, 可选, 默认为 16) — 调用 CanineModel 时传递的token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - pad_token_id (
int, 可选, 默认为 0) — Padding 标记 id。 - bos_token_id (
int, 可选, 默认为 57344) — 流开始标记 id。 - eos_token_id (
int, 可选, 默认为 57345) — 流结束标记 id。 - downsampling_rate (
int, 可选, 默认为 4) — 在应用深度 Transformer 编码器之前，对原始字符序列长度进行下采样的速率。 - upsampling_kernel_size (
int, 可选, 默认为 4) — 当从hidden_size*2 反向投影到hidden_size时，卷积投影层的内核大小（即，每个窗口中的字符数）。 - num_hash_functions (
int, 可选, 默认为 8) — 要使用的哈希函数数量。每个哈希函数都有自己的嵌入矩阵。 - num_hash_buckets (
int, 可选, 默认为 16384) — 要使用的哈希桶的数量。 - local_transformer_stride (
int, 可选, 默认为 128) — 第一个浅层 Transformer 编码器的局部注意力的步幅。 默认为 128，以获得良好的 TPU/XLA 内存对齐。
这是用于存储 CanineModel 配置的配置类。 它用于根据指定的参数实例化 CANINE 模型，定义模型架构。 使用默认值实例化配置将产生与 CANINE google/canine-s 架构类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。 请阅读 PretrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import CanineConfig, CanineModel
>>> # Initializing a CANINE google/canine-s style configuration
>>> configuration = CanineConfig()
>>> # Initializing a model (with random weights) from the google/canine-s style configuration
>>> model = CanineModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configCanineTokenizer
class transformers.CanineTokenizer
< source >( bos_token = '\ue000' eos_token = '\ue001' sep_token = '\ue001' cls_token = '\ue000' pad_token = '\x00' mask_token = '\ue003' add_prefix_space = False model_max_length = 2048 **kwargs )
构建 CANINE 分词器（即字符分割器）。 它将文本转换为字符序列，然后将每个字符转换为其 Unicode 代码点。
CanineTokenizer 继承自 PreTrainedTokenizer。
有关参数的使用示例和文档，请参阅超类 PreTrainedTokenizer。
build_inputs_with_special_tokens
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
通过连接并添加特殊 token，从序列或序列对构建用于序列分类任务的模型输入。 CANINE 序列具有以下格式
- 单个序列：
[CLS] X [SEP] - 序列对：
[CLS] A [SEP] B [SEP]
get_special_tokens_mask
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → List[int]
从没有添加特殊 token 的 token 列表中检索序列 ID。 当使用分词器的 prepare_for_model 方法添加特殊 token 时，会调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
从传递的两个序列创建一个掩码，用于序列对分类任务。 CANINE
如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0）。
CANINE 特定输出
class transformers.models.canine.modeling_canine.CanineModelOutputWithPooling
< source >( last_hidden_state: FloatTensor = None pooler_output: FloatTensor = None hidden_states: typing.Optional[typing.Tuple[torch.FloatTensor]] = None attentions: typing.Optional[typing.Tuple[torch.FloatTensor]] = None )
参数
- last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层输出的隐藏状态序列（即最终浅层 Transformer 编码器的输出）。 - pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 深度 Transformer 编码器最后一层序列的第一个 token（分类 token）的隐藏状态，通过线性层和 Tanh 激活函数进一步处理。 线性层权重通过预训练期间的下一句预测（分类）目标进行训练。 - hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)和(batch_size, sequence_length // config.downsampling_rate, hidden_size)的torch.FloatTensor元组（每个编码器的输入一个，每个编码器的每一层的输出一个）。 模型在每一层输出的隐藏状态，加上每个 Transformer 编码器的初始输入。 浅层编码器的隐藏状态长度为sequence_length，但深层编码器的隐藏状态长度为sequence_length//config.downsampling_rate。 - attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)和(batch_size, num_heads, sequence_length // config.downsampling_rate, sequence_length // config.downsampling_rate)的 3 个 Transformer 编码器（每个层一个）的torch.FloatTensor元组。 注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CanineModel 的输出类型。 基于 BaseModelOutputWithPooling，但具有略微不同的 hidden_states 和 attentions，因为这些也包括浅层 Transformer 编码器的隐藏状态和注意力。
CanineModel
class transformers.CanineModel
< source >( config add_pooling_layer = True )
参数
- config (CanineConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
裸 CANINE 模型 Transformer，输出原始的隐藏状态，顶部没有任何特定的头部。此模型是 PyTorch torch.nn.Module 子类。 可以将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.canine.modeling_canine.CanineModelOutputWithPooling or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 用于避免在填充标记索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示未被掩蔽的标记，
- 0 表示被掩蔽的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 分段标记索引以指示输入的第一部分和第二部分。 索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 位置嵌入中每个输入序列标记的位置索引。 在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (形状为
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可选) — 用于使自注意力模块的选定头部无效的掩码。 掩码值在[0, 1]中选择：- 1 表示头部未被掩蔽，
- 0 表示头部被掩蔽。
- inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。
返回值
transformers.models.canine.modeling_canine.CanineModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 transformers.models.canine.modeling_canine.CanineModelOutputWithPooling 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (CanineConfig) 和输入。
- last_hidden_state (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor) — 模型最后一层的输出处的隐藏状态序列（即，最终浅层 Transformer 编码器的输出）。 - pooler_output (形状为
(batch_size, hidden_size)的torch.FloatTensor) — 序列的第一个标记（分类标记）在深层 Transformer 编码器的最后一层的隐藏状态，通过线性层和 Tanh 激活函数进一步处理。 线性层权重通过预训练期间的下一句预测（分类）目标进行训练。 - hidden_states (
tuple(torch.FloatTensor), 可选, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)和(batch_size, sequence_length // config.downsampling_rate, hidden_size)的torch.FloatTensor元组（每个编码器的输入一个 + 每个编码器的每一层的输出一个）。 模型在每一层输出处的隐藏状态以及每个 Transformer 编码器的初始输入。 浅层编码器的隐藏状态长度为sequence_length，但深层编码器的隐藏状态长度为sequence_length//config.downsampling_rate。 - attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)和(batch_size, num_heads, sequence_length // config.downsampling_rate, sequence_length // config.downsampling_rate)的 3 个 Transformer 编码器的torch.FloatTensor元组（每一层一个）。 注意力 softmax 之后的注意力权重，用于计算自注意力头部的加权平均值。
CanineModel forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CanineModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineModel.from_pretrained("google/canine-s")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateCanineForSequenceClassification
class transformers.CanineForSequenceClassification
< source >( config )
参数
- config (CanineConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
CANINE 模型 Transformer，顶部带有一个序列分类/回归头（池化输出顶部的线性层），例如用于 GLUE 任务。
此模型是 PyTorch torch.nn.Module 子类。 可以将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput or tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor, 可选) — 用于避免在填充标记索引上执行 attention 的掩码。 掩码值在[0, 1]中选择：- 1 表示未被掩蔽的标记，
- 0 表示被掩蔽的标记。
- token_type_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择:- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor, 形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置零自注意力模块中选定 head 的 Mask。 Mask 值在[0, 1]中选择:- 1 表示 head 不被 Mask，
- 0 表示 head 被 Mask。
- 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 时），其中包含各种元素，具体取决于配置 (CanineConfig) 和输入。
-
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时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则一个用于嵌入的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CanineForSequenceClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, CanineForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForSequenceClassification.from_pretrained("google/canine-s")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> # 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 = CanineForSequenceClassification.from_pretrained("google/canine-s", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, CanineForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForSequenceClassification.from_pretrained("google/canine-s", 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 = CanineForSequenceClassification.from_pretrained(
... "google/canine-s", 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).lossCanineForMultipleChoice
class transformers.CanineForMultipleChoice
< source >( config )
参数
- config (CanineConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有置于顶部的多项选择分类头的 CANINE 模型（池化输出和 softmax 之上的线性层），例如，用于 RocStories/SWAG 任务。
此模型是 PyTorch torch.nn.Module 子类。 可以将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列 token 的索引。可以使用 AutoTokenizer 获取索引。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor, 形状为(batch_size, num_choices, sequence_length), 可选) — 用于避免在 padding token 索引上执行 attention 的 Mask。 Mask 值在[0, 1]中选择:- 1 表示 token 未被 Mask，
- 0 表示 token 被 Mask。
- token_type_ids (
torch.LongTensor, 形状为(batch_size, num_choices, sequence_length), 可选) — 分段 token 索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择:- 0 对应于 句子 A token，
- 1 对应于 句子 B token。
- position_ids (
torch.LongTensor, 形状为(batch_size, num_choices, sequence_length), 可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor, 形状为(num_heads,)或(num_layers, num_heads), 可选) — 用于置零自注意力模块中选定 head 的 Mask。 Mask 值在[0, 1]中选择:- 1 表示 head 不被 Mask，
- 0 表示 head 被 Mask。
- 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 时），其中包含各种元素，具体取决于配置 (CanineConfig) 和输入。
-
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时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则一个用于嵌入的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CanineForMultipleChoice forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CanineForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForMultipleChoice.from_pretrained("google/canine-s")
>>> 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.logitsCanineForTokenClassification
class transformers.CanineForTokenClassification
< source >( config )
参数
- config (CanineConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法来加载模型权重。
带有置于顶部的 token 分类头的 CANINE 模型（隐藏状态输出之上的线性层），例如，用于命名实体识别 (NER) 任务。
此模型是 PyTorch torch.nn.Module 子类。 可以将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 Mask 值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 被掩盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使 self-attention 模块的选定 head 失效的掩码。Mask 值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算 token 分类损失的标签。索引应为[0, ..., config.num_labels - 1]。
返回值
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的 tuple （如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (CanineConfig) 和输入。
-
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时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则一个用于嵌入的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
CanineForTokenClassification forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CanineForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForTokenClassification.from_pretrained("google/canine-s")
>>> 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_classesCanineForQuestionAnswering
class transformers.CanineForQuestionAnswering
< 源代码 >( config )
参数
- config (CanineConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
用于抽取式问答任务（如 SQuAD）的 CANINE 模型，顶部带有一个 span 分类 head（在 hidden-states 输出之上有一个线性层，用于计算 span start logits 和 span end logits）。
此模型是 PyTorch torch.nn.Module 子类。 可以将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以获取与常规用法和行为相关的所有事项。
forward
< 源代码 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。索引可以使用 AutoTokenizer 获得。参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免在 padding token 索引上执行 attention 的掩码。 Mask 值在[0, 1]中选择：- 1 表示 tokens 未被掩盖，
- 0 表示 tokens 被掩盖。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — Segment token 索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：- 0 对应于 sentence A token，
- 1 对应于 sentence B token。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - head_mask (
torch.FloatTensor，形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使 self-attention 模块的选定 head 失效的掩码。Mask 值在[0, 1]中选择：- 1 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — （可选）您可以选择直接传递嵌入表示而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更灵活地控制如何将 input_ids 索引转换为关联的向量，这将非常有用。 - output_attentions (
bool，可选) — 是否返回所有 attention 层的 attention tensors。 有关更多详细信息，请参阅返回 tensors 下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回 tensors 下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通 tuple。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标签，表示带标签的 span 起始位置（索引）。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 token 分类损失的标签，表示标注跨度的结束位置（索引）。位置被限制在序列的长度 (sequence_length) 内。序列之外的位置不被纳入损失计算。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (CanineConfig) 和输入的各种元素。
-
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时返回) —torch.FloatTensor元组（如果模型具有嵌入层，则一个用于嵌入的输出，+ 每个层的输出一个），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出的隐藏状态，加上可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
The CanineForQuestionAnswering 的 forward 方法，重写了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数中定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, CanineForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("Splend1dchan/canine-c-squad")
>>> model = CanineForQuestionAnswering.from_pretrained("Splend1dchan/canine-c-squad")
>>> 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)
'nice 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)
8.81