Hugging Face 的 LOGO

Transformers 文档

CANINE

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

该模型发布于 2021-03-11，并于 2021-06-30 添加到 Hugging Face Transformers。

PyTorch

CANINE

CANINE 是一种无需分词的 Transformer。它跳过了将文本拆分为子词 (subwords) 或词元 (wordpieces) 的常规步骤，直接按字符逐个处理文本。这意味着它直接处理原始 Unicode，因此特别适用于分词规则复杂或不一致的语言，甚至能很好地处理包含拼写错误等噪声的输入。由于按字符处理意味着需要处理更长的序列，CANINE 使用了一个巧妙的方法：模型在早期阶段会对输入进行压缩（称为下采样），这样 Transformer 就不必单独处理每个字符。这保证了运行的高速与高效。

你可以在 Google 组织架构下找到所有原始的 CANINE 权重检查点。

点击右侧边栏中的 CANINE 模型，查看更多如何将 CANINE 应用于不同语言任务的示例。

下面的示例演示了如何通过 Pipeline、AutoModel 以及命令行生成嵌入 (embeddings)。

流水线
自动模型
Transformers CLI
import torch
from transformers import pipeline

pipeline = pipeline(
    task="feature-extraction",
    model="google/canine-c",
    device=0,
)

pipeline("Plant create energy through a process known as photosynthesis.")

注意事项

  • CANINE 完全跳过了分词步骤——它直接作用于原始字符，而不是子词。你可以配合或不配合分词器使用它。对于批量推理和训练，建议使用分词器来将所有序列填充或截断至相同长度。

    from transformers import AutoTokenizer, AutoModel

tokenizer = AutoTokenizer("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")

  • CANINE 主要设计用于在下游任务上进行微调。预训练模型可用于掩码语言建模 (Masked Language Modeling) 或下一句预测 (Next Sentence Prediction)。

CanineConfig

class 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) — 注意力概率的丢弃率。
  • 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) — 层归一化 (layer normalization) 层使用的 epsilon 值。
  • pad_token_id (int, 可选, 默认为 0) — 填充词元 (Padding token) 的 ID。
  • bos_token_id (int, 可选, 默认为 57344) — 流起始词元 (Beginning of stream token) 的 ID。
  • eos_token_id (int, 可选, 默认为 57345) — 流结束词元 (End of stream token) 的 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

class 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: list token_ids_1: list[int] | None = None ) → list[int]

参数

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

返回

list[int]

包含特殊标记的输入 ID 列表。

通过添加特殊标记，从一个或一对序列构建模型输入。

此方法根据分词器的 special_tokens_pattern 动态构建输入

  • "none": 无特殊标记
  • "cls_sep": [CLS] seq0 [SEP] 或 [CLS] seq0 [SEP] seq1 [SEP]
  • "eos": seq0 [EOS] 或 seq0 [EOS] seq1 [EOS]
  • "bos": [BOS] seq0 或 [BOS] seq0 [BOS] seq1
  • "bos_eos": [BOS] seq0 [EOS] 或 [BOS] seq0 [EOS] seq1 [EOS]
  • "cls_double_sep": [CLS] seq0 [SEP] 或 [CLS] seq0 [SEP][SEP] seq1 [SEP]
  • "prefix_suffix": <prefix_tokens> seq0 [seq1] <suffix_tokens> (分词器上存储的自定义前缀/后缀)

get_special_tokens_mask

< >

( token_ids_0: list token_ids_1: list | None = None already_has_special_tokens: bool = False ) → A list of integers in the range [0, 1]

参数

  • token_ids_0 (list[int]) — 第一个序列的 ID 列表。
  • token_ids_1 (list[int], 可选) — 第二个序列的 ID 列表。
  • already_has_special_tokens (bool, 可选, 默认为 False) — 标记列表是否已经为模型格式化了特殊标记。

返回

一个范围在 [0, 1] 的整数列表

特殊令牌为 1，序列令牌为 0。

从未添加特殊令牌的令牌列表中检索序列 ID。使用分词器 prepare_for_model 或 encode_plus 方法添加特殊令牌时会调用此方法。

此方法根据分词器的 special_tokens_pattern 动态构建特殊标记掩码

  • "none": 无特殊标记 (默认，返回所有 0)
  • "cls_sep": [CLS] seq0 [SEP] 或 [CLS] seq0 [SEP] seq1 [SEP]
  • "eos": seq0 [EOS] 或 seq0 [EOS] seq1 [EOS]
  • "bos": [BOS] seq0 或 [BOS] seq0 [BOS] seq1
  • "bos_eos": [BOS] seq0 [EOS] 或 [BOS] seq0 [EOS] seq1 [EOS]
  • "cls_double_sep": [CLS] seq0 [SEP] 或 [CLS] seq0 [SEP][SEP] seq1 [SEP]
  • "prefix_suffix": <prefix_tokens> seq0 [seq1] <suffix_tokens>

create_token_type_ids_from_sequences

< >

( token_ids_0: list token_ids_1: list[int] | None = None ) → list[int]

参数

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

返回

list[int]

根据配置的模式生成 token 类型 ID。

为用于序列对分类任务的两个序列创建一个掩码。

此方法根据分词器的配置属性动态构建 token 类型 ID

  • token_type_ids_pattern: 要使用的模式 ("all_zeros" 或 "bert_style")
  • token_type_ids_include_special_tokens: 在长度计算中是否计入特殊标记

示例

# All zeros pattern (default, used by RoBERTa, BART, etc.)
tokenizer.token_type_ids_pattern = "all_zeros"
# Returns: [0, 0, 0, ...] for both sequences

