Keras 3 API 文档 / KerasNLP / 预训练模型 / Phi3 / Phi3CausalLM 模型

Phi3CausalLM 模型

[来源]

Phi3CausalLM

keras_nlp.models.Phi3CausalLM(backbone, preprocessor=None, **kwargs)

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

因果语言模型 (LM) 基于之前的词元预测下一个词元。此任务设置可用于在纯文本输入上无监督训练模型,或自动回归生成类似于用于训练的数据的纯文本。此任务可用于预训练或微调 Phi-3 模型,只需调用 fit() 即可。

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

参数


[来源]

from_preset 方法

Phi3CausalLM.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,
)
预设名称 参数 描述
phi3_mini_4k_instruct_en 3.82B 38 亿个参数,32 层,4k 上下文长度,Phi-3 模型。该模型使用 Phi-3 数据集进行训练。该数据集包含合成数据和经过过滤的公开可用网站数据,重点关注高质量和推理密集型属性。
phi3_mini_128k_instruct_en 3.82B 38 亿个参数,32 层,128k 上下文长度,Phi-3 模型。该模型使用 Phi-3 数据集进行训练。该数据集包含合成数据和经过过滤的公开可用网站数据,重点关注高质量和推理密集型属性。

[来源]

generate 方法

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

根据提示 inputs 生成文本。

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

如果 inputs 是一个 tf.data.Dataset,则将逐批生成输出并连接起来。否则,所有输入都将作为一个批次处理。

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

参数

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

backbone 属性

keras_nlp.models.Phi3CausalLM.backbone

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


preprocessor 属性

keras_nlp.models.Phi3CausalLM.preprocessor

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