MaskedLM

[源代码]

MaskedLM

keras_nlp.models.MaskedLM()

掩码语言建模任务的基类。

MaskedLM 任务封装了一个 keras_nlp.models.Backbone 和一个 keras_nlp.models.Preprocessor,以创建一个可用于使用掩码语言建模损失进行无监督微调的模型。

调用 fit() 时,所有输入都将被标记化,并且输入序列中的随机标记将被掩码。这些掩码标记的位置将作为额外的模型输入提供,并且模型输出预测标记的原始值。

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

示例

# Load a Bert MaskedLM with pre-trained weights.
masked_lm = keras_nlp.models.MaskedLM.from_preset(
    "bert_base_en",
)
masked_lm.fit(train_ds)

[源代码]

from_preset 方法

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

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

参数

  • preset: 字符串。内置预设标识符、Kaggle Models 句柄、Hugging Face 句柄或本地目录的路径。
  • load_weights: 布尔值。如果为 True,则保存的权重将加载到模型架构中。如果为 False,则所有权重都将随机初始化。

示例

# Load a Gemma generative task.
causal_lm = keras_nlp.models.CausalLM.from_preset(
    "gemma_2b_en",
)

# Load a Bert classification task.
model = keras_nlp.models.TextClassifier.from_preset(
    "bert_base_en",
    num_classes=2,
)

[源代码]

compile 方法

MaskedLM.compile(optimizer="auto", loss="auto", weighted_metrics="auto", **kwargs)

配置 MaskedLM 任务以进行训练。

MaskedLM 任务扩展了 keras.Model.compile 的默认编译签名,并为 optimizerlossweighted_metrics 提供了默认值。要覆盖这些默认值,请在编译期间将任何值传递给这些参数。

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

参数

  • optimizer: "auto"、优化器名称或 keras.Optimizer 实例。默认为 "auto",它使用给定模型和任务的默认优化器。有关可能的 optimizer 值的更多信息,请参阅 keras.Model.compilekeras.optimizers
  • loss: "auto"、损失名称或 keras.losses.Loss 实例。默认为 "auto",其中将为标记分类 MaskedLM 任务应用 keras.losses.SparseCategoricalCrossentropy 损失。有关可能的 loss 值的更多信息,请参阅 keras.Model.compilekeras.losses
  • weighted_metrics: "auto" 或模型在训练和测试期间要评估的指标列表。默认为 "auto",其中将应用 keras.metrics.SparseCategoricalAccuracy 来跟踪模型在猜测掩码标记值时的准确性。有关可能的 weighted_metrics 值的更多信息,请参阅 keras.Model.compilekeras.metrics
  • **kwargs: 有关编译方法支持的参数的完整列表,请参阅 keras.Model.compile

[源代码]

save_to_preset 方法

MaskedLM.save_to_preset(preset_dir)

将任务保存到预设目录。

参数

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

preprocessor 属性

keras_nlp.models.MaskedLM.preprocessor

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


backbone 属性

keras_nlp.models.MaskedLM.backbone

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