Skip to content
v2.277.0

Experimental

@aws-cdk/aws-sagemaker-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

ModelData Class ​

Model data represents the source of model artifacts, which will ultimately be loaded from an S3 location.

Example ​

ts
import * as sagemaker from '@aws-cdk/aws-sagemaker-alpha';

declare const image: sagemaker.ContainerImage;
declare const modelData: sagemaker.ModelData;

const model = new sagemaker.Model(this, 'ContainerModel', {
  containers: [
    {
      image,
      modelData,
    }
  ],
  networkIsolation: true,
});
python
import aws_cdk.aws_sagemaker_alpha as sagemaker

# image: sagemaker.ContainerImage
# model_data: sagemaker.ModelData


model = sagemaker.Model(self, "ContainerModel",
    containers=[sagemaker.ContainerDefinition(
        image=image,
        model_data=model_data
    )
    ],
    network_isolation=True
)
java
import software.amazon.awscdk.services.sagemaker.alpha.*;

ContainerImage image;
ModelData modelData;


Model model = Model.Builder.create(this, "ContainerModel")
        .containers(List.of(ContainerDefinition.builder()
                .image(image)
                .modelData(modelData)
                .build()))
        .networkIsolation(true)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Sagemaker.Alpha
using Amazon.CDK.AWS.Sagemaker.Alpha;

ContainerImage image;
ModelData modelData;


var model = new Model(this, "ContainerModel", new ModelProps {
    Containers = new [] { new ContainerDefinition {
        Image = image,
        ModelData = modelData
    } },
    NetworkIsolation = true
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdksagemakeralpha/v2
import sagemaker "github.com/aws/aws-cdk-go/awscdksagemakeralpha"

var image ContainerImage
var modelData ModelData


model := sagemaker.NewModel(this, jsii.String("ContainerModel"), &ModelProps{
	Containers: []ContainerDefinition{
		&ContainerDefinition{
			Image: *Image,
			ModelData: *ModelData,
		},
	},
	NetworkIsolation: jsii.Boolean(true),
})

Initializer ​

ts
new ModelData()
python
ModelData()
java
new ModelData()
csharp
new ModelData()
go
NewModelData()

Methods ​

bind(scope: Construct, model: IModel): ModelDataConfigdef bind(self, scope: Construct, model: IModel) -> ModelDataConfigpublic ModelDataConfig bind(Construct scope, IModel model)public ModelDataConfig Bind(Construct scope, IModel model)func Bind(Scope Construct, Model IModel) ModelDataConfig #
This method is invoked by the SageMaker Model construct when it needs to resolve the model data to a URI.
2 parameters

Parameters

  • scopescopescopescopeScope — The scope within which the model data is resolved.
  • modelmodelmodelmodelModel — The Model construct performing the URI resolution.
fromAsset(path: string, options?: AssetOptions): ModelData // chainable@staticmethod def from_asset(path: str, options: typing.Optional[AssetOptions] = None) -> ModelDatapublic static ModelData fromAsset(String path, AssetOptions options)public static ModelData FromAsset(string path, AssetOptions? options = null)func FromAsset(Path *string, Options AssetOptions) ModelData static #
Constructs model data that will be uploaded to S3 as part of the CDK app deployment.
2 parameters

Parameters

  • pathpathpathpathPath — The local path to a model artifact file as a gzipped tar file.
  • optionsoptionsoptionsoptionsOptions — The options to further configure the selected asset.
fromBucket(bucket: IBucket, objectKey: string): ModelData // chainable@staticmethod def from_bucket(bucket: IBucket, object_key: str) -> ModelDatapublic static ModelData fromBucket(IBucket bucket, String objectKey)public static ModelData FromBucket(IBucket bucket, string objectKey)func FromBucket(Bucket IBucket, ObjectKey *string) ModelData static #
Constructs model data which is already available within S3.
2 parameters

Parameters

  • bucketbucketbucketbucketBucket — The S3 bucket within which the model artifacts are stored.
  • objectKeyobject_keyobjectKeyobjectKeyObjectKey — The S3 object key at which the model artifacts are stored.