Skip to content
v2.277.0

HyperParameterSpecificationProperty 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 hyperParameterSpecificationProperty: sagemaker.CfnAlgorithm.HyperParameterSpecificationProperty = {
  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',
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

hyper_parameter_specification_property = sagemaker.CfnAlgorithm.HyperParameterSpecificationProperty(
    name="name",
    type="type",

    # the properties below are optional
    default_value="defaultValue",
    description="description",
    is_required=False,
    is_tunable=False,
    range=sagemaker.CfnAlgorithm.ParameterRangeProperty(
        categorical_parameter_range_specification=sagemaker.CfnAlgorithm.CategoricalParameterRangeSpecificationProperty(
            values=["values"]
        ),
        continuous_parameter_range_specification=sagemaker.CfnAlgorithm.ContinuousParameterRangeSpecificationProperty(
            max_value="maxValue",
            min_value="minValue"
        ),
        integer_parameter_range_specification=sagemaker.CfnAlgorithm.IntegerParameterRangeSpecificationProperty(
            max_value="maxValue",
            min_value="minValue"
        )
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;

HyperParameterSpecificationProperty hyperParameterSpecificationProperty = HyperParameterSpecificationProperty.builder()
        .name("name")
        .type("type")

        // the properties below are optional
        .defaultValue("defaultValue")
        .description("description")
        .isRequired(false)
        .isTunable(false)
        .range(ParameterRangeProperty.builder()
                .categoricalParameterRangeSpecification(CategoricalParameterRangeSpecificationProperty.builder()
                        .values(List.of("values"))
                        .build())
                .continuousParameterRangeSpecification(ContinuousParameterRangeSpecificationProperty.builder()
                        .maxValue("maxValue")
                        .minValue("minValue")
                        .build())
                .integerParameterRangeSpecification(IntegerParameterRangeSpecificationProperty.builder()
                        .maxValue("maxValue")
                        .minValue("minValue")
                        .build())
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var hyperParameterSpecificationProperty = new HyperParameterSpecificationProperty {
    Name = "name",
    Type = "type",

    // the properties below are optional
    DefaultValue = "defaultValue",
    Description = "description",
    IsRequired = false,
    IsTunable = false,
    Range = new ParameterRangeProperty {
        CategoricalParameterRangeSpecification = new CategoricalParameterRangeSpecificationProperty {
            Values = new [] { "values" }
        },
        ContinuousParameterRangeSpecification = new ContinuousParameterRangeSpecificationProperty {
            MaxValue = "maxValue",
            MinValue = "minValue"
        },
        IntegerParameterRangeSpecification = new IntegerParameterRangeSpecificationProperty {
            MaxValue = "maxValue",
            MinValue = "minValue"
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

hyperParameterSpecificationProperty := &HyperParameterSpecificationProperty{
	Name: jsii.String("name"),
	Type: jsii.String("type"),

	// the properties below are optional
	DefaultValue: jsii.String("defaultValue"),
	Description: jsii.String("description"),
	IsRequired: jsii.Boolean(false),
	IsTunable: jsii.Boolean(false),
	Range: &ParameterRangeProperty{
		CategoricalParameterRangeSpecification: &CategoricalParameterRangeSpecificationProperty{
			Values: []*string{
				jsii.String("values"),
			},
		},
		ContinuousParameterRangeSpecification: &ContinuousParameterRangeSpecificationProperty{
			MaxValue: jsii.String("maxValue"),
			MinValue: jsii.String("minValue"),
		},
		IntegerParameterRangeSpecification: &IntegerParameterRangeSpecificationProperty{
			MaxValue: jsii.String("maxValue"),
			MinValue: jsii.String("minValue"),
		},
	},
}

Properties ​

defaultValueoptionalstringdefault_valueoptionalstrdefaultValueoptionalStringDefaultValueoptionalstringDefaultValueoptional*string #
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
isRequiredoptionalboolean | IResolvableis_requiredoptionaltyping.Union[bool, IResolvable]isRequiredoptionalBooleanIsRequiredoptionalboolIsRequiredoptionalinterface{} #
isTunableoptionalboolean | IResolvableis_tunableoptionaltyping.Union[bool, IResolvable]isTunableoptionalBooleanIsTunableoptionalboolIsTunableoptionalinterface{} #
namestringnamestrnameStringNamestringName*string required #
rangeoptionalIResolvable | CfnAlgorithm.ParameterRangePropertyrangeoptionaltyping.Union[IResolvable, ParameterRangeProperty]rangeoptionalIResolvableRangeoptionalIResolvableRangeoptionalinterface{} #
typestringtypestrtypeStringTypestringType*string required #