tf.estimator.BinaryClassHead

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

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

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)

Методы

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.

Рекомендуется передавать все аргументы через имя.

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 для получения подробной информации.

update_metrics

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

update_metrics(
    eval_metrics, features, logits, labels, regularization_losses=None
)

Обновляет метрики оценки. Смотрите base_head.Head для получения подробной информации.