Skip to content

ModelPackageModelCard

Source code in docs_src/capo_sagemaker/types/model_package_model_card.py
class ModelPackageModelCard(TypedDict, closed=True):
    model_card_content: NotRequired[
        "capo_sagemaker.types.model_card_content.ModelCardContent"
    ]
    """<p>The content of the model card. The content must follow the schema described in <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema">Model Package Model Card Schema</a>.</p>"""
    model_card_status: NotRequired[
        "capo_sagemaker.types.model_card_status.ModelCardStatus"
    ]
    """<p>The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.</p> <ul> <li> <p> <code>Draft</code>: The model card is a work in progress.</p> </li> <li> <p> <code>PendingReview</code>: The model card is pending review.</p> </li> <li> <p> <code>Approved</code>: The model card is approved.</p> </li> <li> <p> <code>Archived</code>: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message <code>Model Card is in Archived state</code>.</p> </li> </ul>"""

model_card_content instance-attribute

model_card_content: NotRequired[ModelCardContent]

The content of the model card. The content must follow the schema described in Model Package Model Card Schema.

model_card_status instance-attribute

model_card_status: NotRequired[ModelCardStatus]

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

  • Draft: The model card is a work in progress.

  • PendingReview: The model card is pending review.

  • Approved: The model card is approved.

  • Archived: The model card is archived. No more updates can be made to the model card content. If you try to update the model card content, you will receive the message Model Card is in Archived state.