OPT
原文链接：
huggingface.co/docs/transformers/v4.37.2/en/model_doc/opt
概述
OPT 模型是由 Meta AI 在Open Pre-trained Transformer Language Models中提出的。OPT 是一系列开源的大型因果语言模型，性能与 GPT3 相似。
该论文的摘要如下：
大型语言模型通常经过数十万计算天的训练，展现出了零次和少次学习的显著能力。考虑到它们的计算成本，这些模型很难在没有重大资本的情况下复制。对于那些通过 API 可用的模型，没有提供完整模型权重的访问权限，这使得它们难以研究。我们提出了 Open Pre-trained Transformers (OPT)，这是一套仅包含解码器的预训练 transformers，参数范围从 125M 到 175B，我们希望与感兴趣的研究人员充分和负责任地分享。我们展示了 OPT-175B 与 GPT-3 相当，但只需要 1/7 的碳足迹来开发。我们还发布了详细记录我们面临的基础设施挑战的日志，以及用于尝试所有发布模型的代码。
该模型由Arthur Zucker、Younes Belkada和Patrick Von Platen贡献。原始代码可以在这里找到。
提示：
- OPT 具有与
BartDecoder相同的架构。 - 与 GPT2 相反，OPT 在每个提示的开头添加了 EOS 标记。
资源
一个官方的 Hugging Face 和社区（由🌎表示）资源列表，可帮助您开始使用 OPT。如果您有兴趣提交资源以包含在此处，请随时提出拉取请求，我们将进行审查。资源应该理想地展示一些新内容，而不是重复现有资源。
文本生成
- 一个关于使用 PEFT、bitsandbytes 和 Transformers 进行微调 OPT 的笔记本。🌎
- 一篇关于使用 OPT 的解码策略的博客文章。
- 🤗 Hugging Face 课程中的因果语言建模章节。
- OPTForCausalLM 由这个因果语言建模示例脚本和笔记本支持。
- TFOPTForCausalLM 由这个因果语言建模示例脚本和笔记本支持。
- FlaxOPTForCausalLM 由这个因果语言建模示例脚本支持。
文本分类
问答
- OPTForQuestionAnswering 可以通过这个问答示例脚本和笔记本来支持。
- 🤗 Hugging Face 课程中的问答章节。
⚡️ 推理
- 关于如何通过 PyTorch 实现🤗加速运行非常大模型的博客文章。
结合 OPT 和 Flash Attention 2
首先确保安装最新版本的 Flash Attention 2，以包括滑动窗口注意力特性。
pip install -U flash-attn --no-build-isolation
还要确保您有与 Flash-Attention 2 兼容的硬件。在 flash-attn 存储库的官方文档中了解更多信息。还要确保以半精度加载模型（例如`torch.float16“）。
要加载和运行使用 Flash Attention 2 的模型，请参考下面的代码片段：
>>> import torch >>> from transformers import OPTForCausalLM, GPT2Tokenizer >>> device = "cuda" # the device to load the model onto >>> model = OPTForCausalLM.from_pretrained("facebook/opt-350m", torch_dtype=torch.float16, attn_implementation="flash_attention_2") >>> tokenizer = GPT2Tokenizer.from_pretrained("facebook/opt-350m") >>> prompt = ("A chat between a curious human and the Statue of Liberty.\n\nHuman: What is your name?\nStatue: I am the " "Statue of Liberty.\nHuman: Where do you live?\nStatue: New York City.\nHuman: How long have you lived " "there?") >>> model_inputs = tokenizer([prompt], return_tensors="pt").to(device) >>> model.to(device) >>> generated_ids = model.generate(**model_inputs, max_new_tokens=30, do_sample=False) >>> tokenizer.batch_decode(generated_ids)[0] '</s>A chat between a curious human and the Statue of Liberty.\n\nHuman: What is your name?\nStatue: I am the Statue of Liberty.\nHuman: Where do you live?\nStatue: New York City.\nHuman: How long have you lived there?\nStatue: I have lived here for about a year.\nHuman: What is your favorite place to eat?\nStatue: I love'
预期的加速
下面是一个预期的加速图，比较了在 transformers 中使用facebook/opt-2.7b检查点和 Flash Attention 2 模型的纯推理时间之间的差异，使用了两种不同的序列长度。
下面是一个预期的加速图，比较了在 transformers 中使用facebook/opt-350m检查点和 Flash Attention 2 模型的纯推理时间之间的差异，使用了两种不同的序列长度。
OPTConfig
class transformers.OPTConfig
( vocab_size = 50272 hidden_size = 768 num_hidden_layers = 12 ffn_dim = 3072 max_position_embeddings = 2048 do_layer_norm_before = True _remove_final_layer_norm = False word_embed_proj_dim = None dropout = 0.1 attention_dropout = 0.0 num_attention_heads = 12 activation_function = 'relu' layerdrop = 0.0 init_std = 0.02 use_cache = True pad_token_id = 1 bos_token_id = 2 eos_token_id = 2 enable_bias = True layer_norm_elementwise_affine = True **kwargs )
参数
vocab_size(int, optional, defaults to 50272) — OPT 模型的词汇量。定义了在调用 OPTModel 时可以表示的不同标记数量。hidden_size(int, optional, defaults to 768) — 层和池化器层的维度。num_hidden_layers(int, optional, defaults to 12) — 解码器层数。ffn_dim(int, optional, defaults to 3072) — 解码器中“中间”（通常称为前馈）层的维度。num_attention_heads(int, optional, defaults to 12) — Transformer 解码器中每个注意力层的注意力头数。activation_function(str或function, optional, defaults to"relu") — 编码器和池化器中的非线性激活函数（函数或字符串）。如果是字符串，支持"gelu"、"relu"、"silu"和"gelu_new"。max_position_embeddings(int, optional, defaults to 2048) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如 512、1024 或 2048）。do_layer_norm_before(bool, optional, defaults toTrue) — 在注意力块之前是否执行层归一化。word_embed_proj_dim(int, optional) —word_embed_proj_dim可以设置为下投影词嵌入，例如opt-350m。默认为hidden_size。dropout(float, optional, defaults to 0.1) — 嵌入层、编码器和池化器中所有全连接层的丢弃概率。attention_dropout(float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。layerdrop(float, optional, defaults to 0.0) — LayerDrop 概率。查看 LayerDrop paper)获取更多详细信息。init_std(float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的截断正态初始化器的标准差。use_cache(bool, optional, defaults toTrue) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。enable_bias(bool, optional, defaults toTrue) — 注意力块中的线性层是否应该使用偏置项。layer_norm_elementwise_affine(bool, optional, defaults toTrue) — 层归一化是否应具有可学习参数。
这是用于存储 OPTModel 配置的配置类。它用于根据指定的参数实例化 OPT 模型，定义模型架构。使用默认值实例化配置将产生类似于 OPT facebook/opt-350m 架构的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
示例：
>>> from transformers import OPTConfig, OPTModel >>> # Initializing a OPT facebook/opt-large style configuration >>> configuration = OPTConfig() >>> # Initializing a model (with random weights) from the facebook/opt-large style configuration >>> model = OPTModel(configuration) >>> # Accessing the model configuration >>> configuration = model.config
PytorchHide Pytorch content
OPTModel
class transformers.OPTModel
( config: OPTConfig )
参数
config(OPTConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。
裸的 OPT 模型输出原始的隐藏状态，没有特定的头部。该模型继承自 PreTrainedModel。查看超类文档以了解库实现的所有模型的通用方法（例如下载或保存，调整输入嵌入大小，修剪头等）。
该模型也是 PyTorch torch.nn.Module子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以获取有关一般用法和行为的所有相关信息。
forward
( input_ids: LongTensor = None attention_mask: Optional = None head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
参数
input_ids(torch.LongTensorof shape(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下将忽略填充。
可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()获取详细信息。
什么是输入 ID？attention_mask(torch.Tensorof shape(batch_size, sequence_length), optional) — 避免对填充标记索引执行注意力的掩码。掩码值选在[0, 1]之间：
- 1 表示
未被掩盖的标记， - 0 表示
被掩盖的标记。
- 什么是注意力掩码？
索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
如果使用past_key_values，可以选择仅输入最后的decoder_input_ids（请参阅past_key_values）。
如果要更改填充行为，应阅读modeling_opt._prepare_decoder_attention_mask并根据需要进行修改。有关默认策略的更多信息，请参阅论文中的图表 1。 head_mask（形状为(encoder_layers, encoder_attention_heads)的torch.Tensor，可选）- 用于使编码器中注意力模块的选定头部失效的掩码。掩码值选定在[0, 1]中：
- 1 表示头部未被掩盖，
- 0 表示头部被掩盖。
past_key_values（tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回）- 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量和 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。
包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码（请参阅past_key_values输入）。
如果使用past_key_values，用户可以选择仅输入最后一个形状为(batch_size, 1)的decoder_input_ids（那些没有将其过去键值状态提供给此模型的）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。inputs_embeds（形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选）- 可选地，您可以选择直接传递嵌入表示而不是传递input_ids。如果您想要更多控制如何将input_ids索引转换为相关向量，而不是使用模型的内部嵌入查找矩阵，这将非常有用。use_cache（bool，可选）- 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（请参阅past_key_values）。output_attentions（bool，可选）- 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。output_hidden_states（bool，可选）- 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。return_dict（bool，可选）- 是否返回[ModelOutput]而不是普通元组。
返回
[transformers.modeling_outputs.BaseModelOutputWithPast]或tuple(torch.FloatTensor)
一个[transformers.modeling_outputs.BaseModelOutputWithPast]或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False时）包括根据配置（[OPTConfig]）和输入不同元素。
last_hidden_state（形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor）- 模型最后一层的隐藏状态序列。
如果使用past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。past_key_values（tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回）— 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，如果config.is_encoder_decoder=True，还有 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。
包含预先计算的隐藏状态（自注意力块中的键和值以及在交叉注意力块中，如果config.is_encoder_decoder=True，还可以使用的）可用于加速顺序解码的（请参见past_key_values输入）。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 之后。
OPTModel 的前向方法，覆盖了__call__特殊方法。
虽然前向传递的步骤需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者会处理运行前后处理步骤，而后者会默默地忽略它们。
示例：
>>> from transformers import AutoTokenizer, OPTModel >>> import torch >>> tokenizer = AutoTokenizer.from_pretrained("facebook/opt-350m") >>> model = OPTModel.from_pretrained("facebook/opt-350m") >>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt") >>> outputs = model(**inputs) >>> last_hidden_states = outputs.last_hidden_state
OPTForCausalLM
class transformers.OPTForCausalLM
( config )
forward
( input_ids: LongTensor = None attention_mask: Optional = None head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → export const metadata = 'undefined';transformers.modeling_outputs.CausalLMOutputWithPast 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.Tensor，可选）— 用于避免在填充令牌索引上执行注意力的掩码。掩码值选定在[0, 1]之间：
- 对于未被屏蔽的标记为 1，
- 对于被屏蔽的标记为 0。
- 什么是注意力掩码？
head_mask（形状为(num_hidden_layers, num_attention_heads)的torch.Tensor，可选）— 用于使注意力模块中的选定头部失效的掩码。掩码值选定在[0, 1]之间：
- 1 表示头部未被屏蔽，
- 0 表示头部被屏蔽。
past_key_values(tuple(tuple(torch.FloatTensor)), optional, 当传递use_cache=True或config.use_cache=True时返回 — 长度为config.n_layers的元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，以及 2 个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的张量。当模型用作序列到序列模型中的解码器时，这两个额外的张量是必需的。
包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码（参见past_key_values输入）。
如果使用past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后一个decoder_input_ids（这些没有给出其过去键值状态的模型）而不是形状为(batch_size, sequence_length)的所有decoder_input_ids。inputs_embeds(torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，optional) — 可选地，可以直接传递嵌入表示而不是传递input_ids。如果您想要更多控制如何将input_ids索引转换为相关向量，而不是模型的内部嵌入查找矩阵，则这很有用。labels(torch.LongTensor，形状为(batch_size, sequence_length)，optional) — 用于计算掩码语言建模损失的标签。索引应该在[0, ..., config.vocab_size]或-100 之间（参见input_ids文档字符串）。将索引设置为-100的标记将被忽略（掩码），损失仅计算具有[0, ..., config.vocab_size]标签的标记。use_cache(bool，optional) — 如果设置为True，将返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。output_attentions(bool，optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。output_hidden_states(bool，optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。return_dict(bool，optional) — 是否返回 ModelOutput 而不是普通元组。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包含根据配置（OPTConfig）和输入的各种元素。
loss(torch.FloatTensor，形状为(1,)，optional，当提供labels时返回) — 语言建模损失（用于下一个标记的预测）。logits(torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。past_key_values(tuple(tuple(torch.FloatTensor)), optional, 当传递use_cache=True或config.use_cache=True时返回 — 长度为config.n_layers的元组，每个元组有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。
包含预先计算的隐藏状态（自注意力块中的键和值），可用于加速顺序解码（参见past_key_values输入）。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 之后的注意力权重，用于计算自注意力头中的加权平均值。
示例：
>>> from transformers import AutoTokenizer, OPTForCausalLM >>> model = OPTForCausalLM.from_pretrained("facebook/opt-350m") >>> tokenizer = AutoTokenizer.from_pretrained("facebook/opt-350m") >>> prompt = "Hey, are you conscious? Can you talk to me?" >>> inputs = tokenizer(prompt, return_tensors="pt") >>> # Generate >>> generate_ids = model.generate(inputs.input_ids, max_length=30) >>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0] "Hey, are you conscious? Can you talk to me?\nI'm not conscious. I'm just a little bit of a weirdo."
Transformers 4.37 中文文档（五十）（2）https://developer.aliyun.com/article/1565250
