Spec-Zone.ru › TensorFlow 1.15

tf.contrib.learn.LinearRegressor

Модель линейной регрессии.

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

tf.contrib.learn.LinearRegressor(
    feature_columns, model_dir=None, weight_column_name=None, optimizer=None,
    gradient_clip_norm=None, enable_centered_bias=False, label_dimension=1,
    _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 = LinearRegressor(
    feature_columns=[sparse_column_a, sparse_feature_a_x_sparse_feature_b])

# 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: key=weight_column_name, значение=a Tensor
  • для столбца в feature_columns:
    • если isinstance(столбец, SparseColumn): key=column.name, значение=a SparseTensor
    • если isinstance(столбец, WeightedSparseColumn): {ключ=имя столбца, значение=a SparseTensor, ключ=имя столбца весов, значение=a SparseTensor}
    • если isinstance(столбец, RealValuedColumn): key=column.name, значение=a Tensor
Аргументы
feature_columns Итерируемый объект, содержащий все столбцы признаков, используемые моделью. Все элементы множества должны быть экземплярами классов, производных от FeatureColumn.
model_dir Директория для сохранения параметров модели, графа и т.д. Это также можно использовать для загрузки контрольных точек из директории в оценщик для продолжения обучения ранее сохранённой модели.
weight_column_name Строка, определяющая имя столбца признака, представляющего веса. Используется для снижения или повышения значимости примеров во время обучения. Будет умножаться на потерю примера.
optimizer Экземпляр tf.Optimizer, используемый для обучения модели. Если None, будет использоваться оптимизатор Ftrl.
gradient_clip_norm Вещественное число > 0. Если указано, градиенты обрезаются до их глобальной нормы с этим коэффициентом обрезки. Подробнее см. tf.clip_by_global_norm.
enable_centered_bias Булево значение. Если True, оценщик будет обучаться смещенной переменной для каждого класса. Остальная часть структуры модели обучает остаток после централизованного смещения.
label_dimension Количество целевых значений регрессии на пример. Это размер последнего измерения меток и логов Tensor объектов (как правило, они имеют форму [batch_size, label_dimension]).
_joint_weights Если True, используйте одну (возможно, разбиение) переменную для хранения весов. Это быстрее, но требует, чтобы все столбцы признаков были разреженными и имели комбинирующую функцию 'sum'. Несовместимо с SDCAOptimizer.
config Объект RunConfig для настройки параметров выполнения.
feature_engineering_fn Функция обработки признаков. Принимает признаки и метки, которые являются результатом input_fn, и возвращает признаки и метки, которые будут переданы в модель.
Атрибуты
config
model_dir Возвращает путь, в котором процесс оценки будет искать контрольные точки.
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. Инструкции по обновлению: Оценщик отделён от интерфейса Scikit Learn путём перемещения в отдельный класс SKCompat. Аргументы x, y и batch_size доступны только в классе SKCompat, оценщик будет принимать только input_fn. Пример преобразования: est = Estimator(...) -> est = SKCompat(Estimator(...))
Исключения
ValueError Если хотя бы один из x или y задан, и хотя бы один из input_fn или feed_fn задан. Или если metrics не None или dict.

export

См. исходный код

export(
    export_dir, input_fn=None, input_feature_key=None, use_deprecated_input_fn=True,
    signature_fn=None, default_batch_size=1, exports_to_keep=None
)

См. BaseEstimator.export. (устарело)

Предупреждение: ЭТА ФУНКЦИЯ УСТАРЕЛА. Она будет удалена после 2017-03-25. Инструкции по обновлению: Пожалуйста, используйте Estimator.export_savedmodel() вместо этого.

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. Инструкции по обновлению: Оценщик отделён от интерфейса Scikit Learn путём перемещения в отдельный класс SKCompat. Аргументы x, y и batch_size доступны только в классе SKCompat, оценщик будет принимать только 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
)

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

Предупреждение: НЕКОТОРЫЕ ЗНАЧЕНИЯ АРГУМЕНТОВ УСТАРЕЛИ: (as_iterable=False). Они будут удалены после 2016-09-15. Инструкции по обновлению: Поведение по умолчанию predict() изменяется. Значение по умолчанию для as_iterable изменится на True, а затем флаг будет полностью удален. Поведение этого флага описано ниже.
Предупреждение: НЕКОТОРЫЕ ЗНАЧЕНИЯ АРГУМЕНТОВ УСТАРЕЛИ: (outputs=None). Они будут удалены после 2017-03-01. Инструкции по обновлению: Пожалуйста, переключитесь на predict_scores или установите аргумент outputs.

По умолчанию возвращает предсказанные значения. Но это значение по умолчанию будет вскоре удалено. Пользователи должны либо передать outputs, или вызвать метод predict_scores.

Аргументы
x признаки.
input_fn Функция ввода. Если задано, x должно быть None.
batch_size Переопределение размера пакета по умолчанию.
outputs список str, имя выходного значения для прогнозирования. Если None, возвращаются значения.
as_iterable Если True, возвращает итератор, который продолжает выдавать прогнозы для каждого примера, пока входные данные не будут исчерпаны. Примечание: входные данные должны завершаться, если вы хотите, чтобы итератор завершился (например, убедитесь, что передали num_epochs=1, если используете что-то вроде read_batch_features).
Возвращает
Массив NumPy предсказанных значений (или итератор предсказанных значений, если as_iterable равно True). Если label_dimension == 1, форма выходных данных [batch_size], в противном случае форма [batch_size, label_dimension]. Если outputs задано, возвращается словарь прогнозов.

predict_scores

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

predict_scores(
    x=None, input_fn=None, batch_size=None, as_iterable=True
)

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

Предупреждение: НЕКОТОРЫЕ ЗНАЧЕНИЯ АРГУМЕНТОВ УСТАРЕЛИ: (as_iterable=False). Они будут удалены после 2016-09-15. Инструкции по обновлению: Поведение по умолчанию predict() изменяется. Значение по умолчанию для as_iterable изменится на True, а затем флаг будет полностью удален. Поведение этого флага описано ниже.
Аргументы
x признаки.
input_fn Функция ввода. Если задано, x должно быть None.
batch_size Переопределение размера пакета по умолчанию.
as_iterable Если True, возвращает итератор, который продолжает выдавать прогнозы для каждого примера, пока входные данные не будут исчерпаны. Примечание: входные данные должны завершаться, если вы хотите, чтобы итератор завершился (например, убедитесь, что передали num_epochs=1, если используете что-то вроде read_batch_features).
Возвращает
Массив NumPy предсказанных значений (или итератор предсказанных значений, если as_iterable равно True). Если label_dimension == 1, форма выходных данных [batch_size], в противном случае форма [batch_size, label_dimension].

set_params

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

set_params(
    **params
)

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

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

Аргументы
**params Параметры.
Возвращает
self
Исключения
ValueError Если параметры содержат недопустимые имена.

© 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/LinearRegressor

Spec-Zone.ru

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