class CfnModelCardPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins.CfnModelCardPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssagemaker/mixins#CfnModelCardPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnModelCardPropsMixin
Python	aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnModelCardPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_sagemaker » mixins » CfnModelCardPropsMixin

Implements IMixin

Extends Mixin

Creates an Amazon SageMaker Model Card.

For information about how to use model cards, see Amazon SageMaker Model Card .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-modelcard.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';

declare const value: any;
const cfnModelCardPropsMixin = new sagemaker_mixins.CfnModelCardPropsMixin({
  content: {
    additionalInformation: {
      caveatsAndRecommendations: 'caveatsAndRecommendations',
      customDetails: {
        customDetailsKey: 'customDetails',
      },
      ethicalConsiderations: 'ethicalConsiderations',
    },
    businessDetails: {
      businessProblem: 'businessProblem',
      businessStakeholders: 'businessStakeholders',
      lineOfBusiness: 'lineOfBusiness',
    },
    evaluationDetails: [{
      datasets: ['datasets'],
      evaluationJobArn: 'evaluationJobArn',
      evaluationObservation: 'evaluationObservation',
      metadata: {
        metadataKey: 'metadata',
      },
      metricGroups: [{
        metricData: [{
          name: 'name',
          notes: 'notes',
          type: 'type',
          value: value,
          xAxisName: ['xAxisName'],
          yAxisName: ['yAxisName'],
        }],
        name: 'name',
      }],
      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',
          modelDataUrl: 'modelDataUrl',
          nearestModelName: 'nearestModelName',
        }],
      },
      modelApprovalStatus: 'modelApprovalStatus',
      modelPackageArn: 'modelPackageArn',
      modelPackageDescription: 'modelPackageDescription',
      modelPackageGroupName: 'modelPackageGroupName',
      modelPackageName: 'modelPackageName',
      modelPackageStatus: 'modelPackageStatus',
      modelPackageVersion: 123,
      sourceAlgorithms: [{
        algorithmName: 'algorithmName',
        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',
          notes: 'notes',
          value: 123,
        }],
        userProvidedHyperParameters: [{
          name: 'name',
          value: 'value',
        }],
        userProvidedTrainingMetrics: [{
          name: 'name',
          notes: 'notes',
          value: 123,
        }],
      },
      trainingObservations: 'trainingObservations',
    },
  },
  createdBy: {
    domainId: 'domainId',
    userProfileArn: 'userProfileArn',
    userProfileName: 'userProfileName',
  },
  lastModifiedBy: {
    domainId: 'domainId',
    userProfileArn: 'userProfileArn',
    userProfileName: 'userProfileName',
  },
  modelCardName: 'modelCardName',
  modelCardStatus: 'modelCardStatus',
  securityConfig: {
    kmsKeyId: 'kmsKeyId',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnModelCardPropsMixin(props: CfnModelCardMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnModelCardMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::SageMaker::ModelCard.

Properties

Name	Type	Description
props	CfnModelCardMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnModelCardMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.