tf.keras.Model

Модель, группирующая слои в объект с функциями обучения/вывода.

Наследуется от: Layer, Operation

tf.keras.Model(
    *args, **kwargs
)

Используется в блокнотах

Существует три способа создания экземпляра Model:

С помощью "Функционального API"

Вы начинаете с Input, вы цепочкой вызовов слоёв указываете прямой проход модели, и, наконец, создаёте модель из входных и выходных данных:

inputs = keras.Input(shape=(37,))
x = keras.layers.Dense(32, activation="relu")(inputs)
outputs = keras.layers.Dense(5, activation="softmax")(x)
model = keras.Model(inputs=inputs, outputs=outputs)

Примечание: Поддерживаются только словари, списки и кортежи входных тензоров. Вложенные входные данные не поддерживаются (например, списки списков или словари словарей).

Новая модель Functional API также может быть создана с использованием промежуточных тензоров. Это позволяет быстро извлечь подкомпоненты модели.

Пример:

inputs = keras.Input(shape=(None, None, 3))
processed = keras.layers.RandomCrop(width=128, height=128)(inputs)
conv = keras.layers.Conv2D(filters=32, kernel_size=3)(processed)
pooling = keras.layers.GlobalAveragePooling2D()(conv)
feature = keras.layers.Dense(10)(pooling)

full_model = keras.Model(inputs, feature)
backbone = keras.Model(processed, conv)
activations = keras.Model(conv, feature)

Обратите внимание, что модели backbone и activations не создаются с помощью объектов keras.Input, а с тензорами, полученными из объектов keras.Input. Под капотом слои и веса будут объединены между этими моделями, поэтому пользователь может обучить full_model и использовать backbone или activations для извлечения признаков. Входы и выходы модели также могут быть вложенными структурами тензоров, и созданные модели являются стандартными моделями Functional API, которые поддерживают все существующие API.

Наследование от класса Model

В этом случае, вы должны определить свои слои в __init__() и реализовать прямой проход модели в call().

class MyModel(keras.Model):
    def __init__(self):
        super().__init__()
        self.dense1 = keras.layers.Dense(32, activation="relu")
        self.dense2 = keras.layers.Dense(5, activation="softmax")

    def call(self, inputs):
        x = self.dense1(inputs)
        return self.dense2(x)

model = MyModel()

Если вы наследуетесь от Model, вы можете необязательно иметь аргумент training (булевый) в call(), который вы можете использовать для указания различного поведения при обучении и выводе:

class MyModel(keras.Model):
    def __init__(self):
        super().__init__()
        self.dense1 = keras.layers.Dense(32, activation="relu")
        self.dense2 = keras.layers.Dense(5, activation="softmax")
        self.dropout = keras.layers.Dropout(0.5)

    def call(self, inputs, training=False):
        x = self.dense1(inputs)
        x = self.dropout(x, training=training)
        return self.dense2(x)

model = MyModel()

После создания модели вы можете настроить модель с потерями и метриками с помощью model.compile(), обучить модель с помощью model.fit() или использовать модель для предсказания с помощью model.predict().

С помощью класса Sequential

Кроме того, keras.Sequential является специальным случаем модели, где модель представляет собой просто стопку слоёв с одним входом и одним выходом.

model = keras.Sequential([
    keras.Input(shape=(None, None, 3)),
    keras.layers.Conv2D(filters=32, kernel_size=3),
])

Методы

compile

Просмотреть исходный код

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(),
    ],
)

compile_from_config

Просмотреть исходный код

compile_from_config(
    config
)

Компилирует модель с помощью информации, предоставленной в конфигурации.

Этот метод использует информацию в конфигурации (оптимизатор, функция потерь, метрики и т. д.) для компиляции модели.

compiled_loss

Просмотреть исходный код

compiled_loss(
    y, y_pred, sample_weight=None, regularization_losses=None
)

compute_loss

Просмотреть исходный код

compute_loss(
    x=None, y=None, y_pred=None, sample_weight=None
)

Вычисляет общую потерю, проверяет её и возвращает её.

Подклассы могут по желанию переопределить этот метод, чтобы предоставить пользовательскую логику вычисления потерь.

Пример:

