因果语言模型 (CausalLM)

[源代码]

CausalLM

keras_nlp.models.CausalLM()

生成语言建模任务的基类。

CausalLM 任务封装了一个 keras_nlp.models.Backbone 和一个 keras_nlp.models.Preprocessor,以创建一个可用于生成和生成式微调的模型。

CausalLM 任务提供了一个额外的、更高级别的 generate() 函数,该函数可用于使用字符串输入、字符串输出签名逐个标记自动回归地对模型进行采样。所有 CausalLM 类的 compile() 方法包含一个额外的 sampler 参数,该参数可用于传递一个 keras_nlp.samplers.Sampler 来控制如何对预测的分布进行采样。

在调用 fit() 时,标记化的输入将使用应用的因果掩码逐个标记进行预测,这为控制推理时生成提供了预训练和监督微调设置。

所有 CausalLM 任务都包含一个 from_preset() 构造函数,该构造函数可用于加载预训练的配置和权重。

示例

# Load a GPT2 backbone with pre-trained weights.
causal_lm = keras_nlp.models.CausalLM.from_preset(
    "gpt2_base_en",
)
causal_lm.compile(sampler="top_k")
causal_lm.generate("Keras is a", max_length=64)

# Load a Mistral instruction tuned checkpoint at bfloat16 precision.
causal_lm = keras_nlp.models.CausalLM.from_preset(
    "mistral_instruct_7b_en",
    dtype="bfloat16",
)
causal_lm.compile(sampler="greedy")
causal_lm.generate("Keras is a", max_length=64)

[源代码]

from_preset 方法

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

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

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

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

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

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

参数

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

示例

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

# Load a Bert classification task.
model = keras_nlp.models.TextClassifier.from_preset(
    "bert_base_en",
    num_classes=2,
)

[源代码]

compile 方法

CausalLM.compile(
    optimizer="auto", loss="auto", weighted_metrics="auto", sampler="top_k", **kwargs
)

配置 CausalLM 任务以进行训练和生成。

CausalLM 任务扩展了 keras.Model.compile 的默认编译签名,其中包含 optimizerlossweighted_metrics 的默认值。要覆盖这些默认值,请在编译期间将任何值传递给这些参数。

CausalLM 任务向 compile 添加了一个新的 sampler,该 sampler 可用于控制与 generate 函数一起使用的采样策略。

请注意,由于训练输入包含从损失中排除的填充标记,因此几乎总是一个好主意使用 weighted_metrics 而不是 metrics 进行编译。

参数

  • optimizer"auto"、优化器名称或 keras.Optimizer 实例。默认为 "auto",它使用给定模型和任务的默认优化器。有关可能的 optimizer 值的更多信息,请参阅 keras.Model.compilekeras.optimizers
  • loss"auto"、损失名称或 keras.losses.Loss 实例。默认为 "auto",其中将为标记分类 CausalLM 任务应用 keras.losses.SparseCategoricalCrossentropy 损失。有关可能的 loss 值的更多信息,请参阅 keras.Model.compilekeras.losses
  • weighted_metrics"auto" 或模型在训练和测试期间要评估的指标列表。默认为 "auto",其中将应用 keras.metrics.SparseCategoricalAccuracy 以跟踪模型在猜测掩码标记值时的准确性。有关可能的 weighted_metrics 值的更多信息,请参阅 keras.Model.compilekeras.metrics
  • sampler:采样器名称或 keras_nlp.samplers.Sampler 实例。配置在 generate() 调用期间使用的采样方法。有关内置采样策略的完整列表,请参阅 keras_nlp.samplers
  • **kwargs:有关编译方法支持的参数的完整列表,请参阅 keras.Model.compile

[源代码]

generate 方法

CausalLM.generate(inputs, max_length=None, stop_token_ids="auto")

根据提示 inputs 生成文本。

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

如果 inputstf.data.Dataset,则输出将“批次到批次”生成并连接。否则,所有输入都将作为单个批次处理。

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

参数

  • inputs:Python 数据、张量数据或 tf.data.Dataset。如果将 preprocessor 附加到模型,则 inputs 应与 preprocessor 层期望的结构匹配。如果未附加 preprocessor,则 inputs 应与 backbone 模型期望的结构匹配。
  • max_length:可选。整数。生成序列的最大长度。将默认为 preprocessor 配置的 sequence_length 最大值。如果 preprocessorNone,则 inputs 应填充到所需的最大长度,并且此参数将被忽略。
  • stop_token_ids:可选。None、“auto”或标记 ID 元组。默认为“auto”,它使用 preprocessor.tokenizer.end_token_id。未指定处理器将产生错误。None 在生成 max_length 个标记后停止生成。您还可以指定模型应停止的标记 ID 列表。请注意,每个标记序列都将被解释为停止标记,不支持多标记停止序列。

[源代码]

save_to_preset 方法

CausalLM.save_to_preset(preset_dir)

将任务保存到预设目录。

参数

  • preset_dir:本地模型预设目录的路径。

preprocessor 属性

keras_nlp.models.CausalLM.preprocessor

用于预处理输入的 keras_nlp.models.Preprocessor 层。


backbone 属性

keras_nlp.models.CausalLM.backbone

具有核心架构的 keras_nlp.models.Backbone 模型。