► KerasHub：预训练模型 / API 文档 / 建模 API / MaskedLM

MaskedLM

`MaskedLM` 类

keras_hub.models.MaskedLM()

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

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

调用 fit() 时，所有输入将被分词，并且输入序列中的随机标记将被掩码。这些掩码标记的位置将作为附加模型输入馈送，并且模型的输出会预测这些标记的原始值。

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

示例

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

[源代码]

`from_preset` 方法

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

从模型预设实例化 keras_hub.models.Task。

预设是一个目录，包含用于保存和加载预训练模型的配置、权重和其他文件资产。preset 可以作为以下之一传入：

一个内置预设标识符，例如 'bert_base_en'
一个 Kaggle Models 句柄，例如 'kaggle://user/bert/keras/bert_base_en'
一个 Hugging Face 句柄，例如 'hf://user/bert_base_en'
本地预设目录的路径，例如 './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,
)

预设	参数数量	描述
albert_base_en_uncased	11.68M	12 层 ALBERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
albert_large_en_uncased	17.68M	24 层 ALBERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
albert_extra_large_en_uncased	58.72M	24 层 ALBERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
albert_extra_extra_large_en_uncased	222.60M	12 层 ALBERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
bert_tiny_en_uncased	4.39M	2 层 BERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
bert_tiny_en_uncased_sst2	4.39M	在 SST-2 情感分析数据集上微调的 bert_tiny_en_uncased 主干模型。
bert_small_en_uncased	28.76M	4 层 BERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
bert_medium_en_uncased	41.37M	8 层 BERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
bert_base_zh	102.27M	12 层 BERT 模型。在 Chinese Wikipedia 上训练。
bert_base_en	108.31M	12 层 BERT 模型，保留大小写。在 English Wikipedia + BooksCorpus 上训练。
bert_base_en_uncased	109.48M	12 层 BERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
bert_base_multi	177.85M	12 层 BERT 模型，保留大小写。在 104 种语言的维基百科上训练
bert_large_en	333.58M	24 层 BERT 模型，保留大小写。在 English Wikipedia + BooksCorpus 上训练。
bert_large_en_uncased	335.14M	24 层 BERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练。
deberta_v3_extra_small_en	70.68M	12 层 DeBERTaV3 模型，保留大小写。在 English Wikipedia、BookCorpus 和 OpenWebText 上训练。
deberta_v3_small_en	141.30M	6 层 DeBERTaV3 模型，保留大小写。在 English Wikipedia、BookCorpus 和 OpenWebText 上训练。
deberta_v3_base_en	183.83M	12 层 DeBERTaV3 模型，保留大小写。在 English Wikipedia、BookCorpus 和 OpenWebText 上训练。
deberta_v3_base_multi	278.22M	12 层 DeBERTaV3 模型，保留大小写。在 2.5TB 多语言 CC100 数据集上训练。
deberta_v3_large_en	434.01M	24 层 DeBERTaV3 模型，保留大小写。在 English Wikipedia、BookCorpus 和 OpenWebText 上训练。
distil_bert_base_en	65.19M	6 层 DistilBERT 模型，保留大小写。在 English Wikipedia + BooksCorpus 上训练，使用 BERT 作为教师模型。
distil_bert_base_en_uncased	66.36M	6 层 DistilBERT 模型，所有输入都已转换为小写。在 English Wikipedia + BooksCorpus 上训练，使用 BERT 作为教师模型。
distil_bert_base_multi	134.73M	6 层 DistilBERT 模型，保留大小写。在 104 种语言的维基百科上训练
f_net_base_en	82.86M	12 层 FNet 模型，保留大小写。在 C4 数据集上训练。
f_net_large_en	236.95M	24 层 FNet 模型，保留大小写。在 C4 数据集上训练。
roberta_base_en	124.05M	12 层 RoBERTa 模型，保留大小写。在 English Wikipedia、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
roberta_large_en	354.31M	24 层 RoBERTa 模型，保留大小写。在 English Wikipedia、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
xlm_roberta_base_multi	277.45M	12 层 XLM-RoBERTa 模型，保留大小写。在 CommonCrawl 上训练，涵盖 100 种语言。
xlm_roberta_large_multi	558.84M	24 层 XLM-RoBERTa 模型，保留大小写。在 CommonCrawl 上训练，涵盖 100 种语言。

[源代码]

`compile` 方法

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

配置 MaskedLM 任务用于训练。

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

请注意，由于训练输入包含填充标记（这些标记不计入损失），因此几乎总是建议使用 weighted_metrics 而不是 metrics 进行编译。

参数

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