Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding model package entity #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This repository contains code to manage the following SageMaker resource provide
- AWS::SageMaker::FeatureGroup
- AWS::SageMaker::Project
- AWS::SageMaker::ModelPackageGroup
- AWS::SageMaker::ModelPackage
- AWS::SageMaker::ModelExplainabilityJobDefinition
- AWS::SageMaker::ModelBiasJobDefinition
- AWS::SageMaker::DataQualityJobDefinition
Expand Down
25 changes: 25 additions & 0 deletions aws-sagemaker-modelpackage/.rpdk-config
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"artifact_type": "RESOURCE",
"typeName": "AWS::SageMaker::ModelPackage",
"language": "java",
"runtime": "java8",
"entrypoint": "software.amazon.sagemaker.modelpackage.HandlerWrapper::handleRequest",
"testEntrypoint": "software.amazon.sagemaker.modelpackage.HandlerWrapper::testEntrypoint",
"settings": {
"version": false,
"subparser_name": null,
"verbose": 0,
"force": false,
"type_name": null,
"artifact_type": null,
"namespace": [
"software",
"amazon",
"sagemaker",
"modelpackage"
],
"codegen_template_path": "guided_aws",
"protocolVersion": "2.0.0"
},
"executableEntrypoint": "software.amazon.sagemaker.modelpackage.HandlerWrapperExecutable"
}
420 changes: 420 additions & 0 deletions aws-sagemaker-modelpackage/README.md

Large diffs are not rendered by default.

1,101 changes: 1,101 additions & 0 deletions aws-sagemaker-modelpackage/aws-sagemaker-modelpackage.json

Large diffs are not rendered by default.

420 changes: 420 additions & 0 deletions aws-sagemaker-modelpackage/docs/README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# AWS::SageMaker::ModelPackage AdditionalInferenceSpecificationDefinition

Additional Inference Specification specifies details about inference jobs that can be run with models based on this model package.AdditionalInferenceSpecifications can be added to existing model packages using AdditionalInferenceSpecificationsToAdd.

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"<a href="#containers" title="Containers">Containers</a>" : <i>[ <a href="modelpackagecontainerdefinition.md">ModelPackageContainerDefinition</a>, ... ]</i>,
"<a href="#description" title="Description">Description</a>" : <i>String</i>,
"<a href="#name" title="Name">Name</a>" : <i>String</i>,
"<a href="#supportedcontenttypes" title="SupportedContentTypes">SupportedContentTypes</a>" : <i>[ String, ... ]</i>,
"<a href="#supportedrealtimeinferenceinstancetypes" title="SupportedRealtimeInferenceInstanceTypes">SupportedRealtimeInferenceInstanceTypes</a>" : <i>[ String, ... ]</i>,
"<a href="#supportedresponsemimetypes" title="SupportedResponseMIMETypes">SupportedResponseMIMETypes</a>" : <i>[ String, ... ]</i>,
"<a href="#supportedtransforminstancetypes" title="SupportedTransformInstanceTypes">SupportedTransformInstanceTypes</a>" : <i>[ String, ... ]</i>
}
</pre>

### YAML

<pre>
<a href="#containers" title="Containers">Containers</a>: <i>
- <a href="modelpackagecontainerdefinition.md">ModelPackageContainerDefinition</a></i>
<a href="#description" title="Description">Description</a>: <i>String</i>
<a href="#name" title="Name">Name</a>: <i>String</i>
<a href="#supportedcontenttypes" title="SupportedContentTypes">SupportedContentTypes</a>: <i>
- String</i>
<a href="#supportedrealtimeinferenceinstancetypes" title="SupportedRealtimeInferenceInstanceTypes">SupportedRealtimeInferenceInstanceTypes</a>: <i>
- String</i>
<a href="#supportedresponsemimetypes" title="SupportedResponseMIMETypes">SupportedResponseMIMETypes</a>: <i>
- String</i>
<a href="#supportedtransforminstancetypes" title="SupportedTransformInstanceTypes">SupportedTransformInstanceTypes</a>: <i>
- String</i>
</pre>

## Properties

#### Containers

The Amazon ECR registry path of the Docker image that contains the inference code.

_Required_: Yes

_Type_: List of <a href="modelpackagecontainerdefinition.md">ModelPackageContainerDefinition</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Description

A description of the additional Inference specification.

_Required_: No

_Type_: String

_Maximum_: <code>1024</code>

_Pattern_: <code>.*</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Name

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

_Required_: Yes

_Type_: String

_Minimum_: <code>1</code>

_Maximum_: <code>63</code>

_Pattern_: <code>^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### SupportedContentTypes

The supported MIME types for the input data.

_Required_: No

_Type_: List of String

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### SupportedRealtimeInferenceInstanceTypes

A list of the instance types that are used to generate inferences in real-time

_Required_: No

_Type_: List of String

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### SupportedResponseMIMETypes

The supported MIME types for the output data.

_Required_: No

_Type_: List of String

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### SupportedTransformInstanceTypes

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

_Required_: No

_Type_: List of String

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

52 changes: 52 additions & 0 deletions aws-sagemaker-modelpackage/docs/bias.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# AWS::SageMaker::ModelPackage Bias

