Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-sagemaker-modelcard.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::SageMaker::ModelCard.. Source:- No source definition found, add manually please

Properties

ModelCardName string | Aws_CF_FunctionString required

The unique name of the model card.

ModelCardStatus string | Aws_CF_FunctionString required

The approval status of the model card within your organization. Different organizations might have different criteria for model card review and approval.

Content object required

The content of the model card.

7 nested properties
ModelOverview object

Overview about the model.

10 nested properties
ModelDescription string | Aws_CF_FunctionString

description of model.

ModelOwner string | Aws_CF_FunctionString

Owner of model.

ModelCreator string | Aws_CF_FunctionString

Creator of model.

ProblemType string | Aws_CF_FunctionString

Problem being solved with the model.

AlgorithmType string | Aws_CF_FunctionString

Algorithm used to solve the problem.

ModelId string | Aws_CF_FunctionString

SageMaker Model Arn or Non SageMaker Model id.

ModelArtifact string[]

Location of the model artifact.

maxItems=15
ModelName string | Aws_CF_FunctionString

Name of the model.

ModelVersion number

Version of the model.

min=1
InferenceEnvironment object

Overview about the inference.

1 nested properties
ContainerImage string[]

SageMaker inference image uri.

maxItems=15
ModelPackageDetails object

Metadata information related to model package version

13 nested properties
ModelPackageDescription string | Aws_CF_FunctionString

A brief summary of the model package

ModelPackageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the model package

CreatedBy object
1 nested properties
UserProfileName string | Aws_CF_FunctionString

The name of the user's profile in Studio

ModelPackageStatus string | Aws_CF_FunctionString

Current status of model package

ModelApprovalStatus string | Aws_CF_FunctionString

Current approval status of model package

ApprovalDescription string | Aws_CF_FunctionString

A description provided for the model approval

ModelPackageGroupName string | Aws_CF_FunctionString

If the model is a versioned model, the name of the model group that the versioned model belongs to.

ModelPackageName string | Aws_CF_FunctionString

Name of the model package

ModelPackageVersion number

Version of the model package

min=1
Domain string | Aws_CF_FunctionString

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

Task string | Aws_CF_FunctionString

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

SourceAlgorithms SourceAlgorithm[]
minItems=1maxItems=1
InferenceSpecification object
1 nested properties
Containers Container[] required

Contains inference related information which were used to create model package.

minItems=1maxItems=15
IntendedUses object

Intended usage of model.

5 nested properties
PurposeOfModel string | Aws_CF_FunctionString

Why the model was developed?

IntendedUses string | Aws_CF_FunctionString

intended use cases.

FactorsAffectingModelEfficiency string | Aws_CF_FunctionString
RiskRating string | Aws_CF_FunctionString

Risk rating of model.

ExplanationsForRiskRating string | Aws_CF_FunctionString
BusinessDetails object

Business details.

3 nested properties
BusinessProblem string | Aws_CF_FunctionString

What business problem does the model solve?

BusinessStakeholders string | Aws_CF_FunctionString

Business stakeholders.

LineOfBusiness string | Aws_CF_FunctionString

Line of business.

TrainingDetails object

Overview about the training.

3 nested properties
ObjectiveFunction object

the objective function the model will optimize for.

2 nested properties
Function object

objective function that training job is optimized for.

Notes string | Aws_CF_FunctionString
TrainingObservations string | Aws_CF_FunctionString
TrainingJobDetails object
7 nested properties
TrainingArn string | Aws_CF_FunctionString

SageMaker Training job arn.

TrainingDatasets string[]

Location of the model datasets.

maxItems=15
TrainingEnvironment object
TrainingMetrics TrainingMetric[]
UserProvidedTrainingMetrics TrainingMetric[]
HyperParameters TrainingHyperParameter[]
UserProvidedHyperParameters TrainingHyperParameter[]
EvaluationDetails EvaluationDetail[]
Default:
[]
AdditionalInformation object
3 nested properties
EthicalConsiderations string | Aws_CF_FunctionString

