Transformers 文档

CANINE（犬类）

Transformers

加入 Hugging Face 社区

并获得增强的文档体验

协作模型、数据集和空间

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

在文档主题之间切换

开始使用

CANINE

概述

CANINE 模型是由 Jonathan H. Clark、Dan Garrette、Iulia Turc 和 John Wieting 在 CANINE：预训练一个无需分词的高效语言表示编码器一文中提出的。它是首批在训练 Transformer 时不使用显式分词步骤（例如字节对编码 (BPE)、WordPiece 或 SentencePiece）的论文之一。相反，该模型直接在 Unicode 字符级别进行训练。在字符级别进行训练不可避免地会导致更长的序列长度，CANINE 通过在应用深度 Transformer 编码器之前采用高效的下采样策略来解决这个问题。

该论文的摘要是：

流水线式的 NLP 系统很大程度上已被端到端的神经网络建模所取代，但几乎所有常用的模型仍然需要显式的分词步骤。虽然最近基于数据派生的子词词典的分词方法比手动设计的分词器更不容易出错，但这些技术并不适用于所有语言，并且使用任何固定的词汇表都可能限制模型的适应能力。在本文中，我们提出了 CANINE，一种直接对字符序列进行操作的神经网络编码器，无需显式分词或词汇表，以及一种直接对字符进行操作或可选地使用子词作为软归纳偏差的预训练策略。为了有效且高效地使用其更细粒度的输入，CANINE 结合了下采样（减少输入序列长度）和深度 Transformer 堆栈（编码上下文）。在具有挑战性的多语言基准 TyDi QA 上，CANINE 的 F1 值比可比的 mBERT 模型高 2.8，尽管模型参数减少了 28%。

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

使用技巧

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

类 transformers.CanineConfig

< 源代码 >

( 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) — 填充标记 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.config

CanineTokenizer

类 transformers.CanineTokenizer

< 源代码 >

( 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 )

参数

model_max_length (int, 可选, 默认为 2048) — 模型接受的最大句子长度。

构造一个 CANINE 分词器（即字符拆分器）。它将文本转换为字符序列，然后将每个字符转换为其 Unicode 代码点。

CanineTokenizer 继承自 PreTrainedTokenizer。

有关参数的使用示例和文档，请参阅超类 PreTrainedTokenizer。

build_inputs_with_special_tokens

< 源代码 >

( token_ids_0: 列表 token_ids_1: 可选 = 无 ) → 列表[int]

参数

token_ids_0 (列表[int]) — 将添加特殊标记的 ID 列表。
token_ids_1 (List[int], 可选) — 可选的第二个序列对的 ID 列表。

List[int]

带有适当特殊标记的输入 ID列表。

通过连接和添加特殊标记，从用于序列分类任务的序列或序列对构建模型输入。CANINE 序列具有以下格式

单个序列： [CLS] X [SEP]
序列对： [CLS] A [SEP] B [SEP]

get_special_tokens_mask

< 源代码 >

( token_ids_0: List token_ids_1: Optional = None already_has_special_tokens: bool = False ) → List[int]

参数

token_ids_0 (List[int]) — ID 列表。
token_ids_1 (List[int], 可选) — 可选的第二个序列对的 ID 列表。
already_has_special_tokens (bool, 可选, 默认为 False) — 标记列表是否已使用模型的特殊标记进行格式化。

List[int]

一个范围在 [0, 1] 内的整数列表：1 表示特殊标记，0 表示序列标记。

从没有添加特殊标记的标记列表中检索序列 ID。当使用分词器 prepare_for_model 方法添加特殊标记时，将调用此方法。

create_token_type_ids_from_sequences

< 源代码 >

( token_ids_0: 列表 token_ids_1: 可选 = 无 ) → 列表[int]

参数

token_ids_0 (List[int]) — ID 列表。
token_ids_1 (List[int], 可选) — 序列对的可选第二个 ID 列表。

List[int]

根据给定序列的标记类型 ID列表。

根据传入的两个序列创建一个掩码，用于序列对分类任务。CANINE

序列对掩码具有以下格式

0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence    | second sequence |

如果 token_ids_1 为 None，则此方法仅返回掩码的第一部分（0）。

CANINE 特定输出

类 transformers.models.canine.modeling_canine.CanineModelOutputWithPooling

< 来源 >

( last_hidden_state: FloatTensor = None pooler_output: FloatTensor = None hidden_states: Optional = None attentions: Optional = None )

参数

