Transformers 4.37 中文文档(六十四)(1)https://developer.aliyun.com/article/1564123
YosoForMultipleChoice
class transformers.YosoForMultipleChoice
( config )
参数
config(YosoConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重,只会加载配置。查看 from_pretrained()方法以加载模型权重。
YOSO 模型在顶部具有多选分类头(池化输出上的线性层和 softmax),例如用于 RocStories/SWAG 任务。此模型是 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以获取有关一般用法和行为的所有信息。
forward
( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.MultipleChoiceModelOutput or tuple(torch.FloatTensor)
参数
input_ids(形状为(batch_size, num_choices, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。
可以使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
输入 ID 是什么?attention_mask(形状为(batch_size, num_choices, 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 是什么?head_mask(形状为(num_heads,)或(num_layers, num_heads)的torch.FloatTensor,可选)— 用于使自注意力模块中选择的头部失效的掩码。掩码值选在[0, 1]之间:
- 1 表示头部未被遮蔽,
- 0 表示头部被遮蔽。
inputs_embeds(形状为(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor,可选)— 可选地,可以直接传递嵌入表示,而不是传递input_ids。如果您想要更多控制权来将input_ids索引转换为相关向量,这将非常有用,而不是使用模型的内部嵌入查找矩阵。output_attentions(bool,可选)— 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions。output_hidden_states(bool,可选)— 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量下的hidden_states。return_dict(bool,可选)— 是否返回一个 ModelOutput 而不是一个普通的元组。labels(形状为(batch_size,)的torch.LongTensor,可选)— 用于计算多项选择分类损失的标签。索引应在[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(形状为*(1,)*的torch.FloatTensor,可选,当提供labels时返回)— 分类损失。logits(形状为(batch_size, num_choices)的torch.FloatTensor)— 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 之后的注意力权重,用于计算自注意力头中的加权平均值。
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.logits
YosoForTokenClassification
class transformers.YosoForTokenClassification
( config )
参数
config(YosoConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只加载配置。查看 from_pretrained()方法加载模型权重。
YOSO 模型,顶部带有一个标记分类头(隐藏状态输出顶部的线性层),例如用于命名实体识别(NER)任务。此模型是 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以获取与一般用法和行为相关的所有事项。
forward
( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.TokenClassifierOutput or 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.max_position_embeddings - 1]中选择。
什么是位置 ID?head_mask(torch.FloatTensorof shape(num_heads,)or(num_layers, num_heads), optional) — 用于使自注意力模块中的选定头部失效的掩码。掩码值选定在[0, 1]之间:
- 1 表示头部未被掩码,
- 0 表示头部被掩码。
inputs_embeds(torch.FloatTensorof shape(batch_size, sequence_length, hidden_size), optional) — 可选地,可以直接传递嵌入表示,而不是传递input_ids。如果您想要更多控制如何将input_ids索引转换为相关向量,而不是使用模型的内部嵌入查找矩阵,这将非常有用。output_attentions(bool, optional) — 是否返回所有注意力层的注意力张量。有关更多细节,请参阅返回张量下的attentions。output_hidden_states(bool, optional) — 是否返回所有层的隐藏状态。有关更多细节,请参阅返回张量下的hidden_states。return_dict(bool, optional) — 是否返回一个 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), 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 后的注意力权重,用于计算自注意力头中的加权平均值。
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).loss
YosoForQuestionAnswering
class transformers.YosoForQuestionAnswering
( config )
参数
config(YosoConfig)-模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重,只加载配置。查看 from_pretrained()方法以加载模型权重。
YOSO 模型在顶部具有用于提取问答任务(如 SQuAD)的跨度分类头(在隐藏状态输出顶部的线性层上计算span start logits和span end logits)。此模型是 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档以获取与一般用法和行为相关的所有事项。
forward
( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.QuestionAnsweringModelOutput or 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]中选择:
- 对于被
masked的令牌,为 1, - 对于被
masked的令牌,为 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.max_position_embeddings - 1]中选择。
什么是位置 ID?head_mask(形状为(num_heads,)或(num_layers, num_heads)的torch.FloatTensor,可选)-用于使自注意力模块的选定头部无效的掩码。掩码值在[0, 1]中选择:
- 1 表示头部未被
masked, - 0 表示头部被
masked。
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 而不是普通元组。start_positions(torch.LongTensor,形状为(batch_size,),可选) — 用于计算标记跨度起始位置的位置(索引)标签,以计算标记分类损失。位置被夹紧到序列的长度(sequence_length)。超出序列范围的位置不会被考虑在内计算损失。end_positions(torch.LongTensor,形状为(batch_size,),可选) — 用于计算标记跨度结束位置的位置(索引)标签。位置被夹紧到序列的长度(sequence_length)。超出序列范围的位置不会被考虑在内计算损失。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.QuestionAnsweringModelOutput 或一个torch.FloatTensor元组(如果传递return_dict=False或config.return_dict=False)包含根据配置(YosoConfig)和输入的不同元素。
loss(torch.FloatTensor,形状为(1,),可选,当提供labels时返回) — 总跨度抽取损失是起始和结束位置的交叉熵之和。start_logits(torch.FloatTensor,形状为(batch_size, sequence_length)) — 跨度起始得分(SoftMax 之前)。end_logits(torch.FloatTensor,形状为(batch_size, sequence_length)) — 跨度结束得分(SoftMax 之前)。hidden_states(tuple(torch.FloatTensor),可选,当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(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 后的注意力权重,用于计算自注意力头中的加权平均值。
YosoForQuestionAnswering 前向方法,覆盖了__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
Transformers 4.37 中文文档(六十四)(3)https://developer.aliyun.com/article/1564125