# BERT-style pattern (first sequence gets 0s, second gets 1s)
tokenizer.token_type_ids_pattern = "bert_style"
# Returns: [0, 0, 0, ..., 1, 1, 1, ...] for sequence pairs

CANINE 特定输出

class transformers.models.canine.modeling_canine.CanineModelOutputWithPooling

< >

( last_hidden_state: torch.FloatTensor | None = None pooler_output: torch.FloatTensor | None = None hidden_states: tuple[torch.FloatTensor] | None = None attentions: tuple[torch.FloatTensor] | None = None )

参数

  • 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 时返回) — 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

class transformers.CanineModel

< >

( config add_pooling_layer = True )

参数

  • config (CanineModel) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重。
  • add_pooling_layer (bool, 可选, 默认为 True) — 是否添加池化层

不带任何特定头部的、仅输出原始隐藏状态的裸 Canine 模型。

此模型继承自 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 output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.models.canine.modeling_canine.CanineModelOutputWithPooling 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充（Padding）。

    可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 ID？

  • 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 的标记。

    什么是标记类型 ID？

  • position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选在 [0, config.n_positions - 1] 范围内。

    什么是位置 ID？

  • 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 时返回) — 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__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

CanineForSequenceClassification

class transformers.CanineForSequenceClassification

< >

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

参数

CANINE 模型 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 output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。

    可以使用 AutoTokenizer 获取索引。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什么是输入 ID？

  • 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 的标记。

    什么是标记类型 ID？

  • position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor, 可选) — 每个输入序列标记在位置嵌入中的位置索引。选在 [0, config.n_positions - 1] 范围内。

    什么是位置 ID？

  • 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，则计算分类损失（交叉熵）。
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详情，请参阅返回张量下的 attentions。
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详情，请参阅返回张量下的 hidden_states。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而非普通元组。

返回

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), 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 后的注意力权重，用于计算自注意力头中的加权平均值。

CanineForSequenceClassification 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 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()
>>> 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 = CanineForSequenceClassification.from_pretrained("google/canine-s", num_labels=num_labels)

>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...

多标签分类示例

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

class transformers.CanineForMultipleChoice

< >

( 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 (CanineForMultipleChoice) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重项。

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

此模型继承自 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 output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

参数

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

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

    什么是输入 ID？

  • attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor，可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选在 [0, 1] 之间：

    • 1 代表未被掩码的标记，
    • 0 代表被掩码的标记。

    什么是注意力掩码？

  • token_type_ids (形状为 (batch_size, num_choices, sequence_length) 的 torch.LongTensor，可选) — 段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 之间选择：

    • 0 对应句子 A 的标记，
    • 1 对应句子 B 的标记。

    什么是标记类型 ID？

  • position_ids (形状为 (batch_size, num_choices, sequence_length) 的 torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选在范围 [0, config.max_position_embeddings - 1] 内。

    什么是位置 ID？

  • inputs_embeds (形状为 (batch_size, num_choices, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 选填项，您可以选择直接传递嵌入表示，而不是传递 input_ids。如果您希望比模型内部的嵌入查找矩阵更多地控制如何将 input_ids 索引转换为关联向量，这将非常有用。
  • labels (形状为 (batch_size,) 的 torch.LongTensor，可选) — 用于计算多选题分类损失的标签。索引应在 [0, ..., num_choices-1] 之间，其中 num_choices 是输入张量第二维的大小。（参见上面的 input_ids）
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.MultipleChoiceModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），由取决于配置（CanineConfig）和输入的各种元素组成。

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

CanineForMultipleChoice 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 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.logits

CanineForTokenClassification

class transformers.CanineForTokenClassification

< >

( 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 (CanineForTokenClassification) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重项。

Canine transformer 在顶部带有一个标记分类头（在隐藏状态输出之上的线性层），例如用于命名实体识别（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 output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充（Padding）。

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

    什么是输入 ID？

  • 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 的标记。

    什么是标记类型 ID？

  • position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选在范围 [0, config.n_positions - 1] 内。

    什么是位置 ID？

  • 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] 之间。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），由取决于配置（CanineConfig）和输入的各种元素组成。

  • 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 后的注意力权重，用于计算自注意力头中的加权平均值。

CanineForTokenClassification 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 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_classes
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)

CanineForQuestionAnswering

class transformers.CanineForQuestionAnswering

< >

( 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 (CanineForQuestionAnswering) — 包含模型所有参数的模型配置类。使用配置文件进行初始化不会加载与模型相关的权重，只加载配置。请查看 from_pretrained() 方法来加载模型权重项。

Canine transformer 在顶部带有一个片段（span）分类头，用于 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 output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。

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

    什么是输入 ID？

  • 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 的标记。

    什么是标记类型 ID？

  • position_ids (形状为 (batch_size, sequence_length) 的 torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选在范围 [0, config.n_positions - 1] 内。

    什么是位置 ID？

  • 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）内。序列之外的位置不计入损失计算。
  • output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
  • output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
  • return_dict (bool，可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），由取决于配置（CanineConfig）和输入的各种元素组成。

  • loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。

  • end_logits (torch.FloatTensor of 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 后的注意力权重，用于计算自注意力头中的加权平均值。

CanineForQuestionAnswering 的前向传播方法，覆盖了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。

示例

>>> from transformers import AutoTokenizer, CanineForQuestionAnswering
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("google/canine-s")
>>> model = CanineForQuestionAnswering.from_pretrained("google/canine-s")

>>> 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)
...
在 GitHub 上更新

←CamemBERT CodeGen→
© . This site is unofficial and not affiliated with Hugging Face, Inc.