KerasHub:预训练模型 / API 文档 / 模型架构 / Falcon / FalconCausalLM 模型

FalconCausalLM 模型

[源代码]

FalconCausalLM

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

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

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

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

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

参数

示例

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

falcon_lm = keras_hub.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_hub.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_hub.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_hub.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_hub.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_hub.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_hub.models.FalconTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_hub.models.FalconCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_hub.models.FalconBackbone(
    vocabulary_size=50304,
    num_layers=24,
    num_attention_heads=64,
    hidden_dim=2048,
    intermediate_dim=4*2048,
)
falcon_lm = keras_hub.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_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,
)
预设 参数 描述
falcon_refinedweb_1b_en 1.31B 24 层 Falcon 模型(参数为 10 亿的 Falcon),在 RefinedWeb 数据集的 3500 亿个标记上训练。

[源代码]

generate 方法

FalconCausalLM.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 数据、张量数据或 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。未指定处理器将导致错误。None 在生成 max_length token 后停止生成。您还可以指定模型应停止的 token ID 列表。请注意,token 序列中的每个 token 都将被解释为停止 token,不支持多 token 停止序列。
  • strip_prompt:可选。默认情况下,generate() 返回完整的提示及其后由模型生成的补全内容。如果此选项设置为 True,则只返回新生成的文本。

backbone 属性

keras_hub.models.FalconCausalLM.backbone

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


preprocessor 属性

keras_hub.models.FalconCausalLM.preprocessor

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