tf.keras.Model

Model группирует слои в объект с функциями обучения и вывода.

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

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

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

1 - С использованием "функционального API", где вы начинаете с Input, цепочкой вызовов слоев определяете прямой проход модели, и, наконец, создаёте модель из входных и выходных данных:

import tensorflow as tf

inputs = tf.keras.Input(shape=(3,))
x = tf.keras.layers.Dense(4, activation=tf.nn.relu)(inputs)
outputs = tf.keras.layers.Dense(5, activation=tf.nn.softmax)(x)
model = tf.keras.Model(inputs=inputs, outputs=outputs)

2 - Наследуя класс Model: в этом случае вы должны определить свои слои в __init__, и реализовать прямой проход модели в call.

import tensorflow as tf

class MyModel(tf.keras.Model):

  def __init__(self):
    super(MyModel, self).__init__()
    self.dense1 = tf.keras.layers.Dense(4, activation=tf.nn.relu)
    self.dense2 = tf.keras.layers.Dense(5, activation=tf.nn.softmax)

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

model = MyModel()

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

import tensorflow as tf

class MyModel(tf.keras.Model):

  def __init__(self):
    super(MyModel, self).__init__()
    self.dense1 = tf.keras.layers.Dense(4, activation=tf.nn.relu)
    self.dense2 = tf.keras.layers.Dense(5, activation=tf.nn.softmax)
    self.dropout = tf.keras.layers.Dropout(0.5)

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

model = MyModel()

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

inputs = tf.keras.layers.Input(shape=(3,))
outputs = tf.keras.layers.Dense(2)(inputs)
model = tf.keras.models.Model(inputs=inputs, outputs=outputs)
model.compile(optimizer="Adam", loss="mse", metrics=["mae"])
model.metrics_names
[]

x = np.random.random((2, 3))
y = np.random.randint(0, 2, (2, 2))
model.fit(x, y)
model.metrics_names
['loss', 'mae']

inputs = tf.keras.layers.Input(shape=(3,))
d = tf.keras.layers.Dense(2, name='out')
output_1 = d(inputs)
output_2 = d(inputs)
model = tf.keras.models.Model(
   inputs=inputs, outputs=[output_1, output_2])
model.compile(optimizer="Adam", loss="mse", metrics=["mae", "acc"])
model.fit(x, (y, y))
model.metrics_names
['loss', 'out_loss', 'out_1_loss', 'out_mae', 'out_acc', 'out_1_mae',
'out_1_acc']

Методы

compile

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

compile(
    optimizer='rmsprop', loss=None, metrics=None, loss_weights=None,
    weighted_metrics=None, run_eagerly=None, steps_per_execution=None, **kwargs
)

Настраивает модель для обучения.

evaluate

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

evaluate(
    x=None, y=None, batch_size=None, verbose=1, sample_weight=None, steps=None,
    callbacks=None, max_queue_size=10, workers=1, use_multiprocessing=False,
    return_dict=False
)

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

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

См. обсуждение Unpacking behavior for iterator-like inputs для Model.fit.

evaluate_generator

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

evaluate_generator(
    generator, steps=None, callbacks=None, max_queue_size=10, workers=1,
    use_multiprocessing=False, verbose=0
)

Оценивает модель на основе генератора данных.

УСТАРЕВШИЙ:

Model.evaluate теперь поддерживает генераторы, поэтому использование этого метода больше не требуется.

fit

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

fit(
    x=None, y=None, batch_size=None, epochs=1, verbose=1, 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,
    max_queue_size=10, workers=1, use_multiprocessing=False
)

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

Поведение распаковки для итераторов: Распространённый подход — передавать tf.data.Dataset, генератор или tf.keras.utils.Sequence в аргумент x метода fit. Он фактически возвращает не только признаки (x), но необязательно и целевые значения (y) и веса выборок. Keras требует, чтобы вывод таких итераторов был однозначным. Итератор должен возвращать кортеж длины 1, 2 или 3, где необязательные второй и третий элементы будут использоваться для y и sample_weight соответственно. Любой другой тип будет заключён в кортеж длиной один, эффективно обрабатывая всё как 'x'. При передаче словарей, они должны соответствовать структуре кортежа верхнего уровня. Например, ({"x0": x0, "x1": x1}, y). Keras не будет пытаться разделить признаки, целевые значения и веса из ключей одного словаря. Заметным неподдерживаемым типом данных является namedtuple. Причина в том, что он ведёт себя как упорядоченный тип данных (кортеж) и как тип данных отображения (словарь). Таким образом, приведён namedtuple вида: namedtuple("example_tuple", ["y", "x"]) неясно, следует ли менять порядок элементов при интерпретации значения. Ещё хуже кортеж вида: namedtuple("other_tuple", ["x", "y", "z"]), где неясно, предназначался ли кортеж для распаковки в x, y и sample_weight или для передачи в качестве одного элемента в x. В результате, код обработки данных просто поднимет ValueError, если встретит namedtuple. (Вместе с инструкциями по решению проблемы.)

