requires_y_true#

requires_y_true()[source]#

Behaviour flag: metric requires y_true in evaluate.

If y_true is not required, the metric is an unsupervised metric.

String name: "requires_y_true"
Public behaviour flag
Values: boolean, True / False
Example: True
Default: True

This tag applies to metrics.

If the tag is True, the metric requires the true target data argument y_true to be passed in the evaluate and evaluate_by_index methods. If the tag is False, the metric does not require the true target data argument y_true to be passed in the evaluate and evaluate_by_index methods.