Keras 3 API 文档 / KerasHub / 预训练模型 / OPT / OPTCausalLM 模型

OPTCausalLM 模型

[来源]

OPTCausalLM

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

用于因果语言建模的端到端 OPT 模型。

因果语言模型 (LM) 根据之前的标记预测下一个标记。此任务设置可用于在纯文本输入上对模型进行无监督训练,或自动回归地生成与用于训练的数据相似的纯文本。此任务可用于预训练或微调 GPT-2 模型,只需调用 fit() 即可。

此模型具有 generate() 方法,该方法根据提示生成文本。所使用的生成策略由 compile() 上的额外 sampler 参数控制。您可以使用不同的 keras_hub.samplers 对象重新编译模型以控制生成。默认情况下,将使用 "top_k" 采样。

此模型可以选择配置一个 preprocessor 层,在这种情况下,它将在 fit()predict()evaluate()generate() 期间自动对字符串输入应用预处理。使用 from_preset() 创建模型时,默认情况下会执行此操作。

免责声明:预训练模型按“现状”提供,没有任何形式的保证或条件。基础模型由第三方提供,并受单独许可的约束,可在 此处 获取。

参数

示例

使用 generate() 进行文本生成。

opt_lm = keras_hub.models.OPTCausalLM.from_preset("opt_125m_en")
opt_lm.generate("I want to say", max_length=30)

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

使用自定义采样器编译 generate() 函数。

opt_lm = keras_hub.models.OPTCausalLM.from_preset("opt_125m_en")
opt_lm.compile(sampler="greedy")
opt_lm.generate("I want to say", max_length=30)

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

在没有预处理的情况下使用 generate()

# Prompt the model with `5338, 318` (the token ids for `"Who is"`).
# Use `"padding_mask"` to indicate values that should not be overridden.
prompt = {
    "token_ids": np.array([[5338, 318, 0, 0, 0]] * 2),
    "padding_mask": np.array([[1, 1, 0, 0, 0]] * 2),
}

opt_lm = keras_hub.models.OPTCausalLM.from_preset(
    "opt_125m_en",
    preprocessor=None,
)
opt_lm.generate(prompt)

在一个批次上调用 fit()

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

在没有预处理的情况下调用 fit()

x = {
    "token_ids": np.array([[1, 2, 3, 4, 5]] * 2),
    "padding_mask": np.array([[1, 1, 1, 1, 1]] * 2),
}
y = np.array([[2, 3, 4, 5, 0]] * 2)
sw = np.array([[1, 1, 1, 1, 1]] * 2)

opt_lm = keras_hub.models.OPTCausalLM.from_preset(
    "opt_base_en",
    preprocessor=None,
)
opt_lm.fit(x=x, y=y, sample_weight=sw, batch_size=2)

自定义骨干和词汇表。

features = ["a quick fox.", "a fox quick."]
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.OPTTokenizer(
    vocabulary=vocab,
    merges=merges,
)
preprocessor = keras_hub.models.OPTCausalLMPreprocessor(
    tokenizer=tokenizer,
    sequence_length=128,
)
model = keras_hub.models.OPTBackbone(
    vocabulary_size=50265,
    num_layers=4,
    num_heads=4,
    hidden_dim=256,
    intermediate_dim=512,
    max_sequence_length=128,
)
opt_lm = keras_hub.models.OPTCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
opt_lm.fit(x=features, batch_size=2)

[来源]

from_preset 方法

OPTCausalLM.from_preset(preset, load_weights=True, **kwargs)

从模型预设实例化一个 keras_hub.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_hub.models.CausalLM.from_preset(),要么从模型类调用,例如 keras_hub.models.BertTextClassifier.from_preset()。如果从基类调用,则返回对象的子类将从预设目录中的配置推断出来。

参数

  • preset: 字符串。内置预设标识符、Kaggle 模型句柄、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,
)
预设名称 参数 描述
opt_125m_en 125.24M 12 层 OPT 模型,其中保留大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
opt_1.3b_en 1.32B 24 层 OPT 模型,其中保留大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
opt_2.7b_en 2.70B 32 层 OPT 模型,其中保留大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。
opt_6.7b_en 6.70B 32 层 OPT 模型,其中保留大小写。在 BookCorpus、CommonCrawl、Pile 和 PushShift.io 语料库上训练。

[来源]

generate 方法

OPTCausalLM.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: 可选。int。生成序列的最大长度。将默认为 preprocessor 的最大配置 sequence_length。如果 preprocessorNone,则 inputs 应填充到所需的长度,并且此参数将被忽略。
  • stop_token_ids: 可选。None、"auto" 或元组令牌 ID。默认为 "auto",它使用 preprocessor.tokenizer.end_token_id。未指定处理器将产生错误。None 在生成 max_length 个令牌后停止生成。您也可以指定模型应停止的令牌 ID 列表。请注意,每个令牌序列都将被解释为一个停止令牌,不支持多令牌停止序列。

backbone 属性

keras_hub.models.OPTCausalLM.backbone

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


preprocessor 属性

keras_hub.models.OPTCausalLM.preprocessor

一个 keras_hub.models.Preprocessor 层,用于预处理输入。