tf.losses.sigmoid_cross_entropy
Stay organized with collections
Save and categorize content based on your preferences.
Creates a cross-entropy loss using tf.nn.sigmoid_cross_entropy_with_logits.
tf.losses.sigmoid_cross_entropy(
multi_class_labels, logits, weights=1.0, label_smoothing=0, scope=None,
loss_collection=tf.GraphKeys.LOSSES, reduction=Reduction.SUM_BY_NONZERO_WEIGHTS
)
weights
acts as a coefficient for the loss. If a scalar is provided,
then the loss is simply scaled by the given value. If weights
is a
tensor of shape [batch_size]
, then the loss weights apply to each
corresponding sample.
If label_smoothing
is nonzero, smooth the labels towards 1/2:
new_multiclass_labels = multiclass_labels * (1 - label_smoothing)
+ 0.5 * label_smoothing
Args |
multi_class_labels
|
[batch_size, num_classes] target integer labels in
{0, 1} .
|
logits
|
Float [batch_size, num_classes] logits outputs of the network.
|
weights
|
Optional Tensor whose rank is either 0, or the same rank as
labels , and must be broadcastable to labels (i.e., all dimensions must
be either 1 , or the same as the corresponding losses dimension).
|
label_smoothing
|
If greater than 0 then smooth the labels.
|
scope
|
The scope for the operations performed in computing the loss.
|
loss_collection
|
collection to which the loss will be added.
|
reduction
|
Type of reduction to apply to loss.
|
Returns |
Weighted loss Tensor of the same type as logits . If reduction is
NONE , this has the same shape as logits ; otherwise, it is scalar.
|
Raises |
ValueError
|
If the shape of logits doesn't match that of
multi_class_labels or if the shape of weights is invalid, or if
weights is None. Also if multi_class_labels or logits is None.
|
Eager Compatibility
The loss_collection
argument is ignored when executing eagerly. Consider
holding on to the return value or collecting losses via a tf.keras.Model
.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-01 UTC.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.losses.sigmoid_cross_entropy\n\n\u003cbr /\u003e\n\n|--------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/ops/losses/losses_impl.py#L649-L710) |\n\nCreates a cross-entropy loss using tf.nn.sigmoid_cross_entropy_with_logits.\n\n#### View aliases\n\n\n**Compat aliases for migration**\n\nSee\n[Migration guide](https://www.tensorflow.org/guide/migrate) for\nmore details.\n\n[`tf.compat.v1.losses.sigmoid_cross_entropy`](/api_docs/python/tf/compat/v1/losses/sigmoid_cross_entropy)\n\n\u003cbr /\u003e\n\n tf.losses.sigmoid_cross_entropy(\n multi_class_labels, logits, weights=1.0, label_smoothing=0, scope=None,\n loss_collection=tf.GraphKeys.LOSSES, reduction=Reduction.SUM_BY_NONZERO_WEIGHTS\n )\n\n`weights` acts as a coefficient for the loss. If a scalar is provided,\nthen the loss is simply scaled by the given value. If `weights` is a\ntensor of shape `[batch_size]`, then the loss weights apply to each\ncorresponding sample.\n\nIf `label_smoothing` is nonzero, smooth the labels towards 1/2: \n\n new_multiclass_labels = multiclass_labels * (1 - label_smoothing)\n\n + 0.5 * label_smoothing\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `multi_class_labels` | `[batch_size, num_classes]` target integer labels in `{0, 1}`. |\n| `logits` | Float `[batch_size, num_classes]` logits outputs of the network. |\n| `weights` | Optional `Tensor` whose rank is either 0, or the same rank as `labels`, and must be broadcastable to `labels` (i.e., all dimensions must be either `1`, or the same as the corresponding `losses` dimension). |\n| `label_smoothing` | If greater than `0` then smooth the labels. |\n| `scope` | The scope for the operations performed in computing the loss. |\n| `loss_collection` | collection to which the loss will be added. |\n| `reduction` | Type of reduction to apply to loss. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| Weighted loss `Tensor` of the same type as `logits`. If `reduction` is `NONE`, this has the same shape as `logits`; otherwise, it is scalar. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ValueError` | If the shape of `logits` doesn't match that of `multi_class_labels` or if the shape of `weights` is invalid, or if `weights` is None. Also if `multi_class_labels` or `logits` is None. |\n\n\u003cbr /\u003e\n\n#### Eager Compatibility\n\nThe `loss_collection` argument is ignored when executing eagerly. Consider\nholding on to the return value or collecting losses via a [`tf.keras.Model`](../../tf/keras/Model)."]]