![]() |
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
)
Attributes | |
---|---|
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
clear()
Clear the subfields of this BaseModelCardField.
copy_from_proto
copy_from_proto(
proto: message.Message
) -> 'BaseModelCardField'
Copies the contents of the model card proto into current object.
merge_from_proto
merge_from_proto(
proto: message.Message
) -> 'BaseModelCardField'
Merges the contents of the model card proto into current object.
to_dict
to_dict() -> Dict[str, Any]
Convert your model card to a python dictionary.
to_json
to_json() -> str
Convert this class object to json.
to_proto
to_proto() -> message.Message
Convert this class object to the proto.
__eq__
__eq__(
other
)
Class Variables | |
---|---|
slice |
None
|
type |
None
|
value |
None
|