tf.estimator.MultiClassHead

Создаёт Head для многоклассовой классификации.

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

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

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

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

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

Если 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.

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

n_classes = 3
head = tf.estimator.MultiClassHead(n_classes)
logits = np.array(((10, 0, 0), (0, 10, 0),), dtype=np.float32)
labels = np.array(((1,), (1,)), dtype=np.int64)
features = {'x': np.array(((42,),), dtype=np.int32)}
# expected_loss = sum(cross_entropy(labels, logits)) / batch_size
#               = sum(10, 0) / 2 = 5.
loss = head.loss(labels, logits, features=features)
print('{:.2f}'.format(loss.numpy()))
5.00
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
average_loss : 5.00
preds = head.predictions(logits)
print(preds['logits'])
tf.Tensor(
  [[10.  0.  0.]
   [ 0. 10.  0.]], shape=(2, 3), dtype=float32)

Использование с готовым оценщиком:

my_head = tf.estimator.MultiClassHead(n_classes=3)
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.MultiClassHead(n_classes=3)
  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 для подробностей.