tf.keras.Sequential

Sequential объединяет линейный стек слоёв в Model.

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

tf.keras.Sequential(
    layers=None, trainable=True, name=None
)

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

Примеры:

model = keras.Sequential()
model.add(keras.Input(shape=(16,)))
model.add(keras.layers.Dense(8))

# Note that you can also omit the initial `Input`.
# In that case the model doesn't have any weights until the first call
# to a training/evaluation method (since it isn't yet built):
model = keras.Sequential()
model.add(keras.layers.Dense(8))
model.add(keras.layers.Dense(4))
# model.weights not created yet

# Whereas if you specify an `Input`, the model gets built
# continuously as you are adding layers:
model = keras.Sequential()
model.add(keras.Input(shape=(16,)))
model.add(keras.layers.Dense(8))
len(model.weights)  # Returns "2"

# When using the delayed-build pattern (no input shape specified), you can
# choose to manually build your model by calling
# `build(batch_input_shape)`:
model = keras.Sequential()
model.add(keras.layers.Dense(8))
model.add(keras.layers.Dense(4))
model.build((None, 16))
len(model.weights)  # Returns "4"

# Note that when using the delayed-build pattern (no input shape specified),
# the model gets built the first time you call `fit`, `eval`, or `predict`,
# or the first time you call the model on some input data.
model = keras.Sequential()
model.add(keras.layers.Dense(8))
model.add(keras.layers.Dense(1))
model.compile(optimizer='sgd', loss='mse')
# This builds the model for the first time:
model.fit(x, y, batch_size=32, epochs=10)

Методы

add

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

add(
    layer, rebuild=True
)

Добавляет экземпляр слоя поверх стека слоёв.

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. Любой другой переданный тип будет обёрнут в кортеж длины 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
)

pop

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

pop(
    rebuild=True
)

Удаляет последний слой модели.

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
)