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.
Этот заголовок может быть использован с готовым оценщиком. Пример:
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. То есть, устанавливает 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.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/r1.15/api_docs/python/tf/estimator/MultiLabelHead