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

FalconCausalLMPreprocessor 层

[源]

FalconCausalLMPreprocessor

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

Falcon Causal LM 预处理器。

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

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

参数

  • tokenizer:一个 keras_hub.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_hub.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, config_file="preprocessor.json", **kwargs
)

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

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

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

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

参数

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

示例

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

# Load a preprocessor for Bert classification.
preprocessor = keras_hub.models.TextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
预设 参数 描述
falcon_refinedweb_1b_en 1.31B 24 层 Falcon 模型(具有 1B 参数的 Falcon),在 350B 个 RefinedWeb 数据集 token 上训练。

[源]

generate_preprocess 方法

FalconCausalLMPreprocessor.generate_preprocess(x, sequence_length=None)

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

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

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


[源]

generate_postprocess 方法

FalconCausalLMPreprocessor.generate_postprocess(x)

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

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


tokenizer 属性

keras_hub.models.FalconCausalLMPreprocessor.tokenizer

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