Open-Llama
此模型仅处于维护模式，我们不接受更改其代码的任何新的 PR。
如果您在运行此模型时遇到任何问题，请重新安装支持此模型的最新版本：v4.31.0。您可以通过运行以下命令来执行此操作：pip install -U transformers==4.31.0。
此模型与 Hugging Face Hub 上的 OpenLLaMA 模型 不同，这些模型主要使用 LLaMA 架构。
概述
Open-Llama 模型是由社区开发者 s-JoL 在开源 Open-Llama 项目中提出的。
该模型主要基于 LLaMA 并进行了一些修改，融合了 Xformers 的内存高效注意力、Bloom 的稳定嵌入以及 PaLM 的共享输入输出嵌入。并且该模型在中文和英文上进行预训练，这使得它在中文语言任务上表现更佳。
此模型由 s-JoL 贡献。原始代码由 s-JoL 在 GitHub 上发布，但现已移除。
OpenLlamaConfig
class transformers.OpenLlamaConfig
< 源代码 >( vocab_size = 100000 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 hidden_act = 'silu' max_position_embeddings = 2048 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False use_memory_efficient_attention = True hidden_dropout_prob = 0.1 attention_dropout_prob = 0.1 use_stable_embedding = True shared_input_output_embedding = True rope_theta = 10000.0 rope_scaling = None **kwargs )
参数
- vocab_size (
int, 可选，默认值 32000) — Open-Llama 模型的词汇量。定义了调用 OpenLlamaModel 时可由inputs_ids表示的不同标记的数量。 - hidden_size (
int, 可选，默认值 4096) — 隐藏表示的维度。 - intermediate_size (
int, 可选，默认值 11008) — MLP 表示的维度。 - num_hidden_layers (
int, 可选，默认值 32) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int, 可选，默认值 32) — Transformer 编码器中每个注意力层的注意力头数量。 - hidden_act (
str或function，可选，默认值为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int，可选，默认值为 2048) — 此模型可能使用的最大序列长度。 通常将其设置为一个较大的值以防万一（例如，512 或 1024 或 2048）。 - initializer_range (
float，可选，默认值为 0.02) — 初始化所有权重矩阵的截断正态初始化的标准差。 - rms_norm_eps (
float，可选，默认值为 1e-12) — RMS 归一化层使用的 epsilon。 - use_cache (
bool，可选，默认值为True) — 模型是否应该返回最后的键值注意力（并非所有模型都使用）。 仅在config.is_decoder=True时才相关。 - tie_word_embeddings(
bool, 可选，默认值为False) — 是否绑定权重嵌入 - rope_theta (
float，可选，默认值为 10000.0) — RoPE 嵌入的基础周期。 - rope_scaling (
Dict，可选) — 包含 RoPE 嵌入缩放配置的字典。 目前支持两种缩放策略：线性缩放和动态缩放。 它们的缩放因子必须大于 1 的浮点数。 预期的格式为{"type": 策略名称, "factor": 缩放因子}。 使用此标志时，不要将max_position_embeddings更新为预期的新的最大值。 有关这些缩放策略的行为方式的更多信息，请参阅以下主题： https://www.reddit.com/r/LocalLLaMA/comments/14mrgpr/dynamically_scaled_rope_further_increases/。 这是一个实验性功能，在将来的版本中可能会出现破坏性 API 更改。示例 —
这是一个配置类，用于存储 OpenLlamaModel 的配置。 它用于根据指定的参数实例化一个 Open-Llama 模型，定义模型架构。 使用默认值实例化一个配置将生成与 s-JoL/Open-Llama-V1 相似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。 阅读 PretrainedConfig 的文档以获取更多信息。
>>> from transformers import OpenLlamaModel, OpenLlamaConfig
>>> # Initializing a Open-Llama open_llama-7b style configuration
>>> configuration = OpenLlamaConfig()
>>> # Initializing a model from the open_llama-7b style configuration
>>> model = OpenLlamaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configOpenLlamaModel
class transformers.OpenLlamaModel
< 源代码 >( config: OpenLlamaConfig )
参数
- config (OpenLlamaConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，只加载配置。 查看 from_pretrained() 方法加载模型权重。 config — OpenLlamaConfig
Open-Llama 模型的裸模型，输出原始隐藏状态，没有任何特定的头部。 此模型继承自 PreTrainedModel。 查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为有关的所有事项。
Transformer 解码器，包含 config.num_hidden_layers 层。 每层都是一个 OpenLlamaDecoderLayer
forward
< source >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: 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 )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。 如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。 查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 获取详细信息。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。 掩码值在[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 以了解有关默认策略的更多信息。- 1 表示头部未屏蔽，
- 0 表示头部屏蔽。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。 在[0, config.n_positions - 1]范围内选择。 - 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 (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递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 而不是普通元组。
OpenLlamaModel 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的方案需要在此函数中定义，但应随后调用 Module 实例，而不是此方法，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
OpenLlamaForCausalLM
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: 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 ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 掩码以避免对填充标记索引执行注意力。掩码值选择在[0, 1]中： - position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记的位置索引。 在范围[0, config.n_positions - 1]内选择。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含两个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量) 和两个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些状态可用于（参见
past_key_values输入）加快顺序解码。如果使用
past_key_values，用户可以选择仅输入形状为(batch_size, 1)的最后decoder_input_ids（那些没有向该模型提供过去键值状态的 ID）而不是所有形状为(batch_size, sequence_length)的decoder_input_ids。 - inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，除了传递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 而不是一个简单的元组。参数 — labels (
torch.LongTensor形状为(batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。 索引应为[0, ..., config.vocab_size]或 -100（参见input_ids文档字符串）。 索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的标记进行计算。
返回值
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或 config.return_dict=False），包含取决于配置 (OpenLlamaConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含两个形状为(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时返回) —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)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
该 OpenLlamaForCausalLM 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的方案需要在此函数中定义，但应随后调用 Module 实例，而不是此方法，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, OpenLlamaForCausalLM
>>> model = OpenLlamaForCausalLM.from_pretrained("openlm-research/open_llama_7b")
>>> tokenizer = AutoTokenizer.from_pretrained("openlm-research/open_llama_7b")
>>> 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, but I can talk to you."OpenLlamaForSequenceClassification
class transformers.OpenLlamaForSequenceClassification
< 来源 >( config )
参数
- config (OpenLlamaConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
LLaMa 模型转换器，顶部带有序列分类头（线性层）。
OpenLlamaForSequenceClassification 使用最后一个 token 进行分类，与其他因果模型（例如 GPT-2）相同。
由于它对最后一个 token 进行分类，因此需要知道最后一个 token 的位置。如果在配置中定义了 pad_token_id，它将找到每行中不是填充 token 的最后一个 token。如果没有定义 pad_token_id，它将简单地获取批处理中每行的最后一个值。由于它在传递 inputs_embeds 而不是 input_ids 时无法猜测填充 token，因此它会执行相同的操作（获取批处理中每行的最后一个值）。
此模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。 将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为有关的所有事项。
forward
< 来源 >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: 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 )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列 token 在词汇表中的索引。默认情况下，如果您提供它，填充将被忽略。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 掩码，以避免对填充 token 索引执行注意力。在[0, 1]中选择的掩码值:- 1 表示未掩码的 token，
- 0 表示掩码的 token。
可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（参见past_key_values）。如果您想更改填充行为，则应阅读
modeling_opt._prepare_decoder_attention_mask并修改以满足您的需求。查看 论文 中的图 1 以获取有关默认策略的更多信息。- 1 表示头部未掩码，
- 0 表示头部掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(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 而不是普通元组。 - labels (形状为
(batch_size,)的torch.LongTensor, 可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
该 OpenLlamaForSequenceClassification 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的方案需要在此函数中定义，但应随后调用 Module 实例，而不是此方法，因为前者负责运行前处理和后处理步骤，而后者会静默地忽略它们。