Use a run
The Run object provides methods to inspect and control an execution.
Persist and refresh
export
Control execution
wait
Inspect logs and metrics
logs
log_metric
Log metric into entity status. A metric is named by a key and value (single number or list of numbers). The metric by default is put in a list or appended to an existing list. If single_value is True, the value will be a single number.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
key
|
str
|
Key of the metric. |
required |
value
|
MetricType
|
Value of the metric. |
required |
overwrite
|
bool
|
If True, overwrite existing metric. |
False
|
single_value
|
bool
|
If True, value is a single value. |
False
|
Examples:
Log a new value in a list
Append a new value in a list
Log a list of values and append them to existing metric:
Log a single value (not represented as list):
Log a list of values and overwrite existing metric:
log_metrics
Log metrics into entity status. If a metric is a list, it will be logged as a list. Otherwise, it will be logged as a single value.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
metrics
|
dict[str, MetricType]
|
Dict of metrics to log. |
required |
overwrite
|
bool
|
If True, overwrite existing metrics. |
False
|
Examples:
Log multiple metrics at once
Log metrics with lists and single values
Append to existing metrics (default behavior)
>>> entity.log_metrics(
... {
... "loss": 0.001,
... "accuracy": 0.96,
... }
... ) # Appends to existing
Overwrite existing metrics
>>> entity.log_metrics(
... {
... "loss": 0.0005,
... "accuracy": 0.98,
... },
... overwrite=True,
... )
See Also
log_metric
Kind-specific methods
Run kinds are provided by runtimes. See the runtime documentation for the corresponding runtime behavior.