Transformers

( vocab_size = 30522 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 = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 0 embedding_size = 768 q_groups = 4 k_groups = 4 v_groups = 4 post_attention_groups = 1 intermediate_groups = 4 output_groups = 4 **kwargs )

参数

vocab_size (int, 可选, 默认 30522) — SqueezeBERT模型的词汇大小。定义在调用SqueezeBertModel时可以通过inputs_ids传递的不同标记的数量。
hidden_size (int, 可选, 默认为 768) — 编码层和池化层的空间维度。
num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层中的注意力头数。
intermediate_size (int, 可选, 默认为 3072) — Transformer 编码器中“中间”层（通常称为前馈）的维度。
hidden_act (str 或 Callable，可选，默认为 "gelu") — 编码器和池器中的非线性激活函数（函数或字符串）。如果是字符串，支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
hidden_dropout_prob (float，可选，默认为 0.1) — 嵌入、编码器、池器中所有全连接层的dropout概率。
attention_probs_dropout_prob (float，可选，默认为 0.1) — 注意力概率的dropout比例。
max_position_embeddings (int, optional, defaults to 512) — 该模型可以使用的最大序列长度。通常为了安全起见，将其设置为较大的数值（例如，512或1024或2048）。
type_vocab_size (int, optional, defaults to 2) — 在调用 BertModel 或 TFBertModel 时传递的 token_type_ids 的词汇量大小。
initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。
layer_norm_eps (float, 可选, 默认为 1e-12) —
pad_token_id (int, 可选, 默认为 0) — 用于填充的单词嵌入中的标记ID。
embedding_size (int, 可选, 默认为 768) — 单词嵌入向量的维度。
q_groups (int, 可选, 默认为 4) — Q层的组数。
k_groups (int, 可选, 默认为4) — K层的组数。
v_groups (int, 可选, 默认为4) — V层的组数。
post_attention_groups (int, 可选, 默认为1) — 第一个前馈网络层的组数。
intermediate_groups (int, 可选, 默认为4) — 第二个前馈网络层的组数。
output_groups (int, 可选, 默认为 4) — 第三个前馈网络层的组数。

这是用于存储 SqueezeBertModel 配置的配置类。它用于根据指定的参数实例化 SqueezeBERT 模型，定义模型架构。使用默认值实例化配置会得到与 SqueezeBERT squeezebert/squeezebert-uncased 架构相似的配置。

配置对象继承自 PretrainedConfig 并可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 的文档。

示例

>>> from transformers import SqueezeBertConfig, SqueezeBertModel

>>> # Initializing a SqueezeBERT configuration
>>> configuration = SqueezeBertConfig()

>>> # Initializing a model (with random weights) from the configuration above
>>> model = SqueezeBertModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

SqueezeBertTokenizer

类 transformers.SqueezeBertTokenizer

< 源码 >

( vocab_file do_lower_case = True do_basic_tokenize = True never_split = None unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )

参数

vocab_file (str) — 包含词汇表的文件。
do_lower_case (bool, 可选, 默认为 True) — 在分词时是否将输入转成小写。
do_basic_tokenize (bool, optional, defaults to True) — 是否在WordPiece之前进行基本标记。
never_split (Iterable, optional) — 在标记过程中不会分裂的标记集合。只有当do_basic_tokenize=True时才有效。
unk_token (str, optional, defaults to "[UNK]") — 代表未知标记。不在词表中的标记不能转为ID，而是设置为这个标记。
sep_token (str, 可选，默认为 "[SEP]") — 序列分隔符，用于将多个序列（例如，用于序列分类的两个序列或用于问答的文本和问题）组合成一个序列时使用。它还用作使用特殊标记构建的序列的最后一个标记。
pad_token (str, 可选，默认为 "[PAD]") — 用于填充的标记，例如在批处理不同长度的序列时使用。
cls_token (str, 可选，默认为 "[CLS]") — 用来做序列分类时的分类标记，详情请参阅使用特殊标记构建序列时。这是序列中的第一个标记。
mask_token (str, 可选，默认为 "[MASK]") —— 用作遮蔽的标记。这是在用遮蔽语言建模训练此模型时使用的标记。这是模型将尝试预测的标记。
tokenize_chinese_chars (bool, 可选，默认为 True) —— 是否对中文字符进行分词。
此选项应针对日文不启用（参见此问题）。
strip_accents (bool, 可选) —— 是否删除所有重音符号。如果没有指定此选项，则将根据 lowercase 的值确定（如原始 SqueezeBERT 中所示）。

