sagemaker/aws.sdk.kotlin.services.sagemaker.model/ModelPackage/Builder

Builder

class Builder

Properties

additionalInferenceSpecifications

var additionalInferenceSpecifications: List<AdditionalInferenceSpecificationDefinition>?

An array of additional Inference Specification objects.

approvalDescription

var approvalDescription: String?

A description provided when the model approval is set.

certifyForMarketplace

var certifyForMarketplace: Boolean?

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

createdBy

var createdBy: UserContext?

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

creationTime

var creationTime: Instant?

The time that the model package was created.

customerMetadataProperties

var customerMetadataProperties: Map<String, String>?

The metadata properties for the model package.

domain

var domain: String?

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

driftCheckBaselines

var driftCheckBaselines: DriftCheckBaselines?

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

inferenceSpecification

var inferenceSpecification: InferenceSpecification?

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

lastModifiedBy

var lastModifiedBy: UserContext?

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

lastModifiedTime

var lastModifiedTime: Instant?

The last time the model package was modified.

metadataProperties

var metadataProperties: MetadataProperties?

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

modelApprovalStatus

var modelApprovalStatus: ModelApprovalStatus?

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

modelCard

var modelCard: ModelPackageModelCard?

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.

modelLifeCycle

var modelLifeCycle: ModelLifeCycle?

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

modelMetrics

var modelMetrics: ModelMetrics?

Metrics for the model.

modelPackageArn

var modelPackageArn: String?

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

modelPackageDescription

var modelPackageDescription: String?

The description of the model package.

modelPackageGroupName

var modelPackageGroupName: String?

The model group to which the model belongs.

modelPackageName

var modelPackageName: String?

The name of the model package. The name can be as follows:

modelPackageStatus

var modelPackageStatus: ModelPackageStatus?

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

modelPackageStatusDetails

var modelPackageStatusDetails: ModelPackageStatusDetails?

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

modelPackageVersion

var modelPackageVersion: Int?

The version number of a versioned model.

samplePayloadUrl

var samplePayloadUrl: String?

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

securityConfig

var securityConfig: ModelPackageSecurityConfig?

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

skipModelValidation

var skipModelValidation: SkipModelValidation?

Indicates if you want to skip model validation.

sourceAlgorithmSpecification

var sourceAlgorithmSpecification: SourceAlgorithmSpecification?

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

sourceUri

var sourceUri: String?

The URI of the source for the model package.