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, позволяющий восстановить тот же слой из словаря конфигурации. Он не обрабатывает соединение слоев (это обрабатывает сеть), а также веса (это обрабатывает 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, которые ведут себя по-разному во время инференции.

Примечание: См. эту запись 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
)