tf.estimator.RegressionHead
| Просмотреть исходный код на GitHub |
Создаёт Head для регрессии, используя mean_squared_error функцию потерь.
Наследуется от: Head
tf.estimator.RegressionHead(
label_dimension=1, weight_column=None,
loss_reduction=losses_utils.ReductionV2.SUM_OVER_BATCH_SIZE, loss_fn=None,
inverse_link_fn=None, name=None
)
Функция потерь представляет собой взвешенную сумму по всем измерениям входных данных. То есть, если входные метки имеют форму [batch_size, label_dimension], функция потерь является взвешенной суммой по batch_size и label_dimension.
Головка ожидает logits с формой [D0, D1, ... DN, label_dimension]. Во многих приложениях форма составляет [batch_size, label_dimension].
Форма labels должна совпадать с logits, то есть [D0, D1, ... DN, label_dimension]. Если label_dimension=1, также поддерживается форма [D0, D1, ... DN].
Если weight_column указано, веса должны иметь форму [D0, D1, ... DN], [D0, D1, ... DN, 1] или [D0, D1, ... DN, label_dimension].
Поддерживает пользовательские loss_fn. loss_fn принимает (labels, logits) или (labels, logits, features, loss_reduction) в качестве аргументов и возвращает функцию потерь без сворачивания, с формой [D0, D1, ... DN, label_dimension].
Также поддерживает пользовательские inverse_link_fn, также известные как "функция среднего значения". inverse_link_fn используется только в режиме PREDICT . Она принимает logits в качестве аргумента и возвращает предсказанные значения. Эта функция является обратной функцией связи, определенной в https://en.wikipedia.org/wiki/Generalized_linear_model#Link_function Например, для регрессии Пуассона установите inverse_link_fn=tf.exp.
Головка может быть использована с готовым оценщиком. Пример:
my_head = tf.estimator.RegressionHead()
my_estimator = tf.estimator.DNNEstimator(
head=my_head,
hidden_units=...,
feature_columns=...)
Она также может быть использована с пользовательским model_fn. Пример:
def _my_model_fn(features, labels, mode):
my_head = tf.estimator.RegressionHead()
logits = tf.keras.Model(...)(features)
return my_head.create_estimator_spec(
features=features,
mode=mode,
labels=labels,
optimizer=tf.keras.optimizers.Adagrad(lr=0.1),
logits=logits)
my_estimator = tf.estimator.Estimator(model_fn=_my_model_fn)
| Аргументы | |
|---|---|
weight_column | Строка или NumericColumn созданный с помощью tf.feature_column.numeric_column, определяющий столбец признаков, представляющий собой веса. Используется для уменьшения или увеличения важности примеров во время обучения. Он будет умножаться на функцию потерь примера. |
label_dimension | Количество меток регрессии на пример. Это размер последнего измерения меток Tensor (обычно, эта форма [batch_size, label_dimension]). |
loss_reduction | Один из tf.losses.Reduction, за исключением NONE. Определяет, как сворачивать функцию потерь во время обучения по партиям и измерениям меток. По умолчанию используется SUM_OVER_BATCH_SIZE, то есть взвешенная сумма потерь, делённая на batch size * label_dimension |
loss_fn | Необязательная функция потерь. По умолчанию mean_squared_error |
inverse_link_fn | Необязательная обратная функция связи, также известная как "функция среднего значения". По умолчанию - тождественная функция. |
name | Название головки. Если указано, ключи сворачивания и метрик будут дополнены "/" + name. Также используется как name_scope при создании операций. |
| Атрибуты | |
|---|---|
logits_dimension | См. base_head.Head для деталей. |
loss_reduction | См. base_head.Head для деталей. |
name | См. base_head.Head для деталей. |
Методы
create_estimator_spec
create_estimator_spec(
features, mode, logits, labels=None, optimizer=None, trainable_variables=None,
train_op_fn=None, update_ops=None, regularization_losses=None
)
Возвращает EstimatorSpec , который может вернуть функция model_fn.
Рекомендуется передавать все аргументы через имя.
| Аргументы | |
|---|---|
features | Входные dict отображения имен признаков в Tensor или SparseTensor объекты, содержащие значения для этого признака в мини-пачке. Часто используется для получения тензора весов примера. |
mode | ModeKeys оценщика. |
logits | Логиты Tensor для использования головкой. |
labels | Метки Tensor, или dict отображения имен меток в Tensor объекты значений меток. |
optimizer | Экземпляр tf.keras.optimizers.Optimizer для оптимизации функции потерь в режиме TRAIN. То есть устанавливает train_op = optimizer.get_updates(loss, trainable_variables), который обновляет переменные для минимизации loss. |
trainable_variables | Список или кортеж объектов Variable для обновления, чтобы минимизировать loss. В Tensorflow 1.x, по умолчанию, это список переменных, собранных в графе под ключом GraphKeys.TRAINABLE_VARIABLES. Так как Tensorflow 2.x не имеет коллекций и GraphKeys, trainable_variables нужно передавать явно здесь. |
train_op_fn | Функция, которая принимает скалярную функцию потерь Tensor и возвращает операцию для оптимизации модели с потерей в режиме TRAIN. Используется, если optimizer имеет значение None. В режиме TRAIN должно быть установлено ровно одно из train_op_fn и optimizer. По умолчанию это None в других режимах. Если вы хотите оптимизировать функцию потерь самостоятельно, вы можете передать lambda _: tf.no_op() и затем использовать EstimatorSpec.loss для вычисления и применения градиентов. |
update_ops | Список или кортеж операций обновления, которые должны выполняться во время обучения. Например, слои, такие как BatchNormalization, создают операции обновления среднего и дисперсии, которые необходимо выполнять во время обучения. В Tensorflow 1.x они добавляются в коллекцию UPDATE_OPS. Поскольку Tensorflow 2.x не имеет коллекций, update_ops необходимо передавать явно здесь. |
regularization_losses | Список дополнительных скалярных функций потерь, которые необходимо добавить к функции потерь обучения, таких как функции потерь регуляризации. |
| Возвращает | |
|---|---|
EstimatorSpec. |
loss
loss(
labels, logits, features=None, mode=None, regularization_losses=None
)
Возвращает предсказания на основе ключей. См. base_head.Head для деталей.
metrics
metrics(
regularization_losses=None
)
Создаёт метрики. См. base_head.Head для деталей.
predictions
predictions(
logits
)
Возвращает предсказания на основе ключей. См. base_head.Head для деталей.
| Аргументы | |
|---|---|
logits | Логиты Tensor с формой [D0, D1, ... DN, logits_dimension]. Во многих приложениях форма составляет [batch_size, logits_dimension]. |
| Возвращает | |
|---|---|
| Словарь предсказаний. |
update_metrics
update_metrics(
eval_metrics, features, logits, labels, regularization_losses=None
)
Обновляет метрики оценки. См. base_head.Head для деталей.
© 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/estimator/RegressionHead