Any ethical considerations that the author wants to provide.

CaveatsAndRecommendations string | Aws_CF_FunctionString

Caveats and recommendations for people who might use this model in their applications.

CustomDetails object

customer details.

SecurityConfig object

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

1 nested properties
KmsKeyId string | Aws_CF_FunctionString

A Key Management Service key ID to use for encrypting a model card.

CreatedBy object

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

3 nested properties
UserProfileArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user's profile.

UserProfileName string | Aws_CF_FunctionString

The name of the user's profile.

DomainId string | Aws_CF_FunctionString

The domain associated with the user.

LastModifiedBy object

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

3 nested properties
UserProfileArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user's profile.

UserProfileName string | Aws_CF_FunctionString

The name of the user's profile.

DomainId string | Aws_CF_FunctionString

The domain associated with the user.

Tags Tag[]

Key-value pairs used to manage metadata for model cards.

minItems=1maxItems=50

Definitions

SecurityConfig object

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

KmsKeyId string | Aws_CF_FunctionString

A Key Management Service key ID to use for encrypting a model card.

UserContext object

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

UserProfileArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user's profile.

UserProfileName string | Aws_CF_FunctionString

The name of the user's profile.

DomainId string | Aws_CF_FunctionString

The domain associated with the user.

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The tag key. Tag keys must be unique per resource.

Value string | Aws_CF_FunctionString required

The tag value.

Content object

The content of the model card.

ModelOverview object

Overview about the model.

10 nested properties
ModelDescription string | Aws_CF_FunctionString

description of model.

ModelOwner string | Aws_CF_FunctionString

Owner of model.

ModelCreator string | Aws_CF_FunctionString

Creator of model.

ProblemType string | Aws_CF_FunctionString

Problem being solved with the model.

AlgorithmType string | Aws_CF_FunctionString

Algorithm used to solve the problem.

ModelId string | Aws_CF_FunctionString

SageMaker Model Arn or Non SageMaker Model id.

ModelArtifact string[]

Location of the model artifact.

maxItems=15
ModelName string | Aws_CF_FunctionString

Name of the model.

ModelVersion number

Version of the model.

min=1
InferenceEnvironment object

Overview about the inference.

1 nested properties
ContainerImage string[]

SageMaker inference image uri.

maxItems=15
ModelPackageDetails object

Metadata information related to model package version

13 nested properties
ModelPackageDescription string | Aws_CF_FunctionString

A brief summary of the model package

ModelPackageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the model package

CreatedBy object
1 nested properties
UserProfileName string | Aws_CF_FunctionString

The name of the user's profile in Studio

ModelPackageStatus string | Aws_CF_FunctionString

Current status of model package

ModelApprovalStatus string | Aws_CF_FunctionString

Current approval status of model package

ApprovalDescription string | Aws_CF_FunctionString

A description provided for the model approval

ModelPackageGroupName string | Aws_CF_FunctionString

If the model is a versioned model, the name of the model group that the versioned model belongs to.

ModelPackageName string | Aws_CF_FunctionString

Name of the model package

ModelPackageVersion number

Version of the model package

min=1
Domain string | Aws_CF_FunctionString

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

Task string | Aws_CF_FunctionString

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

SourceAlgorithms SourceAlgorithm[]
minItems=1maxItems=1
InferenceSpecification object
1 nested properties
Containers Container[] required

Contains inference related information which were used to create model package.

minItems=1maxItems=15
IntendedUses object

Intended usage of model.

5 nested properties
PurposeOfModel string | Aws_CF_FunctionString

Why the model was developed?

IntendedUses string | Aws_CF_FunctionString

intended use cases.

FactorsAffectingModelEfficiency string | Aws_CF_FunctionString
RiskRating string | Aws_CF_FunctionString

Risk rating of model.

ExplanationsForRiskRating string | Aws_CF_FunctionString
BusinessDetails object

Business details.

3 nested properties
BusinessProblem string | Aws_CF_FunctionString

