tf.estimator.BinaryClassHead

Создаёт Head для бинарной классификации с одним меткой.

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

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

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

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

tf.compat.v1.estimator.BinaryClassHead, `tf.compat.v2.estimator.BinaryClassHead`

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

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

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

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

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

Аргументы
`weight_column`	Строка или `NumericColumn`, созданная с помощью `tf.feature_column.numeric_column`, определяющая столбец признаков, представляющий веса. Используется для уменьшения или увеличения важности примеров во время обучения. Он будет умножен на потерю примера.
`thresholds`	Последовательность чисел с плавающей точкой в диапазоне `(0, 1)`. Для метрик бинарной классификации, таких как точность и полнота, генерируется метрика оценки для каждого значения порога. Этот порог применяется к значениям логарифма, чтобы определить бинарную классификацию (т.е., выше порога — `true`, ниже — `false`).
`label_vocabulary`	Список или кортеж строк, представляющих возможные значения меток. Если он не задан, это означает, что метки уже закодированы в [0, 1]. Если задан, метки должны быть строкового типа и иметь любое значение в `label_vocabulary`. Обратите внимание, что ошибки будут подняты, если `label_vocabulary` не предоставлен, но метки являются строками.
`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 ровно один из `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.CLASSES или 'classes'. Если не указано, возвращаются предсказания для всех допустимых ключей.

Аргументы
`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/BinaryClassHead