Skip to content
v2.273.0

TrainingSpecificationProperty Struct ​

Example ​

ts
// 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 trainingSpecificationProperty: sagemaker.CfnAlgorithm.TrainingSpecificationProperty = {
  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',
};

Properties ​

metricDefinitionsIResolvable | IResolvable | CfnAlgorithm.MetricDefinitionProperty[]metric_definitionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricDefinitionProperty]]]metricDefinitionsIResolvableMetricDefinitionsIResolvableMetricDefinitionsinterface{}#
supportedHyperParametersIResolvable | IResolvable | CfnAlgorithm.HyperParameterSpecificationProperty[]supported_hyper_parameterstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HyperParameterSpecificationProperty]]]supportedHyperParametersIResolvableSupportedHyperParametersIResolvableSupportedHyperParametersinterface{}#
supportedTrainingInstanceTypesstring[]supported_training_instance_typestyping.List[str]supportedTrainingInstanceTypesList<String>SupportedTrainingInstanceTypesstring[]SupportedTrainingInstanceTypes*[]*stringrequired#
supportedTuningJobObjectiveMetricsIResolvable | IResolvable | CfnAlgorithm.HyperParameterTuningJobObjectiveProperty[]supported_tuning_job_objective_metricstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HyperParameterTuningJobObjectiveProperty]]]supportedTuningJobObjectiveMetricsIResolvableSupportedTuningJobObjectiveMetricsIResolvableSupportedTuningJobObjectiveMetricsinterface{}#
supportsDistributedTrainingboolean | IResolvablesupports_distributed_trainingtyping.Union[bool, IResolvable]supportsDistributedTrainingBooleanSupportsDistributedTrainingboolSupportsDistributedTraininginterface{}#
trainingChannelsIResolvable | IResolvable | CfnAlgorithm.ChannelSpecificationProperty[]training_channelstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ChannelSpecificationProperty]]]trainingChannelsIResolvableTrainingChannelsIResolvableTrainingChannelsinterface{}required#
trainingImagestringtraining_imagestrtrainingImageStringTrainingImagestringTrainingImage*stringrequired#
trainingImageDigeststringtraining_image_digeststrtrainingImageDigestStringTrainingImageDigeststringTrainingImageDigest*string#