tf.contrib.learn.Estimator

Класс Estimator является базовым инструментом обучения/оценки моделей TensorFlow.

Наследуется от: BaseEstimator

tf.contrib.learn.Estimator(
    model_fn=None, model_dir=None, config=None, params=None,
    feature_engineering_fn=None
)

ЭТОТ КЛАСС УСТЕРЕЛ. Обратитесь к contrib/learn/README.md для получения общих инструкций по миграции.

Аргументы
`model_fn`	Функция модели. Следует подписи: Аргументы: `features`: единственный `Tensor` или `dict` из `Tensor` (в зависимости от данных, переданных в `fit`), `labels`: `Tensor` или `dict` из `Tensor` (для моделей с несколькими выходами). Если режим `ModeKeys.INFER`, `labels=None` будет передано. Если подпись `model_fn` не принимает `mode`, `model_fn` всё равно должен уметь обрабатывать `labels=None`. `mode`: Необязательно. Указывает, является ли это обучение, оценка или прогнозирование. См. `ModeKeys`. `params`: Необязательные `dict` гиперпараметров. Получит то, что передано в `params` параметр Estimator. Это позволяет настраивать Estimators из настройки гиперпараметров. `config`: Необязательный объект конфигурации. Получит то, что передано в `config` параметр Estimator, или значение по умолчанию `config`. Позволяет обновлять вещи в вашей model_fn на основе конфигурации, например, `num_ps_replicas`. `model_dir`: Необязательный каталог, где сохраняются параметры модели, граф и т. д. Получит то, что передано в `model_dir` параметр Estimator, или значение по умолчанию `model_dir`. Позволяет обновлять вещи в вашей model_fn, которые ожидают model_dir, такие как hooks обучения. Возвращает: `ModelFnOps` Также поддерживает устаревшую подпись, которая возвращает кортеж: predictions: `Tensor`, `SparseTensor` или словарь такого же типа. Также может быть любым типом, который преобразуется в `Tensor` или `SparseTensor`, или словарь такого же типа. loss: скалярная потеря `Tensor`. train_op: операция обновления обучения `Tensor` или `Operation`. Поддерживает следующие три подписи для функции: `(features, labels) -> (predictions, loss, train_op)` `(features, labels, mode) -> (predictions, loss, train_op)` `(features, labels, mode, params) -> (predictions, loss, train_op)` `(features, labels, mode, params, config) -> (predictions, loss, train_op)` `(features, labels, mode, params, config, model_dir) -> (predictions, loss, train_op)`
`model_dir`	Каталог для сохранения параметров модели, графа и т. д. Это также можно использовать для загрузки контрольных точек из каталога в estimator для продолжения обучения ранее сохранённой модели.
`config`	Объект конфигурации.
`params`	`dict` гиперпараметров, которые будут переданы в `model_fn`. Ключи — имена параметров, значения — базовые типы Python.
`feature_engineering_fn`	Функция обработки признаков. Принимает признаки и метки, которые являются результатом `input_fn`, и возвращает признаки и метки, которые будут переданы в `model_fn`. Обратитесь к `model_fn` для определения признаков и меток.

Возможные исключения
`ValueError`	параметры `model_fn` не соответствуют `params`.

Атрибуты
`config`
`model_dir`	Возвращает путь, в котором процесс оценки будет искать контрольные точки.
`model_fn`	Возвращает model_fn, привязанный к self.params.

Методы

`evaluate`

Просмотреть исходный код

evaluate(
    x=None, y=None, input_fn=None, feed_fn=None, batch_size=None, steps=None,
    metrics=None, name=None, checkpoint_path=None, hooks=None, log_progress=True
)

См. Evaluable. (устаревшие аргументы)

Возможные исключения
`ValueError`	Если хотя бы один из `x` или `y` предоставлен, и хотя бы один из `input_fn` или `feed_fn` предоставлен. Или если `metrics` не является `None` или `dict`.

`export`

Просмотреть исходный код

export(
    export_dir, input_fn=export._default_input_fn, input_feature_key=None,
    use_deprecated_input_fn=True, signature_fn=None, prediction_key=None,
    default_batch_size=1, exports_to_keep=None, checkpoint_path=None
)

Экспортирует граф вывода в заданный каталог. (устарело)

