MetricFormatter

class tfsnippet.MetricFormatter

Bases: object

Base class for a training metrics formatter.

A training metric formatter determines the order of metrics, and the way to display the values of these metrics, in MetricLogger.

Methods Summary

format_metric(name, value) Format the value of specified metric.
sort_metrics(names) Sort the names of metrics.

Methods Documentation

format_metric(name, value)

Format the value of specified metric.

Parameters:
  • name – Name of the metric.
  • value – Value of the metric.
Returns:

Human readable string representation of the metric value.

Return type:

str

sort_metrics(names)

Sort the names of metrics.

Parameters:names – Iterable metric names.
Returns:Sorted metric names.
Return type:list[str]