class MyModel(Model):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.loss_tracker = metrics.Mean(name='loss')

    def compute_loss(self, x, y, y_pred, sample_weight):
        loss = ops.means((y_pred - y) ** 2)
        loss += ops.sum(self.losses)
        self.loss_tracker.update_state(loss)
        return loss

    def reset_metrics(self):
        self.loss_tracker.reset_state()

    @property
    def metrics(self):
        return [self.loss_tracker]

inputs = layers.Input(shape=(10,), name='my_input')
outputs = layers.Dense(10)(inputs)
model = MyModel(inputs, outputs)
model.add_loss(ops.sum(outputs))

optimizer = SGD()
model.compile(optimizer, loss='mse', steps_per_execution=10)
dataset = ...
model.fit(dataset, epochs=2, steps_per_epoch=10)
print(f"Custom loss: {model.loss_tracker.result()}")

compute_metrics

Просмотреть исходный код

compute_metrics(
    x, y, y_pred, sample_weight=None
)

Обновляет состояния метрик и собирает все метрики для возврата.

Подклассы могут по желанию переопределить этот метод, чтобы предоставить пользовательскую логику обновления и сбора метрик.

Пример:

class MyModel(Sequential):
    def compute_metrics(self, x, y, y_pred, sample_weight):
        # This super call updates `self.compiled_metrics` and returns
        # results for all metrics listed in `self.metrics`.
        metric_results = super().compute_metrics(
            x, y, y_pred, sample_weight)

        # Note that `self.custom_metric` is not listed
        # in `self.metrics`.
        self.custom_metric.update_state(x, y, y_pred, sample_weight)
        metric_results['metric_name'] = self.custom_metric.result()
        return metric_results

evaluate

Просмотреть исходный код

evaluate(
    x=None,
    y=None,
    batch_size=None,
    verbose='auto',
    sample_weight=None,
    steps=None,
    callbacks=None,
    return_dict=False,
    **kwargs
)

Возвращает значение потерь и значения метрик для модели в режиме тестирования.

Вычисление выполняется по партиям (см. аргумент batch_size).

export

Просмотреть исходный код

export(
    filepath, format='tf_saved_model'
)

Создание артефакта TF SavedModel для инференции.

Примечание: В настоящее время это можно использовать только с бэкендами TensorFlow или JAX.

Этот метод позволяет экспортировать модель в лёгкий артефакт SavedModel, который содержит только прямой проход модели (метод call()) и может быть использован для обслуживания, например, через TF-Serving. Прямой проход зарегистрирован под именем serve() (см. пример ниже).

Исходный код модели (включая любые настраиваемые слои, которые вы могли использовать) больше не нужен для загрузки артефакта — он полностью автономный.

Пример:

# Create the artifact
model.export("path/to/location")

# Later, in a different process / environment...
reloaded_artifact = tf.saved_model.load("path/to/location")
predictions = reloaded_artifact.serve(input_data)

Если вы хотите настроить ваши конечные точки обслуживания, вы можете использовать класс keras.export.ExportArchive более низкого уровня. Метод export() использует ExportArchive в качестве внутренней функции.

fit

Просмотреть исходный код

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
)

Обучение модели для фиксированного числа эпох (итераций набора данных).

Поведение распаковки для итераторных входов: Общая практика — передавать итератор, такой как 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("other_tuple", ["x", "y", "z"]), где неясно, предполагалось ли распаковать кортеж в x, y и sample_weight или передать его как единый элемент в x.

from_config

Просмотреть исходный код

@classmethod
from_config(
    config, custom_objects=None
)

Создаёт слой по его конфигурации.

Этот метод является обратным get_config, способным создать тот же слой по словарю конфигурации. Он не обрабатывает подключение слоёв (это обрабатывается сетью), ни веса (это обрабатывается set_weights).

get_compile_config

Просмотреть исходный код

get_compile_config()

Возвращает сериализованную конфигурацию с информацией для компиляции модели.

Этот метод возвращает словарь конфигурации, содержащий всю информацию (оптимизатор, функция потерь, метрики и т. д.), с помощью которой была скомпилирована модель.

get_layer

Просмотреть исходный код

get_layer(
    name=None, index=None
)

Извлекает слой на основе его имени (уникального) или индекса.

Если name и index указаны оба, index будет иметь приоритет. Индексы основаны на порядке горизонтального обхода графа (сверху вниз).

get_metrics_result

Просмотреть исходный код

get_metrics_result()

Возвращает значения метрик модели в виде словаря.

