Keras 3 API 文档 / KerasNLP / 预训练模型 / Falcon / FalconCausalLMPreprocessor 层

FalconCausalLMPreprocessor 层

[源代码]

FalconCausalLMPreprocessor

keras_nlp.models.FalconCausalLMPreprocessor(
    tokenizer, sequence_length=1024, add_start_token=True, add_end_token=True, **kwargs
)

Falcon 因果语言模型预处理器。

此预处理层旨在与 keras_nlp.models.FalconCausalLM 一起使用。默认情况下,它将接收字符串批次,并以 (x, y, sample_weight) 格式返回输出,其中 y 标签是 x 序列中的下一个 token ID。

为了用于生成,该层还公开了两个方法 generate_preprocess()generate_postprocess()。当此预处理器附加到 keras_nlp.models.FalconCausalLM 实例时,这些方法将在 generate() 中被隐式调用。它们也可以单独调用(例如,在单独的进程中预计算生成预处理输入)。

参数

  • tokenizer: keras_nlp.models.FalconTokenizer 实例。
  • sequence_length: 打包输入的长度。
  • add_start_token: 如果为 True,则预处理器将在每个输入序列之前添加分词器起始 token。
  • add_end_token: 如果为 True,则预处理器将在每个输入序列之后添加分词器结束 token。

调用参数

  • x: 字符串、tf.Tensor 或 python 字符串列表。
  • y: 标签数据。应始终为 None,因为该层会生成标签。
  • sample_weight: 标签权重。应始终为 None,因为该层会生成标签权重。
  • sequence_length: 传递以覆盖层的配置 sequence_length

示例

# Load the preprocessor from a preset.
preprocessor = keras_nlp.models.FalconCausalLMPreprocessor.from_preset(
    "falcon_refinedweb_1b_en"
)

# Tokenize and pack a single sentence.
sentence = tf.constant("League of legends")
preprocessor(sentence)
# Same output.
preprocessor("League of legends")

# Tokenize a batch of sentences.
sentences = tf.constant(["Taco tuesday", "Fish taco please!"])
preprocessor(sentences)
# Same output.
preprocessor(["Taco tuesday", "Fish taco please!"])

# Map a dataset to preprocess a single sentence.
features = tf.constant(
    [
        "Avatar 2 is amazing!",
        "Well, I am not sure.",
    ]
)
labels = tf.constant([1, 0])
ds = tf.data.Dataset.from_tensor_slices((features, labels))
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Map a dataset to preprocess unlabled sentences.
ds = tf.data.Dataset.from_tensor_slices(features)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

[源代码]

from_preset 方法

FalconCausalLMPreprocessor.from_preset(preset, **kwargs)

从模型预设实例化 keras_nlp.models.Preprocessor

预设是用于保存和加载预训练模型的配置、权重和其他文件资产的目录。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'

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

由于给定模型通常有多个预处理类,因此此方法应在特定的子类上调用,例如 keras_nlp.models.BertTextClassifierPreprocessor.from_preset()

参数

  • preset: 字符串。内置预设标识符、Kaggle 模型句柄、Hugging Face 句柄或本地目录的路径。

示例

# Load a preprocessor for Gemma generation.
preprocessor = keras_nlp.models.GemmaCausalLMPreprocessor.from_preset(
    "gemma_2b_en",
)

# Load a preprocessor for Bert classification.
preprocessor = keras_nlp.models.BertTextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
预设名称 参数 描述
falcon_refinedweb_1b_en 13.1 亿 在 RefinedWeb 数据集的 3500 亿个 token 上训练的 24 层 Falcon 模型(具有 10 亿个参数的 Falcon 模型)。

[源代码]

generate_preprocess 方法

FalconCausalLMPreprocessor.generate_preprocess(x, sequence_length=None)

将字符串转换为用于生成的整数 token 输入。

类似于调用用于训练的层,此方法接收字符串或张量字符串,对输入进行分词和打包,并计算一个填充掩码,掩盖所有未填充填充值的输入。

与调用用于训练的层不同,此方法不计算标签,并且永远不会在序列末尾附加 tokenizer.end_token_id(因为预计生成将在输入提示的末尾继续)。


[源代码]

generate_postprocess 方法

FalconCausalLMPreprocessor.generate_postprocess(x)

将整数 token 输出转换为用于生成的字符串。

此方法反转 generate_preprocess(),首先删除所有填充和起始/结束 token,然后将整数序列转换回字符串。


tokenizer 属性

keras_nlp.models.FalconCausalLMPreprocessor.tokenizer

用于对字符串进行分词的分词器。