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

FalconCausalLMPreprocessor 層

[原始碼]

FalconCausalLMPreprocessor 類別

keras_hub.models.FalconCausalLMPreprocessor(
    tokenizer, sequence_length=1024, add_start_token=True, add_end_token=True, **kwargs
)

Falcon 因果語言模型預處理器。

這個預處理層旨在與 keras_hub.models.FalconCausalLM 一起使用。預設情況下,它會接收字串批次,並以 (x, y, sample_weight) 格式傳回輸出,其中 y 標籤是 x 序列中的下一個 token id。

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

參數

  • tokenizer:一個 keras_hub.models.FalconTokenizer 實例。
  • sequence_length:打包輸入的長度。
  • add_start_token:若為 True,預處理器將把 tokenizer 的開始 token 前置到每個輸入序列。
  • add_end_token:若為 True,預處理器將把 tokenizer 的結束 token 附加到每個輸入序列。

呼叫參數

  • x:字串、tf.Tensor 或 python 字串列表。
  • y:標籤資料。應始終為 None,因為此層會生成標籤。
  • sample_weight:標籤權重。應始終為 None,因為此層會生成標籤權重。
  • sequence_length:傳遞此參數以覆寫此層配置的 sequence_length

範例

# Load the preprocessor from a preset.
preprocessor = keras_hub.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, config_file="preprocessor.json", **kwargs
)

從模型預設配置實例化一個 keras_hub.models.Preprocessor

預設配置是一個目錄,其中包含用於儲存和載入預訓練模型的配置、權重和其他檔案資產。preset 可以作為以下其中之一傳遞:

  1. 內建預設配置識別符,例如 'bert_base_en'
  2. Kaggle Models handle,例如 'kaggle://user/bert/keras/bert_base_en'
  3. Hugging Face handle,例如 'hf://user/bert_base_en'
  4. 本機預設配置目錄的路徑,例如 './bert_base_en'

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

由於給定模型通常有多個預處理類別,因此此方法應在特定的子類別上呼叫,例如 keras_hub.models.BertTextClassifierPreprocessor.from_preset()

參數

  • preset:字串。內建預設配置識別符、Kaggle Models handle、Hugging Face handle 或本機目錄的路徑。

範例

# Load a preprocessor for Gemma generation.
preprocessor = keras_hub.models.CausalLMPreprocessor.from_preset(
    "gemma_2b_en",
)

# Load a preprocessor for Bert classification.
preprocessor = keras_hub.models.TextClassifierPreprocessor.from_preset(
    "bert_base_en",
)
預設配置 參數 描述
falcon_refinedweb_1b_en 1.31B 24 層 Falcon 模型 (具有 10 億參數的 Falcon),在 3500 億個 RefinedWeb 資料集 tokens 上訓練。

[原始碼]

generate_preprocess 方法

FalconCausalLMPreprocessor.generate_preprocess(x, sequence_length=None)

將字串轉換為整數 token 輸入,以用於生成。

類似於為了訓練而呼叫此層,此方法接收字串或 tensor 字串,對輸入進行 token 化和打包,並計算一個 padding mask,遮罩所有未以 padding 值填滿的輸入。

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


[原始碼]

generate_postprocess 方法

FalconCausalLMPreprocessor.generate_postprocess(x)

將整數 token 輸出轉換為字串,以用於生成。

此方法反轉 generate_preprocess(),首先移除所有 padding 和開始/結束 token,然後將整數序列轉換回字串。


tokenizer 屬性

keras_hub.models.FalconCausalLMPreprocessor.tokenizer

用於 token 化字串的 tokenizer。