Keras 3 API 文档 / KerasNLP / 模型 API / CausalLMPreprocessor

CausalLMPreprocessor

[来源]

CausalLMPreprocessor

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

因果语言建模预处理层的基类。

CausalLMPreprocessor 任务包装 keras_nlp.tokenizer.Tokenizer 以创建因果语言建模任务的预处理层。它旨在与 keras.models.CausalLM 任务配对。

所有 CausalLMPreprocessor 都接受一个输入。这可以是单个字符串或字符串批次。请参见下面的示例。这些输入将被分词并填充/截断到固定的序列长度。

此层将始终输出一个 (x, y, sample_weight) 元组,其中 x 是包含分词输入的字典,y 包含 x 中偏移 1 的令牌,sample_weight 标记 y 中包含填充值的位置。x 的确切内容将根据所使用的模型而有所不同。

CausalLMPreprocessor 包含两个额外的函数,generate_preprocessgenerate_postprocess,用于生成。请参见下面的示例。

所有 CausalLMPreprocessor 任务都包含一个 from_preset() 构造函数,它可以用来加载预训练的配置和词汇表。您可以直接在此基类上调用 from_preset() 构造函数,在这种情况下,您的模型的正确类将被自动实例化。

示例。

preprocessor = keras_nlp.models.CausalLMPreprocessor.from_preset(
    "bert_base_en_uncased",
    sequence_length=256, # Optional.
)

# Tokenize, mask and pack a single sentence.
x = "The quick brown fox jumped."
x, y, sample_weight = preprocessor(x)

# Tokenize and pad/truncate a batch of labeled sentences.
x = ["The quick brown fox jumped.", "Call me Ishmael."]
x, y, sample_weight = preprocessor(x)

# With a [`tf.data.Dataset`](https://tensorflowcn.cn/api_docs/python/tf/data/Dataset).
ds = tf.data.Dataset.from_tensor_slices(x)
ds = ds.map(preprocessor, num_parallel_calls=tf.data.AUTOTUNE)

# Generate preprocess and postprocess.
x = preprocessor.generate_preprocess(x)  # Tokenized numeric inputs.
x = preprocessor.generate_postprocess(x)  # Detokenized string outputs.

[来源]

from_preset 方法

CausalLMPreprocessor.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",
)

[来源]

save_to_preset 方法

CausalLMPreprocessor.save_to_preset(preset_dir)

将预处理器保存到预设目录。

参数

  • preset_dir: 本地模型预设目录的路径。

tokenizer 属性

keras_nlp.models.CausalLMPreprocessor.tokenizer

用于分词字符串的分词器。