![]() |
This section provides a general, high-level description of the model.
Inherits From: BaseModelCardField
model_card_toolkit.ModelDetails(
name: Optional[str] = None,
overview: Optional[str] = None,
documentation: Optional[str] = None,
owners: List[model_card_toolkit.Owner
] = dataclasses.field(default_factory=list),
version: Optional[model_card_toolkit.Version
] = dataclasses.field(default_factory=Version),
licenses: List[model_card_toolkit.License
] = dataclasses.field(default_factory=list),
references: List[model_card_toolkit.Reference
] = dataclasses.field(default_factory=list),
citations: List[model_card_toolkit.Citation
] = dataclasses.field(default_factory=list),
path: Optional[str] = None,
_proto_type: dataclasses.InitVar[type(model_card_pb2.ModelDetails)] = model_card_pb2.ModelDetails
)
Attributes | |
---|---|
name
|
The name of the model. |
overview
|
A description of the model card. |
documentation
|
A more thorough description of the model and its usage. |
owners
|
The individuals or teams who own the model. |
version
|
The version of the model. |
licenses
|
The license information for the model. If the model is licensed for use by others, include the license type. If the model is not licensed for future use, you may state that here as well. |
references
|
Provide any additional links the reader may need. You can link to foundational research, technical documentation, or other materials that may be useful to your audience. |
citations
|
How should the model be cited? If the model is based on published academic research, cite the research. |
path
|
The path where the model is stored. |
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 | |
---|---|
documentation |
None
|
name |
None
|
overview |
None
|
path |
None
|