Spec-Zone.ru › TensorFlow 2.9

tf.estimator.MultiClassHead

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

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

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

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

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

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

tf.compat.v1.estimator.MultiClassHead

tf.estimator.MultiClassHead(
    n_classes,
    weight_column=None,
    label_vocabulary=None,
    loss_reduction=tf.losses.Reduction.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)
Аргументы
n_classes Количество классов, должно быть больше 2 (для 2 классов используйте BinaryClassHead).
weight_column Строка или NumericColumn, созданная с помощью tf.feature_column.numeric_column, определяющая столбец признаков, представляющий веса. Используется для уменьшения или увеличения весов примеров во время обучения. Будет умножаться на функцию потерь примера.
label_vocabulary Список или кортеж строк, представляющих возможные значения меток. Если он не указан, это означает, что метки уже закодированы как целое число в диапазоне [0, n_classes). Если указан, метки должны быть строкового типа и иметь любое значение в label_vocabulary. Обратите внимание, что будут выведены ошибки, если label_vocabulary не предоставлен, но метки являются строками. Если и n_classes и label_vocabulary заданы, label_vocabulary должен содержать ровно n_classes элементов.
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 для возврата модельной функции.

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

Аргументы
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_op_fn и optimizer должен быть установлен в режиме TRAIN. По умолчанию, он 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 для получения подробной информации.

© 2022 The TensorFlow Authors. All rights reserved.
Licensed under the Creative Commons Attribution License 4.0.
Code samples licensed under the Apache 2.0 License.
https://www.tensorflow.org/versions/r2.9/api_docs/python/tf/estimator/MultiClassHead

Spec-Zone.ru

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