► Keras 3 API 文档 / KerasNLP / 预训练模型 / Falcon / FalconCausalLM 模型

FalconCausalLM 模型

[源代码]

FalconCausalLM 类

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

用于因果语言建模的端到端 Falcon 模型。

因果语言模型 (LM) 根据之前的标记预测下一个标记。这种任务设置可用于对模型进行无监督训练，或自回归地生成与用于训练的数据类似的纯文本。此任务可用于预训练或微调 Falcon 模型，只需调用 fit() 即可。

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

此模型可以选择配置 preprocessor 层，在这种情况下，它将在 fit()、predict()、evaluate() 和 generate() 期间自动对字符串输入应用预处理。在使用 from_preset() 创建模型时，默认情况下会执行此操作。

参数

示例

使用 generate() 进行文本生成。

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset("falcon_refinedweb_1b_en")
falcon_lm.generate("I want to say", max_length=30)

# Generate with batched prompts.
falcon_lm.generate(["This is a", "Where are you"], max_length=30)

使用自定义采样器编译 generate() 函数。

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset("falcon_refinedweb_1b_en")
falcon_lm.compile(sampler="top_k")
falcon_lm.generate("I want to say", max_length=30)

falcon_lm.compile(sampler=keras_nlp.samplers.BeamSampler(num_beams=2))
falcon_lm.generate("I want to say", max_length=30)

在没有预处理的情况下使用 generate()。

prompt = {
    # Token ids for "<|endoftext|> Keras is".
    "token_ids": np.array([[50256, 17337,   292,   318]] * 2),
    # Use `"padding_mask"` to indicate values that should not be overridden.
    "padding_mask": np.array([[1, 1, 1, 1]] * 2),
}

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset(
    "falcon_refinedweb_1b_en",
    preprocessor=None,
)
falcon_lm.generate(prompt)

对单个批次调用 fit()。

features = ["The quick brown fox jumped.", "I forgot my homework."]
falcon_lm = keras_nlp.models.FalconCausalLM.from_preset("falcon_refinedweb_1b_en")
falcon_lm.fit(x=features, batch_size=2)

在没有预处理的情况下调用 fit()。

x = {
    # Token ids for "<|endoftext|> Keras is deep learning library<|endoftext|>"
    "token_ids": np.array([[50256, 17337,   292,   318,  2769,  4673,  5888, 50256, 0]] * 2),
    "padding_mask": np.array([[1, 1, 1, 1, 1, 1, 1, 1, 0]] * 2),
}
y = np.array([[17337,   292,   318,  2769,  4673,  5888, 50256, 0, 0]] * 2)
sw = np.array([[1, 1, 1, 1, 1, 1, 1, 0, 0]] * 2)

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset(
    "falcon_refinedweb_1b_en",
    preprocessor=None,
)
falcon_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自定义骨干和词汇表。

vocab = {"<|endoftext|>": 0, "a": 4, "Ġquick": 5, "Ġfox": 6}
merges = ["Ġ q", "u i", "c k", "ui ck", "Ġq uick"]
merges += ["Ġ f", "o x", "Ġf ox"]
tokenizer = keras_nlp.models.FalconTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_nlp.models.FalconCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_nlp.models.FalconBackbone(
    vocabulary_size=50304,
    num_layers=24,
    num_attention_heads=64,
    hidden_dim=2048,
    intermediate_dim=4*2048,
)
falcon_lm = keras_nlp.models.FalconCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
falcon_lm.fit(x=features, batch_size=2)

[源代码]

from_preset 方法

FalconCausalLM.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,
)
预设名称 参数 描述
falcon_refinedweb_1b_en 1.31B 在 350B 个 RefinedWeb 数据集标记上训练的 24 层 Falcon 模型（具有 1B 个参数的 Falcon）。

[源代码]

generate 方法

FalconCausalLM.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: 可选。整数。生成的序列的最大长度。将默认设置为 preprocessor 的最大配置 sequence_length。如果 preprocessor 为 None，则 inputs 应填充到所需的长度，并且此参数将被忽略。
  • stop_token_ids: 可选。None、"auto" 或标记 ID 元组。默认值为 "auto"，它使用 preprocessor.tokenizer.end_token_id。未指定处理器将产生错误。None 在生成 max_length 个标记后停止生成。您也可以指定模型应停止的标记 ID 列表。请注意，每个标记序列都将被解释为停止标记，不支持多标记停止序列。

backbone 属性

keras_nlp.models.FalconCausalLM.backbone

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

preprocessor 属性

keras_nlp.models.FalconCausalLM.preprocessor

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

FalconCausalLM 模型
FalconCausalLM 类
from_preset 方法
generate 方法
backbone 属性
preprocessor 属性