tf.keras.Model

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

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

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, **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
)

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

Файл сохранения содержит:

• Архитектуру модели, позволяющую повторно создать модель.
• Веса модели.
• Состояние оптимизатора, позволяющее продолжить обучение ровно с того места, где вы остановились.

Это позволяет сохранить все состояние модели в одном файле.

Сохранённые модели можно восстановить с помощью keras.models.load_model. Модель, возвращённая методом load_model, является скомпилированной моделью, готовой к использованию (если только сохранённая модель не была скомпилирована в первом месте).

Модели, созданные с помощью API Sequential и Functional, могут быть сохранены в форматах HDF5 и SavedModel. Подклассированные модели могут быть сохранены только в формате SavedModel.

Обратите внимание, что веса модели могут иметь разные имена области видимости после загрузки. Имена области видимости включают имена модели/слоя, такие как "dense_1/kernel:0". Рекомендуется использовать свойства слоя для доступа к конкретным переменным, например, model.get_layer("dense_1").kernel.

Пример:

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, который также можно переопределить.