aws-cdk-lib.aws_sagemaker.CfnModelCardProps

interface CfnModelCardProps

LanguageType name
.NETAmazon.CDK.AWS.Sagemaker.CfnModelCardProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnModelCardProps
Javasoftware.amazon.awscdk.services.sagemaker.CfnModelCardProps
Pythonaws_cdk.aws_sagemaker.CfnModelCardProps
TypeScript aws-cdk-lib » aws_sagemaker » CfnModelCardProps

Properties for defining a CfnModelCard.

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 cfnModelCardProps: sagemaker.CfnModelCardProps = {
  content: {
    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',
    },
  },
  modelCardName: 'modelCardName',
  modelCardStatus: 'modelCardStatus',

  // the properties below are optional
  createdBy: {
    domainId: 'domainId',
    userProfileArn: 'userProfileArn',
    userProfileName: 'userProfileName',
  },
  lastModifiedBy: {
    domainId: 'domainId',
    userProfileArn: 'userProfileArn',
    userProfileName: 'userProfileName',
  },
  securityConfig: {
    kmsKeyId: 'kmsKeyId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
contentIResolvable | ContentPropertyThe content of the model card.
modelCardNamestringThe unique name of the model card.
modelCardStatusstringThe approval status of the model card within your organization.
createdBy?IResolvable | UserContextPropertyInformation about the user who created or modified one or more of the following:.
lastModifiedBy?IResolvable | UserContextPropertyAWS::SageMaker::ModelCard.LastModifiedBy.
securityConfig?IResolvable | SecurityConfigPropertyThe security configuration used to protect model card data.
tags?CfnTag[]Key-value pairs used to manage metadata for the model card.

content

Type: IResolvable | ContentProperty

The content of the model card.

Content uses the model card JSON schema .


modelCardName

Type: string

The unique name of the model card.


modelCardStatus

Type: string

The approval status of the model card within your organization.

Different organizations might have different criteria for model card review and approval.

  • Draft : The model card is a work in progress.
  • PendingReview : The model card is pending review.
  • Approved : The model card is approved.
  • Archived : The model card is archived. No more updates should be made to the model card, but it can still be exported.

createdBy?

Type: IResolvable | UserContextProperty (optional)

Information about the user who created or modified one or more of the following:.

  • Experiment
  • Trial
  • Trial component
  • Lineage group
  • Project
  • Model Card

lastModifiedBy?

Type: IResolvable | UserContextProperty (optional)

AWS::SageMaker::ModelCard.LastModifiedBy.


securityConfig?

Type: IResolvable | SecurityConfigProperty (optional)

The security configuration used to protect model card data.


tags?

Type: CfnTag[] (optional)

Key-value pairs used to manage metadata for the model card.