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
)

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

Распаковка входных данных, похожих на итераторы: часто в fit() передают объект, похожий на итератор, например tf.data.Dataset или keras.utils.PyDataset, который возвращает не только признаки (x), но и, при необходимости, целевые значения (y) и веса образцов (sample_weight). Keras требует, чтобы результат таких объектов был однозначным. Итератор должен возвращать кортеж длины 1, 2 или 3, где необязательные второй и третий элементы будут использоваться соответственно для y и sample_weight. Любой другой переданный тип будет обёрнут в кортеж длины 1 и, таким образом, будет считаться 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 и позволяет создать такой же слой из словаря конфигурации. Он не обрабатывает связи слоя (это делает Network) и веса (это делает 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

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

predict(
    x, batch_size=None, verbose='auto', steps=None, callbacks=None
)

Формирует прогнозы для входных образцов.

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

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

Примечание: Подробнее о различиях между методами 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_on_batch(
    x, y=None, sample_weight=None, return_dict=False
)

Проверяет модель на одном пакете образцов.

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
)