Spec-Zone.ru › TensorFlow 1.15

tf.contrib.learn.LinearEstimator

Линейная модель с заданным пользователем заголовком.

Унаследован от: Estimator

tf.contrib.learn.LinearEstimator(
    feature_columns, head, model_dir=None, weight_column_name=None, optimizer=None,
    gradient_clip_norm=None, _joint_weights=False, config=None,
    feature_engineering_fn=None
)

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

Обучает обобщенную линейную модель для предсказания значения метки на основе наблюдений за значениями признаков.

Пример:

Для выполнения регрессии Пуассона,

sparse_column_a = sparse_column_with_hash_bucket(...)
sparse_column_b = sparse_column_with_hash_bucket(...)

sparse_feature_a_x_sparse_feature_b = crossed_column(...)

estimator = LinearEstimator(
    feature_columns=[sparse_column_a, sparse_feature_a_x_sparse_feature_b],
    head=head_lib.poisson_regression_head())

# Input builders
def input_fn_train: # returns x, y
  ...
def input_fn_eval: # returns x, y
  ...
estimator.fit(input_fn=input_fn_train)
estimator.evaluate(input_fn=input_fn_eval)
estimator.predict(x=x)

Вход fit и evaluate должен иметь следующие признаки, иначе возникнет KeyError:

  • если weight_column_name не None: ключ=weight_column_name, значение=%%CODE_BLOCK_7%%
  • для столбца в feature_columns:
    • если isinstance(столбец, SparseColumn): ключ=имя_столбца, значение=%%CODE_BLOCK_10%%
    • если isinstance(столбец, WeightedSparseColumn): {ключ=имя_столбца, значение=%%CODE_BLOCK_12%%, ключ=имя_столбца_веса, значение=%%CODE_BLOCK_13%%%}
    • если isinstance(столбец, RealValuedColumn): ключ=имя_столбца, значение=%%CODE_BLOCK_15%%%
Аргументы
feature_columns Итерируемый объект, содержащий все столбцы признаков, используемые моделью. Все элементы набора должны быть экземплярами классов, производными от FeatureColumn.
head Экземпляр класса _Head.
model_dir Каталог для сохранения параметров модели, графа и т. д. Это также можно использовать для загрузки контрольных точек из каталога в оценщик для продолжения обучения ранее сохраненной модели.
weight_column_name Строка, определяющая имя столбца признака, представляющего веса. Используется для снижения или повышения веса примеров во время обучения. Будет умножаться на потерю примера.
optimizer Экземпляр tf.Optimizer, используемый для обучения модели. Если None, будет использоваться оптимизатор Ftrl.
gradient_clip_norm Значение float > 0. Если задано, градиенты ограничиваются их глобальной нормой с этим коэффициентом ограничения. См. tf.clip_by_global_norm для получения дополнительной информации.
_joint_weights Если True, используйте один (возможно, раздробленный) переменный для хранения весов. Это быстрее, но требует, чтобы все столбцы признаков были разреженными и имели комбинировщик «сумма». Несовместимо с SDCAOptimizer.
config Объект RunConfig, для настройки параметров выполнения.
feature_engineering_fn Функция обработки признаков. Принимает признаки и метки, которые являются результатом input_fn, и возвращает признаки и метки, которые будут переданы в модель.
Возможные исключения
ValueError если оптимизатор не поддерживается, например, SDCAOptimizer
Атрибуты
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. (устаревшие аргументы)

Предупреждение: НЕКОТОРЫЕ АРГУМЕНТЫ УСТАРЕЛИ: (batch_size, x, y). Они будут удалены после 2016-12-01. Инструкции по обновлению: Класс Estimator отвязан от интерфейса Scikit Learn, переместившись в отдельный класс SKCompat. Аргументы x, y и batch_size доступны только в классе SKCompat, Estimator будет принимать только input_fn. Пример преобразования: est = Estimator(...) -> est = SKCompat(Estimator(...))
Возможные исключения
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
)

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

Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена после 2017-03-25. Инструкции по обновлению: Используйте Estimator.export_savedmodel() вместо нее.
Аргументы
export_dir Строка, содержащая каталог для записи экспортированного графа и контрольных точек.
input_fn Если use_deprecated_input_fn равно true, то функция, которая, учитывая Tensor строк Example, анализирует их в признаки, которые затем передаются модели. В противном случае, функция, которая не принимает аргументов и возвращает кортеж (признаки, метки), где признаки — это словарь со строковым ключом к Tensor, а метки — это Tensor, который в настоящее время не используется (и поэтому может быть None).
input_feature_key Используется только если use_deprecated_input_fn равно false. Строковый ключ в словаре признаков, возвращенном 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, потому что подклассы не возвращают значение.

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. (устаревшие аргументы)

Предупреждение: НЕКОТОРЫЕ АРГУМЕНТЫ УСТАРЕЛИ: (batch_size, x, y). Они будут удалены после 2016-12-01. Инструкции по обновлению: Класс Estimator отвязан от интерфейса Scikit Learn, переместившись в отдельный класс SKCompat. Аргументы x, y и batch_size доступны только в классе SKCompat, Estimator будет принимать только input_fn. Пример преобразования: est = Estimator(...) -> est = SKCompat(Estimator(...))
Исключения
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
)

Инкрементная подгонка на наборе образцов. (устаревшие аргументы)

Предупреждение: НЕКОТОРЫЕ АРГУМЕНТЫ УСТАРЕЛИ: (batch_size, x, y). Они будут удалены после 2016-12-01. Инструкции по обновлению: Класс Estimator отвязан от интерфейса Scikit Learn, переместившись в отдельный класс SKCompat. Аргументы x, y и batch_size доступны только в классе SKCompat, Estimator будет принимать только input_fn. Пример преобразования: est = Estimator(...) -> est = SKCompat(Estimator(...))

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

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

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

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

Предупреждение: НЕКОТОРЫЕ АРГУМЕНТЫ УСТАРЕЛИ: (as_iterable, batch_size, x). Они будут удалены после 2016-12-01. Инструкции по обновлению: Класс Estimator отвязан от интерфейса Scikit Learn, переместившись в отдельный класс SKCompat. Аргументы x, y и batch_size доступны только в классе SKCompat, Estimator будет принимать только input_fn. Пример преобразования: est = Estimator(...) -> est = SKCompat(Estimator(...))
Аргументы
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, если dict возвращает 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/LinearEstimator

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API