Seq2SeqLM

[source]

Seq2SeqLM 类

keras_hub.models.Seq2SeqLM()

用于序列到序列语言建模任务的基类。

Seq2SeqLM 任务封装了一个 keras_hub.models.Backbone 和一个 keras_hub.models.Preprocessor，以创建一个可用于生成和生成式微调的模型，当生成以序列到序列设置中的附加输入序列为条件时。

Seq2SeqLM 任务提供了一个额外的、高级的 generate() 函数，该函数可用于自回归地逐个 token 采样输出序列。Seq2SeqLM 类的 compile() 方法包含一个额外的 sampler 参数，该参数可用于传递一个 keras_hub.samplers.Sampler 来控制如何采样预测的分布。

当调用 fit() 时，每个输入应包含一个输入和输出序列。模型将接受训练，以使用因果掩码逐个 token 预测输出序列，类似于 keras_hub.models.CausalLM 任务。与 CausalLM 任务不同，必须传递输入序列，并且输出序列中的所有 token 都可以完全关注该输入序列。

所有 Seq2SeqLM 任务都包含一个 from_preset() 构造函数，该构造函数可用于加载预训练的配置和权重。

示例

# Load a Bart backbone with pre-trained weights.
seq_2_seq_lm = keras_hub.models.Seq2SeqLM.from_preset(
    "bart_base_en",
)
seq_2_seq_lm.compile(sampler="top_k")
# Generate conditioned on the `"The quick brown fox."` as an input sequence.
seq_2_seq_lm.generate("The quick brown fox.", max_length=30)

[source]

from_preset 方法

Seq2SeqLM.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,
)

[source]

compile 方法

Seq2SeqLM.compile(
    optimizer="auto", loss="auto", weighted_metrics="auto", sampler="top_k", **kwargs
)

配置 CausalLM 任务以进行训练和生成。

CausalLM 任务使用 optimizer、loss 和 weighted_metrics 的默认值扩展了 keras.Model.compile 的默认编译签名。要覆盖这些默认值，请在编译期间将任何值传递给这些参数。

CausalLM 任务向 compile 添加了一个新的 sampler，可用于控制 generate 函数使用的采样策略。

请注意，由于训练输入包括从损失中排除的填充 token，因此几乎总是建议使用 weighted_metrics 而不是 metrics 进行编译。

参数

• optimizer: "auto"、优化器名称或 keras.Optimizer 实例。默认为 "auto"，它使用给定模型和任务的默认优化器。有关可能的 optimizer 值的更多信息，请参阅 keras.Model.compile 和 keras.optimizers。
• loss: "auto"、损失名称或 keras.losses.Loss 实例。默认为 "auto"，其中 keras.losses.SparseCategoricalCrossentropy 损失将应用于 token 分类 CausalLM 任务。有关可能的 loss 值的更多信息，请参阅 keras.Model.compile 和 keras.losses。
• weighted_metrics: "auto" 或在模型训练和测试期间要评估的指标列表。默认为 "auto"，其中 keras.metrics.SparseCategoricalAccuracy 将应用于跟踪模型在猜测掩码 token 值时的准确率。有关可能的 weighted_metrics 值的更多信息，请参阅 keras.Model.compile 和 keras.metrics。
• sampler: 采样器名称或 keras_hub.samplers.Sampler 实例。配置在 generate() 调用期间使用的采样方法。有关内置采样策略的完整列表，请参阅 keras_hub.samplers。
• **kwargs: 有关 compile 方法支持的完整参数列表，请参阅 keras.Model.compile。

[source]

generate 方法

Seq2SeqLM.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，不支持多 token 停止序列。
• strip_prompt: 可选。默认情况下，generate() 返回完整提示，后跟模型生成的完成文本。如果此选项设置为 True，则仅返回新生成的文本。

[source]

save_to_preset 方法

Seq2SeqLM.save_to_preset(preset_dir)

将任务保存到预设目录。

参数

• preset_dir: 本地模型预设目录的路径。

preprocessor 属性

keras_hub.models.Seq2SeqLM.preprocessor

用于预处理输入的 keras_hub.models.Preprocessor 层。

backbone 属性

keras_hub.models.Seq2SeqLM.backbone

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