tfm.uplift.metrics.label_variance.LabelVariance

Computes the overall and treatment sliced label variance.

tfm.uplift.metrics.label_variance.LabelVariance(
    name: str = 'label/variance', **kwargs
)

Note that the prediction tensor is expected to be of type TwoTowerTrainingOutputs.

Example standalone usage:

label_variance = LabelVariance()
y_true = tf.constant([1, 2, 3, 10])
y_pred = types.TwoTowerTrainingOutputs(
    control_logits=tf.zeros(4),
    treatment_logits=tf.zeros(4),
    true_logits=tf.zeros(4),
    is_treatment=tf.constant([True, False, True, False]),
)
label_variance(y_true=y_true, y_pred=y_pred)
{
    "label/variance": 12.5
    "label/variance/control": 16.0
    "label/variance/treatment": 1.0
}

Example usage with the model.compile() API:

model.compile(
    optimizer="sgd",
    loss=TrueLogitsLoss(tf_keras.losses.mean_squared_error),
    metrics=[LabelVariance()]
)

name name for the overall label variance metric result. The control and treatment label variances will have "/control" and "/treatment" appended to the result name.
**kwargs other base metric keyword arguments.

Methods

call

call(
    inputs, *args, **kwargs
)

This is where the layer's logic lives.

The call() method may not create state (except in its first invocation, wrapping the creation of variables or other resources in tf.init_scope()). It is recommended to create state, including tf.Variable instances and nested Layer instances, in __init__(), or in the build() method that is called automatically before call() executes for the first time.

Args
inputs Input tensor, or dict/list/tuple of input tensors. The first positional inputs argument is subject to special rules:

  • inputs must be explicitly passed. A layer cannot have zero arguments, and inputs cannot be provided via the default value of a keyword argument.
  • NumPy array or Python scalar values in inputs get cast as tensors.
  • TF-Keras mask metadata is only collected from inputs.
  • Layers are built (build(input_shape) method) using shape info from inputs only.
  • input_spec compatibility is only checked against inputs.
  • Mixed precision input casting is only applied to inputs. If a layer has tensor arguments in *args or **kwargs, their casting behavior in mixed precision should be handled manually.
  • The SavedModel input specification is generated using inputs only.
  • Integration with various ecosystem packages like TFMOT, TFLite, TF.js, etc is only supported for inputs and not for tensors in positional and keyword arguments.
*args Additional positional arguments. May contain tensors, although this is not recommended, for the reasons above.
**kwargs Additional keyword arguments. May contain tensors, although this is not recommended, for the reasons above. The following optional keyword arguments are reserved:
  • training: Boolean scalar tensor of Python boolean indicating whether the call is meant for training or inference.
  • mask: Boolean input mask. If the layer's call() method takes a mask argument, its default value will be set to the mask generated for inputs by the previous layer (if input did come from a layer that generated a corresponding mask, i.e. if it came from a TF-Keras layer with masking support).

    • Returns
    A tensor or list/tuple of tensors.

    merge_state

    merge_state(
    metrics
)

    Merges the state from one or more metrics.

    This method can be used by distributed systems to merge the state computed by different metric instances. Typically the state will be stored in the form of the metric's weights. For example, a tf.keras.metrics.Mean metric contains a list of two weight values: a total and a count. If there were two instances of a tf.keras.metrics.Accuracy that each independently aggregated partial state for an overall accuracy calculation, these two metric's states could be combined as follows:

    m1 = tf.keras.metrics.Accuracy()
_ = m1.update_state([[1], [2]], [[0], [2]])
     
    m2 = tf.keras.metrics.Accuracy()
_ = m2.update_state([[3], [4]], [[3], [4]])
     
    m2.merge_state([m1])
m2.result().numpy()
0.75

    Args
    metrics an iterable of metrics. The metrics must have compatible state.

    Raises
    ValueError If the provided iterable does not contain metrics matching the metric's required specifications.

    reset_state

    reset_state()

    Resets all of the metric state variables.

    This function is called between epochs/steps, when a metric is evaluated during training.

    result

    View source

    result() -> dict[str, tf.Tensor]

    Computes and returns the scalar metric value tensor or a dict of scalars.

    Result computation is an idempotent operation that simply calculates the metric value using the state variables.

    Returns
    A scalar tensor, or a dictionary of scalar tensors.

    update_state

    View source

    update_state(
    y_true: tf.Tensor,
    y_pred: tfm.uplift.types.TwoTowerTrainingOutputs,
    sample_weight: (tf.Tensor | None) = None
)

    Updates the overall, control and treatment label variances.

    Args
    y_true tensor labels.
    y_pred two tower training outputs. The treatment indicator tensor is used to slice the labels into control and treatment groups.
    sample_weight optional sample weight to compute weighted label variances. If given, the sample weight will also be sliced by the treatment indicator tensor to compute the weighted control and treatment label variances.

    Raises
    TypeError if y_pred is not of type TwoTowerTrainingOutputs.