MetricResult#

from tmlt.tune import MetricResult
class tmlt.tune.MetricResult(name, description, baseline, output, value, grouping_columns, measure_column)#

Bases: object

The output of a Metric with additional metadata.

name: str#

The name of the metric.

description: str#

The description of the metric.

baseline: Union[str, List[str]]#

The name of the baseline program(s) used to calculate this metric.

output: Union[str, List[str]]#

The name of the program output(s) used to calculate this metric.

value: Any#

The value of the metric applied to the program outputs.

grouping_columns: List[str]#

Grouping columns of the metric.

measure_column: Optional[str]#

Measure column of the metric.

format_as_summary_row()#

Returns a table row summarizing the metric result.

Return type:

DataFrame

format_as_dataframe()#

Returns the results of this metric formatted as a DataFrame.

Return type:

DataFrame

result_column_name()#

Returns the name of the column containing the metric results.

Only relevant if value is a DataFrame.

Return type:

str