► Keras 3 API 文件 / KerasNLP / 預訓練模型 / Falcon / FalconCausalLM 模型

FalconCausalLM 模型

[來源]

FalconCausalLM 類別

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

用於因果語言建模的端到端 Falcon 模型。

因果語言模型 (LM) 會根據先前的詞彙預測下一個詞彙。此任務設定可用於在純文字輸入上以非監督式方式訓練模型，或自動遞迴地產生類似於用於訓練的資料的純文字。只需呼叫 fit()，此任務即可用於預訓練或微調 Falcon 模型。

此模型具有 generate() 方法，可根據提示產生文字。所使用的生成策略由 compile() 上的額外 sampler 參數控制。您可以使用不同的 keras_nlp.samplers 物件重新編譯模型以控制生成。預設情況下，將使用 "greedy" 採樣。

此模型可以選擇性地配置 preprocessor 層，在這種情況下，它將在 fit()、predict()、evaluate() 和 generate() 期間自動將預處理應用於字串輸入。使用 from_preset() 建立模型時，預設會執行此操作。

參數

範例

使用 generate() 進行文字生成。

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset("falcon_refinedweb_1b_en")
falcon_lm.generate("I want to say", max_length=30)

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

使用自訂採樣器編譯 generate() 函數。

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset("falcon_refinedweb_1b_en")
falcon_lm.compile(sampler="top_k")
falcon_lm.generate("I want to say", max_length=30)

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

在不進行預處理的情況下使用 generate()。

prompt = {
    # Token ids for "<|endoftext|> Keras is".
    "token_ids": np.array([[50256, 17337,   292,   318]] * 2),
    # Use `"padding_mask"` to indicate values that should not be overridden.
    "padding_mask": np.array([[1, 1, 1, 1]] * 2),
}

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset(
    "falcon_refinedweb_1b_en",
    preprocessor=None,
)
falcon_lm.generate(prompt)

在單一批次上呼叫 fit()。

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

在不進行預處理的情況下呼叫 fit()。

x = {
    # Token ids for "<|endoftext|> Keras is deep learning library<|endoftext|>"
    "token_ids": np.array([[50256, 17337,   292,   318,  2769,  4673,  5888, 50256, 0]] * 2),
    "padding_mask": np.array([[1, 1, 1, 1, 1, 1, 1, 1, 0]] * 2),
}
y = np.array([[17337,   292,   318,  2769,  4673,  5888, 50256, 0, 0]] * 2)
sw = np.array([[1, 1, 1, 1, 1, 1, 1, 0, 0]] * 2)

falcon_lm = keras_nlp.models.FalconCausalLM.from_preset(
    "falcon_refinedweb_1b_en",
    preprocessor=None,
)
falcon_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自訂主幹和詞彙表。

vocab = {"<|endoftext|>": 0, "a": 4, "Ġquick": 5, "Ġfox": 6}
merges = ["Ġ q", "u i", "c k", "ui ck", "Ġq uick"]
merges += ["Ġ f", "o x", "Ġf ox"]
tokenizer = keras_nlp.models.FalconTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_nlp.models.FalconCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_nlp.models.FalconBackbone(
    vocabulary_size=50304,
    num_layers=24,
    num_attention_heads=64,
    hidden_dim=2048,
    intermediate_dim=4*2048,
)
falcon_lm = keras_nlp.models.FalconCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
falcon_lm.fit(x=features, batch_size=2)

[來源]

from_preset 方法

FalconCausalLM.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,
)
預設集名稱 參數 描述
falcon_refinedweb_1b_en 1.31B 24 層 Falcon 模型（具有 1B 個參數的 Falcon），在 350B 個 RefinedWeb 資料集權杖上訓練。

[來源]

generate 方法

FalconCausalLM.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。如果 preprocessor 為 None，則 inputs 應該填充到所需的最大長度，並且此參數將會被忽略。
  • stop_token_ids：可選。None、「auto」或權杖 ID 的元組。預設值為「auto」，它使用 preprocessor.tokenizer.end_token_id。未指定處理器將會產生錯誤。None 會在產生 max_length 個權杖後停止產生。您也可以指定模型應該停止的權杖 ID 清單。請注意，權杖序列將會各自被解釋為停止權杖，不支援多權杖停止序列。

backbone 屬性

keras_nlp.models.FalconCausalLM.backbone

具有核心架構的 keras_nlp.models.Backbone 模型。

preprocessor 屬性

keras_nlp.models.FalconCausalLM.preprocessor

用於預處理輸入的 keras_nlp.models.Preprocessor 層。

FalconCausalLM 模型
FalconCausalLM 類別
from_preset 方法
generate 方法
backbone 屬性
preprocessor 屬性