tf.estimator.DNNLinearCombinedRegressor
| Просмотреть исходный код на GitHub |
Оценщик для соединённых моделей TensorFlow Linear и DNN для регрессии.
Наследуется от: Estimator
tf.estimator.DNNLinearCombinedRegressor(
model_dir=None, linear_feature_columns=None, linear_optimizer='Ftrl',
dnn_feature_columns=None, dnn_optimizer='Adagrad', dnn_hidden_units=None,
dnn_activation_fn=tf.nn.relu, dnn_dropout=None, label_dimension=1,
weight_column=None, config=None, warm_start_from=None,
loss_reduction=losses_utils.ReductionV2.SUM_OVER_BATCH_SIZE, batch_norm=False,
linear_sparse_combiner='sum'
)
Примечание: Этот оценщик также известен как wide-n-deep.
Пример:
numeric_feature = numeric_column(...)
categorical_column_a = categorical_column_with_hash_bucket(...)
categorical_column_b = categorical_column_with_hash_bucket(...)
categorical_feature_a_x_categorical_feature_b = crossed_column(...)
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.DNNLinearCombinedRegressor(
# wide settings
linear_feature_columns=[categorical_feature_a_x_categorical_feature_b],
linear_optimizer=tf.keras.optimizers.Ftrl(...),
# deep settings
dnn_feature_columns=[
categorical_feature_a_emb, categorical_feature_b_emb,
numeric_feature],
dnn_hidden_units=[1000, 500, 100],
dnn_optimizer=tf.keras.optimizers.Adagrad(...),
# warm-start settings
warm_start_from="/path/to/checkpoint/dir")
# To apply L1 and L2 regularization, you can set dnn_optimizer to:
tf.compat.v1.train.ProximalAdagradOptimizer(
learning_rate=0.1,
l1_regularization_strength=0.001,
l2_regularization_strength=0.001)
# To apply learning rate decay, you can set dnn_optimizer to a callable:
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)
# It is the same for linear_optimizer.
# 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, steps=100)
metrics = estimator.evaluate(input_fn=input_fn_eval, steps=10)
predictions = estimator.predict(input_fn=input_fn_predict)
Входные данные train и evaluate должны иметь следующие атрибуты, в противном случае возникнет KeyError:
- для каждого
columnвdnn_feature_columns+linear_feature_columns:- если
columnявляетсяCategoricalColumn, атрибут сkey=column.name, значение которогоvalueявляетсяSparseTensor. - если
columnявляетсяWeightedCategoricalColumn, два атрибута: первый с именем столбцаkey, второй с именем столбцаkey. Оба атрибута должны иметь типSparseTensor. - если
columnявляетсяDenseColumn, атрибут сkey=column.name, значение которогоvalueявляетсяTensor.
- если
Ошибка вычисляется с помощью средней квадратичной ошибки.
| Аргументы | |
|---|---|
model_dir | Каталог для сохранения параметров модели, графа и т. д. Также может быть использован для загрузки контрольных точек из каталога в оценщик для продолжения обучения ранее сохранённой модели. |
linear_feature_columns | Итерируемый объект, содержащий все столбцы признаков, используемые линейной частью модели. Все элементы должны быть экземплярами классов, производных от FeatureColumn. |
linear_optimizer | Экземпляр tf.keras.optimizers.*, используемый для применения градиентов к линейной части модели. Также может быть строкой (одним из 'Adagrad', 'Adam', 'Ftrl', 'RMSProp', 'SGD') или вызываемой функцией. По умолчанию используется оптимизатор FTRL. |
dnn_feature_columns | Итерируемый объект, содержащий все столбцы признаков, используемые глубокой частью модели. Все элементы должны быть экземплярами классов, производных от FeatureColumn. |
dnn_optimizer | Экземпляр tf.keras.optimizers.*, используемый для применения градиентов к глубокой части модели. Также может быть строкой (одним из 'Adagrad', 'Adam', 'Ftrl', 'RMSProp', 'SGD') или вызываемой функцией. По умолчанию используется оптимизатор Adagrad. |
dnn_hidden_units | Список скрытых узлов на слой. Все слои являются полносвязными. |
dnn_activation_fn | Функция активации, применяемая к каждому слою. Если None, будет использоваться tf.nn.relu. |
dnn_dropout | Если не None, вероятность отбрасывания заданной координаты. |
label_dimension | Количество целевых значений регрессии на пример. Это размер последнего измерения меток и логарифмов Tensor объектов (как правило, они имеют форму [batch_size, label_dimension]). |
weight_column | Строка или объект NumericColumn, созданный с помощью tf.feature_column.numeric_column, определяющий столбец признака, представляющий веса. Используется для уменьшения или увеличения весов примеров во время обучения. Он будет умножаться на потерю примера. Если это строка, она используется в качестве ключа для извлечения тензора весов из features. Если это объект, сырой тензор извлекается по ключу weight_column.key, затем применяется weight_column.normalizer_fn для получения тензора весов. |
config | Объект RunConfig для настройки параметров выполнения. |
warm_start_from | Путь к файлу контрольной точки для теплового старта или объект WarmStartSettings для полной настройки теплового старта. Если указан строковый путь вместо объекта, все веса запускаются с теплового старта, и предполагается, что словари и имена тензоров не изменены. |
loss_reduction | Один из tf.losses.Reduction за исключением NONE. Описывает, как уменьшать потерю обучения по партии. По умолчанию SUM_OVER_BATCH_SIZE. |
batch_norm | Нужно ли использовать пакетную нормализацию после каждого скрытого слоя. |
linear_sparse_combiner | Строка, определяющая, как уменьшить линейную модель, если категориальный столбец многозначный. Один из "mean", "sqrtn", и "sum" — это эффективные способы нормализации на уровне примеров, что может быть полезно для атрибутов «мешок слов». Дополнительные сведения см. в tf.feature_column.linear_model. |
| Возбуждает | |
|---|---|
ValueError | Если оба linear_feature_columns и dnn_features_columns пустые одновременно. |
Совместимость с Eager
Оценщики могут использоваться при включённом режиме Eager. Обратите внимание, что 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.ExportOutputs, а входы всегда являются приемниками ввода, предоставляемыми 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 from Estimators.
Этот метод строит новую графу, сначала вызывая serving_input_receiver_fn для получения признаков Tensor , а затем вызывая Estimator's 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.ExportOutputs, а входы всегда — приемниками ввода, предоставленными 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 не работает. См.: issue/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/DNNLinearCombinedRegressor