tf.estimator.MultiClassHead
| Просмотреть исходный код на GitHub |
Создаёт 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.
Заголовок может быть использован с готовым оценщиком. Пример:
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 для возврата 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_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 для получения подробной информации.
© 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/MultiClassHead