Аргументы
`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` placeholder.
`exports_to_keep`	Количество экспортов для хранения.
`checkpoint_path`	Путь контрольной точки модели для экспорта. Если это `None` (что является значением по умолчанию), будет использоваться последняя контрольная точка в export_dir.

Возвращает
Путь к экспортированному каталогу. Примечание: эта функциональность была добавлена примерно 25.09.2016; клиентам, зависящим от возвращаемого значения, может потребоваться обработать случай, когда эта функция возвращает None, потому что подклассы не возвращают значение.

Возвращает

Путь к экспортированному каталогу. Примечание: эта функциональность была добавлена примерно 25.09.2016; клиентам, зависящим от возвращаемого значения, может потребоваться обработать случай, когда эта функция возвращает None, потому что подклассы не возвращают значение.

`export_savedmodel`

Просмотреть исходный код

export_savedmodel(
    export_dir_base, serving_input_fn, default_output_alternative_key=None,
    assets_extra=None, as_text=False, checkpoint_path=None,
    graph_rewrite_specs=(GraphRewriteSpec((tag_constants.SERVING,), ()),),
    strip_default_attrs=False
)

Экспортирует граф вывода как 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") и без перезаписи.
`strip_default_attrs`	Логическое значение. Если `True`, атрибуты со значениями по умолчанию будут удалены из NodeDefs. Более подробное руководство см. в Удаление атрибутов со значениями по умолчанию.

Возвращает
Путь к экспортированному каталогу.

Исключения
`ValueError`	если запрошен нераспознанный тип экспорта.

`fit`

Просмотреть исходный код

fit(
    x=None, y=None, input_fn=None, steps=None, batch_size=None, monitors=None,
    max_steps=None
)

См. Trainable. (аргументы устарели)

Исключения
`ValueError`	Если `x` или `y` не `None`, в то время как `input_fn` не `None`.
`ValueError`	Если оба `steps` и `max_steps` не `None`.

`get_params`

Просмотреть исходный код

get_params(
    deep=True
)

Получить параметры для этого оценщика.

Аргументы
`deep`	boolean, необязательно Если `True`, вернет параметры для этого оценщика и содержащихся в нём подобъектов, которые являются оценщиками.

Возвращает
`params`	отображение строки на любой параметр; имена параметров сопоставлены со своими значениями.

`get_variable_names`

Просмотреть исходный код

get_variable_names()

Возвращает список всех имён переменных в этой модели.

Возвращает
Список имён.

`get_variable_value`

Просмотреть исходный код

get_variable_value(
    name
)

Возвращает значение переменной, заданной по имени.

Аргументы
`name`	строка, имя тензора.

Возвращает
Массив NumPy - значение тензора.

`partial_fit`

Просмотреть исходный код

partial_fit(
    x=None, y=None, input_fn=None, steps=1, batch_size=None, monitors=None
)

Инкрементальное обучение на пакет данных. (устарели аргументы)

Ожидается, что этот метод будет вызываться несколько раз последовательно на разных или одних и тех же фрагментах данных. Это может реализовать итеративное обучение или обучение вне памяти/онлайн-обучение.

Это особенно полезно, когда весь набор данных слишком велик, чтобы поместиться в памяти одновременно. Или когда модель медленно сходится, и вы хотите разбить обучение на подчасти.

Аргументы
`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` задан.

`predict`

Просмотреть исходный код

predict(
    x=None, input_fn=None, batch_size=None, outputs=None, as_iterable=True,
    iterate_batches=False
)

Возвращает предсказания для заданных признаков. (устарели аргументы)

Аргументы
`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.

Массив NumPy предсказанных классов или значений регрессии, если конструктор model_fn возвращает Tensor для predictions или массив NumPy массивов, если model_fn возвращает dict. Возвращает итерируемый объект предсказаний, если as_iterable True.

Исключения
`ValueError`	Если x и input_fn оба предоставлены или оба `None`.

`set_params`

Просмотреть исходный код

set_params(
    **params
)

Установить параметры этого оценщика.

Метод работает как с простыми оценщиками, так и с вложенными объектами (такими как конвейеры). У первых параметры имеют вид <component>__<parameter>, чтобы можно было обновлять каждый компонент вложенного объекта.

Аргументы
`**params`	Параметры.

Возвращает
self

Исключения
`ValueError`	Если params содержат недопустимые имена.

© 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/learn/Estimator