ModelPackage

An array of additional Inference Specification objects.

Type: Array of AdditionalInferenceSpecificationDefinition objects

Array Members: Minimum number of 1 item. Maximum number of 15 items.

Required: No

A description provided when the model approval is set.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: .*

Required: No

Whether the model package is to be certified to be listed on AWS Marketplace. For information about listing model packages on AWS Marketplace, see List Your Algorithm or Model Package on AWS Marketplace.

Type: Boolean

Required: No

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

Required: No

The time that the model package was created.

Type: Timestamp

Required: No

The metadata properties for the model package.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}

Required: No

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

Type: String

Required: No

Represents the drift check baselines that can be used when the model monitor is set using the model package.

Type: DriftCheckBaselines object

Required: No

Defines how to perform inference generation after a training job is run.

Type: InferenceSpecification object

Required: No

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

Type: UserContext object

Required: No

The last time the model package was modified.

Type: Timestamp

Required: No

Metadata properties of the tracking entity, trial, or trial component.

Type: MetadataProperties object

Required: No

The approval status of the model. This can be one of the following values.

Type: String

Valid Values: Approved | Rejected | PendingManualApproval

Required: No

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.

Type: ModelPackageModelCard object

Required: No

A structure describing the current state of the model in its life cycle.

Type: ModelLifeCycle object

Required: No

Metrics for the model.

Type: ModelMetrics object

Required: No

The Amazon Resource Name (ARN) of the model package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$

Required: No

The description of the model package.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*

Required: No

The model group to which the model belongs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

The name of the model.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

The status of the model package. This can be one of the following values.

Type: String

Valid Values: Pending | InProgress | Completed | Failed | Deleting

Required: No

Specifies the validation and image scan statuses of the model package.

Type: ModelPackageStatusDetails object

Required: No

The version number of a versioned model.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

Type: String

Required: No

An optional AWS Key Management Service key to encrypt, decrypt, and re-encrypt model package information for regulated workloads with highly sensitive data.

Type: ModelPackageSecurityConfig object

Required: No

Indicates if you want to skip model validation.

Type: String

Valid Values: All | None

Required: No

A list of algorithms that were used to create a model package.

Type: SourceAlgorithmSpecification object

Required: No

The URI of the source for the model package.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{Z}\p{N}\p{P}]{0,1024}

Required: No

A list of the tags associated with the model package. For more information, see Tagging AWS resources in the AWS General Reference Guide.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

Type: String

Required: No

Specifies batch transform jobs that SageMaker runs to validate your model package.

Type: ModelPackageValidationSpecification object

Required: No