interface CfnAlgorithmProps

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnAlgorithmProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnAlgorithmProps
Java	software.amazon.awscdk.services.sagemaker.CfnAlgorithmProps
Python	aws_cdk.aws_sagemaker.CfnAlgorithmProps
TypeScript	aws-cdk-lib » aws_sagemaker » CfnAlgorithmProps

Properties for defining a CfnAlgorithm.

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

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';
const cfnAlgorithmProps: sagemaker.CfnAlgorithmProps = {
  algorithmName: 'algorithmName',
  trainingSpecification: {
    supportedTrainingInstanceTypes: ['supportedTrainingInstanceTypes'],
    trainingChannels: [{
      name: 'name',
      supportedContentTypes: ['supportedContentTypes'],
      supportedInputModes: ['supportedInputModes'],

      // the properties below are optional
      description: 'description',
      isRequired: false,
      supportedCompressionTypes: ['supportedCompressionTypes'],
    }],
    trainingImage: 'trainingImage',

    // the properties below are optional
    metricDefinitions: [{
      name: 'name',
      regex: 'regex',
    }],
    supportedHyperParameters: [{
      name: 'name',
      type: 'type',

      // the properties below are optional
      defaultValue: 'defaultValue',
      description: 'description',
      isRequired: false,
      isTunable: false,
      range: {
        categoricalParameterRangeSpecification: {
          values: ['values'],
        },
        continuousParameterRangeSpecification: {
          maxValue: 'maxValue',
          minValue: 'minValue',
        },
        integerParameterRangeSpecification: {
          maxValue: 'maxValue',
          minValue: 'minValue',
        },
      },
    }],
    supportedTuningJobObjectiveMetrics: [{
      metricName: 'metricName',
      type: 'type',
    }],
    supportsDistributedTraining: false,
    trainingImageDigest: 'trainingImageDigest',
  },

  // the properties below are optional
  algorithmDescription: 'algorithmDescription',
  certifyForMarketplace: false,
  inferenceSpecification: {
    containers: [{
      image: 'image',

      // the properties below are optional
      containerHostname: 'containerHostname',
      environment: {
        environmentKey: 'environment',
      },
      framework: 'framework',
      frameworkVersion: 'frameworkVersion',
      imageDigest: 'imageDigest',
      isCheckpoint: false,
      modelInput: {
        dataInputConfig: 'dataInputConfig',
      },
      nearestModelName: 'nearestModelName',
    }],

    // the properties below are optional
    supportedContentTypes: ['supportedContentTypes'],
    supportedRealtimeInferenceInstanceTypes: ['supportedRealtimeInferenceInstanceTypes'],
    supportedResponseMimeTypes: ['supportedResponseMimeTypes'],
    supportedTransformInstanceTypes: ['supportedTransformInstanceTypes'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
algorithmName	string	The name of the algorithm.
trainingSpecification	IResolvable | TrainingSpecificationProperty
algorithmDescription?	string	A description of the algorithm.
certifyForMarketplace?	boolean | IResolvable	Whether to certify the algorithm so that it can be listed in AWS Marketplace.
inferenceSpecification?	IResolvable | InferenceSpecificationProperty
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

algorithmName

Type: string

The name of the algorithm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html#cfn-sagemaker-algorithm-algorithmname

---

trainingSpecification

Type: IResolvable | TrainingSpecificationProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html#cfn-sagemaker-algorithm-trainingspecification

---

algorithmDescription?

Type: string (optional)

A description of the algorithm.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html#cfn-sagemaker-algorithm-algorithmdescription

---

certifyForMarketplace?

Type: boolean | IResolvable (optional)

Whether to certify the algorithm so that it can be listed in AWS Marketplace.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html#cfn-sagemaker-algorithm-certifyformarketplace

---

inferenceSpecification?

Type: IResolvable | InferenceSpecificationProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html#cfn-sagemaker-algorithm-inferencespecification

---

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-algorithm.html#cfn-sagemaker-algorithm-tags