构建一个 SqueezeBERT 分词器。基于 WordPiece。

此分词器继承自 PreTrainedTokenizer，它包含大多数主要方法。用户应参考这个超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

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

参数

token_ids_0 (列表[int]) — 添加特殊标记的ID列表。
token_ids_1 (列表[int], 可选) — 可选的ID列表，用于序列对。

返回值

列表[int]

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

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

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

get_special_tokens_mask

( token_ids_0: 列表 token_ids_1: 可选 = None already_has_special_tokens: 布尔 ) → 列表[int]

参数

token_ids_0 (列表[int]) — ID 列表。
token_ids_1 (列表[int], 可选)) — 可选的第二个 ID 列表用于序列对。
already_has_special_tokens (bool, optional, defaults to False) — 是否将特殊标记格式化到标记列表中。

返回值

列表[int]

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

从未添加特殊标记的标记列表中检索序列 ID。此方法在使用标记化器 prepare_for_model 方法添加特殊标记时调用。

create_token_type_ids_from_sequences

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

参数

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

返回值

列表[int]

根据给定的序列创建的token类型ID列表。

从传递的两个序列创建一个掩码，用于序列成对分类任务。一个SqueezeBERT序列

对掩码格式如下

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

save_vocabulary

( save_directory: str filename_prefix: Optional = None )

SqueezeBertTokenizerFast

类 transformers.SqueezeBertTokenizerFast

( vocab_file = None tokenizer_file = None do_lower_case = True unk_token = '[UNK]' sep_token = '[SEP]' pad_token = '[PAD]' cls_token = '[CLS]' mask_token = '[MASK]' tokenize_chinese_chars = True strip_accents = None **kwargs )

参数

vocab_file (str) — 包含词汇的高斯文件。
do_lower_case (bool, 可选, 默认 True) — 在分词时是否将输入转换为小写。
unk_token (str, 可选, 默认 "[UNK]") — 未知标记。不在词汇表中的标记无法转换为ID，将被设置为该标记。
sep_token (str, 可选, 默认 "[SEP]") — 分隔符标记，用于将多个序列组合成一个序列时，例如序列分类或问答中的文本和问题。它还用作特殊标记构建的序列的最后标记。
pad_token (str, 可选，默认为 "[PAD]") — 用于填充的标记，例如在批量处理不同长度的序列时。
cls_token (str, 可选，默认为 "[CLS]") — 用于序列分类（整个序列的分类而不是按标记分类）的分类符标记。当通过特殊标记构建序列时，它是序列的第一个标记。
mask_token (str, 可选，默认为 "[MASK]") — 用于遮蔽值的标记。这是在训练此模型时使用遮蔽语言建模时使用的标记。这是模型将尝试预测的标记。
— 在分词之前是否对文本进行清理，移除所有控制字符，并将所有空白替换为经典样式。默认值为 True（是）。
— 是否对中文字符进行分词。对于日语，可能需要禁用此功能（见相关问题）。默认值为 True（是）。
— 是否去除所有重音符号。如果未指定此选项，则将根据 lowercase 的值进行确定（如原始 SqueezeBERT）。
wordpieces_prefix (str, 可选, 默认为 "##") — 子词的前缀。

构建一个快速的SqueezeBERT分词器（由HuggingFace的tokenizers库支持）。基于WordPiece。

此分词器继承自 PreTrainedTokenizerFast，其中包含大部分主要方法。用户应查阅此超类以获取有关这些方法的更多信息。

build_inputs_with_special_tokens

( token_ids_0 token_ids_1 = None ) → List[int]

参数

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

返回值

列表[int]

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

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

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

create_token_type_ids_from_sequences

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

参数

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

返回值

列表[int]

根据给定的序列创建的token类型ID列表。

从传递的两个序列创建一个掩码，用于序列成对分类任务。一个SqueezeBERT序列

对掩码格式如下

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

SqueezeBertModel

类 transformers.SqueezeBertModel

( config )

参数

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

直接输出原始隐藏状态而不添加任何特定头的裸SqueezeBERT模型转换器。

SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在SqueezeBERT：计算机视觉能够教NLP关于高效神经网络的什么？中提出。

