KerasHub:預訓練模型 / API 文件 / 模型架構 / Falcon / FalconCausalLM 模型

FalconCausalLM 模型

[原始碼]

FalconCausalLM 類別

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

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

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

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

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

引數

範例

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

falcon_lm = keras_hub.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_hub.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_hub.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_hub.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_hub.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_hub.models.FalconCausalLM.from_preset(
    "falcon_refinedweb_1b_en",
    preprocessor=None,
)
falcon_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自訂 backbone 和詞彙表。

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_hub.models.FalconTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_hub.models.FalconCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_hub.models.FalconBackbone(
    vocabulary_size=50304,
    num_layers=24,
    num_attention_heads=64,
    hidden_dim=2048,
    intermediate_dim=4*2048,
)
falcon_lm = keras_hub.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_hub.models.Task

預設是一個組態、權重和其他檔案資產的目錄,用於儲存和載入預訓練模型。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'

對於任何 Task 子類別,您可以執行 cls.presets.keys() 以列出類別上所有可用的內建預設。

此建構子可以兩種方式之一呼叫。從任務特定的基底類別(例如 keras_hub.models.CausalLM.from_preset())呼叫,或從模型類別(例如 keras_hub.models.BertTextClassifier.from_preset())呼叫。如果從基底類別呼叫,則傳回物件的子類別將從預設目錄中的組態推斷出來。

引數

  • preset:字串。內建預設識別碼、Kaggle Models 控制代碼、Hugging Face 控制代碼或本機目錄的路徑。
  • load_weights:布林值。如果為 True,則儲存的權重將載入到模型架構中。如果為 False,則所有權重將隨機初始化。

範例

# Load a Gemma generative task.
causal_lm = keras_hub.models.CausalLM.from_preset(
    "gemma_2b_en",
)

# Load a Bert classification task.
model = keras_hub.models.TextClassifier.from_preset(
    "bert_base_en",
    num_classes=2,
)
預設 參數 描述
falcon_refinedweb_1b_en 1.31B 24 層 Falcon 模型(具有 1B 參數的 Falcon),在 350B tokens 的 RefinedWeb 資料集上訓練。

[原始碼]

generate 方法

FalconCausalLM.generate(
    inputs, max_length=None, stop_token_ids="auto", strip_prompt=False
)

產生給定提示 inputs 的文字。

此方法根據給定的 inputs 生成文字。用於生成的採樣方法可以透過 compile() 方法設定。

如果 inputstf.data.Dataset,則輸出將「逐批次」生成並串聯。否則,所有輸入都將作為單一批次處理。

如果模型附加了 preprocessor,則 inputs 將在 generate() 函數內部進行預處理,並且應符合 preprocessor 層預期的結構(通常為原始字串)。如果未附加 preprocessor,則輸入應符合 backbone 預期的結構。請參閱上面的範例用法,以示範每種情況。

引數

  • inputs:python 資料、張量資料或 tf.data.Dataset。如果模型附加了 preprocessor,則 inputs 應符合 preprocessor 層預期的結構。如果未附加 preprocessor,則 inputs 應符合 backbone 模型預期的結構。
  • max_length:選用。整數。生成序列的最大長度。預設為 preprocessor 配置的最大 sequence_length。如果 preprocessorNone,則 inputs 應填充到所需的最大長度,並且將忽略此引數。
  • stop_token_ids:選用。None、「auto」或 token id 的元組。預設為「auto」,使用 preprocessor.tokenizer.end_token_id。未指定處理器將產生錯誤。None 會在生成 max_length 個 tokens 後停止生成。您也可以指定模型應停止的 token id 列表。請注意,tokens 序列將各自被解釋為停止 token,不支援多 token 停止序列。
  • strip_prompt:選用。預設情況下,generate() 會傳回完整提示,後接模型生成的完成內容。如果此選項設定為 True,則僅傳回新生成的文字。

backbone 屬性

keras_hub.models.FalconCausalLM.backbone

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


preprocessor 屬性

keras_hub.models.FalconCausalLM.preprocessor

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