list_metrics {vip}

List metrics

Description

List all available performance metrics.

Usage

list_metrics()

Value

A data frame with the following columns:

• metric - the optimization or tuning metric;

• description - a brief description about the metric;

• task - whether the metric is suitable for regression or classification;

• smaller_is_better - logical indicating whether or not a smaller value of the metric is considered better.

• yardstick_function - the name of the corresponding function from the yardstick package.

Examples

(metrics <- list_metrics())
metrics[metrics$task == "Multiclass classification", ]