What business problem does the model solve?

BusinessStakeholders string | Aws_CF_FunctionString

Business stakeholders.

LineOfBusiness string | Aws_CF_FunctionString

Line of business.

TrainingDetails object

Overview about the training.

3 nested properties
ObjectiveFunction object

the objective function the model will optimize for.

2 nested properties
Function object

objective function that training job is optimized for.

Notes string | Aws_CF_FunctionString
TrainingObservations string | Aws_CF_FunctionString
TrainingJobDetails object
7 nested properties
TrainingArn string | Aws_CF_FunctionString

SageMaker Training job arn.

TrainingDatasets string[]

Location of the model datasets.

maxItems=15
TrainingEnvironment object
TrainingMetrics TrainingMetric[]
UserProvidedTrainingMetrics TrainingMetric[]
HyperParameters TrainingHyperParameter[]
UserProvidedHyperParameters TrainingHyperParameter[]
EvaluationDetails EvaluationDetail[]
Default:
[]
AdditionalInformation object
3 nested properties
EthicalConsiderations string | Aws_CF_FunctionString

Any ethical considerations that the author wants to provide.

CaveatsAndRecommendations string | Aws_CF_FunctionString

Caveats and recommendations for people who might use this model in their applications.

CustomDetails object

customer details.

ModelOverview object

Overview about the model.

ModelDescription string | Aws_CF_FunctionString

description of model.

ModelOwner string | Aws_CF_FunctionString

Owner of model.

ModelCreator string | Aws_CF_FunctionString

Creator of model.

ProblemType string | Aws_CF_FunctionString

Problem being solved with the model.

AlgorithmType string | Aws_CF_FunctionString

Algorithm used to solve the problem.

ModelId string | Aws_CF_FunctionString

SageMaker Model Arn or Non SageMaker Model id.

ModelArtifact string[]

Location of the model artifact.

maxItems=15
ModelName string | Aws_CF_FunctionString

Name of the model.

ModelVersion number

Version of the model.

min=1
InferenceEnvironment object

Overview about the inference.

1 nested properties
ContainerImage string[]

SageMaker inference image uri.

maxItems=15
ModelPackageDetails object

Metadata information related to model package version

ModelPackageDescription string | Aws_CF_FunctionString

A brief summary of the model package

ModelPackageArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the model package

CreatedBy object
1 nested properties
UserProfileName string | Aws_CF_FunctionString

The name of the user's profile in Studio

ModelPackageStatus string | Aws_CF_FunctionString

Current status of model package

ModelApprovalStatus string | Aws_CF_FunctionString

Current approval status of model package

ApprovalDescription string | Aws_CF_FunctionString

A description provided for the model approval

ModelPackageGroupName string | Aws_CF_FunctionString

If the model is a versioned model, the name of the model group that the versioned model belongs to.

ModelPackageName string | Aws_CF_FunctionString

Name of the model package

ModelPackageVersion number

Version of the model package

min=1
Domain string | Aws_CF_FunctionString

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

Task string | Aws_CF_FunctionString

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

SourceAlgorithms SourceAlgorithm[]
minItems=1maxItems=1
InferenceSpecification object
1 nested properties
Containers Container[] required

Contains inference related information which were used to create model package.

minItems=1maxItems=15
IntendedUses object

Intended usage of model.

PurposeOfModel string | Aws_CF_FunctionString

Why the model was developed?

IntendedUses string | Aws_CF_FunctionString

intended use cases.

FactorsAffectingModelEfficiency string | Aws_CF_FunctionString
RiskRating string | Aws_CF_FunctionString

Risk rating of model.

ExplanationsForRiskRating string | Aws_CF_FunctionString
BusinessDetails object

Business details.

BusinessProblem string | Aws_CF_FunctionString

What business problem does the model solve?

BusinessStakeholders string | Aws_CF_FunctionString

Business stakeholders.

LineOfBusiness string | Aws_CF_FunctionString

Line of business.

TrainingDetails object

Overview about the training.