fit_generator

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

fit_generator(
    generator, steps_per_epoch=None, epochs=1, verbose=1, callbacks=None,
    validation_data=None, validation_steps=None, validation_freq=1,
    class_weight=None, max_queue_size=10, workers=1, use_multiprocessing=False,
    shuffle=True, initial_epoch=0
)

Обучает модель на данных, предоставляемых по частям генератором Python.

УСТАРЕЛО:

Model.fit теперь поддерживает генераторы, поэтому больше нет необходимости использовать этот метод.

get_layer

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

get_layer(
    name=None, index=None
)

Получает слой по имени (уникальному) или индексу.

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

load_weights

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

load_weights(
    filepath, by_name=False, skip_mismatch=False, options=None
)

Загружает все веса слоев из файла весов TensorFlow или HDF5.

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

Если by_name равно True, веса загружаются в слои только в том случае, если они имеют одинаковое имя. Это полезно для тонкой настройки или трансферного обучения моделей, где некоторые слои изменились.

Только топологическая загрузка (by_name=False) поддерживается при загрузке весов из формата TensorFlow. Обратите внимание, что топологическая загрузка немного отличается между форматами TensorFlow и HDF5 для пользовательских классов, наследуемых от tf.keras.Model: HDF5 загружает на основе сглаженного списка весов, а формат TensorFlow загружает на основе локальных имен атрибутов, которым слои назначены в конструкторе Model.

make_predict_function

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

make_predict_function()

Создаёт функцию, которая выполняет один шаг инференции.

Этот метод может быть переопределён для поддержки пользовательской логики инференции. Этот метод вызывается Model.predict и Model.predict_on_batch.

Как правило, этот метод напрямую управляет tf.function и tf.distribute.Strategy настройками и делегирует фактическую логику оценки Model.predict_step.

Функция кэшируется при первом вызове Model.predict или Model.predict_on_batch. Кэш очищается при вызове Model.compile.

make_test_function

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

make_test_function()

Создаёт функцию, которая выполняет один шаг оценки.

Этот метод может быть переопределён для поддержки пользовательской логики оценки. Этот метод вызывается Model.evaluate и Model.test_on_batch.

Как правило, этот метод напрямую управляет tf.function и tf.distribute.Strategy настройками и делегирует фактическую логику оценки Model.test_step.

Функция кэшируется при первом вызове Model.evaluate или Model.test_on_batch. Кэш очищается при вызове Model.compile.

make_train_function

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

make_train_function()

Создаёт функцию, которая выполняет один шаг обучения.

Этот метод может быть переопределён для поддержки пользовательской логики обучения. Этот метод вызывается Model.fit и Model.train_on_batch.

Как правило, этот метод напрямую управляет tf.function и tf.distribute.Strategy настройками и делегирует фактическую логику обучения Model.train_step.

Функция кэшируется при первом вызове Model.fit или Model.train_on_batch. Кэш очищается при вызове Model.compile.

predict

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

predict(
    x, batch_size=None, verbose=0, steps=None, callbacks=None, max_queue_size=10,
    workers=1, use_multiprocessing=False
)

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

Вычисления выполняются по частям. Этот метод разработан для производительности с большими входными данными. Для небольшого количества входных данных, которые помещаются в одну партию, рекомендуется использовать напрямую __call__, например, model(x), или model(x, training=False), если у вас есть слои, такие как tf.keras.layers.BatchNormalization, которые ведут себя по-разному во время инференции. Также обратите внимание на то, что тестовая потеря не зависит от регуляризующих слоёв, таких как шум и дропаут.

См. обсуждение Unpacking behavior for iterator-like inputs для Model.fit. Обратите внимание, что Model.predict использует те же правила интерпретации, что и Model.fit и Model.evaluate, поэтому входы должны быть однозначными для всех трех методов.

predict_generator

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

predict_generator(
    generator, steps=None, callbacks=None, max_queue_size=10, workers=1,
    use_multiprocessing=False, verbose=0
)

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

УСТАРЕЛО:

Model.predict теперь поддерживает генераторы, поэтому больше нет необходимости использовать этот метод.

predict_on_batch

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

predict_on_batch(
    x
)

Возвращает прогнозы для одного батча примеров.

predict_step

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

predict_step(
    data
)

Логика для одного шага прогнозирования.

Этот метод может быть переопределён для поддержки пользовательской логики прогнозирования. Этот метод вызывается методом Model.make_predict_function.

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

Подробности конфигурации как выполняется эта логика (например, tf.function и tf.distribute.Strategy настройки) должны быть оставлены методу Model.make_predict_function, который также может быть переопределён.

reset_metrics

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

reset_metrics()

