► KerasHub：預訓練模型 / API 文件 / 模型架構 / Gemma / GemmaCausalLM 模型

GemmaCausalLM 模型

[原始碼]

GemmaCausalLM 類別

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

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

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

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

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

引數

範例

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

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma_lm.generate("I want to say", max_length=30)

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

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

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma_lm.compile(sampler="top_k")
gemma_lm.generate("I want to say", max_length=30)

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

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

prompt = {
    # Token ids for "<bos> Keras is".
    "token_ids": np.array([[2, 214064, 603, 0, 0, 0, 0]] * 2),
    # Use `"padding_mask"` to indicate values that should not be overridden.
    "padding_mask": np.array([[1, 1, 1, 0, 0, 0, 0]] * 2),
}

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset(
    "gemma_2b_en",
    preprocessor=None,
)
gemma_lm.generate(prompt)

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

features = ["The quick brown fox jumped.", "I forgot my homework."]
gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma_lm.fit(x=features, batch_size=2)

在啟用 LoRA 微調的情況下呼叫 fit()。

features = ["The quick brown fox jumped.", "I forgot my homework."]
gemma_lm = keras_hub.models.GemmaCausalLM.from_preset("gemma_2b_en")
gemma.backbone.enable_lora(rank=4)
gemma_lm.fit(x=features, batch_size=2)

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

x = {
    # Token ids for "<bos> Keras is deep learning library<eos>"
    "token_ids": np.array([[2, 214064, 603, 5271, 6044, 9581, 1, 0]] * 2),
    "padding_mask": np.array([[1, 1, 1, 1, 1, 1, 1, 0]] * 2),
}
y = np.array([[214064, 603, 5271, 6044, 9581, 3, 0, 0]] * 2)
sw = np.array([[1, 1, 1, 1, 1, 1, 0, 0]] * 2)

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset(
    "gemma_2b_en",
    preprocessor=None,
)
gemma_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自訂骨幹網路和詞彙表。

tokenizer = keras_hub.models.GemmaTokenizer(
    proto="proto.spm",
)
preprocessor = keras_hub.models.GemmaCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
backbone = keras_hub.models.GemmaBackbone(
    vocabulary_size=30552,
    num_layers=4,
    num_heads=4,
    hidden_dim=256,
    intermediate_dim=512,
    max_sequence_length=128,
)
gemma_lm = keras_hub.models.GemmaCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
gemma_lm.fit(x=features, batch_size=2)

[原始碼]

from_preset 方法

GemmaCausalLM.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,
)
預設 參數 描述
gemma_2b_en 2.51B 20 億參數、18 層、基礎 Gemma 模型。
gemma_instruct_2b_en 2.51B 20 億參數、18 層、指令微調 Gemma 模型。
gemma_1.1_instruct_2b_en 2.51B 20 億參數、18 層、指令微調 Gemma 模型。1.1 更新提高了模型品質。
code_gemma_1.1_2b_en 2.51B 20 億參數、18 層、CodeGemma 模型。此模型已針對程式碼完成的填空中間 (FIM) 任務進行訓練。1.1 更新提高了模型品質。
code_gemma_2b_en 2.51B 20 億參數、18 層、CodeGemma 模型。此模型已針對程式碼完成的填空中間 (FIM) 任務進行訓練。
gemma2_2b_en 2.61B 20 億參數、26 層、基礎 Gemma 模型。
gemma2_instruct_2b_en 2.61B 20 億參數、26 層、指令微調 Gemma 模型。
shieldgemma_2b_en 2.61B 20 億參數、26 層、ShieldGemma 模型。
gemma_7b_en 8.54B 70 億參數、28 層、基礎 Gemma 模型。
gemma_instruct_7b_en 8.54B 70 億參數、28 層、指令微調 Gemma 模型。
gemma_1.1_instruct_7b_en 8.54B 70 億參數、28 層、指令微調 Gemma 模型。1.1 更新提高了模型品質。
code_gemma_7b_en 8.54B 70 億參數、28 層、CodeGemma 模型。此模型已針對程式碼完成的填空中間 (FIM) 任務進行訓練。
code_gemma_instruct_7b_en 8.54B 70 億參數、28 層、指令微調 CodeGemma 模型。此模型已針對與程式碼相關的聊天用例進行訓練。
code_gemma_1.1_instruct_7b_en 8.54B 70 億參數、28 層、指令微調 CodeGemma 模型。此模型已針對與程式碼相關的聊天用例進行訓練。1.1 更新提高了模型品質。
gemma2_9b_en 9.24B 90 億參數、42 層、基礎 Gemma 模型。
gemma2_instruct_9b_en 9.24B 90 億參數、42 層、指令微調 Gemma 模型。
shieldgemma_9b_en 9.24B 90 億參數、42 層、ShieldGemma 模型。
gemma2_27b_en 27.23B 270 億參數、42 層、基礎 Gemma 模型。
gemma2_instruct_27b_en 27.23B 270 億參數、42 層、指令微調 Gemma 模型。
shieldgemma_27b_en 27.23B 270 億參數、42 層、ShieldGemma 模型。

