Keras 3 API 文档 / KerasNLP / 预训练模型 / Bloom / BloomCausalLM 模型

BloomCausalLM 模型

[源代码]

BloomCausalLM

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

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

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

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

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

参数

示例

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

bloom_lm = keras_nlp.models.BloomCausalLM.from_preset("bloom_560m_multi")
bloom_lm.generate("I want to say", max_length=30)

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

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

bloom_lm = keras_nlp.models.BloomCausalLM.from_preset("bloom_560m_multi")
bloom_lm.compile(sampler="top_k")
bloom_lm.generate("I want to say", max_length=30)

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

在不进行预处理的情况下使用 generate()

prompt = {
    # Token ids for "<s> Keras is".
    "token_ids": np.array([[1, 46, 15762, 632, 3, 3, 3, 3, 3]] * 2),
    # Use `"padding_mask"` to indicate values that should not be overridden.
    "padding_mask": np.array([[1, 1, 1, 1, 0, 0, 0, 0, 0]] * 2),
}

bloom_lm = keras_nlp.models.BloomCausalLM.from_preset(
    "bloom_560m_multi",
    preprocessor=None,
)
bloom_lm.generate(prompt)

在一个批次上调用 fit()

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

在不进行预处理的情况下调用 fit()

x = {
    # Token ids for "<bos> Keras is deep learning library<eos>"
    "token_ids": np.array([[2, 214064, 603, 5271, 6044, 9581, 1, 0]] * 2),
    "padding_mask": np.array([[1, 1, 1, 1, 1, 1, 1, 0]] * 2),
}
y = np.array([[214064, 603, 5271, 6044, 9581, 3, 0, 0]] * 2)
sw = np.array([[1, 1, 1, 1, 1, 1, 0, 0]] * 2)

bloom_lm = keras_nlp.models.BloomCausalLM.from_preset(
    "bloom_560m_multi",
    preprocessor=None,
)
bloom_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自定义骨干网络和词汇表。

features = [
    " airplane at airport",
    " airplane airport",
]
vocab = ["<unk>", "<s>", "</s>", "<pad>"]
vocab += ["!", "air", "Ġair", "plane", "Ġat", "port"]
vocab = dict([(token, i) for i, token in enumerate(vocab)])
merges = ["Ġ a", "Ġ t", "Ġ i", "Ġ b", "a i", "p l", "n e"]
merges += ["Ġa t", "p o", "r t", "Ġt h", "ai r", "pl a", "po rt"]
merges += ["Ġai r", "Ġa i", "pla ne"]
tokenizer = keras_nlp.models.BloomTokenizer(vocabulary=vocab, merges=merges)
preprocessor = keras_nlp.models.BloomCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_nlp.models.BloomBackbone(
    vocabulary_size=tokenizer.vocabulary_size(),
    num_layers=4,
    num_heads=4,
    hidden_dim=32,
    intermediate_dim=128,
)
bloom_lm = keras_nlp.models.BloomCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
bloom_lm.fit(x=features, batch_size=2)

[源代码]

from_preset 方法

BloomCausalLM.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,
)
预设名称 参数 描述
bloom_560m_multi 559.21M 具有 1024 隐藏维度的 24 层 Bloom 模型。在 45 种自然语言和 12 种编程语言上训练。
bloom_1.1b_multi 1.07B 具有 1536 隐藏维度的 24 层 Bloom 模型。在 45 种自然语言和 12 种编程语言上训练。
bloom_1.7b_multi 1.72B 具有 2048 隐藏维度的 24 层 Bloom 模型。在 45 种自然语言和 12 种编程语言上训练。
bloom_3b_multi 3.00B 具有 2560 隐藏维度的 30 层 Bloom 模型。在 45 种自然语言和 12 种编程语言上训练。
bloomz_560m_multi 559.21M 具有 1024 隐藏维度的 24 层 Bloom 模型。在跨语言任务混合 (xP3) 数据集上微调。
bloomz_1.1b_multi 1.07B 具有 1536 隐藏维度的 24 层 Bloom 模型。在跨语言任务混合 (xP3) 数据集上微调。
bloomz_1.7b_multi 1.72B 具有 2048 隐藏维度的 24 层 Bloom 模型。在跨语言任务混合 (xP3) 数据集上微调。
bloomz_3b_multi 3.00B 具有 2560 隐藏维度的 30 层 Bloom 模型。在跨语言任务混合 (xP3) 数据集上微调。

[源代码]

generate 方法

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

backbone 属性

keras_nlp.models.BloomCausalLM.backbone

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


preprocessor 属性

keras_nlp.models.BloomCausalLM.preprocessor

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