KerasHub:預訓練模型 / API 文件 / 模型架構 / Bart / BartSeq2SeqLM 模型

BartSeq2SeqLM 模型

[來源]

BartSeq2SeqLM 類別

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

用於 seq2seq 語言建模的端到端 BART 模型。

seq2seq 語言模型 (LM) 是一個編碼器-解碼器模型,用於條件文字生成。編碼器會接收「上下文」文字(輸入到編碼器),而解碼器會根據編碼器輸入和先前的符記預測下一個符記。您可以微調 BartSeq2SeqLM,為任何 seq2seq 任務(例如,翻譯或摘要)生成文字。

此模型具有 generate() 方法,該方法根據編碼器輸入和解碼器的可選提示生成文字。所使用的生成策略由傳遞給 compile() 的額外 sampler 參數控制。您可以使用不同的 keras_hub.samplers 物件重新編譯模型,以控制生成。預設情況下,將使用 "top_k" 取樣。

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

免責聲明:預訓練模型按「現狀」提供,不提供任何形式的擔保或條件。底層模型由第三方提供,並受單獨的許可證約束,此處提供。

引數

  • backbonekeras_hub.models.BartBackbone 實例。
  • preprocessorkeras_hub.models.BartSeq2SeqLMPreprocessorNone。如果為 None,則此模型不會應用預處理,且輸入應在呼叫模型之前進行預處理。

範例

使用 generate() 根據輸入上下文執行文字生成。

bart_lm = keras_hub.models.BartSeq2SeqLM.from_preset("bart_base_en")
bart_lm.generate("The quick brown fox", max_length=30)

# Generate with batched inputs.
bart_lm.generate(["The quick brown fox", "The whale"], max_length=30)

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

bart_lm = keras_hub.models.BartSeq2SeqLM.from_preset("bart_base_en")
bart_lm.compile(sampler="greedy")
bart_lm.generate("The quick brown fox", max_length=30)

generate() 與編碼器輸入和不完整的解碼器輸入(提示)一起使用。

bart_lm = keras_hub.models.BartSeq2SeqLM.from_preset("bart_base_en")
bart_lm.generate(
    {
        "encoder_text": "The quick brown fox",
        "decoder_text": "The fast"
    }
)

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

# Preprocessed inputs, with encoder inputs corresponding to
# "The quick brown fox", and the decoder inputs to "The fast". Use
# `"padding_mask"` to indicate values that should not be overridden.
prompt = {
    "encoder_token_ids": np.array([[0, 133, 2119, 6219, 23602, 2, 1, 1]]),
    "encoder_padding_mask": np.array(
        [[True, True, True, True, True, True, False, False]]
    ),
    "decoder_token_ids": np.array([[2, 0, 133, 1769, 2, 1, 1]]),
    "decoder_padding_mask": np.array([[True, True, True, True, False, False]])
}

bart_lm = keras_hub.models.BartSeq2SeqLM.from_preset(
    "bart_base_en",
    preprocessor=None,
)
bart_lm.generate(prompt)

在單一批次上呼叫 fit()

features = {
    "encoder_text": ["The quick brown fox jumped.", "I forgot my homework."],
    "decoder_text": ["The fast hazel fox leapt.", "I forgot my assignment."]
}
bart_lm = keras_hub.models.BartSeq2SeqLM.from_preset("bart_base_en")
bart_lm.fit(x=features, batch_size=2)

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

x = {
    "encoder_token_ids": np.array([[0, 133, 2119, 2, 1]] * 2),
    "encoder_padding_mask": np.array([[1, 1, 1, 1, 0]] * 2),
    "decoder_token_ids": np.array([[2, 0, 133, 1769, 2]] * 2),
    "decoder_padding_mask": np.array([[1, 1, 1, 1, 1]] * 2),
}
y = np.array([[0, 133, 1769, 2, 1]] * 2)
sw = np.array([[1, 1, 1, 1, 0]] * 2)

bart_lm = keras_hub.models.BartSeq2SeqLM.from_preset(
    "bart_base_en",
    preprocessor=None,
)
bart_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自訂骨幹和詞彙。

features = {
    "encoder_text": [" afternoon sun"],
    "decoder_text": ["noon sun"],
}
vocab = {
    "<s>": 0,
    "<pad>": 1,
    "</s>": 2,
    "Ġafter": 5,
    "noon": 6,
    "Ġsun": 7,
}
merges = ["Ġ a", "Ġ s", "Ġ n", "e r", "n o", "o n", "Ġs u", "Ġa f", "no on"]
merges += ["Ġsu n", "Ġaf t", "Ġaft er"]

tokenizer = keras_hub.models.BartTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_hub.models.BartSeq2SeqLMPreprocessor(
    tokenizer=tokenizer,
    encoder_sequence_length=128,
    decoder_sequence_length=128,
)
backbone = keras_hub.models.BartBackbone(
    vocabulary_size=50265,
    num_layers=6,
    num_heads=12,
    hidden_dim=768,
    intermediate_dim=3072,
    max_sequence_length=128,
)
bart_lm = keras_hub.models.BartSeq2SeqLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
bart_lm.fit(x=features, batch_size=2)

[來源]

from_preset 方法

BartSeq2SeqLM.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,
)
預設值 參數 說明
bart_base_en 139.42M 6 層 BART 模型,其中保留大小寫。在 BookCorpus、英文維基百科和 CommonCrawl 上訓練。
bart_large_en 406.29M 12 層 BART 模型,其中保留大小寫。在 BookCorpus、英文維基百科和 CommonCrawl 上訓練。
bart_large_en_cnn 406.29M 在 CNN+DM 摘要資料集上微調的 bart_large_en 骨幹模型。

[來源]

generate 方法

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

產生給定提示 inputs 的文字。

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

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

如果模型附加了 preprocessor,則會在 generate() 函式內部預處理 inputs,且應與 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」或符記 ID 的元組。預設為「auto」,它使用 preprocessor.tokenizer.end_token_id。不指定處理器會產生錯誤。None 會在產生 max_length 個符記後停止產生。您也可以指定模型應停止的一系列符記 ID。請注意,符記序列將被解釋為停止符記,不支援多符記停止序列。
  • strip_prompt:選用。預設情況下,generate() 會傳回完整的提示,後接模型產生的完成文字。如果將此選項設定為 True,則只會傳回新產生的文字。

backbone 屬性

keras_hub.models.BartSeq2SeqLM.backbone

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


preprocessor 屬性

keras_hub.models.BartSeq2SeqLM.preprocessor

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