model_card_toolkit.ModelParameters

View source on GitHub

Parameters for construction of the model.

Inherits From: BaseModelCardField

model_card_toolkit.ModelParameters(
    model_architecture: Optional[str] = None,
    data: List[model_card_toolkit.Dataset] = dataclasses.field(default_factory=list),
    input_format: Optional[str] = None,
    input_format_map: List[model_card_toolkit.KeyVal] = dataclasses.field(default_factory=list),
    output_format: Optional[str] = None,
    output_format_map: List[model_card_toolkit.KeyVal] = dataclasses.field(default_factory=list),
    _proto_type: dataclasses.InitVar[type(model_card_pb2.ModelParameters)] = model_card_pb2.ModelParameters
)

Attributes
model_architecture	specifies the architecture of your model.
data	specifies the datasets used to train and evaluate your model.
input_format	describes the data format for inputs to your model.
input_format_map	describes the data format for inputs to your model, in key-value format.
output_format	describes the data format for outputs from your model.
output_format_map	describes the data format for outputs to your model, in key-value format

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
)

Class Variables
input_format	None
model_architecture	None
output_format	None