Interface ModelPackage.Builder

    • Method Detail

      • modelPackageName

        ModelPackage.Builder modelPackageName​(String modelPackageName)

        The name of the model.

        Parameters:
        modelPackageName - The name of the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelPackageGroupName

        ModelPackage.Builder modelPackageGroupName​(String modelPackageGroupName)

        The model group to which the model belongs.

        Parameters:
        modelPackageGroupName - The model group to which the model belongs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelPackageVersion

        ModelPackage.Builder modelPackageVersion​(Integer modelPackageVersion)

        The version number of a versioned model.

        Parameters:
        modelPackageVersion - The version number of a versioned model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelPackageArn

        ModelPackage.Builder modelPackageArn​(String modelPackageArn)

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

        Parameters:
        modelPackageArn - The Amazon Resource Name (ARN) of the model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelPackageDescription

        ModelPackage.Builder modelPackageDescription​(String modelPackageDescription)

        The description of the model package.

        Parameters:
        modelPackageDescription - The description of the model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • creationTime

        ModelPackage.Builder creationTime​(Instant creationTime)

        The time that the model package was created.

        Parameters:
        creationTime - The time that the model package was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • inferenceSpecification

        ModelPackage.Builder inferenceSpecification​(InferenceSpecification inferenceSpecification)

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

        Parameters:
        inferenceSpecification - Defines how to perform inference generation after a training job is run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sourceAlgorithmSpecification

        ModelPackage.Builder sourceAlgorithmSpecification​(SourceAlgorithmSpecification sourceAlgorithmSpecification)

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

        Parameters:
        sourceAlgorithmSpecification - A list of algorithms that were used to create a model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • validationSpecification

        ModelPackage.Builder validationSpecification​(ModelPackageValidationSpecification validationSpecification)

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

        Parameters:
        validationSpecification - Specifies batch transform jobs that SageMaker runs to validate your model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelPackageStatus

        ModelPackage.Builder modelPackageStatus​(String modelPackageStatus)

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

        • PENDING - The model package is pending being created.

        • IN_PROGRESS - The model package is in the process of being created.

        • COMPLETED - The model package was successfully created.

        • FAILED - The model package failed.

        • DELETING - The model package is in the process of being deleted.

        Parameters:
        modelPackageStatus - The status of the model package. This can be one of the following values.

        • PENDING - The model package is pending being created.

        • IN_PROGRESS - The model package is in the process of being created.

        • COMPLETED - The model package was successfully created.

        • FAILED - The model package failed.

        • DELETING - The model package is in the process of being deleted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelPackageStatus, ModelPackageStatus
      • modelPackageStatus

        ModelPackage.Builder modelPackageStatus​(ModelPackageStatus modelPackageStatus)

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

        • PENDING - The model package is pending being created.

        • IN_PROGRESS - The model package is in the process of being created.

        • COMPLETED - The model package was successfully created.

        • FAILED - The model package failed.

        • DELETING - The model package is in the process of being deleted.

        Parameters:
        modelPackageStatus - The status of the model package. This can be one of the following values.

        • PENDING - The model package is pending being created.

        • IN_PROGRESS - The model package is in the process of being created.

        • COMPLETED - The model package was successfully created.

        • FAILED - The model package failed.

        • DELETING - The model package is in the process of being deleted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelPackageStatus, ModelPackageStatus
      • modelPackageStatusDetails

        ModelPackage.Builder modelPackageStatusDetails​(ModelPackageStatusDetails modelPackageStatusDetails)

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

        Parameters:
        modelPackageStatusDetails - Specifies the validation and image scan statuses of the model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelApprovalStatus

        ModelPackage.Builder modelApprovalStatus​(String modelApprovalStatus)

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

        • APPROVED - The model is approved

        • REJECTED - The model is rejected.

        • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

        Parameters:
        modelApprovalStatus - The approval status of the model. This can be one of the following values.

        • APPROVED - The model is approved

        • REJECTED - The model is rejected.

        • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelApprovalStatus, ModelApprovalStatus
      • modelApprovalStatus

        ModelPackage.Builder modelApprovalStatus​(ModelApprovalStatus modelApprovalStatus)

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

        • APPROVED - The model is approved

        • REJECTED - The model is rejected.

        • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

        Parameters:
        modelApprovalStatus - The approval status of the model. This can be one of the following values.

        • APPROVED - The model is approved

        • REJECTED - The model is rejected.

        • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ModelApprovalStatus, ModelApprovalStatus
      • createdBy

        ModelPackage.Builder createdBy​(UserContext createdBy)

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

        Parameters:
        createdBy - Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • metadataProperties

        ModelPackage.Builder metadataProperties​(MetadataProperties metadataProperties)

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

        Parameters:
        metadataProperties - Metadata properties of the tracking entity, trial, or trial component.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelMetrics

        ModelPackage.Builder modelMetrics​(ModelMetrics modelMetrics)

        Metrics for the model.

        Parameters:
        modelMetrics - Metrics for the model.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastModifiedTime

        ModelPackage.Builder lastModifiedTime​(Instant lastModifiedTime)

        The last time the model package was modified.

        Parameters:
        lastModifiedTime - The last time the model package was modified.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastModifiedBy

        ModelPackage.Builder lastModifiedBy​(UserContext lastModifiedBy)

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

        Parameters:
        lastModifiedBy - Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • approvalDescription

        ModelPackage.Builder approvalDescription​(String approvalDescription)

        A description provided when the model approval is set.

        Parameters:
        approvalDescription - A description provided when the model approval is set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • domain

        ModelPackage.Builder domain​(String domain)

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

        Parameters:
        domain - The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • task

        ModelPackage.Builder task​(String task)

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

        Parameters:
        task - The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • samplePayloadUrl

        ModelPackage.Builder samplePayloadUrl​(String samplePayloadUrl)

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

        Parameters:
        samplePayloadUrl - 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).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • additionalInferenceSpecifications

        ModelPackage.Builder additionalInferenceSpecifications​(Collection<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications)

        An array of additional Inference Specification objects.

        Parameters:
        additionalInferenceSpecifications - An array of additional Inference Specification objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • additionalInferenceSpecifications

        ModelPackage.Builder additionalInferenceSpecifications​(AdditionalInferenceSpecificationDefinition... additionalInferenceSpecifications)

        An array of additional Inference Specification objects.

        Parameters:
        additionalInferenceSpecifications - An array of additional Inference Specification objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • sourceUri

        ModelPackage.Builder sourceUri​(String sourceUri)

        The URI of the source for the model package.

        Parameters:
        sourceUri - The URI of the source for the model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • securityConfig

        ModelPackage.Builder securityConfig​(ModelPackageSecurityConfig securityConfig)
        Sets the value of the SecurityConfig property for this object.
        Parameters:
        securityConfig - The new value for the SecurityConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • modelCard

        ModelPackage.Builder modelCard​(ModelPackageModelCard modelCard)
        Sets the value of the ModelCard property for this object.
        Parameters:
        modelCard - The new value for the ModelCard property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • tags

        ModelPackage.Builder tags​(Tag... tags)

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

        Parameters:
        tags - A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • customerMetadataProperties

        ModelPackage.Builder customerMetadataProperties​(Map<String,​String> customerMetadataProperties)

        The metadata properties for the model package.

        Parameters:
        customerMetadataProperties - The metadata properties for the model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • driftCheckBaselines

        ModelPackage.Builder driftCheckBaselines​(DriftCheckBaselines driftCheckBaselines)

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

        Parameters:
        driftCheckBaselines - Represents the drift check baselines that can be used when the model monitor is set using the model package.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • skipModelValidation

        ModelPackage.Builder skipModelValidation​(String skipModelValidation)

        Indicates if you want to skip model validation.

        Parameters:
        skipModelValidation - Indicates if you want to skip model validation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SkipModelValidation, SkipModelValidation