tf.estimator.DNNRegressor
| Просмотреть исходный код на GitHub |
Регрессор для моделей TensorFlow DNN.
Наследуется от: Estimator
tf.estimator.DNNRegressor(
hidden_units, feature_columns, model_dir=None, label_dimension=1,
weight_column=None, optimizer='Adagrad', activation_fn=tf.nn.relu, dropout=None,
config=None, warm_start_from=None,
loss_reduction=losses_utils.ReductionV2.SUM_OVER_BATCH_SIZE, batch_norm=False
)
Пример:
categorical_feature_a = categorical_column_with_hash_bucket(...)
categorical_feature_b = categorical_column_with_hash_bucket(...)
categorical_feature_a_emb = embedding_column(
categorical_column=categorical_feature_a, ...)
categorical_feature_b_emb = embedding_column(
categorical_column=categorical_feature_b, ...)
estimator = tf.estimator.DNNRegressor(
feature_columns=[categorical_feature_a_emb, categorical_feature_b_emb],
hidden_units=[1024, 512, 256])
# Or estimator using the ProximalAdagradOptimizer optimizer with
# regularization.
estimator = tf.estimator.DNNRegressor(
feature_columns=[categorical_feature_a_emb, categorical_feature_b_emb],
hidden_units=[1024, 512, 256],
optimizer=tf.compat.v1.train.ProximalAdagradOptimizer(
learning_rate=0.1,
l1_regularization_strength=0.001
))
# Or estimator using an optimizer with a learning rate decay.
estimator = tf.estimator.DNNRegressor(
feature_columns=[categorical_feature_a_emb, categorical_feature_b_emb],
hidden_units=[1024, 512, 256],
optimizer=lambda: tf.keras.optimizers.Adam(
learning_rate=tf.compat.v1.train.exponential_decay(
learning_rate=0.1,
global_step=tf.compat.v1.train.get_global_step(),
decay_steps=10000,
decay_rate=0.96))
# Or estimator with warm-starting from a previous checkpoint.
estimator = tf.estimator.DNNRegressor(
feature_columns=[categorical_feature_a_emb, categorical_feature_b_emb],
hidden_units=[1024, 512, 256],
warm_start_from="/path/to/checkpoint/dir")
# Input builders
def input_fn_train:
# Returns tf.data.Dataset of (x, y) tuple where y represents label's class
# index.
pass
def input_fn_eval:
# Returns tf.data.Dataset of (x, y) tuple where y represents label's class
# index.
pass
def input_fn_predict:
# Returns tf.data.Dataset of (x, None) tuple.
pass
estimator.train(input_fn=input_fn_train)
metrics = estimator.evaluate(input_fn=input_fn_eval)
predictions = estimator.predict(input_fn=input_fn_predict)
Входные данные train и evaluate должны иметь следующие атрибуты, в противном случае произойдёт KeyError:
- если
weight_columnне равноNone, атрибут с именемkey=weight_column, значение которого являетсяTensor. - для каждого
columnвfeature_columns:- если
columnявляетсяCategoricalColumn, атрибут с именемkey=column.name, значение которого являетсяSparseTensor. - если
columnявляетсяWeightedCategoricalColumn, два атрибута: первый с именем столбцаkey, второй с именем столбцаkey. Значения обоих атрибутов должны бытьSparseTensor. - если
columnявляетсяDenseColumn, атрибут с именемkey=column.name, значение которого являетсяTensor.
- если
Функция потерь рассчитывается с помощью средней квадратичной ошибки.
| Аргументы | |
|---|---|
hidden_units | Итерируемый список количества скрытых нейронов на каждом слое. Все слои — полностью связанные. Например, [64, 32] означает, что первый слой имеет 64 узла, а второй — 32. |
feature_columns | Итерируемый список всех столбцов атрибутов, используемых моделью. Все элементы должны быть экземплярами классов, производных от FeatureColumn. |
model_dir | Директория для сохранения параметров модели, графа и т.д. Также может использоваться для загрузки контрольных точек из директории в оценщик для продолжения обучения ранее сохранённой модели. |
label_dimension | Количество целевых значений регрессии на пример. Это размер последнего измерения меток и логарифмов Tensor (как правило, у них форма [batch_size, label_dimension]). |
weight_column | Строка или объект NumericColumn, созданный с помощью tf.feature_column.numeric_column, определяющий столбец атрибута, представляющий веса. Используется для уменьшения или увеличения весов примеров во время обучения. Умножается на потерю примера. Если это строка, используется в качестве ключа для извлечения тензора весов из features. Если это объект NumericColumn, исходный тензор извлекается по ключу weight_column.key, затем weight_column.normalizer_fn применяется к нему для получения тензора весов. |
optimizer | Экземпляр tf.keras.optimizers.*, используемый для обучения модели. Может быть также строкой (одним из 'Adagrad', 'Adam', 'Ftrl', 'RMSProp', SGD') или вызываемым объектом. По умолчанию используется оптимизатор Adagrad. |
activation_fn | Функция активации, применяемая к каждому слою. Если None, используется tf.nn.relu. |
dropout | Если не None, вероятность отбрасывания заданной координаты. |
config | Объект RunConfig для настройки параметров выполнения. |
warm_start_from | Путь к файлу контрольной точки для предварительной инициализации, или объект WarmStartSettings для полной настройки предварительной инициализации. Если указан путь к файлу вместо объекта WarmStartSettings, все веса предварительно инициализируются, и предполагается, что словари и имена тензоров не изменены. |
loss_reduction | Один из tf.losses.Reduction за исключением NONE. Определяет, как уменьшать функцию потерь на батче. По умолчанию SUM_OVER_BATCH_SIZE. |
batch_norm | Использовать ли пакетную нормализацию после каждого скрытого слоя. |
Совместимость с Eager Execution
Оценщики могут использоваться при включённом Eager execution. Обратите внимание, что input_fn и все хуки выполняются внутри контекста графа, поэтому они должны быть написаны так, чтобы быть совместимыми с режимом графа. Обратите внимание, что input_fn код, использующий tf.data, как правило, работает в режимах графа и eager.
| Атрибуты | |
|---|---|
config | |
export_savedmodel | |
model_dir | |
model_fn | Возвращает model_fn, привязанный к self.params. |
params | |
Методы
eval_dir
eval_dir(
name=None
)
Показывает имя директории, куда сохраняются метрики оценки.
| Аргументы | |
|---|---|
name | Название оценки, если пользователю нужно выполнить несколько оценок на разных наборах данных, например, на обучающих и тестовых данных. Метрики для разных оценок сохраняются в отдельных папках и отображаются раздельно в tensorboard. |
| Возвращаемое значение | |
|---|---|
| Строка, представляющая путь к директории, содержащей метрики оценки. |
evaluate
evaluate(
input_fn, steps=None, hooks=None, checkpoint_path=None, name=None
)
Оценивает модель на основе данных оценки input_fn.
Для каждого шага вызывается input_fn, которая возвращает один пакет данных. Оценивание выполняется до:
-
обработки
stepsпакетов, или -
input_fnвозникает исключение конца входных данных (tf.errors.OutOfRangeErrorилиStopIteration).
| Аргументы | |
|---|---|
input_fn | Функция, которая строит входные данные для оценки. См. Предопределённые оценщики для получения дополнительной информации. Функция должна строить и возвращать одно из следующих:
|
steps | Количество шагов для оценки модели. Если None, выполняется оценка до тех пор, пока input_fn не сгенерирует исключение конца входных данных. |
hooks | Список экземпляров подклассов tf.train.SessionRunHook . Используется для обратных вызовов внутри вызова оценки. |
checkpoint_path | Путь к конкретной контрольной точке для оценки. Если None, используется самая последняя контрольная точка в model_dir. Если в model_dir нет контрольных точек, оценка выполняется с вновь инициализированными Variables вместо восстановленных из контрольной точки. |
name | Название оценки, если пользователю нужно выполнить несколько оценок на разных наборах данных, например, на обучающих и тестовых данных. Метрики для разных оценок сохраняются в отдельных папках и отображаются раздельно в tensorboard. |
| Возвращаемое значение | |
|---|---|
Словарь, содержащий метрики оценки, указанные в model_fn с именами в качестве ключей, а также запись global_step, которая содержит значение глобального шага, для которого была выполнена эта оценка. Для предопределённых оценщиков словарь содержит loss (средняя потеря на мини-батче) и average_loss (средняя потеря на образец). Предопределённые классификаторы также возвращают accuracy. Предопределённые регрессоры также возвращают label/mean и prediction/mean. |
| Исключения | |
|---|---|
ValueError | Если steps <= 0. |
experimental_export_all_saved_models
experimental_export_all_saved_models(
export_dir_base, input_receiver_fn_map, assets_extra=None, as_text=False,
checkpoint_path=None
)
Экспортирует SavedModel с tf.MetaGraphDefs для каждого запрошенного режима.
Для каждого режима, переданного через input_receiver_fn_map, этот метод создаёт новую графу, вызывая input_receiver_fn для получения атрибутов и меток Tensor . Затем этот метод вызывает Estimator's model_fn в переданном режиме для генерации графа модели на основе этих атрибутов и меток, и восстанавливает заданную контрольную точку (или, если её нет, последнюю контрольную точку) в граф. Только один из режимов используется для сохранения переменных в SavedModel (порядок предпочтения: tf.estimator.ModeKeys.TRAIN, tf.estimator.ModeKeys.EVAL, затем tf.estimator.ModeKeys.PREDICT), так что до трёх tf.MetaGraphDefs сохраняются с одним набором переменных в одной директории SavedModel.
Для переменных и tf.MetaGraphDefs, директория экспорта с отметкой времени находится ниже export_dir_base, и в неё записывается SavedModel содержащий tf.MetaGraphDef для данного режима и связанных с ним подписей.
Для предсказания экспортированная MetaGraphDef предоставит по одному SignatureDef для каждого элемента export_outputs словаря, возвращаемого функцией model_fn, с использованием тех же ключей. Один из этих ключей всегда tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY, указывающий, какая подпись будет использоваться, когда запрос на обслуживание не указывает её. Для каждой подписи выходы предоставляются соответствующими tf.estimator.export.ExportOutput, а входы всегда — приемниками ввода, предоставляемыми serving_input_receiver_fn.
Для обучения и оценки train_op хранится в дополнительном наборе, а потери, метрики и предсказания включаются в SignatureDef для рассматриваемого режима.
Дополнительные ресурсы могут быть записаны в SavedModel с помощью аргумента assets_extra. Это должен быть словарь, где каждый ключ указывает путь назначения (включая имя файла) относительно директории assets.extra. Соответствующее значение — полный путь к исходному файлу, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
| Args | |
|---|---|
export_dir_base | Строка, содержащая директорию, в которой будут создаваться поддиректории с отметкой времени, содержащие экспортированные SavedModels. |
input_receiver_fn_map | Словарь сопоставлений tf.estimator.ModeKeys с input_receiver_fn , где input_receiver_fn — функция без аргументов, возвращающая соответствующий подкласс InputReceiver. |
assets_extra | Словарь, определяющий, как заполнить директорию assets.extra внутри экспортированного SavedModel, или None если дополнительные ресурсы не нужны. |
as_text | Нужно ли записывать протокол SavedModel в текстовом формате. |
checkpoint_path | Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается самая последняя контрольная точка, найденная внутри директории модели. |
| Returns | |
|---|---|
| Путь к экспортированной директории в виде объекта байтов. |
| Raises | |
|---|---|
ValueError | если какой-либо input_receiver_fn равен None, не предоставлены export_outputs, или контрольная точка не найдена. |
export_saved_model
export_saved_model(
export_dir_base, serving_input_receiver_fn, assets_extra=None, as_text=False,
checkpoint_path=None, experimental_mode=ModeKeys.PREDICT
)
Экспортирует график вывода как SavedModel в заданную директорию.
Для подробного руководства см. SavedModel от Estimators.
Этот метод строит новый граф, сначала вызвав serving_input_receiver_fn для получения признаков Tensor, а затем вызвав Estimator метод model_fn для создания графа модели на основе этих признаков. Он восстанавливает заданную контрольную точку (или, если её нет, самую последнюю контрольную точку) в этом графе в новой сессии. Наконец, он создаёт директорию экспорта с отметкой времени ниже заданной export_dir_base, и записывает в неё SavedModel содержащий одну tf.MetaGraphDef сохранённую из этой сессии.
Экспортированная MetaGraphDef предоставит по одному SignatureDef для каждого элемента export_outputs словаря, возвращаемого model_fn, используя те же ключи. Один из этих ключей всегда tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY, указывающий, какая подпись будет использоваться, когда запрос на обслуживание не указывает её. Для каждой подписи выходы предоставляются соответствующими tf.estimator.export.ExportOutput, а входы всегда — приемниками ввода, предоставляемыми serving_input_receiver_fn.
Дополнительные ресурсы могут быть записаны в SavedModel с помощью аргумента assets_extra. Это должен быть словарь, где каждый ключ указывает путь назначения (включая имя файла) относительно директории assets.extra. Соответствующее значение — полный путь к исходному файлу, который нужно скопировать. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
Параметр experimental_mode может быть использован для экспорта отдельного графика обучения/оценки/предсказания как SavedModel. См. experimental_export_all_saved_models для полной документации.
| Args | |
|---|---|
export_dir_base | Строка, содержащая директорию, в которой будут создаваться поддиректории с отметкой времени, содержащие экспортированные SavedModels. |
serving_input_receiver_fn | Функция без аргументов, возвращающая tf.estimator.export.ServingInputReceiver или tf.estimator.export.TensorServingInputReceiver. |
assets_extra | Словарь, определяющий, как заполнить директорию assets.extra внутри экспортированного SavedModel, или None если дополнительные ресурсы не нужны. |
as_text | Нужно ли записывать протокол SavedModel в текстовом формате. |
checkpoint_path | Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается самая последняя контрольная точка, найденная внутри директории модели. |
experimental_mode | Значение tf.estimator.ModeKeys, указывающее, какой режим будет экспортирован. Обратите внимание, что эта функция экспериментальная. |
| Returns | |
|---|---|
| Путь к экспортированной директории в виде объекта байтов. |
| Raises | |
|---|---|
ValueError | если не предоставлен serving_input_receiver_fn, не предоставлены export_outputs, или контрольная точка не найдена. |
get_variable_names
get_variable_names()
Возвращает список всех имён переменных в этой модели.
| Returns | |
|---|---|
| Список имён. |
| Raises | |
|---|---|
ValueError | Если Estimator ещё не создал контрольную точку. |
get_variable_value
get_variable_value(
name
)
Возвращает значение переменной, заданной по имени.
| Args | |
|---|---|
name | строка или список строк, имя тензора. |
| Returns | |
|---|---|
| Массив NumPy — значение тензора. |
| Raises | |
|---|---|
ValueError | Если Estimator ещё не создал контрольную точку. |
latest_checkpoint
latest_checkpoint()
Находит имя файла последней сохранённой контрольной точки в model_dir.
| Returns | |
|---|---|
Полный путь к последней контрольной точке или None если контрольная точка не найдена. |
predict
predict(
input_fn, predict_keys=None, hooks=None, checkpoint_path=None,
yield_single_examples=True
)
Возвращает предсказания для заданных признаков.
Обратите внимание, что переплетение двух выводов predict не работает. См.: вопрос/20506
| Аргументы | |
|---|---|
input_fn | Функция, которая строит признаки. Предсказание продолжается до тех пор, пока input_fn не сгенерирует исключение конца ввода (tf.errors.OutOfRangeError или StopIteration). Подробнее см. Предопределенные оценщики. Функция должна сконструировать и вернуть одну из следующих структур:
|
predict_keys | Список str, имя ключей для предсказания. Используется, если tf.estimator.EstimatorSpec.predictions является dict. Если используется predict_keys, то остальные предсказания из словаря будут отфильтрованы. Если None, возвращает все. |
hooks | Список экземпляров подкласса tf.train.SessionRunHook. Используется для обратных вызовов внутри вызова предсказания. |
checkpoint_path | Путь к определённому контрольному пункту для предсказания. Если None, используется последний контрольный пункт в model_dir. Если в model_dir нет контрольных пунктов, предсказание выполняется с только что инициализированным Variables вместо восстановленных из контрольного пункта. |
yield_single_examples | Если False, возвращает весь пакет, как возвращает model_fn, вместо разбиения пакета на отдельные элементы. Это полезно, если model_fn возвращает тензоры, первая размерность которых не равна размеру пакета. |
Возвращает:
Оценённые значения тензоров predictions.
| Исключения | |
|---|---|
ValueError | Если длина пакета предсказаний не совпадает и yield_single_examples является True. |
ValueError | Если возникает конфликт между predict_keys и predictions. Например, если predict_keys не None , но tf.estimator.EstimatorSpec.predictions не является dict. |
train
train(
input_fn, hooks=None, steps=None, max_steps=None, saving_listeners=None
)
Обучает модель с использованием обучающих данных input_fn.
| Аргументы | |
|---|---|
input_fn | Функция, которая предоставляет входные данные для обучения в виде мини-пакетов. Подробнее см. Предопределенные оценщики. Функция должна сконструировать и вернуть одну из следующих структур:
|
hooks | Список экземпляров подкласса tf.train.SessionRunHook . Используется для обратных вызовов внутри цикла обучения. |
steps | Количество шагов для обучения модели. Если None, обучение продолжается бесконечно или до тех пор, пока input_fn не сгенерирует ошибку tf.errors.OutOfRange или исключение StopIteration . steps работает пошагово. Если вызвать train(steps=10) дважды, обучение произойдёт в общей сложности 20 шагов. Если OutOfRange или StopIteration возникнет посредине, обучение остановится до 20 шагов. Если вы не хотите пошаговое поведение, установите max_steps. В этом случае, max_steps должен быть None. |
max_steps | Общее количество шагов для обучения модели. Если None, обучение продолжается бесконечно или до тех пор, пока input_fn не сгенерирует ошибку tf.errors.OutOfRange или исключение StopIteration . Если установлено, steps должно быть None. Если OutOfRange или StopIteration возникнет посредине, обучение остановится до max_steps шагов. Два вызова train(steps=100) означает 200 итераций обучения. С другой стороны, два вызова train(max_steps=100) означает, что второй вызов не будет выполнять никаких итераций, так как первый вызов выполнил все 100 шагов. |
saving_listeners | Список объектов CheckpointSaverListener. Используется для обратных вызовов, которые выполняются непосредственно перед или после сохранения контрольных точек. |
| Возвращает | |
|---|---|
self, для цепочки. |
| Исключения | |
|---|---|
ValueError | Если оба steps и max_steps не None. |
ValueError | Если либо steps или max_steps <= 0. |
© 2020 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 3.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.3/api_docs/python/tf/estimator/DNNRegressor