Class CfnAlgorithmMixinProps

Properties for CfnAlgorithmPropsMixin.

Inheritance

object

CfnAlgorithmMixinProps

Implements

ICfnAlgorithmMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.SageMaker

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnAlgorithmMixinProps : ICfnAlgorithmMixinProps

Syntax (vb)

Public Class CfnAlgorithmMixinProps Implements ICfnAlgorithmMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.SageMaker;

             var cfnAlgorithmMixinProps = new CfnAlgorithmMixinProps {
                 AlgorithmDescription = "algorithmDescription",
                 AlgorithmName = "algorithmName",
                 CertifyForMarketplace = false,
                 InferenceSpecification = new InferenceSpecificationProperty {
                     Containers = new [] { new ModelPackageContainerDefinitionProperty {
                         ContainerHostname = "containerHostname",
                         Environment = new Dictionary<string, string> {
                             { "environmentKey", "environment" }
                         },
                         Framework = "framework",
                         FrameworkVersion = "frameworkVersion",
                         Image = "image",
                         ImageDigest = "imageDigest",
                         IsCheckpoint = false,
                         ModelInput = new ModelInputProperty {
                             DataInputConfig = "dataInputConfig"
                         },
                         NearestModelName = "nearestModelName"
                     } },
                     SupportedContentTypes = new [] { "supportedContentTypes" },
                     SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
                     SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },
                     SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrainingSpecification = new TrainingSpecificationProperty {
                     MetricDefinitions = new [] { new MetricDefinitionProperty {
                         Name = "name",
                         Regex = "regex"
                     } },
                     SupportedHyperParameters = new [] { new HyperParameterSpecificationProperty {
                         DefaultValue = "defaultValue",
                         Description = "description",
                         IsRequired = false,
                         IsTunable = false,
                         Name = "name",
                         Range = new ParameterRangeProperty {
                             CategoricalParameterRangeSpecification = new CategoricalParameterRangeSpecificationProperty {
                                 Values = new [] { "values" }
                             },
                             ContinuousParameterRangeSpecification = new ContinuousParameterRangeSpecificationProperty {
                                 MaxValue = "maxValue",
                                 MinValue = "minValue"
                             },
                             IntegerParameterRangeSpecification = new IntegerParameterRangeSpecificationProperty {
                                 MaxValue = "maxValue",
                                 MinValue = "minValue"
                             }
                         },
                         Type = "type"
                     } },
                     SupportedTrainingInstanceTypes = new [] { "supportedTrainingInstanceTypes" },
                     SupportedTuningJobObjectiveMetrics = new [] { new HyperParameterTuningJobObjectiveProperty {
                         MetricName = "metricName",
                         Type = "type"
                     } },
                     SupportsDistributedTraining = false,
                     TrainingChannels = new [] { new ChannelSpecificationProperty {
                         Description = "description",
                         IsRequired = false,
                         Name = "name",
                         SupportedCompressionTypes = new [] { "supportedCompressionTypes" },
                         SupportedContentTypes = new [] { "supportedContentTypes" },
                         SupportedInputModes = new [] { "supportedInputModes" }
                     } },
                     TrainingImage = "trainingImage",
                     TrainingImageDigest = "trainingImageDigest"
                 }
             };

Synopsis

Constructors

CfnAlgorithmMixinProps()

Properties for CfnAlgorithmPropsMixin.

Properties

AlgorithmDescription	A description of the algorithm.
AlgorithmName	The name of the algorithm.
CertifyForMarketplace	Whether to certify the algorithm so that it can be listed in AWS Marketplace.
InferenceSpecification	Properties for CfnAlgorithmPropsMixin.
Tags	An array of key-value pairs to apply to this resource.
TrainingSpecification	Properties for CfnAlgorithmPropsMixin.

Constructors

CfnAlgorithmMixinProps()

Properties for CfnAlgorithmPropsMixin.

public CfnAlgorithmMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.SageMaker;

             var cfnAlgorithmMixinProps = new CfnAlgorithmMixinProps {
                 AlgorithmDescription = "algorithmDescription",
                 AlgorithmName = "algorithmName",
                 CertifyForMarketplace = false,
                 InferenceSpecification = new InferenceSpecificationProperty {
                     Containers = new [] { new ModelPackageContainerDefinitionProperty {
                         ContainerHostname = "containerHostname",
                         Environment = new Dictionary<string, string> {
                             { "environmentKey", "environment" }
                         },
                         Framework = "framework",
                         FrameworkVersion = "frameworkVersion",
                         Image = "image",
                         ImageDigest = "imageDigest",
                         IsCheckpoint = false,
                         ModelInput = new ModelInputProperty {
                             DataInputConfig = "dataInputConfig"
                         },
                         NearestModelName = "nearestModelName"
                     } },
                     SupportedContentTypes = new [] { "supportedContentTypes" },
                     SupportedRealtimeInferenceInstanceTypes = new [] { "supportedRealtimeInferenceInstanceTypes" },
                     SupportedResponseMimeTypes = new [] { "supportedResponseMimeTypes" },
                     SupportedTransformInstanceTypes = new [] { "supportedTransformInstanceTypes" }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TrainingSpecification = new TrainingSpecificationProperty {
                     MetricDefinitions = new [] { new MetricDefinitionProperty {
                         Name = "name",
                         Regex = "regex"
                     } },
                     SupportedHyperParameters = new [] { new HyperParameterSpecificationProperty {
                         DefaultValue = "defaultValue",
                         Description = "description",
                         IsRequired = false,
                         IsTunable = false,
                         Name = "name",
                         Range = new ParameterRangeProperty {
                             CategoricalParameterRangeSpecification = new CategoricalParameterRangeSpecificationProperty {
                                 Values = new [] { "values" }
                             },
                             ContinuousParameterRangeSpecification = new ContinuousParameterRangeSpecificationProperty {
                                 MaxValue = "maxValue",
                                 MinValue = "minValue"
                             },
                             IntegerParameterRangeSpecification = new IntegerParameterRangeSpecificationProperty {
                                 MaxValue = "maxValue",
                                 MinValue = "minValue"
                             }
                         },
                         Type = "type"
                     } },
                     SupportedTrainingInstanceTypes = new [] { "supportedTrainingInstanceTypes" },
                     SupportedTuningJobObjectiveMetrics = new [] { new HyperParameterTuningJobObjectiveProperty {
                         MetricName = "metricName",
                         Type = "type"
                     } },
                     SupportsDistributedTraining = false,
                     TrainingChannels = new [] { new ChannelSpecificationProperty {
                         Description = "description",
                         IsRequired = false,
                         Name = "name",
                         SupportedCompressionTypes = new [] { "supportedCompressionTypes" },
                         SupportedContentTypes = new [] { "supportedContentTypes" },
                         SupportedInputModes = new [] { "supportedInputModes" }
                     } },
                     TrainingImage = "trainingImage",
                     TrainingImageDigest = "trainingImageDigest"
                 }
             };

Properties

AlgorithmDescription

A description of the algorithm.

public string? AlgorithmDescription { get; set; }

Property Value

string

Remarks

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

AlgorithmName

The name of the algorithm.

public string? AlgorithmName { get; set; }

Property Value

string

Remarks

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

CertifyForMarketplace

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

public object? CertifyForMarketplace { get; set; }

Property Value

object

Remarks

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

Type union: either bool or IResolvable

InferenceSpecification

Properties for CfnAlgorithmPropsMixin.

public object? InferenceSpecification { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnAlgorithmPropsMixin.IInferenceSpecificationProperty

Tags

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

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

TrainingSpecification

Properties for CfnAlgorithmPropsMixin.

public object? TrainingSpecification { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnAlgorithmPropsMixin.ITrainingSpecificationProperty

Implements

ICfnAlgorithmMixinProps