Если значение результата любой метрики является словарем (содержащим несколько метрик), каждый из них добавляется в возвращаемый словарь верхнего уровня этого метода.

load_weights

Просмотреть исходный код

load_weights(
    filepath, skip_mismatch=False, **kwargs
)

Загрузка весов из файла, сохраненного с помощью save_weights().

Веса загружаются на основе топологии сети. Это означает, что архитектура должна быть такой же, как при сохранении весов. Обратите внимание, что слои, у которых нет весов, не учитываются при топологической сортировке, поэтому добавление или удаление слоев допустимо, если у них нет весов.

Частичная загрузка весов

Если вы изменили модель, например, добавили новый слой (с весами) или изменили форму весов слоя, вы можете пропустить ошибки и продолжить загрузку, установив skip_mismatch=True. В этом случае любой слой с несовпадающими весами будет пропущен. Для каждого пропущенного слоя будет выведено предупреждение.

loss

Просмотреть исходный код

loss(
    y, y_pred, sample_weight=None
)

make_predict_function

Просмотреть исходный код

make_predict_function(
    force=False
)

make_test_function

Просмотреть исходный код

make_test_function(
    force=False
)

make_train_function

Просмотреть исходный код

make_train_function(
    force=False
)

predict

Просмотреть исходный код

Генерирует предсказания для входных выборок.

Вычисления выполняются по партиям. Этот метод предназначен для пакетной обработки большого количества входов. Он не предназначен для использования внутри циклов, которые итерируются по данным и обрабатывают небольшое количество входов за раз.

Для небольшого количества входов, которые помещаются в одну партию, используйте непосредственно __call__() для более быстрого выполнения, например, model(x) или model(x, training=False), если у вас есть слои, такие как BatchNormalization, которые ведут себя по-разному во время вывода.

Примечание: См. эту страницу FAQ для получения более подробной информации о различиях между методами Model predict() и __call__().

predict_on_batch

Просмотреть исходный код

predict_on_batch(
    x
)

Возвращает предсказания для одной партии выборок.

predict_step

Просмотреть исходный код

predict_step(
    data
)

reset_metrics

Просмотреть исходный код

reset_metrics()

save

Просмотреть исходный код

save(
    filepath, overwrite=True, **kwargs
)

Сохраняет модель как файл .keras.

Пример:

model = keras.Sequential(
    [
        keras.layers.Dense(5, input_shape=(3,)),
        keras.layers.Softmax(),
    ],
)
model.save("model.keras")
loaded_model = keras.saving.load_model("model.keras")
x = keras.random.uniform((10, 3))
assert np.allclose(model.predict(x), loaded_model.predict(x))

Обратите внимание, что model.save() является псевдонимом для keras.saving.save_model().

Сохраненный .keras файл содержит:

• Конфигурацию модели (архитектуру)
• Веса модели
• Состояние оптимизатора модели (при наличии)

Таким образом, модели могут быть повторно созданы в точно таком же состоянии.

save_weights

Просмотреть исходный код

save_weights(
    filepath, overwrite=True
)

Сохраняет все весовые коэффициенты слоёв в файл .weights.h5.

stateless_compute_loss

Просмотреть исходный код

stateless_compute_loss(
    trainable_variables,
    non_trainable_variables,
    metrics_variables,
    x=None,
    y=None,
    y_pred=None,
    sample_weight=None
)

summary

Просмотреть исходный код

summary(
    line_length=None,
    positions=None,
    print_fn=None,
    expand_nested=False,
    show_trainable=False,
    layer_range=None
)

Выводит текстовое описание сети.

symbolic_call

Просмотреть исходный код

symbolic_call(
    *args, **kwargs
)

test_on_batch

Просмотреть исходный код

Тестирование модели на одной порции образцов.

test_step

Просмотреть исходный код

test_step(
    data
)

to_json

Просмотреть исходный код

to_json(
    **kwargs
)

Возвращает строку в формате JSON, содержащую конфигурацию сети.

Для загрузки сети из сохранённого файла в формате JSON используйте keras.models.model_from_json(json_string, custom_objects={...}).

train_on_batch

Просмотреть исходный код

train_on_batch(
    x, y=None, sample_weight=None, class_weight=None, return_dict=False
)

Выполняет одно обновление градиента на одной порции данных.

train_step

Просмотреть исходный код

train_step(
    data
)