model_card_toolkit.Dataset

View source on GitHub

Provide some information about a dataset used to generate a model.

Inherits From: BaseModelCardField

model_card_toolkit.Dataset(
    name: Optional[str] = None,
    description: Optional[str] = None,
    link: Optional[str] = None,
    sensitive: Optional[model_card_toolkit.SensitiveData] = dataclasses.field(default_factory=SensitiveData),
    graphics: model_card_toolkit.GraphicsCollection = dataclasses.field(default_factory=GraphicsCollection),
    _proto_type: dataclasses.InitVar[type(model_card_pb2.Dataset)] = model_card_pb2.Dataset
)

Attributes
name	The name of the dataset.
description	The description of dataset.
link	A link to the dataset.
sensitive	Does this dataset contain human or other sensitive data?
graphics	Visualizations of the dataset.

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
description	None
link	None
name	None