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 序列中的下一個權杖 ID。

為了用於生成,該層還公開了兩種方法 generate_preprocess()generate_postprocess()。當這個預處理器附加到 keras_nlp.models.FalconCausalLM 實例時,這些方法將在 generate() 中隱式調用。它們也可以獨立調用(例如,在單獨的進程中預先計算生成的預處理輸入)。

參數

  • tokenizer:一個 keras_nlp.models.FalconTokenizer 實例。
  • sequence_length:打包輸入的長度。
  • add_start_token:如果為 True,預處理器會將分詞器的起始權杖添加到每個輸入序列的開頭。
  • add_end_token:如果為 True,預處理器會將分詞器的結束權杖添加到每個輸入序列的結尾。

調用參數

  • 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 1.31B 24 層 Falcon 模型(具有 1B 參數的 Falcon),在 350B 個 RefinedWeb 資料集的詞彙上訓練。

[來源]

generate_preprocess 方法

FalconCausalLMPreprocessor.generate_preprocess(x, sequence_length=None)

將字串轉換為用於生成的整數詞彙輸入。

與呼叫訓練層類似,此方法會接收字串或張量字串,對輸入進行詞彙化和打包,並計算遮罩所有未填入填充值的輸入的填充遮罩。

與呼叫訓練層不同,此方法不會計算標籤,也不會將 tokenizer.end_token_id 附加到序列的末尾(因為預計生成會在輸入提示的末尾繼續)。


[來源]

generate_postprocess 方法

FalconCausalLMPreprocessor.generate_postprocess(x)

將整數詞彙輸出轉換為用於生成的字串。

此方法會反轉 generate_preprocess(),方法是先移除所有填充和開始/結束詞彙,然後將整數序列轉換回字串。


tokenizer 屬性

keras_nlp.models.FalconCausalLMPreprocessor.tokenizer

用於對字串進行詞彙化的詞彙化器。