run_log_metric: run_log_metric

In botchkoAI/vertaReticulateClient: Reticulated-based client to the Verta AI Platform

Description

Logs a metric to this Experiment Run.

Usage

run_log_metric(run, key, value, overwrite = FALSE)

Arguments

key	key
value	value
overwrite	overwrite

Details

If the metadatum of interest might recur, :meth:'.log_observation' should be used instead. Parameters ———- key : str Name of the metric. value : one of NULL, bool, float, int, str Value of the metric. overwrite : bool, default FALSE Whether to allow overwriting an existing metric with key 'key'.

key

str: Name of the metric. value : one of NULL, bool, float, int, str Value of the metric. overwrite : bool, default FALSE Whether to allow overwriting an existing metric with key 'key'.

value

one of None, bool, float, int, str: Value of the metric. overwrite : bool, default FALSE Whether to allow overwriting an existing metric with key 'key'.

overwrite

bool, default False: Whether to allow overwriting an existing metric with key 'key'.

botchkoAI/vertaReticulateClient documentation built on Dec. 19, 2021, 10:50 a.m.