kf_add_metric: Add metric to pipeline metrics set

In ndiquattro/kflow: Functions for Interacting with Kubeflow from R

Description

Adds on to an existing metric set and checks values are formatted correctly.

Usage

kf_add_metric(metric_set, name, value, format)

Arguments

metric_set	Metric set from kf_init_metrics() or a previious call of this function.
name	Name of metric.
value	Value of metric. Must be numeric.
format	Format to display metric in Kubeflow. Must be either RAW or PERCENTAGE.

Details

You can repeatedly chain this function to iteratively build up a pipeline metrics output.

Value

Metric set

Examples

# Create ROC AUC and PR AUC output
kf_init_metrics() %>%
  kf_add_metric("roc-auc", .75, "RAW") %>%
  kf_add_metric("pr-auc", .45, "RAW")

ndiquattro/kflow documentation built on Jan. 27, 2020, 4:19 p.m.