log_row_to_run: Log a row metric to a run

Description Usage Arguments Value Examples

View source: R/run.R

Description

Using log_row_to_run() creates a metric with multiple columns as described in .... Each named parameter generates a column with the value specified. log_row_to_run() can be called once to log an arbitrary tuple, or multiple times in a loop to generate a complete table.

Usage

1
log_row_to_run(name, description = "", run = NULL, ...)

Arguments

name

A string of the name of metric.

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.

...

Each named parameter generates a column with the value specified.

Value

None

Examples

Log an arbitrary tuple:

1
log_row_to_run("Y over X", x = 1, y = 0.4)

Log the complete table:

1
2
3
4
5
citrus <- c("orange", "lemon", "lime")
sizes <- c(10, 7, 3)
for (i in seq_along(citrus)) {
    log_row_to_run("citrus", fruit = citrus[i], size = sizes[i])
}

azuremlsdk documentation built on Oct. 23, 2020, 8:22 p.m.