Skip to content

/AWS1/CL_SGM=>CREATEMODELPACKAGE()

About CreateModelPackage

Creates a model package that you can use to create SageMaker models or list on Amazon Web Services Marketplace, or a versioned model that is part of a model group. Buyers can subscribe to model packages listed on Amazon Web Services Marketplace to create models in SageMaker.

To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in Amazon Web Services Marketplace, provide a value for SourceAlgorithmSpecification.

There are two types of model packages:

  • Versioned - a model that is part of a model group in the model registry.

  • Unversioned - a model package that is not part of a model group.

Method Signature

IMPORTING

Optional arguments:

IV_MODELPACKAGENAME TYPE /AWS1/SGMENTITYNAME /AWS1/SGMENTITYNAME

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

IV_MODELPACKAGEGROUPNAME TYPE /AWS1/SGMARNORNAME /AWS1/SGMARNORNAME

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

IV_MODELPACKAGEDESCRIPTION TYPE /AWS1/SGMENTITYDESCRIPTION /AWS1/SGMENTITYDESCRIPTION

A description of the model package.

IO_INFERENCESPECIFICATION TYPE REF TO /AWS1/CL_SGMINFERENCESPEC /AWS1/CL_SGMINFERENCESPEC

Specifies details about inference jobs that you can run with models based on this model package, including the following information:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.

  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

  • The input and output content formats that the model package supports for inference.

IO_VALIDATIONSPECIFICATION TYPE REF TO /AWS1/CL_SGMMDELPACKAGEVALID00 /AWS1/CL_SGMMDELPACKAGEVALID00

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

IO_SOURCEALGORITHMSPEC TYPE REF TO /AWS1/CL_SGMSOURCEALGSPEC /AWS1/CL_SGMSOURCEALGSPEC

Details about the algorithm that was used to create the model package.

IV_CERTIFYFORMARKETPLACE TYPE /AWS1/SGMCERTIFYFORMARKETPLACE /AWS1/SGMCERTIFYFORMARKETPLACE

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

IT_TAGS TYPE /AWS1/CL_SGMTAG=>TT_TAGLIST TT_TAGLIST

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

If you supply ModelPackageGroupName, your model package belongs to the model group you specify and uses the tags associated with the model group. In this case, you cannot supply a tag argument.

IV_MODELAPPROVALSTATUS TYPE /AWS1/SGMMODELAPPROVALSTATUS /AWS1/SGMMODELAPPROVALSTATUS

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

IO_METADATAPROPERTIES TYPE REF TO /AWS1/CL_SGMMETADATAPROPERTIES /AWS1/CL_SGMMETADATAPROPERTIES

MetadataProperties

IO_MODELMETRICS TYPE REF TO /AWS1/CL_SGMMODELMETRICS /AWS1/CL_SGMMODELMETRICS

A structure that contains model metrics reports.

IV_CLIENTTOKEN TYPE /AWS1/SGMCLIENTTOKEN /AWS1/SGMCLIENTTOKEN

A unique token that guarantees that the call to this API is idempotent.

IV_DOMAIN TYPE /AWS1/SGMSTRING /AWS1/SGMSTRING

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

IV_TASK TYPE /AWS1/SGMSTRING /AWS1/SGMSTRING

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

Specify "OTHER" if none of the tasks listed fit your use case.

IV_SAMPLEPAYLOADURL TYPE /AWS1/SGMS3URI /AWS1/SGMS3URI

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). This archive can hold multiple files that are all equally used in the load test. Each file in the archive must satisfy the size constraints of the InvokeEndpoint call.

IT_CUSTOMERMETADATAPRPS TYPE /AWS1/CL_SGMCUSTOMERMETMAP_W=>TT_CUSTOMERMETADATAMAP TT_CUSTOMERMETADATAMAP

The metadata properties associated with the model package versions.

IO_DRIFTCHECKBASELINES TYPE REF TO /AWS1/CL_SGMDRIFTCHECKBASELI00 /AWS1/CL_SGMDRIFTCHECKBASELI00

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

IT_ADDITIONALINFERENCESPECS TYPE /AWS1/CL_SGMADDLINFERENCESPE00=>TT_ADDITIONALINFERENCESPECS TT_ADDITIONALINFERENCESPECS

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

IV_SKIPMODELVALIDATION TYPE /AWS1/SGMSKIPMODELVALIDATION /AWS1/SGMSKIPMODELVALIDATION

Indicates if you want to skip model validation.

IV_SOURCEURI TYPE /AWS1/SGMMODELPACKAGESOURCEURI /AWS1/SGMMODELPACKAGESOURCEURI

The URI of the source for the model package. If you want to clone a model package, set it to the model package Amazon Resource Name (ARN). If you want to register a model, set it to the model ARN.

IO_SECURITYCONFIG TYPE REF TO /AWS1/CL_SGMMODELPACKAGESECCFG /AWS1/CL_SGMMODELPACKAGESECCFG

The KMS Key ID (KMSKeyId) used for encryption of model package information.

IO_MODELCARD TYPE REF TO /AWS1/CL_SGMMDELPACKAGEMDELC00 /AWS1/CL_SGMMDELPACKAGEMDELC00

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SGMCREMODELPACKAGEOUT /AWS1/CL_SGMCREMODELPACKAGEOUT