[原始碼]

generate 方法

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

產生給定提示 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" 或 token ID 元組。預設為 "auto"，它使用 preprocessor.tokenizer.end_token_id。未指定處理器將產生錯誤。None 會在產生 max_length 個 token 後停止產生。您也可以指定模型應停止的 token ID 列表。請注意，token 序列將各自被解釋為停止 token，不支援多 token 停止序列。
  • strip_prompt：選用。預設情況下，generate() 會傳回完整提示，後跟模型產生的完成文字。如果此選項設定為 True，則僅傳回新產生的文字。

backbone 屬性

keras_hub.models.GemmaCausalLM.backbone

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

preprocessor 屬性

keras_hub.models.GemmaCausalLM.preprocessor

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

[原始碼]

score 方法

GemmaCausalLM.score(
    token_ids,
    padding_mask=None,
    scoring_mode="logits",
    layer_intercept_fn=None,
    target_ids=None,
)

對提供的 token ID 表示的生成結果進行評分。

引數

  • token_ids：一個[batch_size, num_tokens] 張量，包含要評分的 token。通常，此張量擷取對 GemmaCausalLM.generate() 的呼叫輸出，即輸入文字和模型產生文字的 token。
  • padding_mask：一個[batch_size, num_tokens] 張量，指示在產生期間應保留的 token。這是 GemmaBackbone 所需的人工產物，對此函數的計算沒有影響。如果省略，此函數會使用 keras.ops.ones() 建立適當形狀的張量。
  • scoring_mode：要傳回的分數類型，可以是 "logits" 或 "loss"，兩者都將是每個輸入 token 的分數。
  • layer_intercept_fn：一個選用函數，用於使用額外計算來擴增激活，例如，作為可解釋性研究的一部分。此函數將傳遞激活作為其第一個參數，以及與該骨幹網路層相關聯的數字索引。此索引_不是 self.backbone.layers 的索引_。索引 -1 伴隨著透過在正向呼叫 self.backbone.token_embedding() 在 token_ids 上傳回的嵌入。所有後續索引將是骨幹網路中每個 Transformer 層傳回的激活的從 0 開始的索引。此函數必須傳回一個[batch_size, num_tokens, hidden_dims] 張量，可以作為模型中下一層的輸入傳遞。
  • target_ids：一個[batch_size, num_tokens] 張量，包含應計算損失的預測 token。如果提供了一個 token 跨度（張量中沿軸 = 1 的循序真值），則損失將計算為這些 token 的總計。

引發

  • ValueError：如果提供了不支援的 scoring_mode，或者在使用 ScoringMode.LOSS 時未提供 target_ids。

傳回

每個 token 的分數，以大小為[batch_size, num_tokens, vocab_size] 的張量（在 "logits" 模式下），或[batch_size, num_tokens] （在 "loss" 模式下）。

範例

使用 TensorFlow 計算嵌入和損失分數之間的梯度

gemma_lm = keras_hub.models.GemmaCausalLM.from_preset(
    "gemma_2b_en"
)
generations = gemma_lm.generate(
    ["This is a", "Where are you"],
    max_length=30
)
preprocessed = gemma_lm.preprocessor.generate_preprocess(generations)
generation_ids = preprocessed["token_ids"]
padding_mask = preprocessed["padding_mask"]
target_ids = keras.ops.roll(generation_ids, shift=-1, axis=1)

embeddings = None
with tf.GradientTape(watch_accessed_variables=True) as tape:
    def layer_intercept_fn(x, i):
        if i == -1:
            nonlocal embeddings, tape
            embeddings = x
            tape.watch(embeddings)
        return x

    losses = gemma_lm.score(
        token_ids=generation_ids,
        padding_mask=padding_mask,
        scoring_mode="loss",
        layer_intercept_fn=layer_intercept_fn,
        target_ids=target_ids,
    )

grads = tape.gradient(losses, embeddings)
GemmaCausalLM 模型
GemmaCausalLM 類別
from_preset 方法
generate 方法
backbone 屬性
preprocessor 屬性
score 方法