Class: Aws::SageMaker::Types::ModelPackageModelCard

Inherits:

Struct

Object
Struct
Aws::SageMaker::Types::ModelPackageModelCard

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-sagemaker/types.rb

Overview

The model card associated with the model package. Since ‘ModelPackageModelCard` is tied to a model package, it is a specific usage of a model card and its schema is simplified compared to the schema of `ModelCard`. The `ModelPackageModelCard` schema does not include `model_package_details`, and `model_overview` is composed of the `model_creator` and `model_artifact` properties. For more information about the model package model card schema, see [Model package model card schema]. For more information about the model card associated with the model package, see [View the Details of a Model Version].

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema [2]: docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html

Constant Summary collapse

SENSITIVE =

[:model_card_content]

Instance Attribute Summary collapse

#model_card_content ⇒ String

The content of the model card.
#model_card_status ⇒ String

The approval status of the model card within your organization.

Instance Attribute Details

#model_card_content ⇒ `String`

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

[1]: docs.aws.amazon.com/sagemaker/latest/dg/model-registry-details.html#model-card-schema

Returns:

(String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 33501

class ModelPackageModelCard < Struct.new(
  :model_card_content,
  :model_card_status)
  SENSITIVE = [:model_card_content]
  include Aws::Structure
end

#model_card_status ⇒ `String`

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`.