compile 方法Model.compile(
optimizer="rmsprop",
loss=None,
loss_weights=None,
metrics=None,
weighted_metrics=None,
run_eagerly=False,
steps_per_execution=1,
jit_compile="auto",
auto_scale_loss=True,
)
配置模型用于训练。
示例
model.compile(
optimizer=keras.optimizers.Adam(learning_rate=1e-3),
loss=keras.losses.BinaryCrossentropy(),
metrics=[
keras.metrics.BinaryAccuracy(),
keras.metrics.FalseNegatives(),
],
)
参数
keras.optimizers。keras.losses.Loss 实例。详见 keras.losses。损失函数可以是任何带有签名 loss = fn(y_true, y_pred) 的可调用对象，其中 y_true 是真实值，y_pred 是模型的预测值。y_true 的形状应为 (batch_size, d0, .. dN)（稀疏损失函数（如稀疏分类交叉熵）除外，它需要形状为 (batch_size, d0, .. dN-1) 的整数数组）。y_pred 的形状应为 (batch_size, d0, .. dN)。损失函数应返回一个浮点张量。loss_weights 系数指定。如果是列表，应与模型的输出一一对应。如果是字典，应将输出名称（字符串）映射到标量系数。keras.metrics.Metric 实例。详见 keras.metrics。通常会使用 metrics=['accuracy']。函数可以是任何带有签名 result = fn(y_true, _pred) 的可调用对象。对于多输出模型，为了为不同输出指定不同的指标，您还可以传递一个字典，例如 metrics={'a':'accuracy', 'b':['accuracy', 'mse']}。您也可以传递一个列表，为每个输出指定一个或多个指标，例如 metrics=[['accuracy'], ['accuracy', 'mse']] 或 metrics=['accuracy', ['accuracy', 'mse']]。当您传递字符串 'accuracy' 或 'acc' 时，我们将根据目标和模型输出的形状将其转换为 keras.metrics.BinaryAccuracy、keras.metrics.CategoricalAccuracy 或 keras.metrics.SparseCategoricalAccuracy 中的一个。对于字符串 "crossentropy" 和 "ce" 也进行类似的转换。此处传递的指标在评估时不会考虑样本权重；如果您希望应用样本权重，可以通过 weighted_metrics 参数指定指标。sample_weight 或 class_weight 加权评估的指标列表。True，则此模型的前向传播将不会被编译。建议在训练时将其设为 False（以获得最佳性能），并在调试时设为 True。steps_per_execution 设置为 N，则 Callback.on_batch_begin 和 Callback.on_batch_end 方法仅在每 N 个批次后（即每次编译函数执行之前/之后）调用。PyTorch 后端不支持此功能。"auto"。编译模型时是否使用 XLA 编译。对于 jax 和 tensorflow 后端，如果模型支持 XLA 编译，则 jit_compile="auto" 会启用它，否则禁用。对于 torch 后端，"auto" 默认为 eager execution，jit_compile=True 将使用 torch.compile 及 "inductor" 后端运行。True 且模型 dtype 策略为 "mixed_float16"，则传入的优化器将自动包装在 LossScaleOptimizer 中，该优化器将动态缩放损失以防止下溢。fit 方法Model.fit(
x=None,
y=None,
batch_size=None,
epochs=1,
verbose="auto",
callbacks=None,
validation_split=0.0,
validation_data=None,
shuffle=True,
class_weight=None,
sample_weight=None,
initial_epoch=0,
steps_per_epoch=None,
validation_steps=None,
validation_batch_size=None,
validation_freq=1,
)
按固定数量的 epoch（数据集迭代次数）训练模型。
参数
keras.utils.PyDataset，返回 (inputs, targets) 或 (inputs, targets, sample_weights)。tf.data.Dataset，产生 (inputs, targets) 或 (inputs, targets, sample_weights)。torch.utils.data.DataLoader，产生 (inputs, targets) 或 (inputs, targets, sample_weights)。(inputs, targets) 或 (inputs, targets, sample_weights)。x 类似，可以是 NumPy 数组或后端原生张量。如果 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则不应指定 y，因为目标将从 x 中获取。None。每次梯度更新的样本数量。如果未指定，batch_size 将默认为 32。如果您的输入数据 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则不要指定 batch_size，因为它们会生成批次。x 和 y 数据进行一次迭代（除非 steps_per_epoch 标志设置为 None 以外的值）。请注意，结合 initial_epoch，epochs 应理解为“最终 epoch”。模型不会按照 epochs 指定的迭代次数进行训练，而只是训练到索引为 epochs 的 epoch 结束。"auto"、0、1 或 2。详细模式。0 = 静默，1 = 进度条，2 = 每 epoch 一行。“auto”在大多数情况下变为 1。请注意，当记录到文件时，进度条不是特别有用，因此在非交互式运行（例如在生产环境中）时建议使用 verbose=2。默认为 "auto"。keras.callbacks.Callback 实例列表。训练期间要应用的 callback 列表。详见 keras.callbacks。请注意，keras.callbacks.ProgbarLogger 和 keras.callbacks.History callback 是自动创建的，无需传递给 model.fit()。keras.callbacks.ProgbarLogger 是否创建取决于 model.fit() 中的 verbose 参数。x 和 y 数据中的最后样本中选取。此参数仅在 x 和 y 是 NumPy 数组或张量时受支持。如果同时提供 validation_data 和 validation_split，则 validation_data 将覆盖 validation_split。validation_split 或 validation_data 提供的数据的验证损失不受噪声和 dropout 等正则化层的影响。validation_data 将覆盖 validation_split。它可以是(x_val, y_val)。(x_val, y_val, val_sample_weights)。keras.utils.PyDataset、tf.data.Dataset、产生 (inputs, targets) 的 torch.utils.data.DataLoader 或产生 (x_val, y_val) 或 (inputs, targets, sample_weights) 的 Python 生成器函数。x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数时，此参数将被忽略。class_weight 且目标具有 2 或更高秩时，y 必须是 one-hot 编码，或者对于稀疏类别标签，必须包含一个显式的最终维度 1。(samples, sequence_length) 的 2D NumPy 数组或张量，以便对每个样本的每个时间步应用不同的权重。当 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数时，不支持此参数。此时应将 sample_weights 作为 x 的第三个元素提供。请注意，样本加权不适用于通过 compile() 的 metrics 参数指定的指标。要将样本加权应用于指标，可以通过 compile() 中的 weighted_metrics 参数指定。None。在声明一个 epoch 完成并开始下一个 epoch 之前所需的总步数（样本批次）。当使用输入张量或 NumPy 数组进行训练时，默认值 None 表示使用的值是数据集中样本数量除以批次大小，如果无法确定则为 1。如果 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则 epoch 将运行直到输入数据集耗尽。当传递一个无限重复的数据集时，必须指定 steps_per_epoch 参数，否则训练将无限期运行。None。仅在提供 validation_data 时相关。在每个 epoch 结束时执行验证之前，需要绘制的总步数（样本批次）。如果 validation_steps 为 None，验证将运行直到 validation_data 数据集耗尽。对于无限重复的数据集，它将无限期运行。如果指定了 validation_steps 且只消耗了数据集的一部分，则评估将在每个 epoch 从数据集的开头开始。这确保每次都使用相同的验证样本。None。每个验证批次的样本数量。如果未指定，将默认为 batch_size。如果您的数据是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则不要指定 validation_batch_size，因为它们会生成批次。validation_freq=2 表示每隔 2 个 epoch 运行一次验证。迭代器类输入的解包行为：一种常见模式是将类似迭代器的对象（如 tf.data.Dataset 或 keras.utils.PyDataset）传递给 fit() 方法，它实际上不仅产生特征 (x)，还可选地产生目标 (y) 和样本权重 (sample_weight)。Keras 要求此类迭代器的输出必须是明确的。迭代器应返回长度为 1、2 或 3 的元组，其中可选的第二个和第三个元素将分别用于 y 和 sample_weight。提供的任何其他类型将被包装在长度为一的元组中，从而有效地将所有内容视为 x。当产生字典时，它们仍应遵循顶层元组结构，例如 ({"x0": x0, "x1": x1}, y)。Keras 不会尝试从单个字典的键中分离特征、目标和权重。一个值得注意的不受支持的数据类型是 namedtuple。原因是它既表现得像有序数据类型（元组），又表现得像映射数据类型（字典）。因此，给定形式为 namedtuple("example_tuple", ["y", "x"]) 的 namedtuple，解释值时是否颠倒元素的顺序是不明确的。更糟糕的是形式为 namedtuple("other_tuple", ["x", "y", "z"]) 的元组，其中不清楚该元组是否旨在解包为 x、y 和 sample_weight，还是作为一个单一元素传递给 x。
返回值
一个 History 对象。其 History.history 属性记录了连续 epoch 的训练损失值和指标值，以及验证损失值和验证指标值（如果适用）。
evaluate 方法Model.evaluate(
x=None,
y=None,
batch_size=None,
verbose="auto",
sample_weight=None,
steps=None,
callbacks=None,
return_dict=False,
**kwargs
)
在测试模式下返回模型的损失值和指标值。
计算按批次进行（参见 batch_size 参数）。
参数
keras.utils.PyDataset，返回 (inputs, targets) 或 (inputs, targets, sample_weights)。tf.data.Dataset，产生 (inputs, targets) 或 (inputs, targets, sample_weights)。torch.utils.data.DataLoader，产生 (inputs, targets) 或 (inputs, targets, sample_weights)。(inputs, targets) 或 (inputs, targets, sample_weights)。x 类似，可以是 NumPy 数组或后端原生张量。如果 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则不应指定 y，因为目标将从 x 中获取。None。每次计算批次的样本数量。如果未指定，batch_size 将默认为 32。如果您的输入数据 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则不要指定 batch_size，因为它们会生成批次。"auto"、0、1 或 2。详细模式。0 = 静默，1 = 进度条，2 = 单行。“auto”在大多数情况下变为 1。请注意，当记录到文件时，进度条不是特别有用，因此在非交互式运行（例如在生产环境中）时建议使用 verbose=2。默认为 "auto"。(samples, sequence_length) 的 2D NumPy 数组或张量，以便对每个样本的每个时间步应用不同的权重。当 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数时，不支持此参数。此时应将 sample_weights 作为 x 的第三个元素提供。请注意，样本加权不适用于通过 compile() 的 metrics 参数指定的指标。要将样本加权应用于指标，可以通过 compile() 中的 weighted_metrics 参数指定。None。在声明评估轮次完成之前需要绘制的总步数（样本批次）。如果 steps 为 None，它将运行直到 x 耗尽。对于无限重复的数据集，它将无限期运行。keras.callbacks.Callback 实例列表。评估期间要应用的 callback 列表。True，则损失和指标结果将作为字典返回，其中每个键是指标的名称。如果为 False，则作为列表返回。返回值
标量测试损失（如果模型具有单个输出且无指标）或标量列表（如果模型具有多个输出和/或指标）。属性 model.metrics_names 将提供标量输出的显示标签。
predict 方法Model.predict(x, batch_size=None, verbose="auto", steps=None, callbacks=None)
为输入样本生成输出预测。
计算按批次进行。此方法专为处理大量输入的批处理而设计。它不适用于在循环内部迭代数据并一次处理少量输入的情况。
对于适合单个批次的小量输入，直接使用 __call__() 以获得更快的执行速度，例如 model(x)，或者如果您的层（如 BatchNormalization）在推断期间行为不同，则使用 model(x, training=False)。
注意：有关 Model 方法 predict() 和 __call__() 之间差异的更多详细信息，请参见 此常见问题解答条目。
参数
keras.utils.PyDataset。tf.data.Dataset。torch.utils.data.DataLoader。None。每次计算批次的样本数量。如果未指定，batch_size 将默认为 32。如果您的输入数据 x 是 keras.utils.PyDataset、tf.data.Dataset、torch.utils.data.DataLoader 或 Python 生成器函数，则不要指定 batch_size，因为它们会生成批次。"auto"、0、1 或 2。详细模式。0 = 静默，1 = 进度条，2 = 单行。“auto”在大多数情况下变为 1。请注意，当记录到文件时，进度条不是特别有用，因此在非交互式运行（例如在生产环境中）时建议使用 verbose=2。默认为 "auto"。steps 为 None，它将运行直到 x 耗尽。对于无限重复的数据集，它将无限期运行。keras.callbacks.Callback 实例列表。预测期间要应用的 callback 列表。返回值
NumPy 预测数组。
train_on_batch 方法Model.train_on_batch(
x, y=None, sample_weight=None, class_weight=None, return_dict=False
)
在单个数据批次上运行一次梯度更新。
参数
(samples, sequence_length) 的 2D 数组，以便对每个样本的每个时间步应用不同的权重。class_weight 且目标具有 2 或更高秩时，y 必须是 one-hot 编码，或者对于稀疏类别标签，必须包含一个显式的最终维度 1。True，则损失和指标结果将作为字典返回，其中每个键是指标的名称。如果为 False，则作为列表返回。返回值
标量损失值（当没有指标且 return_dict=False 时），损失和指标值列表（如果存在指标且 return_dict=False 时），或指标和损失值的字典（如果 return_dict=True 时）。
test_on_batch 方法Model.test_on_batch(x, y=None, sample_weight=None, return_dict=False)
在单个样本批次上测试模型。
参数
(samples, sequence_length) 的 2D 数组，以便对每个样本的每个时间步应用不同的权重。True，则损失和指标结果将作为字典返回，其中每个键是指标的名称。如果为 False，则作为列表返回。返回值
标量损失值（当没有指标且 return_dict=False 时），损失和指标值列表（如果存在指标且 return_dict=False 时），或指标和损失值的字典（如果 return_dict=True 时）。
predict_on_batch 方法Model.predict_on_batch(x)
返回单个样本批次的预测。
参数
返回值
NumPy 预测数组。