tfma.metrics.PlotKey

A PlotKey is a metric key that uniquely identifies a plot.

Inherits From: MetricKey

tfma.metrics.PlotKey(
    name: str,
    model_name: str = '',
    output_name: str = '',
    sub_key: Optional[tfma.metrics.SubKey] = None,
    aggregation_type: Optional[AggregationType] = None,
    example_weighted: Optional[bool] = False,
    is_diff: Optional[bool] = False
)

Attributes
name	A namedtuple alias for field number 0
model_name	A namedtuple alias for field number 1
output_name	A namedtuple alias for field number 2
sub_key	A namedtuple alias for field number 3
aggregation_type	A namedtuple alias for field number 4
example_weighted	A namedtuple alias for field number 5
is_diff	A namedtuple alias for field number 6

Methods

from_proto

View source

@staticmethod
from_proto(
    pb: metrics_for_slice_pb2.PlotKey
) -> 'PlotKey'

Configures class from proto.

make_baseline_key

View source

make_baseline_key(
    model_name: str
) -> 'MetricKey'

make_diff_key

View source

make_diff_key() -> 'MetricKey'

to_proto

View source

to_proto() -> metrics_for_slice_pb2.PlotKey

Converts key to proto.