Spec-Zone.ru › TensorFlow 2.4

tf.estimator.BinaryClassHead

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

Создаёт Head для бинарной классификации с одним меткой.

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

Просмотр псевдонимов

Псевдонимы для миграции

См. Руководство по миграции для получения дополнительной информации.

tf.compat.v1.estimator.BinaryClassHead

tf.estimator.BinaryClassHead(
    weight_column=None, thresholds=None, label_vocabulary=None,
    loss_reduction=losses_utils.ReductionV2.SUM_OVER_BATCH_SIZE, loss_fn=None,
    name=None
)

Использует sigmoid_cross_entropy_with_logits потерю.

Головка ожидает logits с формой [D0, D1, ... DN, 1]. Во многих приложениях форма — [batch_size, 1].

labels должен быть плотным Tensor с формой, соответствующей logits, а именно [D0, D1, ... DN, 1]. Если label_vocabulary задано, labels должен быть строковым Tensor со значениями из словаря. Если label_vocabulary не задано, labels должны быть вещественными Tensor со значениями в интервале [0, 1].

Если weight_column указано, веса должны иметь форму [D0, D1, ... DN], или [D0, D1, ... DN, 1].

Потеря — взвешенная сумма по входным измерениям. А именно, если входные метки имеют форму [batch_size, 1], потеря — взвешенная сумма по batch_size.

Также поддерживает пользовательские loss_fn. loss_fn принимает (labels, logits) или (labels, logits, features, loss_reduction) в качестве аргументов и возвращает потерю с формой [D0, D1, ... DN, 1]. loss_fn должен поддерживать вещественные labels с формой [D0, D1, ... DN, 1]. А именно, головка применяет label_vocabulary к входным меткам перед передачей их loss_fn.

Использование:

head = tf.estimator.BinaryClassHead()
logits = np.array(((45,), (-41,),), dtype=np.float32)
labels = np.array(((1,), (1,),), dtype=np.int32)
features = {'x': np.array(((42,),), dtype=np.float32)}
# expected_loss = sum(cross_entropy(labels, logits)) / batch_size
#               = sum(0, 41) / 2 = 41 / 2 = 20.50
loss = head.loss(labels, logits, features=features)
print('{:.2f}'.format(loss.numpy()))
20.50
eval_metrics = head.metrics()
updated_metrics = head.update_metrics(
  eval_metrics, features, logits, labels)
for k in sorted(updated_metrics):
 print('{} : {:.2f}'.format(k, updated_metrics[k].result().numpy()))
  accuracy : 0.50
  accuracy_baseline : 1.00
  auc : 0.00
  auc_precision_recall : 1.00
  average_loss : 20.50
  label/mean : 1.00
  precision : 1.00
  prediction/mean : 0.50
  recall : 0.50
preds = head.predictions(logits)
print(preds['logits'])
tf.Tensor(
  [[ 45.]
   [-41.]], shape=(2, 1), dtype=float32)

Использование со стандартной оценкой:

my_head = tf.estimator.BinaryClassHead()
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.BinaryClassHead()
  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, определяющая столбец признаков, представляющий веса. Используется для уменьшения или увеличения веса примеров во время обучения. Будет умножаться на потерю примера.
thresholds Последовательность чисел с плавающей запятой в диапазоне (0, 1). Для метрик бинарной классификации, таких как точность и полнота, генерируется метрика оценки для каждого значения порога. Этот порог применяется к значениям логитов, чтобы определить бинарную классификацию (т.е., выше порога — true, ниже — false.
label_vocabulary Список или кортеж строк, представляющих возможные значения меток. Если не задано, это означает, что метки уже закодированы в диапазоне [0, 1]. Если задано, метки должны быть строкового типа и иметь любое значение в label_vocabulary. Обратите внимание, что будут генерироваться ошибки, если label_vocabulary не предоставлен, но метки являются строками.
loss_reduction Один из tf.losses.Reduction за исключением NONE. Определяет, как уменьшать обучающую потерю по партиям. По умолчанию SUM_OVER_BATCH_SIZE, а именно взвешенная сумма потерь, делённая на batch size * label_dimension.
loss_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, keys=None
)

Возвращает прогнозы на основе ключей.

См. base_head.Head для получения подробностей.

Аргументы
logits Логиты Tensor с формой [D0, D1, ... DN, logits_dimension]. Для многих приложений форма — [batch_size, logits_dimension].
keys Список или кортеж ключей прогнозов. Каждый ключ может быть либо переменной класса prediction_keys.PredictionKeys, либо его строковым значением, например: prediction_keys.PredictionKeys.CLASSES или 'classes'. Если не указано, будут возвращены прогнозы для всех допустимых ключей.
Возвращает
Словарь прогнозов.

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/r2.4/api_docs/python/tf/estimator/BinaryClassHead

Spec-Zone.ru

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