tf.contrib.estimator.RNNClassifier
Классификатор для моделей TensorFlow RNN.
Наследуется от: Estimator
tf.contrib.estimator.RNNClassifier(
sequence_feature_columns, context_feature_columns=None, num_units=None,
cell_type=USE_DEFAULT, rnn_cell_fn=None, model_dir=None, n_classes=2,
weight_column=None, label_vocabulary=None, optimizer='Adagrad',
loss_reduction=losses.Reduction.SUM_OVER_BATCH_SIZE,
input_layer_partitioner=None, config=None
)
Обучает рекуррентную нейронную сеть для классификации экземпляров в один из нескольких классов.
Пример:
token_sequence = sequence_categorical_column_with_hash_bucket(...)
token_emb = embedding_column(categorical_column=token_sequence, ...)
estimator = RNNClassifier(
sequence_feature_columns=[token_emb],
num_units=[32, 16], cell_type='lstm')
# Input builders
def input_fn_train: # returns x, y
pass
estimator.train(input_fn=input_fn_train, steps=100)
def input_fn_eval: # returns x, y
pass
metrics = estimator.evaluate(input_fn=input_fn_eval, steps=10)
def input_fn_predict: # returns x, None
pass
predictions = estimator.predict(input_fn=input_fn_predict)
Входные данные train и evaluate должны иметь следующие признаки, в противном случае возникнет KeyError:
- если
weight_columnне являетсяNone, признак сkey=weight_column, значение которого являетсяTensor. - для каждого
columnвsequence_feature_columns:- признак с
key=column.name, значение которого являетсяSparseTensor.
- признак с
- для каждого
columnвcontext_feature_columns:- если
columnявляется_CategoricalColumn, признак сkey=column.name, значение которого являетсяSparseTensor. - если
columnявляется_WeightedCategoricalColumn, два признака: первый с именем колонкиkey, второй с именем колонкиkey. Значение обоих признаков должно бытьSparseTensor. - если
columnявляется_DenseColumn, признак сkey=column.name, значение которого являетсяTensor.
- если
Функция потерь вычисляется с использованием софтмакс-перекрестной энтропии.
| Аргументы | |
|---|---|
sequence_feature_columns | Итерируемый объект, содержащий последовательные входные данные. Все элементы должны быть либо последовательными колонками (например, sequence_numeric_column), либо созданы на основе одной из них (например, embedding_column с входными данными sequence_categorical_column_*). |
context_feature_columns | Итерируемый объект, содержащий контекстные входные данные. Данные, представленные этими колонками, будут дублироваться и передаваться RNN на каждом шаге. Эти колонки должны быть экземплярами классов, производными от _DenseColumn, таких как numeric_column, а не последовательными вариантами. |
num_units | Итерируемый объект, содержащий количество скрытых узлов на каждом слое RNN. Если задано, необходимо также указать cell_type и rnn_cell_fn должно быть None. |
cell_type | Подкласс tf.nn.rnn_cell.RNNCell или строка, определяющая тип ячейки. Поддерживаемые строки: 'basic_rnn', 'lstm', и 'gru'. Если задано, необходимо также указать num_units и rnn_cell_fn должно быть None. |
rnn_cell_fn | Функция с одним аргументом, tf.estimator.ModeKeys, которая возвращает объект типа tf.nn.rnn_cell.RNNCell, используемый для построения RNN. Если задано, num_units и cell_type нельзя задавать. Это для продвинутых пользователей, которым требуется дополнительная настройка, выходящая за рамки num_units и cell_type. Обратите внимание, что tf.nn.rnn_cell.MultiRNNCell необходим для стопки RNN. |
model_dir | Директория для сохранения параметров модели, графа и т.д. Также может использоваться для загрузки контрольных точек из директории в оценщик для продолжения обучения ранее сохранённой модели. |
n_classes | Количество классов меток. По умолчанию 2 (бинарная классификация). Должно быть > 1. |
weight_column | Строка или _NumericColumn, созданная с помощью tf.feature_column.numeric_column, определяющая колонку признаков, представляющую веса. Используется для уменьшения или увеличения веса примеров во время обучения. Умножается на потерю примера. Если строка, используется в качестве ключа для извлечения тензора весов из features. Если _NumericColumn, тензор извлекается по ключу weight_column.key, а затем применяется weight_column.normalizer_fn для получения тензора весов. |
label_vocabulary | Список строк, представляющих возможные значения меток. Если задано, метки должны быть строкового типа и иметь любое значение в label_vocabulary. Если не задано, это означает, что метки уже закодированы как целые или плавающие числа в [0, 1] для n_classes=2 и закодированы как целые значения в {0, 1,..., n_classes-1} для n_classes>2. Также будут ошибки, если словарь не указан, а метки являются строками. |
optimizer | Экземпляр tf.Optimizer или строка, определяющая тип оптимизатора. По умолчанию используется оптимизатор Adagrad. |
loss_reduction | Один из tf.losses.Reduction, кроме NONE. Описывает, как уменьшать потери обучения по батчу. По умолчанию SUM_OVER_BATCH_SIZE. |
input_layer_partitioner | Необязательно. Разделитель для входного слоя. По умолчанию min_max_variable_partitioner с min_slice_size 64 << 20. |
config | Объект RunConfig для настройки параметров выполнения. |
| Исключения | |
|---|---|
ValueError | Если num_units, cell_type, и rnn_cell_fn несовместимы. |
Совместимость с Eager
Оценщики несовместимы с Eager выполнением.
| Атрибуты | |
|---|---|
config | |
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'}.
| Аргументы | |
|---|---|
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 (по умолчанию), выбирается последний контрольный пункт, найденный в каталоге модели. |
| Возвращаемое значение | |
|---|---|
| Строка пути к экспортированному каталогу. |
| Исключения | |
|---|---|
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'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 для полной документации.
| Аргументы | |
|---|---|
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, указывающее, какой режим будет экспортирован. Обратите внимание, что эта функция является экспериментальной. |
| Возвращаемое значение | |
|---|---|
| Строка пути к экспортированному каталогу. |
| Исключения | |
|---|---|
ValueError | если не предоставлен serving_input_receiver_fn, не предоставлены export_outputs или не найден контрольный пункт. |
export_savedmodel
export_savedmodel(
export_dir_base, serving_input_receiver_fn, assets_extra=None, as_text=False,
checkpoint_path=None, strip_default_attrs=False
)
Экспортирует графу вывода как SavedModel в указанный каталог. (устарело)
Для подробного руководства см. Использование SavedModel с 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'}.
| Аргументы | |
|---|---|
export_dir_base | Строка, содержащая каталог, в котором будут создаваться подкаталоги с отметками времени, содержащие экспортированные SavedModel. |
serving_input_receiver_fn | Функция без аргументов, возвращающая tf.estimator.export.ServingInputReceiver или tf.estimator.export.TensorServingInputReceiver. |
assets_extra | Словарь, определяющий, как заполнить каталог assets.extra в экспортированном SavedModel, или None в случае отсутствия дополнительных ресурсов. |
as_text | Флаг, указывающий, нужно ли записывать прото SavedModel в текстовом формате. |
checkpoint_path | Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается самая последняя контрольная точка, найденная в каталоге модели. |
strip_default_attrs | Булево значение. Если True, атрибуты с значениями по умолчанию будут удалены из NodeDef. Более подробное руководство см. в Удалении атрибутов со значениями по умолчанию. |
| Возвращаемое значение | |
|---|---|
| Строка с путем к экспортированному каталогу. |
| Исключения | |
|---|---|
ValueError | если не предоставлена serving_input_receiver_fn, не предоставлены export_outputs или не найдена контрольная точка. |
get_variable_names
get_variable_names()
Возвращает список всех имён переменных в этой модели.
| Возвращаемое значение | |
|---|---|
| Список имён. |
| Исключения | |
|---|---|
ValueError | Если Estimator ещё не создал контрольную точку. |
get_variable_value
get_variable_value(
name
)
Возвращает значение переменной по имени.
| Аргументы | |
|---|---|
name | Строка или список строк, имя тензора. |
| Возвращаемое значение | |
|---|---|
| Массив NumPy - значение тензора. |
| Исключения | |
|---|---|
ValueError | Если Estimator ещё не создал контрольную точку. |
latest_checkpoint
latest_checkpoint()
Находит имя файла последней сохранённой контрольной точки в model_dir.
| Возвращаемое значение | |
|---|---|
Полный путь к последней контрольной точке или 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/r1.15/api_docs/python/tf/contrib/estimator/RNNClassifier