R/classif_acc.R

In mlr3measures: Performance Measures for 'mlr3'

#' @title Classification Accuracy
#'
#' @details
#' The Classification Accuracy is defined as
#'  \deqn{
#'   \frac{1}{n} \sum_{i=1}^n w_i \mathbf{1} \left( t_i = r_i \right),
#' }{1 / n * sum(wi * 1(ti = ri))}
#' where \eqn{w_i} are normalized weights for all observations \eqn{x_i}.
#'
#' @templateVar mid acc
#' @template classif_template
#'
#' @inheritParams classif_params
#' @template classif_example
#' @export
acc = function(truth, response, sample_weights = NULL, ...) {
  assert_classif(truth, response = response)
  wmean(truth == response, sample_weights)
}

acc_cm = function(m, na_value = NaN) {
  sum(diag(m)) / sum(m)
}

#' @include measures.R
add_measure(acc, "Classification Accuracy", "classif", 0, 1, FALSE, obs_loss = "one_zero")