Сбрасывает состояние всех метрик в модели.

Примеры:

inputs = tf.keras.layers.Input(shape=(3,))
outputs = tf.keras.layers.Dense(2)(inputs)
model = tf.keras.models.Model(inputs=inputs, outputs=outputs)
model.compile(optimizer="Adam", loss="mse", metrics=["mae"])

x = np.random.random((2, 3))
y = np.random.randint(0, 2, (2, 2))
_ = model.fit(x, y, verbose=0)
assert all(float(m.result()) for m in model.metrics)

model.reset_metrics()
assert all(float(m.result()) == 0 for m in model.metrics)

reset_states

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

reset_states()

save

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

save(
    filepath, overwrite=True, include_optimizer=True, save_format=None,
    signatures=None, options=None, save_traces=True
)

Сохраняет модель в формате Tensorflow SavedModel или в файл HDF5.

Подробности см. в разделе tf.keras.models.save_model или руководстве по сериализации и сохранению Serialization and Saving guide.

Пример:

from keras.models import load_model

model.save('my_model.h5')  # creates a HDF5 file 'my_model.h5'
del model  # deletes the existing model

# returns a compiled model
# identical to the previous one
model = load_model('my_model.h5')

save_weights

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

save_weights(
    filepath, overwrite=True, save_format=None, options=None
)

Сохраняет все веса слоёв.

Сохранение происходит в формате HDF5 или TensorFlow, в зависимости от аргумента save_format.

При сохранении в формате HDF5 файл весов содержит:

• layer_names (атрибут), список строк (упорядоченные имена слоёв модели).
• Для каждого слоя, атрибут group с именем layer.name
  • Для каждой такой группы слоёв, атрибут группы weight_names, список строк (упорядоченные имена тензоров весов слоя).
  • Для каждого веса в слое, набор данных, хранящий значение веса, с именем, соответствующим тензору веса.

При сохранении в формате TensorFlow все объекты, на которые ссылается сеть, сохраняются в том же формате, что и tf.train.Checkpoint, включая любые Layer экземпляры или Optimizer экземпляры, назначенные атрибутам объектов. Для сетей, построенных из входных и выходных данных с использованием tf.keras.Model(inputs, outputs), Layer экземпляры, используемые сетью, отслеживаются/сохраняются автоматически. Для пользовательских классов, унаследованных от tf.keras.Model, Layer экземпляры должны быть назначены атрибутам объектов, обычно в конструкторе. Подробности см. в документации tf.train.Checkpoint и tf.keras.Model.

Хотя форматы одинаковы, не смешивайте save_weights и tf.train.Checkpoint. Точки останова, сохранённые с помощью Model.save_weights, должны загружаться с помощью Model.load_weights. Точки останова, сохраненные с использованием tf.train.Checkpoint.save, должны восстанавливаться с помощью соответствующей tf.train.Checkpoint.restore. Для точек останова обучения предпочтительнее использовать tf.train.Checkpoint вместо save_weights.

Формат TensorFlow сопоставляет объекты и переменные, начиная с корневого объекта, self для save_weights, и жадно сопоставляет имена атрибутов. Для Model.save это Model, а для Checkpoint.save это Checkpoint даже если у Checkpoint есть присоединённая модель. Это означает, что сохранение tf.keras.Model с помощью save_weights и загрузка в tf.train.Checkpoint с присоединённой Model (или наоборот) не приведут к совпадению переменных Model. Подробные сведения о формате TensorFlow см. в руководстве по точкам останова обучения.

summary

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

summary(
    line_length=None, positions=None, print_fn=None
)

Выводит текстовое резюме сети.

test_on_batch

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

test_on_batch(
    x, y=None, sample_weight=None, reset_metrics=True, return_dict=False
)

Тестирование модели на одной пачке данных.

test_step

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

test_step(
    data
)

Логика одного шага оценки.

Этот метод может быть переопределен для поддержки пользовательской логики оценки. Этот метод вызывается методом Model.make_test_function.

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

Детали конфигурации того, *как* выполняется эта логика (например, настройки tf.function и tf.distribute.Strategy), должны быть оставлены Model.make_test_function, который также может быть переопределен.

to_json

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

to_json(
    **kwargs
)

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

Чтобы загрузить сеть из сохранённого JSON-файла, используйте keras.models.model_from_json(json_string, custom_objects={}).

to_yaml

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

to_yaml(
    **kwargs
)

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

Чтобы загрузить сеть из сохраненного YAML-файла, используйте keras.models.model_from_yaml(yaml_string, custom_objects={}).

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

train_on_batch

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

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

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

train_step

Просмотр исходного кода

train_step(
    data
)

Логика одного шага обучения.

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

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

Подробности конфигурации способа выполнения этой логики (например, tf.function и tf.distribute.Strategy настройки) следует оставлять Model.make_train_function, который также можно переопределить.