YOSO模型在You Only Sample (Almost) Once: Linear Cost Self-Attention Via Bernoulli Sampling中提出
由Zhanpeng Zeng、Yunyang Xiong、Sathya N. Ravi、Shailesh Acharya、Glenn Fung和Vikas Singh提出。YOSO通过基于局部敏感哈希（LSH）的伯努利抽样方案来近似标准的softmax自注意力。原则上，所有的伯努利随机变量可以用单个哈希值进行采样。
论文的摘要如下
基于变压器的模型在自然语言处理（NLP）中得到广泛应用。变换器模型的核心是自注意力机制，它捕捉输入序列中标记对之间的交互，其复杂度与序列长度呈二次关系。在较长的序列上训练这种模型代价很高。在本文中，我们展示了基于局部敏感哈希（LSH）的伯努利采样注意力机制，将这种模型的二次复杂度降低到线性。我们通过将自注意力视为与伯努利随机变量相关的单个标记之和来规避二次成本，这些随机变量原则上可以通过单个散列一次性抽取（尽管在实践中，这个数字可能是一个小的常数）。这导致了一种有效的采样方案来估计自注意力，该方案依赖于LSH的特定修改（以使GPU架构上的部署成为可能）。我们在具有标准512序列长度的GLUE基准上评估了我们的算法，与标准预训练变换器相比，我们看到了有利的性能。在长序列评估基准（LRA）上，我们的方法取得了与softmax自注意力一致的结果，但速度更快，内存节省更多，并且通常优于其他高效的自注意力方法。我们的代码可在以下https URL找到
使用技巧
- YOSO注意力算法通过自定义CUDA内核实现，这些内核是可以在GPU上并行执行的CUDA C++函数。
- 内核提供了一个
fast_hash函数，该函数使用快速哈达玛变换近似查询和键的随机投影。使用这些哈希代码，lsh_cumulation函数通过基于LSH的伯努利采样近似自注意力。 - 要使用自定义内核，用户应设置
config.use_expectation = False。为确保内核成功编译，用户必须安装正确的PyTorch和cudatoolkit版本。默认情况下，config.use_expectation = True，这会使用YOSO-E，并不需要编译CUDA内核。
YOSO注意力算法。摘自原始论文。资源
YosoConfig
类 transformers.YosoConfig
< source >( 词汇大小 = 50265 隐藏层大小 = 768 隐藏层数量 = 12 注意力头数量 = 12 中间层大小 = 3072 隐藏层激活函数 = 'gelu' 隐藏层dropout概率 = 0.1 注意力dropout概率 = 0.1 最大位置嵌入 = 4096 类型词汇大小 = 1 初始化范围 = 0.02 层归一化epsilon = 1e-12 位置嵌入类型 = 'absolute' 使用期望 = True 哈希码长度 = 9 哈希数量 = 64 卷积窗口 = None 使用快速哈希 = True 反向局部敏感哈希 = True 填充令牌ID = 1 开始令牌ID = 0 结束令牌ID = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 50265) — YOSO 模型的词汇表大小。定义了在调用 YosoModel 时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或function，可选，默认值为"gelu"）—— 编码器和池器中使用的非线性激活函数（函数或字符串）。如果为字符串，则支持“gelu”、“relu”、“selu”和“gelu_new”。 - hidden_dropout_prob （
float，可选，默认值为0.1）—— 嵌入、编码器和池器中所有全连接层的dropout概率。 - attention_probs_dropout_prob (
float, 可选，默认为0.1) — 注意力概率的dropout比率。 - max_position_embeddings (
int, 可选，默认为512) — 该模型可能使用的最大序列长度。通常设置得较大以防万一（例如，512或1024或2048）。 - type_vocab_size (
int, 可选，默认为2) — 在调用YosoModel时传递的token_type_ids的词汇表大小。 - initializer_range (
float, 可选, 默认值为0.02) — 用于初始化所有权重矩阵的截断正态初始值的标准差。 - layer_norm_eps (
float, 可选, 默认值为1e-12) — 层归一化层所使用的epsilon值。 - position_embedding_type (
str, 可选, 默认值为"absolute") — 位置嵌入的类型。选择以下之一："absolute"，"relative_key"，"relative_key_query"。 - use_expectation (
bool, 可选, 默认值为True) — 是否使用YOSO Expectation。覆盖num_hash的任何影响。 - hash_code_len (
int, 可选, 默认为 9) — 由哈希函数生成的哈希长度。 - num_hash (
int, 可选, 默认为 64) — 在YosoSelfAttention中使用的哈希函数数量。 - conv_window (
int, 可选) — 深度卷积的内核大小。 - use_fast_hash (
bool, 可选, 默认为False) — 是否使用自定义 CUDA 内核，通过 hadamard 变换执行快速随机投影。 - lsh_backward (
bool, 可选, 默认为True) — 是否使用局部敏感哈希进行反向传播。
这是用于存储 YosoModel 配置的配置类。它用于根据指定的参数实例化 YOSO 模型，定义模型架构。以默认值实例化配置将得到一个与 YOSO uw-madison/yoso-4096 架构相似的配置。
配置对象继承自 PretrainedConfig，并可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 文档。
示例
>>> from transformers import YosoConfig, YosoModel
>>> # Initializing a YOSO uw-madison/yoso-4096 style configuration
>>> configuration = YosoConfig()
>>> # Initializing a model (with random weights) from the uw-madison/yoso-4096 style configuration
>>> model = YosoModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configYosoModel
类 transformers.YosoModel
< source >( config )
参数
- config (YosoConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。请查看 from_pretrained() 方法以加载模型权重。
仅输出原始隐藏状态而不具有任何特定头的裸 YOSO 模型转换器。该模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并查阅 PyTorch 文档，获取所有与一般用途和行为相关的信息。
forward
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) —词汇表中的输入序列标记的索引。可以使用 AutoTokenizer 获取索引。请参阅PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) —用于避免在填充标记索引上进行注意力的掩码。掩码值取自[0, 1]:- 1 对应于未掩码的标记，
- 0 对应于掩码的标记。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) —段标记索引以指示输入的第一第二部分。索引取自[0, 1]:- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择的范围在[0, config.max_position_embeddings - 1]之间。 - head_mask (
torch.FloatTensorof shape(num_heads,)or(num_layers, num_heads), 可选) — 用于取消自我注意力模块中选定头部的屏蔽。屏蔽值在[0, 1]之间：- 1表示头部未被屏蔽，
- 0表示头部被屏蔽。
- inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), 可选) — 也可以直接传递嵌入表示，而不是传递《input_ids》。这在您想比模型内部的嵌入查找矩阵有更多控制权时很有用，来将《input_ids》索引转换为相关的向量。
返回
-
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果没有嵌入层，则为嵌入层的输出 + 每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出后的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力软化的注意力权重，用于在自注意头中计算加权的平均。
-
cross_attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True和config.add_cross_attention=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。解码器交叉注意力层在注意力软化后的注意力权重，用于在交叉注意头中计算加权的平均。
YosoModel 前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的配方，但在以后应调用 Module 实例而不是此函数，因为前者负责运行预和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, YosoModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoModel.from_pretrained("uw-madison/yoso-4096")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateYosoForMaskedLM
class transformers.YosoForMaskedLM
< source >( config )
参数
- 配置 (YosoConfig) — 带有所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
顶部带有关键词填充建模（language modeling）模块的YOSO模型。该模型是PyTorch的torch.nn.Module子类。将其作为一个常规的PyTorch模块使用，有关一般使用和行为的相关问题，请参阅PyTorch文档。
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 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor的形状为(batch_size, sequence_length)) — 输入序列中词汇的索引。索引可以通过 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 用于防止在填充token索引上执行关注的掩码。选定的掩码值在[0, 1]范围内：- 1 代表 未掩码 的token,
- 0 代表 掩码 的token。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 段token索引，用于指示输入的第一和第二部分。索引选择在[0, 1]范围内：- 0 对应于 句子A token,
- 1 对应于 句子B token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 每个输入序列token在位置嵌入中的索引。选择范围在[0, config.max_position_embeddings - 1]内。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多细节请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor的形状为(batch_size, sequence_length), 可选) — 用于计算 masked language modeling (MLM) 损失的标签。索引应在[-100, 0, ..., config.vocab_size]范围内（参见input_ids的说明）。索引设置为-100的标记将被忽略（被遮蔽），损失只对带有标签的标记[0, ..., config.vocab_size]进行计算。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.MaskedLMOutput 或一个包含多个元素元组 torch.FloatTensor（如果传递了 return_dict=False 或当 config.return_dict=False）的 tuple，这些元素取决于配置（YosoConfig）和输入。
-
loss （
torch.FloatTensor形状为(1,), 可选，当labels被提供时返回）— 标记语言模型 (MLM) 损失。 -
logits（《code》torch.FloatTensor《code》形状
(batch_size, sequence_length, config.vocab_size)）—— 语言模型头的预测分数（SoftMax前的每个词汇单元的分数）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果没有嵌入层，则为嵌入层的输出 + 每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出后的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力软化的注意力权重，用于在自注意头中计算加权的平均。
YosoForMaskedLM的前向方法，覆盖了__call__特殊方法。
尽管需要在此函数中定义前向传递的配方，但在以后应调用 Module 实例而不是此函数，因为前者负责运行预和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, YosoForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoForMaskedLM.from_pretrained("uw-madison/yoso-4096")
>>> 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)YosoForSequenceClassification
类 transformers.YosoForSequenceClassification
< source >( config )
参数
- config（《a》YosoConfig（《a》）—— 包含模型所有参数的模型配置类。使用配置文件初始化时不会加载与模型关联的权重，只有配置。请查看from_pretrained()方法以加载模型权重。
带有序列分类/回归头（在池化输出之上的一层线性层）的YOSO模型（用于GLUE任务等）。这是一个PyTorch torch.nn.Module子类。将其用作常规PyTorch模块，并参阅PyTorch文档了解有关通用使用和行为的所有相关内容。
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.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, 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, sequence_length)，可选) — 用于指示输入的两个部分的段词元索引。索引选择在[0, 1]：- 0 对应于 句子 A 词元，
- 1 对应于 句子 B 词元。
- position_ids（
torch.LongTensor维度(batch_size, sequence_length)，可选）— 每个输入序列令牌的位置索引在位置嵌入中的位置。在范围内选择[0, config.max_position_embeddings - 1]。 - 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.LongTensorof shape(batch_size,), optional) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.SequenceClassifierOutput 或一个元组，包含 torch.FloatTensor (如果传递了 return_dict=False 或当 config.return_dict=False 时)，它包含根据配置（YosoConfig）和输入的不同元素。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供labels时返回) — 分类（或回归，如果 config.num_labels==1）损失。 -
logits (
torch.FloatTensorof 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时返回) —torch.FloatTensor元组（如果没有嵌入层，则为嵌入层的输出 + 每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出后的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力软化的注意力权重，用于在自注意头中计算加权的平均。
YosoForSequenceClassification 前向方法覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的配方，但在以后应调用 Module 实例而不是此函数，因为前者负责运行预和后处理步骤，而后者则默默地忽略它们。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, YosoForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoForSequenceClassification.from_pretrained("uw-madison/yoso-4096")
>>> 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 = YosoForSequenceClassification.from_pretrained("uw-madison/yoso-4096", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, YosoForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoForSequenceClassification.from_pretrained("uw-madison/yoso-4096", 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 = YosoForSequenceClassification.from_pretrained(
... "uw-madison/yoso-4096", 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).lossYosoForMultipleChoice
class transformers.YosoForMultipleChoice
< source >( config )
参数
- config (YosoConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型的相关权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。
YOSO 模型顶部具有多选分类头（在池化输出上方的线性层和 softmax）。例如，用于 RocStories/SWAG 任务。此模型是 PyTorch 的torch.nn.Module子类。将其用作常规 PyTorch 模块，并查阅 PyTorch 文档以了解所有与通用使用和行为相关的事项。
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.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, num_choices, sequence_length)) — 输入序列标记的词汇表索引。索引可以使用 AutoTokenizer 获取。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask （形状为
(batch_size, num_choices, sequence_length)的torch.FloatTensor，可选） — 用于避免对填充token索引执行注意力的掩码。选择掩码值在[0, 1]范围内：- 1 对应未掩码的token，
- 0 对应掩码的token。
- token_type_ids （形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选） — 指示输入的第一部分和第二部分的分词索引。选择范围在[0, 1]内：- 0 对应句子 A 的 token，
- 1 对应句子 B 的 token。
- position_ids （形状为
(batch_size, num_choices, sequence_length)的torch.LongTensor，可选） — 每个输入序列token的位置索引。选择范围在[0, config.max_position_embeddings - 1]之间。 - 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），包含依赖配置（YosoConfig）和输入的各种元素。
-
loss (
torch.FloatTensor，形状为 (1,)，可选，当提供labels时返回) — 分类损失。 -
logits (
torch.FloatTensor，形状为(batch_size, num_choices)) — num_choices 是输入张量第二维的大小。（参见上方的 input_ids）分类得分（在 SoftMax 之前）。
-
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果没有嵌入层，则为嵌入层的输出 + 每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出后的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力软化的注意力权重，用于在自注意头中计算加权的平均。
YosoForMultipleChoice 的前向方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的配方，但在以后应调用 Module 实例而不是此函数，因为前者负责运行预和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, YosoForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoForMultipleChoice.from_pretrained("uw-madison/yoso-4096")
>>> 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.logitsYosoForTokenClassification
类 transformers.YosoForTokenClassification
< 来源 >( config )
参数
- config (YosoConfig) — 包含模型所有参数的模型配置类。用配置文件初始化时不会加载模型相关的权重，只加载配置。检查from_pretrained()方法以加载模型权重。
在顶部带有标记分类头（在隐藏状态输出之上的线性层）的YOSO模型，例如用于命名实体识别（NER）任务。此模型是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档了解所有有关通用用途和行为的内容。
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.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中的输入序列标记索引。索引可以通过使用 AutoTokenizer 获取。有关详细信息，请参阅PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]之间:- 1 对应于 未屏蔽 的标记,
- 0 对应于 屏蔽 的标记。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 分段标记索引以指示输入的第一和第二部分。索引选择在[0, 1]之间:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 每个输入序列中token位置的索引。在选择范围内[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensorof shape(num_heads,)or(num_layers, num_heads), optional) —posable to nullify selected heads of the self-attention modules. Mask values selected in[0, 1]:- 1 indicates the head is not masked,
- 0 indicates the head is masked.
- inputs_embeds (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 有选择地，你可以直接传递嵌入式表示，而不是传递input_ids。这在你想比模型的内部嵌入查找矩阵有更多控制权来将input_ids索引转换为相关向量时很有用。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。更多详情见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。更多详情见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回ModelOutput而不是普通的元组。 - labels (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 计算标记分类损失的标签。索引应在[0, ..., config.num_labels - 1]之间。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.TokenClassifierOutput 或一个包含 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False），取决于配置（YosoConfig）和输入。
-
loss (
torch.FloatTensorof shape(1,), optional, 当提供了labels时返回) — 分类损失。 -
logits (
torch.FloatTensorof shape(batch_size, sequence_length, config.num_labels)) — 分类得分（在 SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果没有嵌入层，则为嵌入层的输出 + 每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出后的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力软化的注意力权重，用于在自注意头中计算加权的平均。
YosoForTokenClassification 的前进方法，覆盖了 __call__ 特殊方法。
尽管需要在此函数中定义前向传递的配方，但在以后应调用 Module 实例而不是此函数，因为前者负责运行预和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, YosoForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoForTokenClassification.from_pretrained("uw-madison/yoso-4096")
>>> 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).lossYosoForQuestionAnswering
类 transformers.YosoForQuestionAnswering
< source >( config )
参数
- config (YosoConfig) — 模型配置类，包含所有模型参数。使用配置文件初始化时，不会加载模型相关的权重，只有配置。请检查from_pretrained()方法来加载模型权重。
YOSO模型，在顶部添加了跨度分类的头，用于SQuAD（例如）的提取式问答任务（在隐藏状态输出之上使用线性层计算跨度起始对数和跨度结束对数）。这是一个PyTorchtorch.nn.Module子类。将其用作普通PyTorch模块，并参考PyTorch文档以了解所有与通用使用和行为相关的内容。
forward
< 源代码 >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None start_positions: 可选 = None end_positions: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensorof shape(batch_size, sequence_length), optional) — 避免在填充token索引上进行注意力的掩码。掩码值选自[0, 1]：- 1 表示没有被掩码的token，
- 0 表示被掩码的token。
- token_type_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 用于指明输入的第一部分和第二部分的token段索引。索引选自[0, 1]：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.LongTensorof shape(batch_size, sequence_length), optional) — 每个输入序列token的其在位置嵌入中的索引。选择范围在[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensor形状(num_heads,)或(num_layers, num_heads)，可选) — 取消所选自注意力模块的头部的掩码。掩码值选在[0, 1]：- 1 表示头部 未掩码，
- 0 表示头部 掩码。
- inputs_embeds (
torch.FloatTensor形状(batch_size, sequence_length, hidden_size)，可选) — 可选择直接传递嵌入式表示，而不是传递input_ids。这在您想要比模型内部的嵌入查找矩阵有更多控制权来转换 input_ids 索引到相关向量时非常有用。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否以ModelOutput的形式返回而非普通元组。 - start_positions (
torch.LongTensor形状为(batch_size,), 可选) — 标记段的起始位置（索引）的标签，用于计算标记分类损失。位置将被限制为序列长度（sequence_length）。序列之外的位置不用于计算损失。 - end_positions (
torch.LongTensorof shape(batch_size,), optional) — 标记段末尾位置（索引）的标签，用于计算token分类损失。位置限制在序列长度（sequence_length）之内。序列之外的位弛不会用于计算损失。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个torch.FloatTensor的元组（如果return_dict=False被传递或当config.return_dict=False），包括的各种元素取决于配置（YosoConfig）和输入。
-
loss (
torch.FloatTensorof shape(1,), optional, returned whenlabelsis provided) — 总的段提取损失是开始和结束位置的交叉熵之和。 -
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), 可选，当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor元组（如果没有嵌入层，则为嵌入层的输出 + 每层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出后的隐藏状态以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor), 可选，当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力软化的注意力权重，用于在自注意头中计算加权的平均。
YosoForQuestionAnswering的forward方法覆盖了__call__特殊方法。
尽管需要在此函数中定义前向传递的配方，但在以后应调用 Module 实例而不是此函数，因为前者负责运行预和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, YosoForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("uw-madison/yoso-4096")
>>> model = YosoForQuestionAnswering.from_pretrained("uw-madison/yoso-4096")
>>> 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]
>>> # 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