tf.estimator.MultiLabelHead
| Просмотреть исходный код на GitHub |
Создаёт Head для многоклассовой классификации.
Наследуется от: Head
tf.estimator.MultiLabelHead(
n_classes, weight_column=None, thresholds=None, label_vocabulary=None,
loss_reduction=losses_utils.ReductionV2.SUM_OVER_BATCH_SIZE, loss_fn=None,
classes_for_class_based_metrics=None, name=None
)
Многоклассовая классификация обрабатывает случай, когда каждый пример может иметь ноль или более связанных меток из дискретного набора. Это отличается от MultiClassHead, которое имеет ровно одну метку на пример.
Использует sigmoid_cross_entropy потерь, усреднённых по классам и взвешенную сумму по пакету. Иными словами, если входные логарифмические вероятности имеют размер [batch_size, n_classes], то потери — среднее по n_classes и взвешенная сумма по batch_size.
Заголовок ожидает logits с размером [D0, D1, ... DN, n_classes]. Во многих приложениях размер [batch_size, n_classes].
Метки могут быть:
- Многомерный тензор формы
[D0, D1, ... DN, n_classes] - Целое число
SparseTensorиндексов классов.dense_shapeдолжен быть[D0, D1, ... DN, ?], а значения внутри[0, n_classes). - Если
label_vocabularyзадано, строковоеSparseTensor.dense_shapeдолжен быть[D0, D1, ... DN, ?], а значения внутриlabel_vocabularyили многомерный тензор формы[D0, D1, ... DN, n_classes].
Если weight_column указано, веса должны иметь размер [D0, D1, ... DN], или [D0, D1, ... DN, 1].
Также поддерживает пользовательские loss_fn. loss_fn принимает (labels, logits) или (labels, logits, features) в качестве аргументов и возвращает нередуцированные потери с размером [D0, D1, ... DN, 1]. loss_fn должен поддерживать индикатор labels с размером [D0, D1, ... DN, n_classes]. Иными словами, заголовок применяет label_vocabulary к входным меткам перед передачей их в loss_fn.
Использование:
n_classes = 2
head = tf.estimator.MultiLabelHead(n_classes)
logits = np.array([[-1., 1.], [-1.5, 1.5]], dtype=np.float32)
labels = np.array([[1, 0], [1, 1]], dtype=np.int64)
features = {'x': np.array([[41], [42]], dtype=np.int32)}
# expected_loss = sum(_sigmoid_cross_entropy(labels, logits)) / batch_size
# = sum(1.31326169, 0.9514133) / 2 = 1.13
loss = head.loss(labels, logits, features=features)
print('{:.2f}'.format(loss.numpy()))
1.13
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()))
auc : 0.33
auc_precision_recall : 0.77
average_loss : 1.13
preds = head.predictions(logits)
print(preds['logits'])
tf.Tensor(
[[-1. 1. ]
[-1.5 1.5]], shape=(2, 2), dtype=float32)
Использование с готовым оценщиком:
my_head = tf.estimator.MultiLabelHead(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.MultiLabelHead(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 | Количество классов, должно быть больше 1 (для 1 класса используйте BinaryClassHead). |
weight_column | Строка или NumericColumn, созданная с помощью tf.feature_column.numeric_column, определяющая столбец признаков, представляющий веса. Он используется для понижения или повышения примера в процессе обучения. Он будет умножен на потерю примера. Взвешивание по классам не поддерживается. |
thresholds | Последовательность чисел с плавающей точкой в диапазоне (0, 1). Метрики точности, полноты и точности вычисляются для каждого значения порога. Порог применяется к предсказанным вероятностям, т.е. выше порога — true, ниже — false. |
label_vocabulary | Список строк, представляющих возможные значения меток. Если он не задан, это означает, что метки уже закодированы как целые числа в пределах [0, n_classes) или многомерный тензор. Если задан, метки должны быть SparseTensor типа string и иметь любое значение в label_vocabulary. Также возникнут ошибки, если словарь не задан, а метки — строковые. |
loss_reduction | Один из tf.losses.Reduction, за исключением NONE. Определяет, как редуцировать потери обучения по пакету. По умолчанию SUM_OVER_BATCH_SIZE, а именно, взвешенная сумма потерь, делённая на размер пакета. |
loss_fn | Необязательная функция потерь. |
classes_for_class_based_metrics | Список целочисленных идентификаторов классов или строковых имён классов, для которых вычисляются метрики по классам. Если целые числа, все должны быть в диапазоне [0, n_classes - 1]. Если строки, все должны быть в label_vocabulary. |
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_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 и возвращает операцию для оптимизации модели с потерями в режиме ОБУЧЕНИЯ. Используется, если optimizer None. В режиме ОБУЧЕНИЯ точно один из 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.LOGITS или 'logits'. |
| Возвращает | |
|---|---|
| Словарь предсказаний. |
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/MultiLabelHead