Примечание: Новым пользователям необходимо установить fix_global_step_increment_bug=True при создании эстиматора.
Входные данные fit, train, и evaluate должны иметь следующие атрибуты, иначе произойдёт KeyError: если weight_column_name не None, атрибут с key=weight_column_name, значение которого — Tensor. Для каждого column в dnn_feature_columns + linear_feature_columns.
- if `column` is a `SparseColumn`, a feature with `key=column.name`
whose `value` is a `SparseTensor`.
- if `column` is a `WeightedSparseColumn`, two features: the first with
`key` the id column name, the second with `key` the weight column
name. Both features' `value` must be a `SparseTensor`.
- if `column` is a `RealValuedColumn, a feature with `key=column.name`
whose `value` is a `Tensor`.
Аргументы
head
Объект _Head.
model_dir
Каталог для сохранения параметров модели, графа и т. д. Также может быть использован для загрузки контрольных точек из каталога в эстиматор для продолжения обучения ранее сохранённой модели.
linear_feature_columns
Итерируемый объект, содержащий все столбцы признаков, используемые линейной частью модели. Все элементы должны быть экземплярами классов, производных от FeatureColumn.
linear_optimizer
Экземпляр tf.Optimizer для применения градиентов к линейной части модели. Если None, используется оптимизатор FTRL.
_joint_linear_weights
Если True, используется один (возможно, разнесённый по частям) переменный для хранения всех весов линейной модели. Более эффективно при большом количестве столбцов, однако требует, чтобы все столбцы были разреженными и имели комбинирующее свойство «суммы».
dnn_feature_columns
Итерируемый объект, содержащий все столбцы признаков, используемые глубокой частью модели. Все элементы должны быть экземплярами классов, производных от FeatureColumn.
dnn_optimizer
Экземпляр tf.Optimizer для применения градиентов к глубокой части модели. Если None, используется оптимизатор Adagrad.
dnn_hidden_units
Список скрытых узлов на слой. Все слои полностью соединены.
dnn_activation_fn
Функция активации, применяемая к каждому слою. Если None, используется tf.nn.relu.
dnn_dropout
Если не None, вероятность отбрасывания заданной координаты.
gradient_clip_norm
Вещественное число > 0. Если указано, градиенты ограничены по глобальной норме с этим коэффициентом ограничения. См. tf.clip_by_global_norm для получения дополнительной информации.
config
Объект RunConfig для настройки параметров выполнения.
feature_engineering_fn
Функция инженерной обработки признаков. Принимает признаки и метки, которые являются результатом input_fn, и возвращает признаки и метки, которые будут переданы в модель.
embedding_lr_multipliers
Необязательно. Словарь из EmbeddingColumn до множителя float. Множитель будет использоваться для умножения на скорость обучения для переменных вложения.
fix_global_step_increment_bug
Если False, для оптимизации линейной и глубокой частей эстиматор требует двух шагов подгонки. Если True, эта ошибка исправлена. Новым пользователям необходимо установить это в True, но по умолчанию значение равно False для обратной совместимости.
input_layer_partitioner
Необязательно. Разделитель для входного слоя.
Исключения
ValueError
Если и linear_feature_columns, и dnn_features_columns одновременно пусты.
Атрибуты
config
model_dir
Возвращает путь, по которому процесс оценки будет искать контрольные точки.
Экспортирует граф вывода в указанный каталог. (устарело)
Аргументы
export_dir
Строка, содержащая каталог для записи экспортированного графа и контрольных точек.
input_fn
Если use_deprecated_input_fn истинно, то функция, которая, принимая Tensor из Example строк, парсит их в признаки, которые затем передаются модели. В противном случае функция, которая не принимает аргументов и возвращает кортеж из (признаков, меток), где признаки — словарь строк в качестве ключей к Tensor, а метки — Tensor, которые в данный момент не используются (и поэтому могут быть None).
input_feature_key
Используется только если use_deprecated_input_fn ложно. Строковый ключ в словаре признаков, возвращаемом input_fn, который соответствует сырым Example строкам Tensor, которые будет принимать экспортированная модель. Может быть только None, если вы используете пользовательскую signature_fn, которая не использует первый аргумент (примеры).
use_deprecated_input_fn
Определяет формат сигнатуры input_fn.
signature_fn
Функция, возвращающая стандартную сигнатуру и карту именованных сигнатур, принимая Tensor из Example строк, dict из Tensor для признаков и Tensor или dict из Tensor для прогнозов.
prediction_key
Ключ для тензора в словаре predictions (выходной данные model_fn) для использования в качестве входных данных predictions для signature_fn. Необязательно. Если None, прогнозы будут переданы signature_fn без фильтрации.
default_batch_size
Стандартный размер пакета для Example заполнителя.
exports_to_keep
Количество экспортов для сохранения.
checkpoint_path
Путь к контрольной точке модели, которая должна быть экспортирована. Если это None (по умолчанию), будет использоваться последняя контрольная точка в export_dir.
Возвращаемое значение
Строковый путь к экспортированному каталогу. Примечание: эта функциональность была добавлена ок. 2016/09/25; клиентам, которые зависят от возвращаемого значения, может потребоваться обработать случай, когда эта функция возвращает None, потому что подклассы не возвращают значение.
Экспортирует граф вывода как SavedModel в указанный каталог.
Аргументы
export_dir_base
Строка, содержащая путь к каталогу для записи экспортированной графы и контрольных точек.
serving_input_fn
Функция без аргументов, возвращающая InputFnOps.
default_output_alternative_key
Имя головки для обработки, если не указано. Не нужно для моделей с одной головкой.
assets_extra
Словарь, определяющий, как заполнить каталог assets.extra в экспортированном SavedModel. Каждый ключ должен указывать путь назначения (включая имя файла) относительно каталога assets.extra. Соответствующее значение — полный путь к исходному файлу для копирования. Например, простой случай копирования одного файла без переименования задаётся как {'my_asset_file.txt': '/path/to/my_asset_file.txt'}.
as_text
Нужно ли записать прото SavedModel в текстовом формате.
checkpoint_path
Путь к контрольной точке для экспорта. Если None (по умолчанию), выбирается самая последняя контрольная точка, найденная в каталоге модели.
graph_rewrite_specs
Итерируемый набор GraphRewriteSpec. Каждый элемент создаст отдельную MetaGraphDef в экспортированном SavedModel, помеченную и переписанную в соответствии с указанными параметрами. По умолчанию используется один элемент с меткой по умолчанию ("serve") и без переписывания.
Инкрементное обучение на наборе образцов. (аргументы устарели)
Ожидается, что этот метод будет вызываться несколько раз последовательно на разных или одних и тех же частях набора данных. Это может реализовать итеративное обучение или обучение вне памяти/онлайн.
Это особенно полезно, когда весь набор данных слишком велик, чтобы поместиться в памяти одновременно. Или когда модель долго сходится, и вы хотите разбить обучение на части.
Аргументы
x
Матрица формы [n_samples, n_features...]. Может быть итератором, возвращающим массивы признаков. Образцы входных данных для обучения модели. Если задано, input_fn должно быть None.
y
Вектор или матрица [n_samples] или [n_samples, n_outputs]. Может быть итератором, возвращающим массив меток. Значения меток обучения (метки классов в классификации, вещественные числа в регрессии). Если задано, input_fn должно быть None.
input_fn
Функция ввода. Если задано, x, y, и batch_size должны быть None.
steps
Количество шагов для обучения модели. Если None, обучаться бесконечно.
batch_size
Размер мини-пакета для использования на входе, по умолчанию — первое измерение x. Должно быть None, если задан input_fn.
monitors
Список экземпляров подкласса BaseMonitor. Используются для обратных вызовов внутри цикла обучения.
Возвращает
self, для цепочки.
Исключения
ValueError
Если хотя бы один из x и y задан, а input_fn задан.
Возвращает предсказания для заданных признаков. (аргументы устарели)
Аргументы
x
Матрица формы [n_samples, n_features...]. Может быть итератором, возвращающим массивы признаков. Образцы входных данных для обучения модели. Если задано, input_fn должно быть None.
input_fn
Функция ввода. Если задано, x и 'batch_size' должны быть None.
batch_size
Переопределение размера пакета по умолчанию. Если задано, 'input_fn' должно быть 'None'.
outputs
список str, имя выходного значения для предсказания. Если None, возвращаются все.
as_iterable
Если True, возвращает итератор, который продолжает генерировать предсказания для каждого примера, пока входные данные не закончатся. Примечание: Входные данные должны завершиться, если вы хотите, чтобы итератор завершился (например, убедитесь, что вы передаёте num_epochs=1, если вы используете что-то вроде read_batch_features).
iterate_batches
Если True, возвращает всю партию сразу вместо разбиения партии на отдельные образцы. Актуально только когда as_iterable равно True.
Возвращаемое значение
Массив NumPy предсказанных классов или значений регрессии, если конструктор model_fn возвращает Tensor для predictions или список массивов NumPy, если model_fn возвращает dict. Возвращает итерируемый объект предсказаний, если as_iterable имеет значение True.
Метод работает как с простыми оценщиками, так и с вложенными объектами (например, с конвейерами). В первом случае параметры имеют вид <component>__<parameter>, что позволяет обновлять каждый компонент вложенного объекта.