此模型继承自PreTrainedModel。查看超类文档，了解库为所有模型实现的方法（如下载或保存、调整输入嵌入尺寸、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch模块使用，并参考PyTorch文档了解与通用使用和行为相关的事项。

为了在文本分类任务上微调SqueezeBERT获得最佳结果，建议以squeezebert/squeezebert-mnli-headless检查点作为起点。

层次结构

Internal class hierarchy:
SqueezeBertModel
    SqueezeBertEncoder
        SqueezeBertModule
        SqueezeBertSelfAttention
            ConvActivation
            ConvDropoutLayerNorm

数据布局

Input data is in [batch, sequence_length, hidden_size] format.

Data inside the encoder is in [batch, hidden_size, sequence_length] format. But, if `output_hidden_states == True`, the data from inside the encoder is returned in [batch, sequence_length, hidden_size] format.

The final output of the encoder is in [batch, sequence_length, hidden_size] format.

forward

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.BaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor of shape (batch_size, sequence_length)) — 输入序列中词汇的索引。

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

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

什么是位置 ID？
head_mask (torch.FloatTensor 的 shape 为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于取消选定自注意力模块选择的头的掩码。掩码值选择在 [0, 1]：
- 1 表示头部没有被掩码，
- 0 表示头部被掩码。
inputs_embeds (torch.FloatTensor 的 shape 为 (batch_size, sequence_length, hidden_size)，可选) — 可以直接传递嵌入表示，而不是传递 input_ids。这在您想要比模型的内部嵌入查找矩阵更多地控制如何将 input_ids 索引转换为相关向量时非常有用。
output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参考返回的张量中的hidden_states。
return_dict (bool, 可选) — 是否返回<a href="/docs/transformers/v4.44.0/en/main_classes/output#transformers.utils.ModelOutput">ModelOutput</a>而非纯元组。

返回值

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

一个transformers.modeling_outputs.BaseModelOutputWithPooling或一个包含torch.FloatTensor的元组（如果return_dict=False被传递或当config.return_dict=False时），这取决于配置（《SqueezeBertConfig》）和输入。

last_hidden_state （shape为(batch_size, sequence_length, hidden_size)的torch.FloatTensor） — 模型最后一层的输出序列隐藏状态。
pooler_output （shape为(batch_size, hidden_size)的torch.FloatTensor） — 经过用于辅助预训练任务的层进一步处理后的第一个token的最后一层隐藏状态（分类token）。例如，对于BERT系列模型，这表示通过一个线性层和一个tanh激活函数处理后返回的分类token。在线性层权重中，从预训练期间的下一个句子预测（分类）目标中训练得到。
hidden_states （tuple(torch.FloatTensor)，可选，当通过output_hidden_states=True或当config.output_hidden_states=True时返回） — 一个形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入输出的输出，再加上每一层的输出）。

在每个层的输出加上可选的初始嵌入输出处的模型隐藏状态。
attentions （tuple(torch.FloatTensor)，可选，当通过output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor的元组（每个层一个）（用于计算自注意力头中的加权平均的自注意力权重）。

在注意力softmax后的注意力权重，用于计算各个自注意力头中的加权平均。

The SqueezeBertModel 的 forward 方法，重写了 __call__ 特殊方法。

尽管前向计算的配方需要在此函数内定义，但应该在此之后调用 Module 实例，而不是使用此方法，因为前者负责执行预处理和后处理步骤，而后者则默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, SqueezeBertModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertModel.from_pretrained("squeezebert/squeezebert-uncased")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

SqueezeBertForMaskedLM

class transformers.SqueezeBertForMaskedLM

( config )

参数

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

SqueezeBERT Model，顶部带有一个 language modeling 头。

SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在SqueezeBERT：计算机视觉能够教NLP关于高效神经网络的什么？中提出。

此模型继承自PreTrainedModel。查看超类文档，了解库为所有模型实现的方法（如下载或保存、调整输入嵌入尺寸、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch模块使用，并参考PyTorch文档了解与通用使用和行为相关的事项。

为了在文本分类任务上微调SqueezeBERT获得最佳结果，建议以squeezebert/squeezebert-mnli-headless检查点作为起点。

层次结构

Internal class hierarchy:
SqueezeBertModel
    SqueezeBertEncoder
        SqueezeBertModule
        SqueezeBertSelfAttention
            ConvActivation
            ConvDropoutLayerNorm

数据布局

Input data is in [batch, sequence_length, hidden_size] format.

Data inside the encoder is in [batch, hidden_size, sequence_length] format. But, if `output_hidden_states == True`, the data from inside the encoder is returned in [batch, sequence_length, hidden_size] format.

The final output of the encoder is in [batch, sequence_length, hidden_size] format.

forward

( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.MaskedLMOutput or tuple(torch.FloatTensor)

参数

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

索引可以通过 AutoTokenizer 获取。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。

什么是输入ID？
attention_mask （用于避免在填充标记索引上执行注意力的掩码，torch.FloatTensor形式，形状为(batch_size, sequence_length)，可选项）：
- 值为1表示未掩码标记，
- 值为0表示掩码标记。
什么是注意掩码？
token_type_ids （用于表示输入的第一部分和第二部分，形状为torch.LongTensor，形状为(batch_size, sequence_length)，可选项）：
- 值为0对应于“句子A”标记，
- 值为1对应于“句子B”标记。
什么是标记类型ID？
position_ids （每个输入序列标记在位置嵌入中的索引，形状为torch.LongTensor，形状为(batch_size, sequence_length)，可选项）：

什么是位置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, 可选) - 是否返回所有层的隐藏状态。请参阅返回张量中的
return_dict (bool, 可选) - 是否返回ModelOutput而不是普通元组。
labels (torch.LongTensor形状为(batch_size, sequence_length), 可选) - 用于计算掩码语言建模损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids的文档字符串）。索引设置为-100的标记将被忽略（掩码），损失只在具有标签的标记[0, ..., config.vocab_size]上计算。

返回值

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

一个transformers.modeling_outputs.MaskedLMOutput，或者当传递return_dict=False时为torch.FloatTensor的tuple（如果config.return_dict=False），它包含各种元素，这些元素取决于配置（SqueezeBertConfig）和输入。

loss (torch.FloatTensor形状为(1,), 可选，当提供labels时返回) - 掩码语言建模（MLM）损失。
logits (torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) - 语言建模头部的预测得分（SoftMax之前的每个词汇表标记的得分）。
hidden_states （tuple(torch.FloatTensor)，可选，当通过output_hidden_states=True或当config.output_hidden_states=True时返回） — 一个形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入输出的输出，再加上每一层的输出）。

在每个层的输出加上可选的初始嵌入输出处的模型隐藏状态。
attentions （tuple(torch.FloatTensor)，可选，当通过output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor的元组（每个层一个）（用于计算自注意力头中的加权平均的自注意力权重）。

在注意力softmax后的注意力权重，用于计算各个自注意力头中的加权平均。

《SqueezeBertForMaskedLM》的前向方法，重写了 __call__ 特殊方法。

示例

>>> from transformers import AutoTokenizer, SqueezeBertForMaskedLM
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForMaskedLM.from_pretrained("squeezebert/squeezebert-uncased")

>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> # retrieve index of [MASK]
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]

