model_card_toolkit.PerformanceMetric

The details of the performance metric.

Inherits From: BaseModelCardField

model_card_toolkit.PerformanceMetric(
    type: Optional[str] = None,
    value: Optional[str] = None,
    slice: Optional[str] = None,
    confidence_interval: model_card_toolkit.ConfidenceInterval = dataclasses.field(default_factory=ConfidenceInterval),
    _proto_type: dataclasses.InitVar[BaseModelCardField._get_type(model_card_pb2.
        PerformanceMetric)] = model_card_pb2.PerformanceMetric
)

type What performance metric are you reporting on?
value What is the value of this performance metric?
slice What slice of your data was this metric computed on?
confidence_interval The confidence interval of the metric.

Methods

clear

View source

clear()

Clear the subfields of this BaseModelCardField.

copy_from_proto

View source

copy_from_proto(
    proto: message.Message
) -> 'BaseModelCardField'

Copies the contents of the model card proto into current object.

merge_from_proto

View source

merge_from_proto(
    proto: message.Message
) -> 'BaseModelCardField'

Merges the contents of the model card proto into current object.

to_dict

View source

to_dict() -> Dict[str, Any]

Convert your model card to a python dictionary.

to_json

View source

to_json() -> str

Convert this class object to json.

to_proto

View source

to_proto() -> message.Message

Convert this class object to the proto.

__eq__

__eq__(
    other
)

__len__

View source

__len__() -> int

Returns the number of items in a field. Ignores None values recursively, so the length of a field that only contains another field that has all None values would be 0.

slice None
type None
value None