KerasHub: 预训练模型 / API 文档 / 模型架构 / Llama / LlamaCausalLM 模型

LlamaCausalLM 模型

[源代码]

LlamaCausalLM

keras_hub.models.LlamaCausalLM(backbone, preprocessor=None, **kwargs)

一个用于因果语言建模的端到端 Llama 模型。

因果语言模型(LM)根据先前的 token 预测下一个 token。此任务设置可用于在纯文本输入上无监督地训练模型,或自回归地生成与用于训练的数据相似的纯文本。只需调用 fit(),即可将此任务用于 LLaMA 模型的预训练或微调。

此模型具有 generate() 方法,该方法根据提示生成文本。用于生成文本的策略由 compile() 方法上的额外 sampler 参数控制。您可以使用不同的 keras_hub.samplers 对象重新编译模型以控制生成。默认情况下,将使用 "top_k" 采样。

参数


[源代码]

from_preset 方法

LlamaCausalLM.from_preset(preset, load_weights=True, **kwargs)

从模型预设实例化一个 keras_hub.models.Task

预设是用于保存和加载预训练模型的配置文件、权重和其他文件资产的目录。preset 可以是以下之一:

  1. 一个内置预设标识符,例如 'bert_base_en'
  2. 一个 Kaggle Models 句柄,例如 'kaggle://user/bert/keras/bert_base_en'
  3. 一个 Hugging Face 句柄,例如 'hf://user/bert_base_en'
  4. 本地预设目录的路径,例如 './bert_base_en'

对于任何 Task 子类,您可以运行 cls.presets.keys() 来列出该类上所有可用的内置预设。

此构造函数可以通过两种方式之一调用。可以从任务特定的基类调用,例如 keras_hub.models.CausalLM.from_preset(),也可以从模型类调用,例如 keras_hub.models.BertTextClassifier.from_preset()。如果从基类调用,则返回对象的子类将从预设目录中的配置推断。

参数

  • preset:字符串。一个内置预设标识符、一个 Kaggle Models 句柄、一个 Hugging Face 句柄或本地目录的路径。
  • load_weights:布尔值。如果为 True,则会将保存的权重加载到模型架构中。如果为 False,则所有权重将随机初始化。

示例

# Load a Gemma generative task.
causal_lm = keras_hub.models.CausalLM.from_preset(
    "gemma_2b_en",
)

# Load a Bert classification task.
model = keras_hub.models.TextClassifier.from_preset(
    "bert_base_en",
    num_classes=2,
)
预设 参数量 描述
llama2_7b_en 6.74B 70 亿参数、32 层、基础 LLaMA 2 模型。
llama2_instruct_7b_en 6.74B 70 亿参数、32 层、指令微调的 LLaMA 2 模型。
vicuna_1.5_7b_en 6.74B 70 亿参数、32 层、指令微调的 Vicuna v1.5 模型。
llama2_7b_en_int8 6.74B 70 亿参数、32 层、基础 LLaMA 2 模型(激活和权重量化到 int8)。
llama2_instruct_7b_en_int8 6.74B 70 亿参数、32 层、指令微调的 LLaMA 2 模型(激活和权重量化到 int8)。
llama3_8b_en 8.03B 80 亿参数、32 层、基础 LLaMA 3 模型。
llama3_instruct_8b_en 8.03B 80 亿参数、32 层、指令微调的 LLaMA 3 模型。
llama3_8b_en_int8 8.03B 80 亿参数、32 层、基础 LLaMA 3 模型(激活和权重量化到 int8)。
llama3_instruct_8b_en_int8 8.03B 80 亿参数、32 层、指令微调的 LLaMA 3 模型(激活和权重量化到 int8)。

[源代码]

generate 方法

LlamaCausalLM.generate(
    inputs, max_length=None, stop_token_ids="auto", strip_prompt=False
)

根据提示 inputs 生成文本。

此方法根据给定的 inputs 生成文本。用于生成的采样方法可以通过 compile() 方法设置。

如果 inputs 是一个 tf.data.Dataset,则输出将“逐批”生成并拼接。否则,所有输入将作为单个批次处理。

如果模型附加了 preprocessor,则 inputs 将在 generate() 函数内部进行预处理,并且应与 preprocessor 层预期的结构(通常是原始字符串)匹配。如果未附加 preprocessor,则输入应与 backbone 预期的结构匹配。请参阅上面的示例用法以了解每种情况的演示。

参数

  • inputs:python 数据、tensor 数据或 tf.data.Dataset。如果模型附加了 preprocessor,则 inputs 应与 preprocessor 层预期的结构匹配。如果未附加 preprocessor,则 inputs 应与 backbone 模型预期的结构匹配。
  • max_length:可选。int。生成的序列的最大长度。将默认为 preprocessor 配置的最大 sequence_length。如果 preprocessorNone,则 inputs 应填充到所需的最大长度,并且此参数将被忽略。
  • stop_token_ids:可选。None、“auto” 或 token id 元组。默认为“auto”,使用 preprocessor.tokenizer.end_token_id。未指定 processor 将产生错误。None 在生成 max_length 个 token 后停止生成。您还可以指定模型应停止的一系列 token id。请注意,token 序列中的每个 token 都将被解释为停止 token,不支持多 token 停止序列。
  • strip_prompt:可选。默认情况下,generate() 返回完整的提示以及模型生成的补全文本。如果将此选项设置为 True,则仅返回新生成的文本。

backbone 属性

keras_hub.models.LlamaCausalLM.backbone

一个带有核心架构的 keras_hub.models.Backbone 模型。


preprocessor 属性

keras_hub.models.LlamaCausalLM.preprocessor

一个用于预处理输入的 keras_hub.models.Preprocessor 层。