tf.estimator.DNNLinearCombinedClassifier
| Просмотреть исходный код на GitHub |
Оценщик для моделей классификации TensorFlow Linear и DNN, объединённых в одну.
Наследуется от: Estimator, Estimator
tf.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=tf.losses.Reduction.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 = tf.estimator.DNNLinearCombinedClassifier(
# 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именем столбца весов. Обе функцииvalueдолжны быть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, вероятность отбрасывания заданной координаты. |
n_classes | Количество классов метки. По умолчанию 2 (бинарная классификация). Должно быть > 1. |
weight_column | Строка или объект, созданный с помощью 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 | Путь к файлу контрольной точки для начальной загрузки, или объект для полной настройки начальной загрузки. Если указан путь к файлу, а не объект, то все веса загружаются, и предполагается, что словари и имена тензоров не изменены. |
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 одновременно пусты. |
| Атрибуты | |
|---|---|
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 см. в Использование формата 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.ExportOutput, а входные данные всегда являются входными приемниками, предоставленными serving_input_receiver_fn.
Дополнительные ресурсы могут быть записаны в SavedModel через аргумент assets_extra. Он должен быть словарем, где каждый ключ указывает путь назначения (включая имя файла) относительно каталога assets.extra. Соответствующее значение даёт полный путь к исходному файлу, который будет скопирован. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
Параметр experimental_mode может быть использован для экспорта одной графической модели train/eval/predict как 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 | Если модель ещё не создала контрольный пункт. |
get_variable_value
get_variable_value(
name
)
Возвращает значение переменной, заданной по имени.
| Args | |
|---|---|
name | Строка или список строк, имя тензора. |
| Returns | |
|---|---|
| Массив NumPy - значение тензора. |
| Raises | |
|---|---|
ValueError | Если модель ещё не создала контрольный пункт. |
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. |
совместимость с немедленным выполнением
Оценщики могут использоваться при включенном немедленном выполнении. Обратите внимание, что input_fn и все хуки выполняются внутри контекста графа, поэтому они должны быть написаны так, чтобы быть совместимыми с режимом графа. Обратите внимание, что код input_fn с использованием tf.data обычно работает как в режиме графа, так и в режиме немедленного выполнения.
© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/estimator/DNNLinearCombinedClassifier