get_run_metrics: Get the metrics logged to a run

Description Usage Arguments Value Examples

View source: R/run.R

Description

Retrieve the metrics logged to a run that were logged with the log_*() methods.

Usage

1
2
3
4
5
6
7
get_run_metrics(
  run,
  name = NULL,
  recursive = FALSE,
  run_type = NULL,
  populate = FALSE
)

Arguments

run

The Run object.

name

The name of the metric.

recursive

If specified, returns runs matching specified "property" or "property": "value".

run_type

run type

populate

Boolean indicating whether to fetch the contents of external data linked to the metric.

Value

A named list of the metrics associated with the run, e.g. list("metric_name" = metric).

Examples

1
2
3
4
ws <- load_workspace_from_config()
exp <- experiment(ws, name = 'myexperiment')
run <- get_run(exp, run_id = "myrunid")
metrics <- get_run_metrics(run)

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