tf.compat.v2.estimator.DNNLinearCombinedClassifier
Оценщик для моделей классификации TensorFlow Linear и DNN, объединённых в одну.
Наследуется от: Estimator
tf.compat.v2.estimator.DNNLinearCombinedClassifier(
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, n_classes=2, weight_column=None,
label_vocabulary=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_id_column=categorical_feature_b, ...)
estimator = DNNLinearCombinedClassifier(
# wide settings
linear_feature_columns=[categorical_feature_a_x_categorical_feature_b],
linear_optimizer=tf.train.FtrlOptimizer(...),
# deep settings
dnn_feature_columns=[
categorical_feature_a_emb, categorical_feature_b_emb,
numeric_feature],
dnn_hidden_units=[1000, 500, 100],
dnn_optimizer=tf.train.ProximalAdagradOptimizer(...),
# warm-start settings
warm_start_from="/path/to/checkpoint/dir")
# To apply L1 and L2 regularization, you can set dnn_optimizer to:
tf.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.AdamOptimizer(
learning_rate=tf.exponential_decay(
learning_rate=0.1,
global_step=tf.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. Значенияvalueобоих атрибутов должны бытьSparseTensor. - если
columnявляется_DenseColumn, атрибут сkey=column.name, чьё значениеvalueявляетсяTensor.
- если
Функция потерь рассчитывается с использованием мягкой кросс-энтропии.
| Аргументы | |
|---|---|
model_dir | Директория для сохранения параметров модели, графа и т.д. Также может быть использована для загрузки контрольных точек из директории в оценщик для продолжения обучения ранее сохранённой модели. |
linear_feature_columns | Итерируемый объект, содержащий все атрибуты признаков, используемые линейной частью модели. Все элементы должны быть экземплярами классов, полученных от FeatureColumn. |
linear_optimizer | Экземпляр tf.Optimizer, используемый для применения градиентов к линейной части модели. Также может быть строкой (одной из 'Adagrad', 'Adam', 'Ftrl', 'RMSProp', 'SGD') или вызываемым объектом. По умолчанию используется оптимизатор FTRL. |
dnn_feature_columns | Итерируемый объект, содержащий все атрибуты признаков, используемые глубокой частью модели. Все элементы должны быть экземплярами классов, полученных от FeatureColumn. |
dnn_optimizer | Экземпляр tf.Optimizer, используемый для применения градиентов к глубокой части модели. Также может быть строкой (одной из 'Adagrad', 'Adam', 'Ftrl', 'RMSProp', 'SGD') или вызываемым объектом. По умолчанию используется оптимизатор Adagrad. |
dnn_hidden_units | Список скрытых слоёв по количеству узлов в каждом слое. Все слои являются полностью подключёнными. |
dnn_activation_fn | Функция активации, применяемая к каждому слою. Если None, используется tf.nn.relu. |
dnn_dropout | Если не равно None, вероятность отбрасывания заданной координаты. |
n_classes | Количество классов меток. По умолчанию 2, то есть бинарная классификация. Должно быть > 1. |
weight_column | Строка или объект _NumericColumn, созданный с помощью tf.feature_column.numeric_column, определяющий атрибут признака, представляющий веса. Используется для снижения или повышения весов примеров во время обучения. Умножается на потерю примера. Если строка, используется как ключ для получения тензора весов из features. Если объект, исходный тензор извлекается по ключу weight_column.key, затем weight_column.normalizer_fn применяется к нему для получения тензора весов. |
label_vocabulary | Список строк, представляющих возможные значения меток. Если задано, метки должны быть строкового типа и иметь любое значение из label_vocabulary. Если не задано, это означает, что метки уже закодированы как целые или вещественные числа в диапазоне [0, 1] для n_classes=2 и закодированы как целые значения в {0, 1,..., n_classes-1} для n_classes>2. Также будут ошибки, если словарь не задан, а метки являются строками. |
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 | Функция, строящая входные данные для оценки. См. Предопределённые оценщики для получения дополнительной информации. Функция должна строить и возвращать одно из следующего: * Объект tf.data.Dataset: Выходы объекта Dataset должны быть кортежем (features, labels) с теми же ограничениями, что и ниже. * Кортеж (features, labels): Где features является tf.Tensor или словарем из имени атрибута признака к Tensor, и labels является Tensor или словарем имени метки к Tensor. И features и labels потребляются model_fn. Они должны удовлетворять ожиданиям model_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 с оценщиками.
Этот метод создает новую графу, сначала вызвав 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
)
Возвращает прогнозы для заданных признаков.
Обратите внимание, что чередование двух выходов предсказания не работает. См.: проблема/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 возвращает некоторые тензоры, первая размерность которых не равна размеру пакета. |
data-text="Возвращает:" id="yields" tabindex="0">Возвращает:
Оцененные значения тензоров predictions.
| Исключения | |
|---|---|
ValueError | Если длина пакета предсказаний не одинаковая, и yield_single_examples — True. |
ValueError | Если есть конфликт между predict_keys и predictions. Например, если predict_keys не None но tf.estimator.EstimatorSpec.predictions не dict. |
data-text="train" id="train" tabindex="0">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/r1.15/api_docs/python/tf/compat/v2/estimator/DNNLinearCombinedClassifier