Transformers 文档
CANINE
并获得增强的文档体验
开始使用
该模型于 2021 年 3 月 11 日发表在 HF papers 上，并于 2021 年 6 月 30 日贡献给 Hugging Face Transformers。
CANINE
CANINE 是一种无需分词（tokenization-free）的 Transformer。它跳过了通常将文本拆分为子词（subwords）或词片（wordpieces）的步骤，而是逐个字符地处理文本。这意味着它直接处理原始 Unicode，因此对于具有复杂或不一致分词规则的语言，甚至包含错别字等噪声的输入，都特别有用。由于处理字符意味着要处理更长的序列，CANINE 使用了一个巧妙的技巧。该模型在早期阶段压缩输入（称为下采样），因此 Transformer 不需要单独处理每个字符。这保证了模型运行的快速和高效。
你可以在 Google 组织下找到所有原始的 CANINE 检查点。
点击右侧边栏中的 CANINE 模型，查看关于如何将 CANINE 应用于不同语言任务的更多示例。
下面的示例演示了如何使用 Pipeline、AutoModel 以及从命令行生成嵌入（embeddings）。
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 完全跳过了分词过程——它直接作用于原始字符，而不是子词。你可以选择使用或不使用分词器（tokenizer）。对于批量推理和训练，建议使用分词器将所有序列填充（pad）和截断（truncate）到相同的长度。
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").to(model.device)CANINE 主要设计用于下游任务的微调。预训练模型可用于掩码语言建模（masked language modeling）或下一句预测（next sentence prediction）。
CanineConfig
class transformers.CanineConfig
< 源代码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None hidden_size: int = 768 num_hidden_layers: int = 12 num_attention_heads: int = 12 intermediate_size: int = 3072 hidden_act: str = 'gelu' hidden_dropout_prob: float | int = 0.1 attention_probs_dropout_prob: float | int = 0.1 max_position_embeddings: int = 16384 type_vocab_size: int = 16 initializer_range: float = 0.02 layer_norm_eps: float = 1e-12 pad_token_id: int | None = 0 bos_token_id: int | None = 57344 eos_token_id: int | list[int] | None = 57345 downsampling_rate: int = 4 upsampling_kernel_size: int = 4 num_hash_functions: int = 8 num_hash_buckets: int = 16384 local_transformer_stride: int = 128 )
参数
- hidden_size (
int, 可选, 默认为768) — 隐藏表示的维度。 - num_hidden_layers (
int, 可选, 默认为12) — Transformer 解码器中的隐藏层数量。 - num_attention_heads (
int, 可选, 默认为12) — Transformer 解码器中每个注意力层的注意力头数量。 - intermediate_size (
int, 可选, 默认为3072) — MLP 表示的维度。 - hidden_act (
str, 可选, 默认为gelu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu","relu","silu"等。 - hidden_dropout_prob (
Union[float, int], 可选, 默认为0.1) — 嵌入、编码器和池化层中所有全连接层的丢弃（dropout）概率。 - attention_probs_dropout_prob (
Union[float, int], 可选, 默认为0.1) — 注意力概率的丢弃率。 - max_position_embeddings (
int, 可选, 默认为16384) — 此模型可能使用的最大序列长度。 - type_vocab_size (
int, 可选, 默认为16) —token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为1e-12) — 层归一化层使用的 epsilon 值。 - pad_token_id (
int, 可选, 默认为0) — 词汇表中用于填充的 token id。 - bos_token_id (
int, 可选, 默认为57344) — 词汇表中用于序列开头的 token id。 - eos_token_id (
Union[int, list[int]], 可选, 默认为57345) — 词汇表中用于序列结尾的 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 模型，从而定义模型架构。使用默认值实例化配置将产生与 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
< 源代码 >( 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
< 源码 >( token_ids_0: list token_ids_1: list[int] | None = None ) → list[int]
通过添加特殊标记，从一个或一对序列构建模型输入。
此方法根据分词器的 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]
从未添加特殊令牌的令牌列表中检索序列 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 类型 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 pairsCANINE 特有的输出
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 (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列（即最终浅层 Transformer 编码器的输出）。 - pooler_output (
torch.FloatTensor，形状为(batch_size, hidden_size)) — 深度 Transformer 编码器最后一层中序列第一个标记（分类标记）的隐藏状态，并经过线性层和 Tanh 激活函数进一步处理。线性层的权重是在预训练阶段通过下一句预测（分类）目标进行训练的。 - hidden_states (
tuple(torch.FloatTensor), optional, 当传入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), optional, 当传入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 之后的注意力权重，用于计算自注意力头中的加权平均值。 - 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), optional, 当传入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), optional, 当传入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, optional, 默认为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 ) → CanineModelOutputWithPooling 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下将忽略填充（padding）。索引可以使用 AutoTokenizer 获取。有关详情，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.__call__()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于 句子 A 标记，
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - 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 而不是普通元组。
返回
CanineModelOutputWithPooling 或 tuple(torch.FloatTensor)
一个 CanineModelOutputWithPooling 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），根据配置（CanineConfig）和输入，包含各种元素。
CanineModel 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
- 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 之后的注意力权重，用于计算自注意力头中的加权平均值。
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] )
参数
- config (CanineForSequenceClassification) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
CANINE 模型转换器，顶部带有序列分类/回归头（合并输出之上的线性层），例如用于 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 ) → SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 词汇表中输入序列标记的索引。默认情况下，填充（Padding）将被忽略。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示已屏蔽的标记。
- token_type_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选择直接传入嵌入表示，而不是传入input_ids。如果您想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[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 而不是普通元组。
返回
SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutput 或 torch.FloatTensor 元组（如果传入 return_dict=False 或 config.return_dict=False 时），根据配置（CanineConfig）和输入，包含各种元素。
CanineForSequenceClassification 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, 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).lossCanineForMultipleChoice
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 ) → MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未屏蔽的标记，
- 0 表示已屏蔽的标记。
- token_type_ids (
torch.LongTensor，形状为(batch_size, num_choices, sequence_length)，可选) — 段标记索引，用于指示输入的第一个和第二个部分。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。 - inputs_embeds (形状为
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关向量，这会很有用。 - 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 而不是普通元组。
返回
MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
根据配置（CanineConfig）和输入，包含各种元素的 MultipleChoiceModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False）。
CanineForMultipleChoice 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为 (1,) 的
torch.FloatTensor，可选，当提供labels时返回) — 分类损失。logits (形状为
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是输入张量的第二维大小。（请参阅上面的 input_ids）。分类分数（SoftMax 之前）。
hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, 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
< 源码 >( 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 ) → TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这会很有用。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
TokenClassifierOutput 或 tuple(torch.FloatTensor)
根据配置（CanineConfig）和输入，包含各种元素的 TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False）。
CanineForTokenClassification 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, 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 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，用于诸如 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 ) → QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于 句子 A 的标记，
- 1 对应于 句子 B 的标记。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这会很有用。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 Token 分类损失的标注跨度（span）起始位置（索引）标签。位置会被截断至序列长度（sequence_length）。序列之外的位置不会被计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算 Token 分类损失的标注跨度（span）结束位置（索引）标签。位置会被截断至序列长度（sequence_length）。序列之外的位置不会被计入损失计算。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 对象而不是普通的元组。
返回
QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 QuestionAnsweringModelOutput 对象或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（CanineConfig）和输入包含各种元素。
CanineForQuestionAnswering 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, 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)
...