Skip to content
v2.277.0

ModelOverviewProperty Struct ​

An overview about the model.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const modelOverviewProperty: sagemaker.CfnModelCard.ModelOverviewProperty = {
  algorithmType: 'algorithmType',
  inferenceEnvironment: {
    containerImage: ['containerImage'],
  },
  modelArtifact: ['modelArtifact'],
  modelCreator: 'modelCreator',
  modelDescription: 'modelDescription',
  modelId: 'modelId',
  modelName: 'modelName',
  modelOwner: 'modelOwner',
  modelVersion: 123,
  problemType: 'problemType',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

model_overview_property = sagemaker.CfnModelCard.ModelOverviewProperty(
    algorithm_type="algorithmType",
    inference_environment=sagemaker.CfnModelCard.InferenceEnvironmentProperty(
        container_image=["containerImage"]
    ),
    model_artifact=["modelArtifact"],
    model_creator="modelCreator",
    model_description="modelDescription",
    model_id="modelId",
    model_name="modelName",
    model_owner="modelOwner",
    model_version=123,
    problem_type="problemType"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

ModelOverviewProperty modelOverviewProperty = ModelOverviewProperty.builder()
        .algorithmType("algorithmType")
        .inferenceEnvironment(InferenceEnvironmentProperty.builder()
                .containerImage(List.of("containerImage"))
                .build())
        .modelArtifact(List.of("modelArtifact"))
        .modelCreator("modelCreator")
        .modelDescription("modelDescription")
        .modelId("modelId")
        .modelName("modelName")
        .modelOwner("modelOwner")
        .modelVersion(123)
        .problemType("problemType")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var modelOverviewProperty = new ModelOverviewProperty {
    AlgorithmType = "algorithmType",
    InferenceEnvironment = new InferenceEnvironmentProperty {
        ContainerImage = new [] { "containerImage" }
    },
    ModelArtifact = new [] { "modelArtifact" },
    ModelCreator = "modelCreator",
    ModelDescription = "modelDescription",
    ModelId = "modelId",
    ModelName = "modelName",
    ModelOwner = "modelOwner",
    ModelVersion = 123,
    ProblemType = "problemType"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

modelOverviewProperty := &ModelOverviewProperty{
	AlgorithmType: jsii.String("algorithmType"),
	InferenceEnvironment: &InferenceEnvironmentProperty{
		ContainerImage: []*string{
			jsii.String("containerImage"),
		},
	},
	ModelArtifact: []*string{
		jsii.String("modelArtifact"),
	},
	ModelCreator: jsii.String("modelCreator"),
	ModelDescription: jsii.String("modelDescription"),
	ModelId: jsii.String("modelId"),
	ModelName: jsii.String("modelName"),
	ModelOwner: jsii.String("modelOwner"),
	ModelVersion: jsii.Number(123),
	ProblemType: jsii.String("problemType"),
}

Properties ​

algorithmTypeoptionalstringalgorithm_typeoptionalstralgorithmTypeoptionalStringAlgorithmTypeoptionalstringAlgorithmTypeoptional*string #
The algorithm used to solve the problem.
inferenceEnvironmentoptionalIResolvable | CfnModelCard.InferenceEnvironmentPropertyinference_environmentoptionaltyping.Union[IResolvable, InferenceEnvironmentProperty]inferenceEnvironmentoptionalIResolvableInferenceEnvironmentoptionalIResolvableInferenceEnvironmentoptionalinterface{} #
An overview about model inference.
modelArtifactoptionalstring[]model_artifactoptionaltyping.List[str]modelArtifactoptionalList<String>ModelArtifactoptionalstring[]ModelArtifactoptional*[]*string #
The location of the model artifact.
modelCreatoroptionalstringmodel_creatoroptionalstrmodelCreatoroptionalStringModelCreatoroptionalstringModelCreatoroptional*string #
The creator of the model.
modelDescriptionoptionalstringmodel_descriptionoptionalstrmodelDescriptionoptionalStringModelDescriptionoptionalstringModelDescriptionoptional*string #
A description of the model.
modelIdoptionalstringmodel_idoptionalstrmodelIdoptionalStringModelIdoptionalstringModelIdoptional*string #
The SageMaker AI Model ARN or non- SageMaker AI Model ID.
modelNameoptionalstringmodel_nameoptionalstrmodelNameoptionalStringModelNameoptionalstringModelNameoptional*string #
The name of the model.
modelOwneroptionalstringmodel_owneroptionalstrmodelOwneroptionalStringModelOwneroptionalstringModelOwneroptional*string #
The owner of the model.
modelVersionoptionalnumbermodel_versionoptionalint | floatmodelVersionoptionalNumberModelVersionoptionaldoubleModelVersionoptional*float64 #
The version of the model.
problemTypeoptionalstringproblem_typeoptionalstrproblemTypeoptionalStringProblemTypeoptionalstringProblemTypeoptional*string #
The problem being solved with the model.