>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)

>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-[MASK] tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)

>>> outputs = model(**inputs, labels=labels)

SqueezeBertForSequenceClassification

类 transformers.SqueezeBertForSequenceClassification

( config )

参数

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

SqueezeBERT是一个具有序列分类/回归头（位于池化输出之上的线性层）的模型转换器，例如用于GLUE任务。

SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在SqueezeBERT：计算机视觉能够教NLP关于高效神经网络的什么？中提出。

此模型继承自PreTrainedModel。查看超类文档，了解库为所有模型实现的方法（如下载或保存、调整输入嵌入尺寸、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch模块使用，并参考PyTorch文档了解与通用使用和行为相关的事项。

为了在文本分类任务上微调SqueezeBERT获得最佳结果，建议以squeezebert/squeezebert-mnli-headless检查点作为起点。

层次结构

Internal class hierarchy:
SqueezeBertModel
    SqueezeBertEncoder
        SqueezeBertModule
        SqueezeBertSelfAttention
            ConvActivation
            ConvDropoutLayerNorm

数据布局

Input data is in [batch, sequence_length, hidden_size] format.

Data inside the encoder is in [batch, hidden_size, sequence_length] format. But, if `output_hidden_states == True`, the data from inside the encoder is returned in [batch, sequence_length, hidden_size] format.

