View source on GitHub |
Information about risks involved when using the model.
Inherits From: BaseModelCardField
model_card_toolkit.Risk(
name: Optional[str] = None,
mitigation_strategy: Optional[str] = None,
_proto_type: dataclasses.InitVar[type(model_card_pb2.Risk)] = model_card_pb2.Risk
)
Attributes | |
---|---|
name
|
The name of the risk. |
mitigation_strategy
|
A mitigation strategy that you've implemented, or one that you suggest to users. |
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
)
__len__
__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.
Class Variables | |
---|---|
mitigation_strategy |
None
|
name |
None
|