MLMetric: MLMetric Class Constructor

Description Usage Arguments Value See Also Examples

View source: R/MLMetric.R

Description

Create a performance metric for use with the MachineShop package.

Usage

1
2
3
MLMetric(object, name = "MLMetric", label = name, maximize = TRUE)

MLMetric(object) <- value

Arguments

object

function to compute the metric, defined to accept observed and predicted as the first two arguments and with an ellipsis (...) to accommodate others.

name

character name of the object to which the metric is assigned.

label

optional character descriptor for the model.

maximize

logical indicating whether higher values of the metric correspond to better predictive performance.

value

list of arguments to pass to the MLMetric constructor.

Value

MLMetric class object.

See Also

metrics

Examples

1
2
3
4
5
6
7
f2_score <- function(observed, predicted, ...) {
  f_score(observed, predicted, beta = 2, ...)
}

MLMetric(f2_score) <- list(name = "f2_score",
                           label = "F Score (beta = 2)",
                           maximize = TRUE)

MachineShop documentation built on Aug. 20, 2021, 1:10 a.m.