model_card_toolkit.Version

The information about verions of a model.

Inherits From: BaseModelCardField

model_card_toolkit.Version(
    name: Optional[str] = None,
    date: Optional[str] = None,
    diff: Optional[str] = None,
    _proto_type: dataclasses.InitVar[type(model_card_pb2.Version)] = model_card_pb2.Version
)

If there are multiple versions of the model, or there may be in the future, it’s useful for your audience to know which version of the model is discussed in the Model Card. If there are previous versions of this model, briefly describe how this version is different. If no more than one version of the model will be released, this field may be omitted.

Attributes
name	The name of the version.
date	The date this version was released.
diff	The changes from the previous version.

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.

Class Variables
date	None
diff	None
name	None