interface ContentProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Sagemaker.CfnModelCard.ContentProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnModelCard_ContentProperty |
![]() | software.amazon.awscdk.services.sagemaker.CfnModelCard.ContentProperty |
![]() | aws_cdk.aws_sagemaker.CfnModelCard.ContentProperty |
![]() | aws-cdk-lib » aws_sagemaker » CfnModelCard » ContentProperty |
The content of the model card.
It follows the model card json schema .
Example
// 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';
declare const value: any;
const contentProperty: sagemaker.CfnModelCard.ContentProperty = {
additionalInformation: {
caveatsAndRecommendations: 'caveatsAndRecommendations',
customDetails: {
customDetailsKey: 'customDetails',
},
ethicalConsiderations: 'ethicalConsiderations',
},
businessDetails: {
businessProblem: 'businessProblem',
businessStakeholders: 'businessStakeholders',
lineOfBusiness: 'lineOfBusiness',
},
evaluationDetails: [{
name: 'name',
// the properties below are optional
datasets: ['datasets'],
evaluationJobArn: 'evaluationJobArn',
evaluationObservation: 'evaluationObservation',
metadata: {
metadataKey: 'metadata',
},
metricGroups: [{
metricData: [{
name: 'name',
type: 'type',
value: value,
// the properties below are optional
notes: 'notes',
xAxisName: ['xAxisName'],
yAxisName: ['yAxisName'],
}],
name: 'name',
}],
}],
intendedUses: {
explanationsForRiskRating: 'explanationsForRiskRating',
factorsAffectingModelEfficiency: 'factorsAffectingModelEfficiency',
intendedUses: 'intendedUses',
purposeOfModel: 'purposeOfModel',
riskRating: 'riskRating',
},
modelOverview: {
algorithmType: 'algorithmType',
inferenceEnvironment: {
containerImage: ['containerImage'],
},
modelArtifact: ['modelArtifact'],
modelCreator: 'modelCreator',
modelDescription: 'modelDescription',
modelId: 'modelId',
modelName: 'modelName',
modelOwner: 'modelOwner',
modelVersion: 123,
problemType: 'problemType',
},
modelPackageDetails: {
approvalDescription: 'approvalDescription',
createdBy: {
userProfileName: 'userProfileName',
},
domain: 'domain',
inferenceSpecification: {
containers: [{
image: 'image',
// the properties below are optional
modelDataUrl: 'modelDataUrl',
nearestModelName: 'nearestModelName',
}],
},
modelApprovalStatus: 'modelApprovalStatus',
modelPackageArn: 'modelPackageArn',
modelPackageDescription: 'modelPackageDescription',
modelPackageGroupName: 'modelPackageGroupName',
modelPackageName: 'modelPackageName',
modelPackageStatus: 'modelPackageStatus',
modelPackageVersion: 123,
sourceAlgorithms: [{
algorithmName: 'algorithmName',
// the properties below are optional
modelDataUrl: 'modelDataUrl',
}],
task: 'task',
},
trainingDetails: {
objectiveFunction: {
function: {
condition: 'condition',
facet: 'facet',
function: 'function',
},
notes: 'notes',
},
trainingJobDetails: {
hyperParameters: [{
name: 'name',
value: 'value',
}],
trainingArn: 'trainingArn',
trainingDatasets: ['trainingDatasets'],
trainingEnvironment: {
containerImage: ['containerImage'],
},
trainingMetrics: [{
name: 'name',
value: 123,
// the properties below are optional
notes: 'notes',
}],
userProvidedHyperParameters: [{
name: 'name',
value: 'value',
}],
userProvidedTrainingMetrics: [{
name: 'name',
value: 123,
// the properties below are optional
notes: 'notes',
}],
},
trainingObservations: 'trainingObservations',
},
};
Properties
Name | Type | Description |
---|---|---|
additional | IResolvable | Additional | Additional information about the model. |
business | IResolvable | Business | Information about how the model supports business goals. |
evaluation | IResolvable | IResolvable | Evaluation [] | An overview about the model's evaluation. |
intended | IResolvable | Intended | The intended usage of the model. |
model | IResolvable | Model | An overview about the model. |
model | IResolvable | Model | Metadata information related to model package version. |
training | IResolvable | Training | An overview about model training. |
additionalInformation?
Type:
IResolvable
|
Additional
(optional)
Additional information about the model.
businessDetails?
Type:
IResolvable
|
Business
(optional)
Information about how the model supports business goals.
evaluationDetails?
Type:
IResolvable
|
IResolvable
|
Evaluation
[]
(optional)
An overview about the model's evaluation.
intendedUses?
Type:
IResolvable
|
Intended
(optional)
The intended usage of the model.
modelOverview?
Type:
IResolvable
|
Model
(optional)
An overview about the model.
modelPackageDetails?
Type:
IResolvable
|
Model
(optional)
Metadata information related to model package version.
trainingDetails?
Type:
IResolvable
|
Training
(optional)
An overview about model training.