The final output of the encoder is in [batch, sequence_length, hidden_size] format.

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 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 表示掩码的单词。
什么是注意力掩码?// HTML_TAG_END -->
—— HTML_TAG_START —>token_type_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 段落单词索引以指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
- 0 对应于 句子 A 单词，
- 1 对应于 句子 B 单词。
什么是token_type_ids?// HTML_TAG_END —>
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 of shape (batch_size,), optional) — 计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1]。如果 config.num_labels == 1，则计算回归损失（均方损失），如果 config.num_labels > 1，则计算分类损失（交叉熵）。

返回值

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

A transformers.modeling_outputs.SequenceClassifierOutput 或一个包含 torch.FloatTensor 的元组（如果 return_dict=False 被传递或当 config.return_dict=False）根据配置（SqueezeBertConfig）和输入元素的配置。

loss (torch.FloatTensor of shape (1,), optional, returned when labels is provided) — 分类（或回归，如果 config.num_labels==1）损失。
logits (torch.FloatTensor of shape (batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（SoftMax 之前）。
hidden_states （tuple(torch.FloatTensor)，可选，当通过output_hidden_states=True或当config.output_hidden_states=True时返回） — 一个形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入输出的输出，再加上每一层的输出）。

在每个层的输出加上可选的初始嵌入输出处的模型隐藏状态。
attentions （tuple(torch.FloatTensor)，可选，当通过output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor的元组（每个层一个）（用于计算自注意力头中的加权平均的自注意力权重）。

在注意力softmax后的注意力权重，用于计算各个自注意力头中的加权平均。

The SqueezeBertForSequenceClassification 前向方法覆盖了 __call__ 特殊方法。

单标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, SqueezeBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForSequenceClassification.from_pretrained("squeezebert/squeezebert-uncased")

>>> 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 = SqueezeBertForSequenceClassification.from_pretrained("squeezebert/squeezebert-uncased", num_labels=num_labels)

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

多标签分类示例

>>> import torch
>>> from transformers import AutoTokenizer, SqueezeBertForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForSequenceClassification.from_pretrained("squeezebert/squeezebert-uncased", 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 = SqueezeBertForSequenceClassification.from_pretrained(
...     "squeezebert/squeezebert-uncased", 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

SqueezeBertForMultipleChoice

class transformers.SqueezeBertForMultipleChoice

( config )

参数

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

SqueezeBERT 模型，上方有一个多选分类头（在池化输出之上添加一个线性层和一个 softmax 层），例如用于 RocStories/SWAG 任务。

SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在SqueezeBERT：计算机视觉能够教NLP关于高效神经网络的什么？中提出。

此模型继承自PreTrainedModel。查看超类文档，了解库为所有模型实现的方法（如下载或保存、调整输入嵌入尺寸、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch模块使用，并参考PyTorch文档了解与通用使用和行为相关的事项。

为了在文本分类任务上微调SqueezeBERT获得最佳结果，建议以squeezebert/squeezebert-mnli-headless检查点作为起点。

层次结构

Internal class hierarchy:
SqueezeBertModel
    SqueezeBertEncoder
        SqueezeBertModule
        SqueezeBertSelfAttention
            ConvActivation
            ConvDropoutLayerNorm

数据布局

Input data is in [batch, sequence_length, hidden_size] format.

Data inside the encoder is in [batch, hidden_size, sequence_length] format. But, if `output_hidden_states == True`, the data from inside the encoder is returned in [batch, sequence_length, hidden_size] format.

The final output of the encoder is in [batch, sequence_length, hidden_size] format.

forward

参数

input_ids (torch.LongTensor 的形状为 (批大小, 选项数, 序列长度)) — 输入序列标记索引的词汇表。

可以使用 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，你可以直接传递嵌入表示。如果你希望比模型内部的嵌入查找矩阵有更多控制权，将其索引转换为相关向量，则此操作很有用。
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），这些元素取决于配置（请参阅 SqueezeBertConfig）和输入。

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时返回） — 一个形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入输出的输出，再加上每一层的输出）。

在每个层的输出加上可选的初始嵌入输出处的模型隐藏状态。
attentions （tuple(torch.FloatTensor)，可选，当通过output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor的元组（每个层一个）（用于计算自注意力头中的加权平均的自注意力权重）。

在注意力softmax后的注意力权重，用于计算各个自注意力头中的加权平均。

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

示例

>>> from transformers import AutoTokenizer, SqueezeBertForMultipleChoice
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForMultipleChoice.from_pretrained("squeezebert/squeezebert-uncased")

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

SqueezeBertForTokenClassification

类 transformers.SqueezeBertForTokenClassification

< 源 >

( config )

参数

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

在顶部带有标记分类头部（位于隐藏状态输出之上的一层线性层）的 SqueezeBERT 模型，例如用于命名实体识别（NER）任务。

SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在SqueezeBERT：计算机视觉能够教NLP关于高效神经网络的什么？中提出。

此模型继承自PreTrainedModel。查看超类文档，了解库为所有模型实现的方法（如下载或保存、调整输入嵌入尺寸、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch模块使用，并参考PyTorch文档了解与通用使用和行为相关的事项。

为了在文本分类任务上微调SqueezeBERT获得最佳结果，建议以squeezebert/squeezebert-mnli-headless检查点作为起点。

层次结构

Internal class hierarchy:
SqueezeBertModel
    SqueezeBertEncoder
        SqueezeBertModule
        SqueezeBertSelfAttention
            ConvActivation
            ConvDropoutLayerNorm

数据布局

Input data is in [batch, sequence_length, hidden_size] format.

Data inside the encoder is in [batch, hidden_size, sequence_length] format. But, if `output_hidden_states == True`, the data from inside the encoder is returned in [batch, sequence_length, hidden_size] format.

The final output of the encoder is in [batch, sequence_length, hidden_size] format.

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 or tuple(torch.FloatTensor)

参数

attention_mask (torch.FloatTensor of shape (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)

A transformers.modeling_outputs.TokenClassifierOutput 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（SqueezeBertConfig）和输入包含各种元素。

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时返回） — 一个形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor的元组（如果模型有嵌入层，则包含嵌入输出的输出，再加上每一层的输出）。

在每个层的输出加上可选的初始嵌入输出处的模型隐藏状态。
attentions （tuple(torch.FloatTensor)，可选，当通过output_attentions=True或当config.output_attentions=True时返回） — 一个形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor的元组（每个层一个）（用于计算自注意力头中的加权平均的自注意力权重）。

在注意力softmax后的注意力权重，用于计算各个自注意力头中的加权平均。

SqueezeBertForTokenClassification 的前进方法覆盖了 __call__ 特别方法。

示例

>>> from transformers import AutoTokenizer, SqueezeBertForTokenClassification
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("squeezebert/squeezebert-uncased")
>>> model = SqueezeBertForTokenClassification.from_pretrained("squeezebert/squeezebert-uncased")

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

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

SqueezeBertForQuestionAnswering

类 transformers.SqueezeBertForQuestionAnswering

( config )

参数

配置 (SqueezeBertConfig) — 包含所有参数的模型配置类。使用配置文件初始化不会加载模型关联的权重，仅加载配置。有关加载模型权重的信息，请参阅 from_pretrained() 方法。

SqueezeBERT模型在顶部添加了一个用于SQuAD（extractive question-answering任务）的跨度分类头。

SqueezeBERT模型由Forrest N. Iandola、Albert E. Shaw、Ravi Krishna和Kurt W. Keutzer在SqueezeBERT：计算机视觉能够教NLP关于高效神经网络的什么？中提出。

此模型继承自PreTrainedModel。查看超类文档，了解库为所有模型实现的方法（如下载或保存、调整输入嵌入尺寸、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其作为常规PyTorch模块使用，并参考PyTorch文档了解与通用使用和行为相关的事项。

为了在文本分类任务上微调SqueezeBERT获得最佳结果，建议以squeezebert/squeezebert-mnli-headless检查点作为起点。

层次结构

Internal class hierarchy:
SqueezeBertModel
    SqueezeBertEncoder
        SqueezeBertModule
        SqueezeBertSelfAttention
            ConvActivation
            ConvDropoutLayerNorm

数据布局

Input data is in [batch, sequence_length, hidden_size] format.

Data inside the encoder is in [batch, hidden_size, sequence_length] format. But, if `output_hidden_states == True`, the data from inside the encoder is returned in [batch, sequence_length, hidden_size] format.

The final output of the encoder is in [batch, sequence_length, hidden_size] format.

forward