Contains bias metrics for a model.

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"<a href="#report" title="Report">Report</a>" : <i><a href="metricssource.md">MetricsSource</a></i>,
"<a href="#pretrainingreport" title="PreTrainingReport">PreTrainingReport</a>" : <i><a href="metricssource.md">MetricsSource</a></i>,
"<a href="#posttrainingreport" title="PostTrainingReport">PostTrainingReport</a>" : <i><a href="metricssource.md">MetricsSource</a></i>
}
</pre>

### YAML

<pre>
<a href="#report" title="Report">Report</a>: <i><a href="metricssource.md">MetricsSource</a></i>
<a href="#pretrainingreport" title="PreTrainingReport">PreTrainingReport</a>: <i><a href="metricssource.md">MetricsSource</a></i>
<a href="#posttrainingreport" title="PostTrainingReport">PostTrainingReport</a>: <i><a href="metricssource.md">MetricsSource</a></i>
</pre>

## Properties

#### Report

_Required_: No

_Type_: <a href="metricssource.md">MetricsSource</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### PreTrainingReport

_Required_: No

_Type_: <a href="metricssource.md">MetricsSource</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### PostTrainingReport

_Required_: No

_Type_: <a href="metricssource.md">MetricsSource</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

50 changes: 50 additions & 0 deletions aws-sagemaker-modelpackage/docs/customermetadataproperties.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# AWS::SageMaker::ModelPackage CustomerMetadataProperties

The metadata properties associated with the model package versions.

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"<a href="#^([\p{l}\p{z}\p{n}_.:\/=+\-@]*)${1,128}" title="^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}">^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}</a>" : <i>String</i>,
"<a href="#^([\p{l}\p{z}\p{n}_.:\/=+\-@]*)${1,256}" title="^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}">^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}</a>" : <i>String</i>
}
</pre>

### YAML

<pre>
<a href="#^([\p{l}\p{z}\p{n}_.:\/=+\-@]*)${1,128}" title="^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}">^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,128}</a>: <i>String</i>
<a href="#^([\p{l}\p{z}\p{n}_.:\/=+\-@]*)${1,256}" title="^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}">^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)${1,256}</a>: <i>String</i>
</pre>

## Properties

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

_Required_: No

_Type_: String

_Minimum_: <code>1</code>

_Maximum_: <code>128</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

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

_Required_: No

_Type_: String

_Minimum_: <code>1</code>

_Maximum_: <code>256</code>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

34 changes: 34 additions & 0 deletions aws-sagemaker-modelpackage/docs/datasource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# AWS::SageMaker::ModelPackage DataSource

Describes the input source of a transform job and the way the transform job consumes it.

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"<a href="#s3datasource" title="S3DataSource">S3DataSource</a>" : <i><a href="s3datasource.md">S3DataSource</a></i>
}
</pre>

### YAML

<pre>
<a href="#s3datasource" title="S3DataSource">S3DataSource</a>: <i><a href="s3datasource.md">S3DataSource</a></i>
</pre>

## Properties

#### S3DataSource

Describes the S3 data source.

_Required_: Yes

_Type_: <a href="s3datasource.md">S3DataSource</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

70 changes: 70 additions & 0 deletions aws-sagemaker-modelpackage/docs/driftcheckbaselines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# AWS::SageMaker::ModelPackage DriftCheckBaselines

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

## Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

### JSON

<pre>
{
"<a href="#bias" title="Bias">Bias</a>" : <i><a href="driftcheckbias.md">DriftCheckBias</a></i>,
"<a href="#explainability" title="Explainability">Explainability</a>" : <i><a href="driftcheckexplainability.md">DriftCheckExplainability</a></i>,
"<a href="#modeldataquality" title="ModelDataQuality">ModelDataQuality</a>" : <i><a href="driftcheckmodeldataquality.md">DriftCheckModelDataQuality</a></i>,
"<a href="#modelquality" title="ModelQuality">ModelQuality</a>" : <i><a href="driftcheckmodelquality.md">DriftCheckModelQuality</a></i>
}
</pre>

### YAML

<pre>
<a href="#bias" title="Bias">Bias</a>: <i><a href="driftcheckbias.md">DriftCheckBias</a></i>
<a href="#explainability" title="Explainability">Explainability</a>: <i><a href="driftcheckexplainability.md">DriftCheckExplainability</a></i>
<a href="#modeldataquality" title="ModelDataQuality">ModelDataQuality</a>: <i><a href="driftcheckmodeldataquality.md">DriftCheckModelDataQuality</a></i>
<a href="#modelquality" title="ModelQuality">ModelQuality</a>: <i><a href="driftcheckmodelquality.md">DriftCheckModelQuality</a></i>
</pre>

## Properties

#### Bias

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

_Required_: No

_Type_: <a href="driftcheckbias.md">DriftCheckBias</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### Explainability

Contains explainability metrics for a model.

_Required_: No

_Type_: <a href="driftcheckexplainability.md">DriftCheckExplainability</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### ModelDataQuality

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

_Required_: No

_Type_: <a href="driftcheckmodeldataquality.md">DriftCheckModelDataQuality</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

#### ModelQuality

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

_Required_: No

_Type_: <a href="driftcheckmodelquality.md">DriftCheckModelQuality</a>

_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

Loading