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

MaskedLM

`MaskedLM` 类

keras_hub.models.MaskedLM()

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

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

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

所有 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)

[source]

`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 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
albert_large_en_uncased	17.68M	24 层 ALBERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
albert_extra_large_en_uncased	58.72M	24 层 ALBERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
albert_extra_extra_large_en_uncased	222.60M	12 层 ALBERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
bert_tiny_en_uncased	4.39M	2 层 BERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
bert_tiny_en_uncased_sst2	4.39M	在 SST-2 情感分析数据集上微调的 bert_tiny_en_uncased backbone 模型。
bert_small_en_uncased	28.76M	4 层 BERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
bert_medium_en_uncased	41.37M	8 层 BERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
bert_base_zh	102.27M	12 层 BERT 模型。在中国维基百科上训练。
bert_base_en	108.31M	12 层 BERT 模型，其中保留大小写。在英文维基百科 + BooksCorpus 上训练。
bert_base_en_uncased	109.48M	12 层 BERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
bert_base_multi	177.85M	12 层 BERT 模型，其中保留大小写。在 104 种语言的维基百科上训练
bert_large_en	333.58M	24 层 BERT 模型，其中保留大小写。在英文维基百科 + BooksCorpus 上训练。
bert_large_en_uncased	335.14M	24 层 BERT 模型，其中所有输入均为小写。在英文维基百科 + BooksCorpus 上训练。
deberta_v3_extra_small_en	70.68M	12 层 DeBERTaV3 模型，其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_small_en	141.30M	6 层 DeBERTaV3 模型，其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_base_en	183.83M	12 层 DeBERTaV3 模型，其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
deberta_v3_base_multi	278.22M	12 层 DeBERTaV3 模型，其中保留大小写。在 2.5TB 多语言 CC100 数据集上训练。
deberta_v3_large_en	434.01M	24 层 DeBERTaV3 模型，其中保留大小写。在英文维基百科、BookCorpus 和 OpenWebText 上训练。
distil_bert_base_en	65.19M	6 层 DistilBERT 模型，其中保留大小写。使用 BERT 作为教师模型在英文维基百科 + BooksCorpus 上训练。
distil_bert_base_en_uncased	66.36M	6 层 DistilBERT 模型，其中所有输入均为小写。使用 BERT 作为教师模型在英文维基百科 + BooksCorpus 上训练。
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 模型，其中保留大小写。在英文维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
roberta_large_en	354.31M	24 层 RoBERTa 模型，其中保留大小写。在英文维基百科、BooksCorpus、CommonCraw 和 OpenWebText 上训练。
xlm_roberta_base_multi	277.45M	12 层 XLM-RoBERTa 模型，其中保留大小写。在 100 种语言的 CommonCrawl 上训练。
xlm_roberta_large_multi	558.84M	24 层 XLM-RoBERTa 模型，其中保留大小写。在 100 种语言的 CommonCrawl 上训练。

[source]

`compile` 方法

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

配置 MaskedLM 任务以进行训练。

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

请注意，由于训练输入包括从损失中排除的填充 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 分类 MaskedLM 任务。有关可能的 loss 值的更多信息，请参阅 keras.Model.compile 和 keras.losses。
weighted_metrics: "auto"，或要在模型训练和测试期间评估的指标列表。默认为 "auto"，其中 keras.metrics.SparseCategoricalAccuracy 将应用于跟踪模型在猜测掩码 token 值时的准确率。有关可能的 weighted_metrics 值的更多信息，请参阅 keras.Model.compile 和 keras.metrics。
**kwargs: 有关 compile 方法支持的完整参数列表，请参阅 keras.Model.compile。

[source]

`save_to_preset` 方法

MaskedLM.save_to_preset(preset_dir)

将任务保存到预设目录。

参数

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

`preprocessor` 属性

keras_hub.models.MaskedLM.preprocessor

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

`backbone` 属性

keras_hub.models.MaskedLM.backbone

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

MaskedLM

MaskedLM 类

from_preset 方法

compile 方法

save_to_preset 方法

preprocessor 属性

backbone 属性

MaskedLM

MaskedLM 类

from_preset 方法

compile 方法

save_to_preset 方法

preprocessor 属性

backbone 属性

`MaskedLM` 类

`from_preset` 方法

`compile` 方法

`save_to_preset` 方法

`preprocessor` 属性

`backbone` 属性