requires_y_pred_benchmark#

requires_y_pred_benchmark()[source]#

Behaviour flag: metric requires y_pred in evaluate.

  • String name: "requires-y-pred-benchmark"

  • Public behaviour flag

  • Values: boolean, True / False

  • Example: True

  • Default: True

  • Alias: "requires_y_pred_benchmark"

This tag applies to metrics.

If the tag is True, the metric requires the benchmark prediction argument y_pred_benchmark to be passed in the evaluate and evaluate_by_index methods. If the tag is False, the metric does not require the benchmark prediction argument y_pred_benchmark to be passed in the evaluate and evaluate_by_index methods.