last_hidden_state (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列（即最终浅层 Transformer 编码器的输出）。
pooler_output (torch.FloatTensor 形状为 (batch_size, hidden_size)) — 序列第一个标记（分类标记）在深层 Transformer 编码器最后一层的隐藏状态，经过线性层和 Tanh 激活函数的进一步处理。线性层权重在预训练期间通过下一句预测（分类）目标进行训练。
hidden_states (tuple(torch.FloatTensor), 可选, 当传入 output_hidden_states=True 或 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（每个编码器的输入一个 + 每个编码器的每一层的输出一个），形状为 (batch_size, sequence_length, hidden_size) 和 (batch_size, sequence_length // config.downsampling_rate, hidden_size)。模型在每个层输出处的隐藏状态以及每个 Transformer 编码器的初始输入。浅层编码器的隐藏状态长度为 sequence_length，但深层编码器的隐藏状态长度为 sequence_length // config.downsampling_rate。
attentions (tuple(torch.FloatTensor), 可选, 当传入 output_attentions=True 或 config.output_attentions=True 时返回) — 3 个 Transformer 编码器的 torch.FloatTensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length) 和 (batch_size, num_heads, sequence_length // config.downsampling_rate, sequence_length // config.downsampling_rate)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

CanineModel 的输出类型。基于 BaseModelOutputWithPooling，但 hidden_states 和 attentions 略有不同，因为它们还包括浅层 Transformer 编码器的隐藏状态和注意力。

CanineModel

类 transformers.CanineModel

< 源代码 >

( config add_pooling_layer = True )

参数

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

基础 CANINE 模型 transformer，输出原始隐藏状态，顶部没有任何特定的头部。此模型是 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 output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.models.canine.modeling_canine.CanineModelOutputWithPooling or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值在 [0, 1] 中选择：
- 未屏蔽标记为 1，
- 已屏蔽标记为 0。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

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

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 (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层（即最终浅层 Transformer 编码器的输出）输出的隐藏状态序列。
pooler_output (torch.FloatTensor 形状为 (batch_size, hidden_size)) — 深层 Transformer 编码器最后一层序列的第一个标记（分类标记）的隐藏状态，由线性层和 Tanh 激活函数进一步处理。线性层权重在预训练期间从下一句预测（分类）目标训练而来。
hidden_states (tuple(torch.FloatTensor)，可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组（每个编码器的输入一个 + 每个编码器的每一层的输出一个），形状为 (batch_size, sequence_length, hidden_size) 和 (batch_size, sequence_length // config.downsampling_rate, hidden_size)。模型在每一层输出处的隐藏状态加上每个 Transformer 编码器的初始输入。浅层编码器的隐藏状态长度为 sequence_length，但深层编码器的隐藏状态长度为 sequence_length // config.downsampling_rate。
attentions (tuple(torch.FloatTensor)，可选，当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — 3 个 Transformer 编码器的 torch.FloatTensor 的元组（每一层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length) 和 (batch_size, num_heads, sequence_length // config.downsampling_rate, sequence_length // config.downsampling_rate)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。

CanineModel 前向方法，覆盖 __call__ 特殊方法。

尽管前向传递的配方需要在此函数中定义，但之后应该调用 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_state

CanineForSequenceClassification

类 transformers.CanineForSequenceClassification

< 源代码 >

( config )

参数

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

CANINE 模型 transformer，顶部带有序列分类/回归头（在池化输出顶部的线性层），例如用于 GLUE 任务。

此模型是 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()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 掩码，避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值：
- 未屏蔽标记为 1，
- 已屏蔽标记为 0。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 片段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 （形状为 (batch_size,) 的 torch.LongTensor，可选） — 用于计算序列分类/回归损失的标签。索引应在 [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 （形状为 (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)，可选，当传递 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__ 特殊方法。

单标签分类示例

>>> 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).loss

CanineForMultipleChoice

类 transformers.CanineForMultipleChoice

< 源代码 >

( config )

参数

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

顶部有多项选择分类头的 CANINE 模型（在池化输出之上有一个线性层和一个 softmax），例如用于 RocStories/SWAG 任务。

此模型是 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.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor ，形状为 (batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。

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

什么是输入 ID？
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 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor ，形状为 (batch_size, num_choices, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 时）包含根据配置（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__ 特殊方法。

示例

>>> 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.logits

CanineForTokenClassification

类 transformers.CanineForTokenClassification

< 源代码 >

( config )

参数

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

CANINE 模型，顶部带有令牌分类头（隐藏状态输出顶部的线性层），例如用于命名实体识别 (NER) 任务。

此模型是 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()。

什么是输入 ID？
attention_mask (torch.FloatTensor 形形 (batch_size, sequence_length), 可选) — 掩码，避免对填充标记索引执行注意力。在 [0, 1] 中选择的掩码值：
- 未被掩码的标记为 1，
- 被掩码的标记为 0。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 段落标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 时）包含根据配置 (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__ 特殊方法。

示例

>>> 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_classes

>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)

CanineForQuestionAnswering

类 transformers.CanineForQuestionAnswering

< 源码 >

( config )

参数

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

CANINE 模型，顶部有一个用于提取式问答任务（如 SQuAD）的跨度分类头（隐藏状态输出顶部的线性层，用于计算 span start logits 和 span end logits）。

此模型是 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 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 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列标记的索引。

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

什么是输入 ID？
attention_mask (torch.FloatTensor 形状为 (batch_size, sequence_length)，可选) — 避免对填充标记索引执行注意力机制的掩码。掩码值在 [0, 1] 中选择：
- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
什么是注意力掩码？
token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
什么是标记类型 ID？
position_ids (torch.LongTensor 形状为 (batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列标记的位置索引。在 [0, config.max_position_embeddings - 1] 范围内选择。

什么是位置 ID？
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 时），其中包含根据配置（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 之后的注意力权重，用于计算自注意力头中的加权平均值。

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

示例

>>> 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

< > GitHub 上的更新

←CamemBERT CodeGen→