mlflow_log_metric: Log Metric

View source: R/tracking-runs.R

mlflow_log_metricR Documentation

Log Metric

Description

Logs a metric for a run. Metrics key-value pair that records a single float measure. During a single execution of a run, a particular metric can be logged several times. The MLflow Backend keeps track of historical metric values along two axes: timestamp and step.

Usage

mlflow_log_metric(
  key,
  value,
  timestamp = NULL,
  step = NULL,
  run_id = NULL,
  client = NULL
)

Arguments

key

Name of the metric.

value

Float value for the metric being logged.

timestamp

Timestamp at which to log the metric. Timestamp is rounded to the nearest integer. If unspecified, the number of milliseconds since the Unix epoch is used.

step

Step at which to log the metric. Step is rounded to the nearest integer. If unspecified, the default value of zero is used.

run_id

Run ID.

client

(Optional) An MLflow client object returned from mlflow_client. If specified, MLflow will use the tracking server associated with the passed-in client. If unspecified (the common case), MLflow will use the tracking server associated with the current tracking URI.


mlflow documentation built on Nov. 1, 2024, 1:07 a.m.