Log a residuals metric to a run

Source: R/run.R

log_residuals_to_run() logs the data needed to display a histogram of residuals for a regression task. The residuals are predicted - actual.

There should be one more edge than the number of counts.

log_residuals_to_run(name, value, description = "", run = NULL)

Arguments

name

A string of the name of the metric.
value

A named list containing name, version, and data properties.
description

(Optional) A string of the metric description.
run

The Run object. If not specified, will default to the current run from the service context.

Value

None

Examples

data <- list("bin_edges" = c(50, 100, 200, 300, 350),
             "bin_counts" = c(0.88, 20, 30, 50.99))
residuals <- list("schema_type" = "residuals",
                    "schema_version" = "v1",
                    "data" = data)
log_predictions_to_run("myresiduals", predictions)