Multi-label classification handles the case where each example may have zero
or more associated labels, from a discrete set. This is distinct from
multi_class_head which has exactly one label from a discrete set.
This head by default uses sigmoid cross entropy loss, which expects as input
a multi-hot tensor of shape (batch_size, num_classes).
Args
n_classes
Integer, number of classes, must be >= 2
label_name
String, name of the key in label dict. Can be null if label
is a tensor (single headed models).
weight_column_name
A string defining feature column name representing
weights. It is used to down weight or boost examples during training. It
will be multiplied by the loss of the example.
enable_centered_bias
A bool. If True, estimator will learn a centered
bias variable for each class. Rest of the model structure learns the
residual after centered bias.
head_name
name of the head. If provided, predictions, summary and metrics
keys will be suffixed by "/" + head_name and the default variable scope
will be head_name.
thresholds
thresholds for eval metrics, defaults to [.5]
metric_class_ids
List of class IDs for which we should report per-class
metrics. Must all be in the range [0, n_classes).
loss_fn
Optional function that takes (labels, logits, weights) as
parameter and returns a weighted scalar loss. weights should be
optional. See tf.losses
Returns
An instance of Head for multi label classification.
[null,null,["Last updated 2020-10-01 UTC."],[],[],null,["# tf.contrib.learn.multi_label_head\n\n\u003cbr /\u003e\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/contrib/learn/python/learn/estimators/head.py#L387-L445) |\n\nCreates a Head for multi label classification. (deprecated) \n\n tf.contrib.learn.multi_label_head(\n n_classes, label_name=None, weight_column_name=None, enable_centered_bias=False,\n head_name=None, thresholds=None, metric_class_ids=None, loss_fn=None\n )\n\n| **Warning:** THIS FUNCTION IS DEPRECATED. It will be removed in a future version. Instructions for updating: Please switch to tf.contrib.estimator.\\*_head.\n\nMulti-label classification handles the case where each example may have zero\nor more associated labels, from a discrete set. This is distinct from\n`multi_class_head` which has exactly one label from a discrete set.\n\nThis head by default uses sigmoid cross entropy loss, which expects as input\na multi-hot tensor of shape `(batch_size, num_classes)`.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `n_classes` | Integer, number of classes, must be \\\u003e= 2 |\n| `label_name` | String, name of the key in label dict. Can be null if label is a tensor (single headed models). |\n| `weight_column_name` | A string defining feature column name representing weights. It is used to down weight or boost examples during training. It will be multiplied by the loss of the example. |\n| `enable_centered_bias` | A bool. If True, estimator will learn a centered bias variable for each class. Rest of the model structure learns the residual after centered bias. |\n| `head_name` | name of the head. If provided, predictions, summary and metrics keys will be suffixed by `\"/\" + head_name` and the default variable scope will be `head_name`. |\n| `thresholds` | thresholds for eval metrics, defaults to \\[.5\\] |\n| `metric_class_ids` | List of class IDs for which we should report per-class metrics. Must all be in the range `[0, n_classes)`. |\n| `loss_fn` | Optional function that takes (`labels`, `logits`, `weights`) as parameter and returns a weighted scalar loss. `weights` should be optional. See [`tf.losses`](../../../tf/losses) |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| An instance of `Head` for multi label classification. ||\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Raises ------ ||\n|--------------|----------------------------------------------|\n| `ValueError` | If n_classes is \\\u003c 2 |\n| `ValueError` | If loss_fn does not have expected signature. |\n\n\u003cbr /\u003e"]]