ObjectiveFunction object

the objective function the model will optimize for.

2 nested properties
Function object

objective function that training job is optimized for.

3 nested properties
Function string | Aws_CF_FunctionString
Facet string | Aws_CF_FunctionString
Condition string | Aws_CF_FunctionString
Notes string | Aws_CF_FunctionString
TrainingObservations string | Aws_CF_FunctionString
TrainingJobDetails object
7 nested properties
TrainingArn string | Aws_CF_FunctionString

SageMaker Training job arn.

TrainingDatasets string[]

Location of the model datasets.

maxItems=15
TrainingEnvironment object
1 nested properties
ContainerImage string[]

SageMaker training image uri.

maxItems=15
TrainingMetrics TrainingMetric[]
UserProvidedTrainingMetrics TrainingMetric[]
HyperParameters TrainingHyperParameter[]
UserProvidedHyperParameters TrainingHyperParameter[]
EvaluationDetails EvaluationDetail[]
EvaluationDetail object

item of evaluation details

Name string | Aws_CF_FunctionString required
EvaluationObservation string | Aws_CF_FunctionString
EvaluationJobArn string | Aws_CF_FunctionString
Datasets string[]
maxItems=10
Metadata object

additional attributes associated with the evaluation results.

MetricGroups MetricGroup[]
Default:
[]
MetricGroup object

item in metric groups

Name string | Aws_CF_FunctionString required
MetricData SimpleMetric | LinearGraphMetric | BarChartMetric | MatrixMetric[] required
AdditionalInformation object
EthicalConsiderations string | Aws_CF_FunctionString

Any ethical considerations that the author wants to provide.

CaveatsAndRecommendations string | Aws_CF_FunctionString

Caveats and recommendations for people who might use this model in their applications.

CustomDetails object

customer details.

ModelPackageCreator object
UserProfileName string | Aws_CF_FunctionString

The name of the user's profile in Studio

SourceAlgorithms SourceAlgorithm[]
SourceAlgorithm object
AlgorithmName string | Aws_CF_FunctionString required

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

ModelDataUrl string | Aws_CF_FunctionString

The Amazon S3 path where the model artifacts, which result from model training, are stored.

InferenceSpecification object
Containers Container[] required

Contains inference related information which were used to create model package.

minItems=1maxItems=15
Container object
Image string | Aws_CF_FunctionString required

Inference environment path. The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

ModelDataUrl string | Aws_CF_FunctionString

The Amazon S3 path where the model artifacts, which result from model training, are stored.

NearestModelName string | Aws_CF_FunctionString

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model.

RiskRating string | Aws_CF_FunctionString

Risk rating of model.

ObjectiveFunction object

the objective function the model will optimize for.

Function object

objective function that training job is optimized for.

3 nested properties
Function string | Aws_CF_FunctionString
Facet string | Aws_CF_FunctionString
Condition string | Aws_CF_FunctionString
Notes string | Aws_CF_FunctionString
TrainingMetric object

training metric data.

Name string | Aws_CF_FunctionString required
Value number required
Notes string | Aws_CF_FunctionString
TrainingHyperParameter object

training hyper parameter

Name string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
LinearGraphMetric object

Linear graph metric.

Name string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required
Value number[][] required
Notes string | Aws_CF_FunctionString
XAxisName string | Aws_CF_FunctionString
YAxisName string | Aws_CF_FunctionString
BarChartMetric object
Name string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required
Value number[] required
Notes string | Aws_CF_FunctionString
XAxisName string[]
YAxisName string | Aws_CF_FunctionString
MatrixMetric object
Name string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required
Value number[][] required
Notes string | Aws_CF_FunctionString
XAxisName string[]
YAxisName string[]
SimpleMetric object

metric data

Name string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required
Value number | string | boolean required
Notes string | Aws_CF_FunctionString
XAxisName string | Aws_CF_FunctionString
YAxisName string | Aws_CF_FunctionString
AxisNameString string | Aws_CF_FunctionString
AxisNameArray string[]